cgit.sxemacs.org Git - gnus/blob - lisp/gnus-group.el

   1 ;;; gnus-group.el --- group mode commands for Gnus
   2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
   3 ;;        Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-when-compile
  30   (require 'cl)
  31   (defvar tool-bar-map))
  32
  33 (require 'gnus)
  34 (require 'gnus-start)
  35 (require 'nnmail)
  36 (require 'gnus-spec)
  37 (require 'gnus-int)
  38 (require 'gnus-range)
  39 (require 'gnus-win)
  40 (require 'gnus-undo)
  41 (require 'time-date)
  42 (require 'gnus-ems)
  43
  44 (eval-when-compile (require 'mm-url))
  45
  46 (defcustom gnus-group-archive-directory
  47   "*ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list/"
  48   "*The address of the (ding) archives."
  49   :group 'gnus-group-foreign
  50   :type 'directory)
  51
  52 (defcustom gnus-group-recent-archive-directory
  53   "*ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list-recent/"
  54   "*The address of the most recent (ding) articles."
  55   :group 'gnus-group-foreign
  56   :type 'directory)
  57
  58 (defcustom gnus-no-groups-message "No gnus is bad news"
  59   "*Message displayed by Gnus when no groups are available."
  60   :group 'gnus-start
  61   :type 'string)
  62
  63 (defcustom gnus-keep-same-level nil
  64   "*Non-nil means that the next newsgroup after the current will be on the same level.
  65 When you type, for instance, `n' after reading the last article in the
  66 current newsgroup, you will go to the next newsgroup.  If this variable
  67 is nil, the next newsgroup will be the next from the group
  68 buffer.
  69 If this variable is non-nil, Gnus will either put you in the
  70 next newsgroup with the same level, or, if no such newsgroup is
  71 available, the next newsgroup with the lowest possible level higher
  72 than the current level.
  73 If this variable is `best', Gnus will make the next newsgroup the one
  74 with the best level."
  75   :group 'gnus-group-levels
  76   :type '(choice (const nil)
  77                  (const best)
  78                  (sexp :tag "other" t)))
  79
  80 (defcustom gnus-group-goto-unread t
  81   "*If non-nil, movement commands will go to the next unread and subscribed group."
  82   :link '(custom-manual "(gnus)Group Maneuvering")
  83   :group 'gnus-group-various
  84   :type 'boolean)
  85
  86 (defcustom gnus-goto-next-group-when-activating t
  87   "*If non-nil, the \\<gnus-group-mode-map>\\[gnus-group-get-new-news-this-group] command will advance point to the next group."
  88   :link '(custom-manual "(gnus)Scanning New Messages")
  89   :group 'gnus-group-various
  90   :type 'boolean)
  91
  92 (defcustom gnus-permanently-visible-groups nil
  93   "*Regexp to match groups that should always be listed in the group buffer.
  94 This means that they will still be listed even when there are no
  95 unread articles in the groups.
  96
  97 If nil, no groups are permanently visible."
  98   :group 'gnus-group-listing
  99   :type '(choice regexp (const nil)))
 100
 101 (defcustom gnus-list-groups-with-ticked-articles t
 102   "*If non-nil, list groups that have only ticked articles.
 103 If nil, only list groups that have unread articles."
 104   :group 'gnus-group-listing
 105   :type 'boolean)
 106
 107 (defcustom gnus-group-default-list-level gnus-level-subscribed
 108   "*Default listing level.
 109 Ignored if `gnus-group-use-permanent-levels' is non-nil."
 110   :group 'gnus-group-listing
 111   :type 'integer)
 112
 113 (defcustom gnus-group-list-inactive-groups t
 114   "*If non-nil, inactive groups will be listed."
 115   :group 'gnus-group-listing
 116   :group 'gnus-group-levels
 117   :type 'boolean)
 118
 119 (defcustom gnus-group-sort-function 'gnus-group-sort-by-alphabet
 120   "*Function used for sorting the group buffer.
 121 This function will be called with group info entries as the arguments
 122 for the groups to be sorted.  Pre-made functions include
 123 `gnus-group-sort-by-alphabet', `gnus-group-sort-by-real-name',
 124 `gnus-group-sort-by-unread', `gnus-group-sort-by-level',
 125 `gnus-group-sort-by-score', `gnus-group-sort-by-method',
 126 `gnus-group-sort-by-server', and `gnus-group-sort-by-rank'.
 127
 128 This variable can also be a list of sorting functions.  In that case,
 129 the most significant sort function should be the last function in the
 130 list."
 131   :group 'gnus-group-listing
 132   :link '(custom-manual "(gnus)Sorting Groups")
 133   :type '(repeat :value-to-internal (lambda (widget value)
 134                                       (if (listp value) value (list value)))
 135                  :match (lambda (widget value)
 136                           (or (symbolp value)
 137                               (widget-editable-list-match widget value)))
 138                  (choice (function-item gnus-group-sort-by-alphabet)
 139                          (function-item gnus-group-sort-by-real-name)
 140                          (function-item gnus-group-sort-by-unread)
 141                          (function-item gnus-group-sort-by-level)
 142                          (function-item gnus-group-sort-by-score)
 143                          (function-item gnus-group-sort-by-method)
 144                          (function-item gnus-group-sort-by-server)
 145                          (function-item gnus-group-sort-by-rank)
 146                          (function :tag "other" nil))))
 147
 148 (defcustom gnus-group-line-format "%M\%S\%p\%P\%5y:%B%(%g%)%l %O\n"
 149   "*Format of group lines.
 150 It works along the same lines as a normal formatting string,
 151 with some simple extensions.
 152
 153 %M    Only marked articles (character, \"*\" or \" \")
 154 %S    Whether the group is subscribed (character, \"U\", \"K\", \"Z\" or \" \")
 155 %L    Level of subscribedness (integer)
 156 %N    Number of unread articles (integer)
 157 %I    Number of dormant articles (integer)
 158 %i    Number of ticked and dormant (integer)
 159 %T    Number of ticked articles (integer)
 160 %R    Number of read articles (integer)
 161 %U    Number of unseen articles (integer)
 162 %t    Estimated total number of articles (integer)
 163 %y    Number of unread, unticked articles (integer)
 164 %G    Group name (string)
 165 %g    Qualified group name (string)
 166 %c    Short (collapsed) group name.  See `gnus-group-uncollapsed-levels'.
 167 %C    Group comment (string)
 168 %D    Group description (string)
 169 %s    Select method (string)
 170 %o    Moderated group (char, \"m\")
 171 %p    Process mark (char)
 172 %B    Whether a summary buffer for the group is open (char, \"*\")
 173 %O    Moderated group (string, \"(m)\" or \"\")
 174 %P    Topic indentation (string)
 175 %m    Whether there is new(ish) mail in the group (char, \"%\")
 176 %l    Whether there are GroupLens predictions for this group (string)
 177 %n    Select from where (string)
 178 %z    A string that look like `<%s:%n>' if a foreign select method is used
 179 %d    The date the group was last entered.
 180 %E    Icon as defined by `gnus-group-icon-list'.
 181 %u    User defined specifier.  The next character in the format string should
 182       be a letter.  Gnus will call the function gnus-user-format-function-X,
 183       where X is the letter following %u.  The function will be passed a
 184       single dummy parameter as argument.  The function should return a
 185       string, which will be inserted into the buffer just like information
 186       from any other group specifier.
 187
 188 Note that this format specification is not always respected.  For
 189 reasons of efficiency, when listing killed groups, this specification
 190 is ignored altogether.  If the spec is changed considerably, your
 191 output may end up looking strange when listing both alive and killed
 192 groups.
 193
 194 If you use %o or %O, reading the active file will be slower and quite
 195 a bit of extra memory will be used.  %D will also worsen performance.
 196 Also note that if you change the format specification to include any
 197 of these specs, you must probably re-start Gnus to see them go into
 198 effect.
 199
 200 General format specifiers can also be used.
 201 See Info node `(gnus)Formatting Variables'."
 202   :link '(custom-manual "(gnus)Formatting Variables")
 203   :group 'gnus-group-visual
 204   :type 'string)
 205
 206 (defcustom gnus-group-mode-line-format "Gnus: %%b {%M\%:%S}"
 207   "*The format specification for the group mode line.
 208 It works along the same lines as a normal formatting string,
 209 with some simple extensions:
 210
 211 %S   The native news server.
 212 %M   The native select method.
 213 %:   \":\" if %S isn't \"\"."
 214   :group 'gnus-group-visual
 215   :type 'string)
 216
 217 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
 218 (when (featurep 'xemacs)
 219   (add-hook 'gnus-group-mode-hook 'gnus-xmas-group-menu-add)
 220   (add-hook 'gnus-group-mode-hook 'gnus-xmas-setup-group-toolbar))
 221
 222 (defcustom gnus-group-menu-hook nil
 223   "Hook run after the creation of the group mode menu."
 224   :group 'gnus-group-various
 225   :type 'hook)
 226
 227 (defcustom gnus-group-catchup-group-hook nil
 228   "Hook run when catching up a group from the group buffer."
 229   :group 'gnus-group-various
 230   :link '(custom-manual "(gnus)Group Data")
 231   :type 'hook)
 232
 233 (defcustom gnus-group-update-group-hook nil
 234   "Hook called when updating group lines."
 235   :group 'gnus-group-visual
 236   :type 'hook)
 237
 238 (defcustom gnus-group-prepare-function 'gnus-group-prepare-flat
 239   "*A function that is called to generate the group buffer.
 240 The function is called with three arguments: The first is a number;
 241 all group with a level less or equal to that number should be listed,
 242 if the second is non-nil, empty groups should also be displayed.  If
 243 the third is non-nil, it is a number.  No groups with a level lower
 244 than this number should be displayed.
 245
 246 The only current function implemented is `gnus-group-prepare-flat'."
 247   :group 'gnus-group-listing
 248   :type 'function)
 249
 250 (defcustom gnus-group-prepare-hook nil
 251   "Hook called after the group buffer has been generated.
 252 If you want to modify the group buffer, you can use this hook."
 253   :group 'gnus-group-listing
 254   :type 'hook)
 255
 256 (defcustom gnus-suspend-gnus-hook nil
 257   "Hook called when suspending (not exiting) Gnus."
 258   :group 'gnus-exit
 259   :type 'hook)
 260
 261 (defcustom gnus-exit-gnus-hook nil
 262   "Hook called when exiting Gnus."
 263   :group 'gnus-exit
 264   :type 'hook)
 265
 266 (defcustom gnus-after-exiting-gnus-hook nil
 267   "Hook called after exiting Gnus."
 268   :group 'gnus-exit
 269   :type 'hook)
 270
 271 (defcustom gnus-group-update-hook '(gnus-group-highlight-line)
 272   "Hook called when a group line is changed.
 273 The hook will not be called if `gnus-visual' is nil.
 274
 275 The default function `gnus-group-highlight-line' will
 276 highlight the line according to the `gnus-group-highlight'
 277 variable."
 278   :group 'gnus-group-visual
 279   :type 'hook)
 280
 281 (defcustom gnus-useful-groups
 282   '(("(ding) mailing list mirrored at sunsite.auc.dk"
 283      "emacs.ding"
 284      (nntp "sunsite.auc.dk"
 285            (nntp-address "sunsite.auc.dk")))
 286     ("gnus-bug archive"
 287      "gnus-bug"
 288      (nndir "/ftp@ftp.ifi.uio.no:/pub/emacs/gnus/gnus-bug/"))
 289     ("Gnus help group"
 290      "gnus-help"
 291      (nndoc "gnus-help"
 292             (nndoc-article-type mbox)
 293             (eval `(nndoc-address
 294                     ,(let ((file (nnheader-find-etc-directory
 295                                   "gnus-tut.txt" t)))
 296                        (unless file
 297                          (error "Couldn't find doc group"))
 298                        file))))))
 299   "*Alist of useful group-server pairs."
 300   :group 'gnus-group-listing
 301   :type '(repeat (list (string :tag "Description")
 302                        (string :tag "Name")
 303                        (sexp :tag "Method"))))
 304
 305 (defcustom gnus-group-highlight
 306   '(;; Mail.
 307     ((and mailp (= unread 0) (eq level 1)) .
 308      gnus-group-mail-1-empty-face)
 309     ((and mailp (eq level 1)) .
 310      gnus-group-mail-1-face)
 311     ((and mailp (= unread 0) (eq level 2)) .
 312      gnus-group-mail-2-empty-face)
 313     ((and mailp (eq level 2)) .
 314      gnus-group-mail-2-face)
 315     ((and mailp (= unread 0) (eq level 3)) .
 316      gnus-group-mail-3-empty-face)
 317     ((and mailp (eq level 3)) .
 318      gnus-group-mail-3-face)
 319     ((and mailp (= unread 0)) .
 320      gnus-group-mail-low-empty-face)
 321     ((and mailp) .
 322      gnus-group-mail-low-face)
 323     ;; News.
 324     ((and (= unread 0) (eq level 1)) .
 325      gnus-group-news-1-empty-face)
 326     ((and (eq level 1)) .
 327      gnus-group-news-1-face)
 328     ((and (= unread 0) (eq level 2)) .
 329      gnus-group-news-2-empty-face)
 330     ((and (eq level 2)) .
 331      gnus-group-news-2-face)
 332     ((and (= unread 0) (eq level 3)) .
 333      gnus-group-news-3-empty-face)
 334     ((and (eq level 3)) .
 335      gnus-group-news-3-face)
 336     ((and (= unread 0) (eq level 4)) .
 337      gnus-group-news-4-empty-face)
 338     ((and (eq level 4)) .
 339      gnus-group-news-4-face)
 340     ((and (= unread 0) (eq level 5)) .
 341      gnus-group-news-5-empty-face)
 342     ((and (eq level 5)) .
 343      gnus-group-news-5-face)
 344     ((and (= unread 0) (eq level 6)) .
 345      gnus-group-news-6-empty-face)
 346     ((and (eq level 6)) .
 347      gnus-group-news-6-face)
 348     ((and (= unread 0)) .
 349      gnus-group-news-low-empty-face)
 350     (t .
 351      gnus-group-news-low-face))
 352   "*Controls the highlighting of group buffer lines.
 353
 354 Below is a list of `Form'/`Face' pairs.  When deciding how a a
 355 particular group line should be displayed, each form is
 356 evaluated.  The content of the face field after the first true form is
 357 used.  You can change how those group lines are displayed by
 358 editing the face field.
 359
 360 It is also possible to change and add form fields, but currently that
 361 requires an understanding of Lisp expressions.  Hopefully this will
 362 change in a future release.  For now, you can use the following
 363 variables in the Lisp expression:
 364
 365 group: The name of the group.
 366 unread: The number of unread articles in the group.
 367 method: The select method used.
 368 mailp: Whether it's a mail group or not.
 369 level: The level of the group.
 370 score: The score of the group.
 371 ticked: The number of ticked articles."
 372   :group 'gnus-group-visual
 373   :type '(repeat (cons (sexp :tag "Form") face)))
 374
 375 (defcustom gnus-new-mail-mark ?%
 376   "Mark used for groups with new mail."
 377   :group 'gnus-group-visual
 378   :type 'character)
 379
 380 (defgroup gnus-group-icons nil
 381   "Add Icons to your group buffer.  "
 382   :group 'gnus-group-visual)
 383
 384 (defcustom gnus-group-icon-list
 385   nil
 386   "*Controls the insertion of icons into group buffer lines.
 387
 388 Below is a list of `Form'/`File' pairs.  When deciding how a
 389 particular group line should be displayed, each form is evaluated.
 390 The icon from the file field after the first true form is used.  You
 391 can change how those group lines are displayed by editing the file
 392 field.  The File will either be found in the
 393 `gnus-group-glyph-directory' or by designating absolute name of the
 394 file.
 395
 396 It is also possible to change and add form fields, but currently that
 397 requires an understanding of Lisp expressions.  Hopefully this will
 398 change in a future release.  For now, you can use the following
 399 variables in the Lisp expression:
 400
 401 group: The name of the group.
 402 unread: The number of unread articles in the group.
 403 method: The select method used.
 404 mailp: Whether it's a mail group or not.
 405 newsp: Whether it's a news group or not
 406 level: The level of the group.
 407 score: The score of the group.
 408 ticked: The number of ticked articles."
 409   :group 'gnus-group-icons
 410   :type '(repeat (cons (sexp :tag "Form") file)))
 411
 412 (defcustom gnus-group-name-charset-method-alist nil
 413   "Alist of method and the charset for group names.
 414
 415 For example:
 416     (((nntp \"news.com.cn\") . cn-gb-2312))"
 417   :version "21.1"
 418   :group 'gnus-charset
 419   :type '(repeat (cons (sexp :tag "Method") (symbol :tag "Charset"))))
 420
 421 (defcustom gnus-group-name-charset-group-alist
 422   (if (or (and (fboundp 'find-coding-system) (find-coding-system 'utf-8))
 423           (mm-coding-system-p 'utf-8))
 424       '((".*" . utf-8))
 425     nil)
 426   "Alist of group regexp and the charset for group names.
 427
 428 For example:
 429     ((\"\\.com\\.cn:\" . cn-gb-2312))"
 430   :group 'gnus-charset
 431   :type '(repeat (cons (regexp :tag "Group") (symbol :tag "Charset"))))
 432
 433 (defcustom gnus-group-jump-to-group-prompt nil
 434   "Default prompt for `gnus-group-jump-to-group'.
 435 If non-nil, the value should be a string, e.g. \"nnml:\",
 436 in which case `gnus-group-jump-to-group' offers \"Group: nnml:\"
 437 in the minibuffer prompt."
 438   :group 'gnus-group-various
 439   :type '(choice (string :tag "Prompt string")
 440                  (const :tag "Empty" nil)))
 441
 442 (defvar gnus-group-listing-limit 1000
 443   "*A limit of the number of groups when listing.
 444 If the number of groups is larger than the limit, list them in a
 445 simple manner.")
 446
 447 ;;; Internal variables
 448
 449 (defvar gnus-group-is-exiting-p nil)
 450 (defvar gnus-group-is-exiting-without-update-p nil)
 451 (defvar gnus-group-sort-alist-function 'gnus-group-sort-flat
 452   "Function for sorting the group buffer.")
 453
 454 (defvar gnus-group-sort-selected-function 'gnus-group-sort-selected-flat
 455   "Function for sorting the selected groups in the group buffer.")
 456
 457 (defvar gnus-group-indentation-function nil)
 458 (defvar gnus-goto-missing-group-function nil)
 459 (defvar gnus-group-update-group-function nil)
 460 (defvar gnus-group-goto-next-group-function nil
 461   "Function to override finding the next group after listing groups.")
 462
 463 (defvar gnus-group-edit-buffer nil)
 464
 465 (defvar gnus-group-line-format-alist
 466   `((?M gnus-tmp-marked-mark ?c)
 467     (?S gnus-tmp-subscribed ?c)
 468     (?L gnus-tmp-level ?d)
 469     (?N (cond ((eq number t) "*" )
 470               ((numberp number)
 471                (int-to-string
 472                 (+ number
 473                    (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
 474                    (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))))))
 475               (t number)) ?s)
 476     (?R gnus-tmp-number-of-read ?s)
 477     (?U (gnus-number-of-unseen-articles-in-group gnus-tmp-group) ?d)
 478     (?t gnus-tmp-number-total ?d)
 479     (?y gnus-tmp-number-of-unread ?s)
 480     (?I (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked))) ?d)
 481     (?T (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))) ?d)
 482     (?i (+ (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
 483            (gnus-range-length (cdr (assq 'tick gnus-tmp-marked)))) ?d)
 484     (?g gnus-tmp-group ?s)
 485     (?G gnus-tmp-qualified-group ?s)
 486     (?c (gnus-short-group-name gnus-tmp-group) ?s)
 487     (?C gnus-tmp-comment ?s)
 488     (?D gnus-tmp-newsgroup-description ?s)
 489     (?o gnus-tmp-moderated ?c)
 490     (?O gnus-tmp-moderated-string ?s)
 491     (?p gnus-tmp-process-marked ?c)
 492     (?s gnus-tmp-news-server ?s)
 493     (?n gnus-tmp-news-method ?s)
 494     (?P gnus-group-indentation ?s)
 495     (?E gnus-tmp-group-icon ?s)
 496     (?B gnus-tmp-summary-live ?c)
 497     (?l gnus-tmp-grouplens ?s)
 498     (?z gnus-tmp-news-method-string ?s)
 499     (?m (gnus-group-new-mail gnus-tmp-group) ?c)
 500     (?d (gnus-group-timestamp-string gnus-tmp-group) ?s)
 501     (?u gnus-tmp-user-defined ?s)))
 502
 503 (defvar gnus-group-mode-line-format-alist
 504   `((?S gnus-tmp-news-server ?s)
 505     (?M gnus-tmp-news-method ?s)
 506     (?u gnus-tmp-user-defined ?s)
 507     (?: gnus-tmp-colon ?s)))
 508
 509 (defvar gnus-topic-topology nil
 510   "The complete topic hierarchy.")
 511
 512 (defvar gnus-topic-alist nil
 513   "The complete topic-group alist.")
 514
 515 (defvar gnus-group-marked nil)
 516
 517 (defvar gnus-group-list-mode nil)
 518
 519
 520 (defvar gnus-group-icon-cache nil)
 521
 522 (defvar gnus-group-listed-groups nil)
 523 (defvar gnus-group-list-option nil)
 524
 525 ;;;
 526 ;;; Gnus group mode
 527 ;;;
 528
 529 (put 'gnus-group-mode 'mode-class 'special)
 530
 531 (when t
 532   (gnus-define-keys gnus-group-mode-map
 533     " " gnus-group-read-group
 534     "=" gnus-group-select-group
 535     "\r" gnus-group-select-group
 536     "\M-\r" gnus-group-quick-select-group
 537     "\M- " gnus-group-visible-select-group
 538     [(meta control return)] gnus-group-select-group-ephemerally
 539     "j" gnus-group-jump-to-group
 540     "n" gnus-group-next-unread-group
 541     "p" gnus-group-prev-unread-group
 542     "\177" gnus-group-prev-unread-group
 543     [delete] gnus-group-prev-unread-group
 544     [backspace] gnus-group-prev-unread-group
 545     "N" gnus-group-next-group
 546     "P" gnus-group-prev-group
 547     "\M-n" gnus-group-next-unread-group-same-level
 548     "\M-p" gnus-group-prev-unread-group-same-level
 549     "," gnus-group-best-unread-group
 550     "." gnus-group-first-unread-group
 551     "u" gnus-group-unsubscribe-current-group
 552     "U" gnus-group-unsubscribe-group
 553     "c" gnus-group-catchup-current
 554     "C" gnus-group-catchup-current-all
 555     "\M-c" gnus-group-clear-data
 556     "l" gnus-group-list-groups
 557     "L" gnus-group-list-all-groups
 558     "m" gnus-group-mail
 559     "i" gnus-group-news
 560     "g" gnus-group-get-new-news
 561     "\M-g" gnus-group-get-new-news-this-group
 562     "R" gnus-group-restart
 563     "r" gnus-group-read-init-file
 564     "B" gnus-group-browse-foreign-server
 565     "b" gnus-group-check-bogus-groups
 566     "F" gnus-group-find-new-groups
 567     "\C-c\C-d" gnus-group-describe-group
 568     "\M-d" gnus-group-describe-all-groups
 569     "\C-c\C-a" gnus-group-apropos
 570     "\C-c\M-\C-a" gnus-group-description-apropos
 571     "a" gnus-group-post-news
 572     "\ek" gnus-group-edit-local-kill
 573     "\eK" gnus-group-edit-global-kill
 574     "\C-k" gnus-group-kill-group
 575     "\C-y" gnus-group-yank-group
 576     "\C-w" gnus-group-kill-region
 577     "\C-x\C-t" gnus-group-transpose-groups
 578     "\C-c\C-l" gnus-group-list-killed
 579     "\C-c\C-x" gnus-group-expire-articles
 580     "\C-c\M-\C-x" gnus-group-expire-all-groups
 581     "V" gnus-version
 582     "s" gnus-group-save-newsrc
 583     "z" gnus-group-suspend
 584     "q" gnus-group-exit
 585     "Q" gnus-group-quit
 586     "?" gnus-group-describe-briefly
 587     "\C-c\C-i" gnus-info-find-node
 588     "\M-e" gnus-group-edit-group-method
 589     "^" gnus-group-enter-server-mode
 590     gnus-mouse-2 gnus-mouse-pick-group
 591     "<" beginning-of-buffer
 592     ">" end-of-buffer
 593     "\C-c\C-b" gnus-bug
 594     "\C-c\C-s" gnus-group-sort-groups
 595     "t" gnus-topic-mode
 596     "\C-c\M-g" gnus-activate-all-groups
 597     "\M-&" gnus-group-universal-argument
 598     "#" gnus-group-mark-group
 599     "\M-#" gnus-group-unmark-group)
 600
 601   (gnus-define-keys (gnus-group-mark-map "M" gnus-group-mode-map)
 602     "m" gnus-group-mark-group
 603     "u" gnus-group-unmark-group
 604     "w" gnus-group-mark-region
 605     "b" gnus-group-mark-buffer
 606     "r" gnus-group-mark-regexp
 607     "U" gnus-group-unmark-all-groups)
 608
 609   (gnus-define-keys (gnus-group-sieve-map "D" gnus-group-mode-map)
 610     "u" gnus-sieve-update
 611     "g" gnus-sieve-generate)
 612
 613   (gnus-define-keys (gnus-group-group-map "G" gnus-group-mode-map)
 614     "d" gnus-group-make-directory-group
 615     "h" gnus-group-make-help-group
 616     "u" gnus-group-make-useful-group
 617     "a" gnus-group-make-archive-group
 618     "k" gnus-group-make-kiboze-group
 619     "l" gnus-group-nnimap-edit-acl
 620     "m" gnus-group-make-group
 621     "E" gnus-group-edit-group
 622     "e" gnus-group-edit-group-method
 623     "p" gnus-group-edit-group-parameters
 624     "v" gnus-group-add-to-virtual
 625     "V" gnus-group-make-empty-virtual
 626     "D" gnus-group-enter-directory
 627     "f" gnus-group-make-doc-group
 628     "w" gnus-group-make-web-group
 629     "r" gnus-group-rename-group
 630     "R" gnus-group-make-rss-group
 631     "c" gnus-group-customize
 632     "x" gnus-group-nnimap-expunge
 633     "\177" gnus-group-delete-group
 634     [delete] gnus-group-delete-group)
 635
 636   (gnus-define-keys (gnus-group-soup-map "s" gnus-group-group-map)
 637     "b" gnus-group-brew-soup
 638     "w" gnus-soup-save-areas
 639     "s" gnus-soup-send-replies
 640     "p" gnus-soup-pack-packet
 641     "r" nnsoup-pack-replies)
 642
 643   (gnus-define-keys (gnus-group-sort-map "S" gnus-group-group-map)
 644     "s" gnus-group-sort-groups
 645     "a" gnus-group-sort-groups-by-alphabet
 646     "u" gnus-group-sort-groups-by-unread
 647     "l" gnus-group-sort-groups-by-level
 648     "v" gnus-group-sort-groups-by-score
 649     "r" gnus-group-sort-groups-by-rank
 650     "m" gnus-group-sort-groups-by-method
 651     "n" gnus-group-sort-groups-by-real-name)
 652
 653   (gnus-define-keys (gnus-group-sort-selected-map "P" gnus-group-group-map)
 654     "s" gnus-group-sort-selected-groups
 655     "a" gnus-group-sort-selected-groups-by-alphabet
 656     "u" gnus-group-sort-selected-groups-by-unread
 657     "l" gnus-group-sort-selected-groups-by-level
 658     "v" gnus-group-sort-selected-groups-by-score
 659     "r" gnus-group-sort-selected-groups-by-rank
 660     "m" gnus-group-sort-selected-groups-by-method
 661     "n" gnus-group-sort-selected-groups-by-real-name)
 662
 663   (gnus-define-keys (gnus-group-list-map "A" gnus-group-mode-map)
 664     "k" gnus-group-list-killed
 665     "z" gnus-group-list-zombies
 666     "s" gnus-group-list-groups
 667     "u" gnus-group-list-all-groups
 668     "A" gnus-group-list-active
 669     "a" gnus-group-apropos
 670     "d" gnus-group-description-apropos
 671     "m" gnus-group-list-matching
 672     "M" gnus-group-list-all-matching
 673     "l" gnus-group-list-level
 674     "c" gnus-group-list-cached
 675     "?" gnus-group-list-dormant)
 676
 677   (gnus-define-keys (gnus-group-list-limit-map "/" gnus-group-list-map)
 678     "k"  gnus-group-list-limit
 679     "z"  gnus-group-list-limit
 680     "s"  gnus-group-list-limit
 681     "u"  gnus-group-list-limit
 682     "A"  gnus-group-list-limit
 683     "m"  gnus-group-list-limit
 684     "M"  gnus-group-list-limit
 685     "l"  gnus-group-list-limit
 686     "c"  gnus-group-list-limit
 687     "?"  gnus-group-list-limit)
 688
 689   (gnus-define-keys (gnus-group-list-flush-map "f" gnus-group-list-map)
 690     "k"  gnus-group-list-flush
 691     "z"  gnus-group-list-flush
 692     "s"  gnus-group-list-flush
 693     "u"  gnus-group-list-flush
 694     "A"  gnus-group-list-flush
 695     "m"  gnus-group-list-flush
 696     "M"  gnus-group-list-flush
 697     "l"  gnus-group-list-flush
 698     "c"  gnus-group-list-flush
 699     "?"  gnus-group-list-flush)
 700
 701   (gnus-define-keys (gnus-group-list-plus-map "p" gnus-group-list-map)
 702     "k"  gnus-group-list-plus
 703     "z"  gnus-group-list-plus
 704     "s"  gnus-group-list-plus
 705     "u"  gnus-group-list-plus
 706     "A"  gnus-group-list-plus
 707     "m"  gnus-group-list-plus
 708     "M"  gnus-group-list-plus
 709     "l"  gnus-group-list-plus
 710     "c"  gnus-group-list-plus
 711     "?"  gnus-group-list-plus)
 712
 713   (gnus-define-keys (gnus-group-score-map "W" gnus-group-mode-map)
 714     "f" gnus-score-flush-cache)
 715
 716   (gnus-define-keys (gnus-group-help-map "H" gnus-group-mode-map)
 717     "c" gnus-group-fetch-charter
 718     "C" gnus-group-fetch-control
 719     "d" gnus-group-describe-group
 720     "f" gnus-group-fetch-faq
 721     "v" gnus-version)
 722
 723   (gnus-define-keys (gnus-group-sub-map "S" gnus-group-mode-map)
 724     "l" gnus-group-set-current-level
 725     "t" gnus-group-unsubscribe-current-group
 726     "s" gnus-group-unsubscribe-group
 727     "k" gnus-group-kill-group
 728     "y" gnus-group-yank-group
 729     "w" gnus-group-kill-region
 730     "\C-k" gnus-group-kill-level
 731     "z" gnus-group-kill-all-zombies))
 732
 733 (defun gnus-topic-mode-p ()
 734   "Return non-nil in `gnus-topic-mode'."
 735   (and (boundp 'gnus-topic-mode)
 736        (symbol-value 'gnus-topic-mode)))
 737
 738 (defun gnus-group-make-menu-bar ()
 739   (gnus-turn-off-edit-menu 'group)
 740   (unless (boundp 'gnus-group-reading-menu)
 741
 742     (easy-menu-define
 743      gnus-group-reading-menu gnus-group-mode-map ""
 744      `("Group"
 745        ["Read" gnus-group-read-group
 746         :included (not (gnus-topic-mode-p))
 747         :active (gnus-group-group-name)]
 748        ["Read " gnus-topic-read-group
 749         :included (gnus-topic-mode-p)]
 750        ["Select" gnus-group-select-group
 751         :included (not (gnus-topic-mode-p))
 752         :active (gnus-group-group-name)]
 753        ["Select " gnus-topic-select-group
 754         :included (gnus-topic-mode-p)]
 755        ["See old articles" (gnus-group-select-group 'all)
 756         :keys "C-u SPC" :active (gnus-group-group-name)]
 757        ["Catch up" gnus-group-catchup-current
 758         :included (not (gnus-topic-mode-p))
 759         :active (gnus-group-group-name)
 760         ,@(if (featurep 'xemacs) nil
 761             '(:help "Mark unread articles in the current group as read"))]
 762        ["Catch up " gnus-topic-catchup-articles
 763         :included (gnus-topic-mode-p)
 764         ,@(if (featurep 'xemacs) nil
 765             '(:help "Mark unread articles in the current group or topic as read"))]
 766        ["Catch up all articles" gnus-group-catchup-current-all
 767         (gnus-group-group-name)]
 768        ["Check for new articles" gnus-group-get-new-news-this-group
 769         :included (not (gnus-topic-mode-p))
 770         :active (gnus-group-group-name)
 771         ,@(if (featurep 'xemacs) nil
 772             '(:help "Check for new messages in current group"))]
 773        ["Check for new articles " gnus-topic-get-new-news-this-topic
 774         :included (gnus-topic-mode-p)
 775         ,@(if (featurep 'xemacs) nil
 776             '(:help "Check for new messages in current group or topic"))]
 777        ["Toggle subscription" gnus-group-unsubscribe-current-group
 778         (gnus-group-group-name)]
 779        ["Kill" gnus-group-kill-group :active (gnus-group-group-name)
 780         ,@(if (featurep 'xemacs) nil
 781               '(:help "Kill (remove) current group"))]
 782        ["Yank" gnus-group-yank-group gnus-list-of-killed-groups]
 783        ["Describe" gnus-group-describe-group :active (gnus-group-group-name)
 784         ,@(if (featurep 'xemacs) nil
 785             '(:help "Display description of the current group"))]
 786        ["Fetch FAQ" gnus-group-fetch-faq (gnus-group-group-name)]
 787        ["Fetch charter" gnus-group-fetch-charter
 788         :active (gnus-group-group-name)
 789         ,@(if (featurep 'xemacs) nil
 790             '(:help "Display the charter of the current group"))]
 791        ["Fetch control message" gnus-group-fetch-control
 792         :active (gnus-group-group-name)
 793         ,@(if (featurep 'xemacs) nil
 794             '(:help "Display the archived control message for the current group"))]
 795        ;; Actually one should check, if any of the marked groups gives t for
 796        ;; (gnus-check-backend-function 'request-expire-articles ...)
 797        ["Expire articles" gnus-group-expire-articles
 798         :included (not (gnus-topic-mode-p))
 799         :active (or (and (gnus-group-group-name)
 800                          (gnus-check-backend-function
 801                           'request-expire-articles
 802                           (gnus-group-group-name))) gnus-group-marked)]
 803        ["Expire articles " gnus-topic-expire-articles
 804         :included (gnus-topic-mode-p)]
 805        ["Set group level..." gnus-group-set-current-level
 806         (gnus-group-group-name)]
 807        ["Select quick" gnus-group-quick-select-group (gnus-group-group-name)]
 808        ["Customize" gnus-group-customize (gnus-group-group-name)]
 809        ("Edit"
 810         ["Parameters" gnus-group-edit-group-parameters
 811          :included (not (gnus-topic-mode-p))
 812          :active (gnus-group-group-name)]
 813         ["Parameters " gnus-topic-edit-parameters
 814          :included (gnus-topic-mode-p)]
 815         ["Select method" gnus-group-edit-group-method
 816          (gnus-group-group-name)]
 817         ["Info" gnus-group-edit-group (gnus-group-group-name)]
 818         ["Local kill file" gnus-group-edit-local-kill (gnus-group-group-name)]
 819         ["Global kill file" gnus-group-edit-global-kill t])))
 820
 821     (easy-menu-define
 822      gnus-group-group-menu gnus-group-mode-map ""
 823      '("Groups"
 824        ("Listing"
 825         ["List unread subscribed groups" gnus-group-list-groups t]
 826         ["List (un)subscribed groups" gnus-group-list-all-groups t]
 827         ["List killed groups" gnus-group-list-killed gnus-killed-list]
 828         ["List zombie groups" gnus-group-list-zombies gnus-zombie-list]
 829         ["List level..." gnus-group-list-level t]
 830         ["Describe all groups" gnus-group-describe-all-groups t]
 831         ["Group apropos..." gnus-group-apropos t]
 832         ["Group and description apropos..." gnus-group-description-apropos t]
 833         ["List groups matching..." gnus-group-list-matching t]
 834         ["List all groups matching..." gnus-group-list-all-matching t]
 835         ["List active file" gnus-group-list-active t]
 836         ["List groups with cached" gnus-group-list-cached t]
 837         ["List groups with dormant" gnus-group-list-dormant t])
 838        ("Sort"
 839         ["Default sort" gnus-group-sort-groups t]
 840         ["Sort by method" gnus-group-sort-groups-by-method t]
 841         ["Sort by rank" gnus-group-sort-groups-by-rank t]
 842         ["Sort by score" gnus-group-sort-groups-by-score t]
 843         ["Sort by level" gnus-group-sort-groups-by-level t]
 844         ["Sort by unread" gnus-group-sort-groups-by-unread t]
 845         ["Sort by name" gnus-group-sort-groups-by-alphabet t]
 846         ["Sort by real name" gnus-group-sort-groups-by-real-name t])
 847        ("Sort process/prefixed"
 848         ["Default sort" gnus-group-sort-selected-groups
 849          (not (gnus-topic-mode-p))]
 850         ["Sort by method" gnus-group-sort-selected-groups-by-method
 851          (not (gnus-topic-mode-p))]
 852         ["Sort by rank" gnus-group-sort-selected-groups-by-rank
 853          (not (gnus-topic-mode-p))]
 854         ["Sort by score" gnus-group-sort-selected-groups-by-score
 855          (not (gnus-topic-mode-p))]
 856         ["Sort by level" gnus-group-sort-selected-groups-by-level
 857          (not (gnus-topic-mode-p))]
 858         ["Sort by unread" gnus-group-sort-selected-groups-by-unread
 859          (not (gnus-topic-mode-p))]
 860         ["Sort by name" gnus-group-sort-selected-groups-by-alphabet
 861          (not (gnus-topic-mode-p))]
 862         ["Sort by real name" gnus-group-sort-selected-groups-by-real-name
 863          (not (gnus-topic-mode-p))])
 864        ("Mark"
 865         ["Mark group" gnus-group-mark-group
 866          (and (gnus-group-group-name)
 867               (not (memq (gnus-group-group-name) gnus-group-marked)))]
 868         ["Unmark group" gnus-group-unmark-group
 869          (and (gnus-group-group-name)
 870               (memq (gnus-group-group-name) gnus-group-marked))]
 871         ["Unmark all" gnus-group-unmark-all-groups gnus-group-marked]
 872         ["Mark regexp..." gnus-group-mark-regexp t]
 873         ["Mark region" gnus-group-mark-region :active (gnus-mark-active-p)]
 874         ["Mark buffer" gnus-group-mark-buffer t]
 875         ["Execute command" gnus-group-universal-argument
 876          (or gnus-group-marked (gnus-group-group-name))])
 877        ("Subscribe"
 878         ["Subscribe to a group..." gnus-group-unsubscribe-group t]
 879         ["Kill all newsgroups in region" gnus-group-kill-region
 880          :active (gnus-mark-active-p)]
 881         ["Kill all zombie groups" gnus-group-kill-all-zombies
 882          gnus-zombie-list]
 883         ["Kill all groups on level..." gnus-group-kill-level t])
 884        ("Foreign groups"
 885         ["Make a foreign group..." gnus-group-make-group t]
 886         ["Add a directory group..." gnus-group-make-directory-group t]
 887         ["Add the help group" gnus-group-make-help-group t]
 888         ["Add the archive group" gnus-group-make-archive-group t]
 889         ["Make a doc group..." gnus-group-make-doc-group t]
 890         ["Make a web group..." gnus-group-make-web-group t]
 891         ["Make a kiboze group..." gnus-group-make-kiboze-group t]
 892         ["Make a virtual group..." gnus-group-make-empty-virtual t]
 893         ["Add a group to a virtual..." gnus-group-add-to-virtual t]
 894         ["Rename group..." gnus-group-rename-group
 895          (gnus-check-backend-function
 896           'request-rename-group (gnus-group-group-name))]
 897         ["Delete group" gnus-group-delete-group
 898          (gnus-check-backend-function
 899           'request-delete-group (gnus-group-group-name))])
 900        ("Move"
 901         ["Next" gnus-group-next-group t]
 902         ["Previous" gnus-group-prev-group t]
 903         ["Next unread" gnus-group-next-unread-group t]
 904         ["Previous unread" gnus-group-prev-unread-group t]
 905         ["Next unread same level" gnus-group-next-unread-group-same-level t]
 906         ["Previous unread same level"
 907          gnus-group-prev-unread-group-same-level t]
 908         ["Jump to group..." gnus-group-jump-to-group t]
 909         ["First unread group" gnus-group-first-unread-group t]
 910         ["Best unread group" gnus-group-best-unread-group t])
 911        ("Sieve"
 912         ["Generate" gnus-sieve-generate t]
 913         ["Generate and update" gnus-sieve-update t])
 914        ["Delete bogus groups" gnus-group-check-bogus-groups t]
 915        ["Find new newsgroups" gnus-group-find-new-groups t]
 916        ["Transpose" gnus-group-transpose-groups
 917         (gnus-group-group-name)]
 918        ["Read a directory as a group..." gnus-group-enter-directory t]))
 919
 920     (easy-menu-define
 921      gnus-group-misc-menu gnus-group-mode-map ""
 922      `("Gnus"
 923        ("SOUP"
 924         ["Pack replies" nnsoup-pack-replies (fboundp 'nnsoup-request-group)]
 925         ["Send replies" gnus-soup-send-replies
 926          (fboundp 'gnus-soup-pack-packet)]
 927         ["Pack packet" gnus-soup-pack-packet (fboundp 'gnus-soup-pack-packet)]
 928         ["Save areas" gnus-soup-save-areas (fboundp 'gnus-soup-pack-packet)]
 929         ["Brew SOUP" gnus-group-brew-soup (fboundp 'gnus-soup-pack-packet)])
 930        ["Send a mail" gnus-group-mail t]
 931        ["Send a message (mail or news)" gnus-group-post-news t]
 932        ["Create a local message" gnus-group-news t]
 933        ["Check for new news" gnus-group-get-new-news
 934         ,@(if (featurep 'xemacs) '(t)
 935             '(:help "Get newly arrived articles"))
 936         ]
 937        ["Send queued messages" gnus-delay-send-queue
 938         ,@(if (featurep 'xemacs) '(t)
 939             '(:help "Send all messages that are scheduled to be sent now"))
 940         ]
 941        ["Activate all groups" gnus-activate-all-groups t]
 942        ["Restart Gnus" gnus-group-restart t]
 943        ["Read init file" gnus-group-read-init-file t]
 944        ["Browse foreign server..." gnus-group-browse-foreign-server t]
 945        ["Enter server buffer" gnus-group-enter-server-mode t]
 946        ["Expire all expirable articles" gnus-group-expire-all-groups t]
 947        ["Generate any kiboze groups" nnkiboze-generate-groups t]
 948        ["Gnus version" gnus-version t]
 949        ["Save .newsrc files" gnus-group-save-newsrc t]
 950        ["Suspend Gnus" gnus-group-suspend t]
 951        ["Clear dribble buffer" gnus-group-clear-dribble t]
 952        ["Read manual" gnus-info-find-node t]
 953        ["Flush score cache" gnus-score-flush-cache t]
 954        ["Toggle topics" gnus-topic-mode t]
 955        ["Send a bug report" gnus-bug t]
 956        ["Exit from Gnus" gnus-group-exit
 957         ,@(if (featurep 'xemacs) '(t)
 958             '(:help "Quit reading news"))]
 959        ["Exit without saving" gnus-group-quit t]))
 960
 961     (gnus-run-hooks 'gnus-group-menu-hook)))
 962
 963 (defvar gnus-group-toolbar-map nil)
 964
 965 ;; Emacs 21 tool bar.  Should be no-op otherwise.
 966 (defun gnus-group-make-tool-bar ()
 967   (if (and
 968        (condition-case nil (require 'tool-bar) (error nil))
 969        (fboundp 'tool-bar-add-item-from-menu)
 970        (default-value 'tool-bar-mode)
 971        (not gnus-group-toolbar-map))
 972       (setq gnus-group-toolbar-map
 973             (let ((tool-bar-map (make-sparse-keymap))
 974                   (load-path (mm-image-load-path)))
 975               (tool-bar-add-item-from-menu
 976                'gnus-group-get-new-news "get-news" gnus-group-mode-map)
 977               (tool-bar-add-item-from-menu
 978                'gnus-group-get-new-news-this-group "gnntg" gnus-group-mode-map)
 979               (tool-bar-add-item-from-menu
 980                'gnus-group-catchup-current "catchup" gnus-group-mode-map)
 981               (tool-bar-add-item-from-menu
 982                'gnus-group-describe-group "describe-group" gnus-group-mode-map)
 983               (tool-bar-add-item "subscribe" 'gnus-group-subscribe 'subscribe
 984                                  :help "Subscribe to the current group")
 985               (tool-bar-add-item "unsubscribe" 'gnus-group-unsubscribe
 986                                  'unsubscribe
 987                                  :help "Unsubscribe from the current group")
 988               (tool-bar-add-item-from-menu
 989                'gnus-group-exit "exit-gnus" gnus-group-mode-map)
 990               tool-bar-map)))
 991   (if gnus-group-toolbar-map
 992       (set (make-local-variable 'tool-bar-map) gnus-group-toolbar-map)))
 993
 994 (defun gnus-group-mode ()
 995   "Major mode for reading news.
 996
 997 All normal editing commands are switched off.
 998 \\<gnus-group-mode-map>
 999 The group buffer lists (some of) the groups available.  For instance,
1000 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
1001 lists all zombie groups.
1002
1003 Groups that are displayed can be entered with `\\[gnus-group-read-group]'.  To subscribe
1004 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
1005
1006 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
1007
1008 The following commands are available:
1009
1010 \\{gnus-group-mode-map}"
1011   (interactive)
1012   (kill-all-local-variables)
1013   (when (gnus-visual-p 'group-menu 'menu)
1014     (gnus-group-make-menu-bar)
1015     (gnus-group-make-tool-bar))
1016   (gnus-simplify-mode-line)
1017   (setq major-mode 'gnus-group-mode)
1018   (setq mode-name "Group")
1019   (gnus-group-set-mode-line)
1020   (setq mode-line-process nil)
1021   (use-local-map gnus-group-mode-map)
1022   (buffer-disable-undo)
1023   (setq truncate-lines t)
1024   (setq buffer-read-only t)
1025   (gnus-set-default-directory)
1026   (gnus-update-format-specifications nil 'group 'group-mode)
1027   (gnus-update-group-mark-positions)
1028   (when gnus-use-undo
1029     (gnus-undo-mode 1))
1030   (when gnus-slave
1031     (gnus-slave-mode))
1032   (gnus-run-hooks 'gnus-group-mode-hook))
1033
1034 (defun gnus-update-group-mark-positions ()
1035   (save-excursion
1036     (let ((gnus-process-mark ?\200)
1037           (gnus-group-update-hook nil)
1038           (gnus-group-marked '("dummy.group"))
1039           (gnus-active-hashtb (make-vector 10 0))
1040           (topic ""))
1041       (gnus-set-active "dummy.group" '(0 . 0))
1042       (gnus-set-work-buffer)
1043       (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
1044       (goto-char (point-min))
1045       (setq gnus-group-mark-positions
1046             (list (cons 'process (and (search-forward "\200" nil t)
1047                                       (- (point) 2))))))))
1048
1049 (defun gnus-mouse-pick-group (e)
1050   "Enter the group under the mouse pointer."
1051   (interactive "e")
1052   (mouse-set-point e)
1053   (gnus-group-read-group nil))
1054
1055 ;; Look at LEVEL and find out what the level is really supposed to be.
1056 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
1057 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
1058 (defun gnus-group-default-level (&optional level number-or-nil)
1059   (cond
1060    (gnus-group-use-permanent-levels
1061     (or (setq gnus-group-use-permanent-levels
1062               (or level (if (numberp gnus-group-use-permanent-levels)
1063                             gnus-group-use-permanent-levels
1064                           (or gnus-group-default-list-level
1065                               gnus-level-subscribed))))
1066         gnus-group-default-list-level gnus-level-subscribed))
1067    (number-or-nil
1068     level)
1069    (t
1070     (or level gnus-group-default-list-level gnus-level-subscribed))))
1071
1072 (defun gnus-group-setup-buffer ()
1073   (set-buffer (gnus-get-buffer-create gnus-group-buffer))
1074   (unless (eq major-mode 'gnus-group-mode)
1075     (gnus-group-mode)
1076     (when gnus-carpal
1077       (gnus-carpal-setup-buffer 'group))))
1078
1079 (defun gnus-group-name-charset (method group)
1080   (if (null method)
1081       (setq method (gnus-find-method-for-group group)))
1082   (let ((item (assoc method gnus-group-name-charset-method-alist))
1083         (alist gnus-group-name-charset-group-alist)
1084         result)
1085     (if item
1086         (cdr item)
1087       (while (setq item (pop alist))
1088         (if (string-match (car item) group)
1089             (setq alist nil
1090                   result (cdr item))))
1091       result)))
1092
1093 (defun gnus-group-name-decode (string charset)
1094   ;; Fixme: Don't decode in unibyte mode.
1095   (if (and string charset (featurep 'mule))
1096       (mm-decode-coding-string string charset)
1097     string))
1098
1099 (defun gnus-group-decoded-name (string)
1100   (let ((charset (gnus-group-name-charset nil string)))
1101     (gnus-group-name-decode string charset)))
1102
1103 (defun gnus-group-list-groups (&optional level unread lowest)
1104   "List newsgroups with level LEVEL or lower that have unread articles.
1105 Default is all subscribed groups.
1106 If argument UNREAD is non-nil, groups with no unread articles are also
1107 listed.
1108
1109 Also see the `gnus-group-use-permanent-levels' variable."
1110   (interactive
1111    (list (if current-prefix-arg
1112              (prefix-numeric-value current-prefix-arg)
1113            (or
1114             (gnus-group-default-level nil t)
1115             gnus-group-default-list-level
1116             gnus-level-subscribed))))
1117   (unless level
1118     (setq level (car gnus-group-list-mode)
1119           unread (cdr gnus-group-list-mode)))
1120   (setq level (gnus-group-default-level level))
1121   (gnus-group-setup-buffer)
1122   (gnus-update-format-specifications nil 'group 'group-mode)
1123   (let ((case-fold-search nil)
1124         (props (text-properties-at (gnus-point-at-bol)))
1125         (empty (= (point-min) (point-max)))
1126         (group (gnus-group-group-name))
1127         number)
1128     (set-buffer gnus-group-buffer)
1129     (setq number (funcall gnus-group-prepare-function level unread lowest))
1130     (when (or (and (numberp number)
1131                    (zerop number))
1132               (zerop (buffer-size)))
1133       ;; No groups in the buffer.
1134       (gnus-message 5 gnus-no-groups-message))
1135     ;; We have some groups displayed.
1136     (goto-char (point-max))
1137     (when (or (not gnus-group-goto-next-group-function)
1138               (not (funcall gnus-group-goto-next-group-function
1139                             group props)))
1140       (cond
1141        (empty
1142         (goto-char (point-min)))
1143        ((not group)
1144         ;; Go to the first group with unread articles.
1145         (gnus-group-search-forward t))
1146        (t
1147         ;; Find the right group to put point on.  If the current group
1148         ;; has disappeared in the new listing, try to find the next
1149         ;; one.  If no next one can be found, just leave point at the
1150         ;; first newsgroup in the buffer.
1151         (when (not (gnus-goto-char
1152                     (text-property-any
1153                      (point-min) (point-max)
1154                      'gnus-group (gnus-intern-safe
1155                                   group gnus-active-hashtb))))
1156           (let ((newsrc (cdddr (gnus-gethash group gnus-newsrc-hashtb))))
1157             (while (and newsrc
1158                         (not (gnus-goto-char
1159                               (text-property-any
1160                                (point-min) (point-max) 'gnus-group
1161                                (gnus-intern-safe
1162                                 (caar newsrc) gnus-active-hashtb)))))
1163               (setq newsrc (cdr newsrc)))
1164             (unless newsrc
1165               (goto-char (point-max))
1166               (forward-line -1)))))))
1167     ;; Adjust cursor point.
1168     (gnus-group-position-point)))
1169
1170 (defun gnus-group-list-level (level &optional all)
1171   "List groups on LEVEL.
1172 If ALL (the prefix), also list groups that have no unread articles."
1173   (interactive "nList groups on level: \nP")
1174   (gnus-group-list-groups level all level))
1175
1176 (defun gnus-group-prepare-logic (group test)
1177   (or (and gnus-group-listed-groups
1178            (null gnus-group-list-option)
1179            (member group gnus-group-listed-groups))
1180       (cond
1181        ((null gnus-group-listed-groups) test)
1182        ((null gnus-group-list-option) test)
1183        (t (and (member group gnus-group-listed-groups)
1184                (if (eq gnus-group-list-option 'flush)
1185                    (not test)
1186                  test))))))
1187
1188 (defun gnus-group-prepare-flat (level &optional predicate lowest regexp)
1189   "List all newsgroups with unread articles of level LEVEL or lower.
1190 If PREDICATE is a function, list groups that the function returns non-nil;
1191 if it is t, list groups that have no unread articles.
1192 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
1193 If REGEXP is a function, list dead groups that the function returns non-nil;
1194 if it is a string, only list groups matching REGEXP."
1195   (set-buffer gnus-group-buffer)
1196   (let ((buffer-read-only nil)
1197         (newsrc (cdr gnus-newsrc-alist))
1198         (lowest (or lowest 1))
1199         (not-in-list (and gnus-group-listed-groups
1200                           (copy-sequence gnus-group-listed-groups)))
1201         info clevel unread group params)
1202     (erase-buffer)
1203     (when (or (< lowest gnus-level-zombie)
1204               gnus-group-listed-groups)
1205       ;; List living groups.
1206       (while newsrc
1207         (setq info (car newsrc)
1208               group (gnus-info-group info)
1209               params (gnus-info-params info)
1210               newsrc (cdr newsrc)
1211               unread (car (gnus-gethash group gnus-newsrc-hashtb)))
1212         (when not-in-list
1213           (setq not-in-list (delete group not-in-list)))
1214         (when (gnus-group-prepare-logic
1215                group
1216                (and unread              ; This group might be unchecked
1217                     (or (not (stringp regexp))
1218                         (string-match regexp group))
1219                     (<= (setq clevel (gnus-info-level info)) level)
1220                     (>= clevel lowest)
1221                     (cond
1222                      ((functionp predicate)
1223                       (funcall predicate info))
1224                      (predicate t)      ; We list all groups?
1225                      (t
1226                       (or
1227                        (if (eq unread t) ; Unactivated?
1228                            gnus-group-list-inactive-groups
1229                                         ; We list unactivated
1230                          (> unread 0))
1231                                         ; We list groups with unread articles
1232                        (and gnus-list-groups-with-ticked-articles
1233                             (cdr (assq 'tick (gnus-info-marks info))))
1234                                         ; And groups with tickeds
1235                        ;; Check for permanent visibility.
1236                        (and gnus-permanently-visible-groups
1237                             (string-match gnus-permanently-visible-groups
1238                                           group))
1239                        (memq 'visible params)
1240                        (cdr (assq 'visible params)))))))
1241           (gnus-group-insert-group-line
1242            group (gnus-info-level info)
1243            (gnus-info-marks info) unread (gnus-info-method info)))))
1244
1245     ;; List dead groups.
1246     (when (or gnus-group-listed-groups
1247               (and (>= level gnus-level-zombie)
1248                    (<= lowest gnus-level-zombie)))
1249       (gnus-group-prepare-flat-list-dead
1250        (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
1251        gnus-level-zombie ?Z
1252        regexp))
1253     (when not-in-list
1254       (dolist (group gnus-zombie-list)
1255         (setq not-in-list (delete group not-in-list))))
1256     (when (or gnus-group-listed-groups
1257               (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)))
1258       (gnus-group-prepare-flat-list-dead
1259        (gnus-union
1260         not-in-list
1261         (setq gnus-killed-list (sort gnus-killed-list 'string<)))
1262        gnus-level-killed ?K regexp))
1263
1264     (gnus-group-set-mode-line)
1265     (setq gnus-group-list-mode (cons level predicate))
1266     (gnus-run-hooks 'gnus-group-prepare-hook)
1267     t))
1268
1269 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
1270   ;; List zombies and killed lists somewhat faster, which was
1271   ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.  It does
1272   ;; this by ignoring the group format specification altogether.
1273   (let (group)
1274     (if (> (length groups) gnus-group-listing-limit)
1275         (while groups
1276           (setq group (pop groups))
1277           (when (gnus-group-prepare-logic
1278                  group
1279                  (or (not regexp)
1280                      (and (stringp regexp) (string-match regexp group))
1281                      (and (functionp regexp) (funcall regexp group))))
1282             (gnus-add-text-properties
1283              (point) (prog1 (1+ (point))
1284                        (insert " " mark "     *: "
1285                                (gnus-group-decoded-name group)
1286                                "\n"))
1287              (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1288                    'gnus-unread t
1289                    'gnus-level level))))
1290       (while groups
1291         (setq group (pop groups))
1292         (when (gnus-group-prepare-logic
1293                group
1294                (or (not regexp)
1295                    (and (stringp regexp) (string-match regexp group))
1296                    (and (functionp regexp) (funcall regexp group))))
1297           (gnus-group-insert-group-line
1298            group level nil
1299            (let ((active (gnus-active group)))
1300              (if active
1301                  (if (zerop (cdr active))
1302                      0
1303                    (- (1+ (cdr active)) (car active)))
1304                nil))
1305            (gnus-method-simplify (gnus-find-method-for-group group))))))))
1306
1307 (defun gnus-group-update-group-line ()
1308   "Update the current line in the group buffer."
1309   (let* ((buffer-read-only nil)
1310          (group (gnus-group-group-name))
1311          (entry (and group (gnus-gethash group gnus-newsrc-hashtb)))
1312          gnus-group-indentation)
1313     (when group
1314       (and entry
1315            (not (gnus-ephemeral-group-p group))
1316            (gnus-dribble-enter
1317             (concat "(gnus-group-set-info '"
1318                     (gnus-prin1-to-string (nth 2 entry))
1319                     ")")))
1320       (setq gnus-group-indentation (gnus-group-group-indentation))
1321       (gnus-delete-line)
1322       (gnus-group-insert-group-line-info group)
1323       (forward-line -1)
1324       (gnus-group-position-point))))
1325
1326 (defun gnus-group-insert-group-line-info (group)
1327   "Insert GROUP on the current line."
1328   (let ((entry (gnus-gethash group gnus-newsrc-hashtb))
1329         (gnus-group-indentation (gnus-group-group-indentation))
1330         active info)
1331     (if entry
1332         (progn
1333           ;; (Un)subscribed group.
1334           (setq info (nth 2 entry))
1335           (gnus-group-insert-group-line
1336            group (gnus-info-level info) (gnus-info-marks info)
1337            (or (car entry) t) (gnus-info-method info)))
1338       ;; This group is dead.
1339       (gnus-group-insert-group-line
1340        group
1341        (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1342        nil
1343        (if (setq active (gnus-active group))
1344            (if (zerop (cdr active))
1345                0
1346              (- (1+ (cdr active)) (car active)))
1347          nil)
1348        (gnus-method-simplify (gnus-find-method-for-group group))))))
1349
1350 (defun gnus-number-of-unseen-articles-in-group (group)
1351   (let* ((info (nth 2 (gnus-group-entry group)))
1352          (marked (gnus-info-marks info))
1353          (seen (cdr (assq 'seen marked)))
1354          (active (gnus-active group)))
1355     (if (not active)
1356         0
1357       (length (gnus-uncompress-range
1358                (gnus-range-difference
1359                 (gnus-range-difference (list active) (gnus-info-read info))
1360                 seen))))))
1361
1362 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1363                                                     gnus-tmp-marked number
1364                                                     gnus-tmp-method)
1365   "Insert a group line in the group buffer."
1366   (let* ((gnus-tmp-method
1367           (gnus-server-get-method gnus-tmp-group gnus-tmp-method))
1368          (group-name-charset (gnus-group-name-charset gnus-tmp-method
1369                                                       gnus-tmp-group))
1370          (gnus-tmp-active (gnus-active gnus-tmp-group))
1371          (gnus-tmp-number-total
1372           (if gnus-tmp-active
1373               (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1374             0))
1375          (gnus-tmp-number-of-unread
1376           (if (numberp number) (int-to-string (max 0 number))
1377             "*"))
1378          (gnus-tmp-number-of-read
1379           (if (numberp number)
1380               (int-to-string (max 0 (- gnus-tmp-number-total number)))
1381             "*"))
1382          (gnus-tmp-subscribed
1383           (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1384                 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1385                 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1386                 (t ?K)))
1387          (gnus-tmp-qualified-group
1388           (gnus-group-name-decode (gnus-group-real-name gnus-tmp-group)
1389                                   group-name-charset))
1390          (gnus-tmp-comment
1391           (or (gnus-group-get-parameter gnus-tmp-group 'comment t)
1392               gnus-tmp-group))
1393          (gnus-tmp-newsgroup-description
1394           (if gnus-description-hashtb
1395               (or (gnus-group-name-decode
1396                    (gnus-gethash gnus-tmp-group gnus-description-hashtb)
1397                    group-name-charset) "")
1398             ""))
1399          (gnus-tmp-moderated
1400           (if (and gnus-moderated-hashtb
1401                    (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1402               ?m ? ))
1403          (gnus-tmp-moderated-string
1404           (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1405          (gnus-tmp-group-icon "==&&==")
1406          (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1407          (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1408          (gnus-tmp-news-method-string
1409           (if gnus-tmp-method
1410               (format "(%s:%s)" (car gnus-tmp-method)
1411                       (cadr gnus-tmp-method)) ""))
1412          (gnus-tmp-marked-mark
1413           (if (and (numberp number)
1414                    (zerop number)
1415                    (cdr (assq 'tick gnus-tmp-marked)))
1416               ?* ? ))
1417          (gnus-tmp-summary-live
1418           (if (and (not gnus-group-is-exiting-p)
1419                    (gnus-buffer-live-p (gnus-summary-buffer-name
1420                                         gnus-tmp-group)))
1421               ?* ? ))
1422          (gnus-tmp-process-marked
1423           (if (member gnus-tmp-group gnus-group-marked)
1424               gnus-process-mark ? ))
1425          (gnus-tmp-grouplens
1426           (or (and gnus-use-grouplens
1427                    (bbb-grouplens-group-p gnus-tmp-group))
1428               ""))
1429          (buffer-read-only nil)
1430          header gnus-tmp-header)        ; passed as parameter to user-funcs.
1431     (beginning-of-line)
1432     (gnus-add-text-properties
1433      (point)
1434      (prog1 (1+ (point))
1435        ;; Insert the text.
1436        (let ((gnus-tmp-group (gnus-group-name-decode
1437                               gnus-tmp-group group-name-charset)))
1438          (eval gnus-group-line-format-spec)))
1439      `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1440                   gnus-unread ,(if (numberp number)
1441                                    (string-to-int gnus-tmp-number-of-unread)
1442                                  t)
1443                   gnus-marked ,gnus-tmp-marked-mark
1444                   gnus-indentation ,gnus-group-indentation
1445                   gnus-level ,gnus-tmp-level))
1446     (forward-line -1)
1447     (when (inline (gnus-visual-p 'group-highlight 'highlight))
1448       (gnus-run-hooks 'gnus-group-update-hook))
1449     (forward-line)
1450     ;; Allow XEmacs to remove front-sticky text properties.
1451     (gnus-group-remove-excess-properties)))
1452
1453 (defun gnus-group-highlight-line ()
1454   "Highlight the current line according to `gnus-group-highlight'."
1455   (let* ((list gnus-group-highlight)
1456          (p (point))
1457          (end (gnus-point-at-eol))
1458          ;; now find out where the line starts and leave point there.
1459          (beg (progn (beginning-of-line) (point)))
1460          (group (gnus-group-group-name))
1461          (entry (gnus-group-entry group))
1462          (unread (if (numberp (car entry)) (car entry) 0))
1463          (active (gnus-active group))
1464          (total (if active (1+ (- (cdr active) (car active))) 0))
1465          (info (nth 2 entry))
1466          (method (gnus-server-get-method group (gnus-info-method info)))
1467          (marked (gnus-info-marks info))
1468          (mailp (apply 'append
1469                        (mapcar
1470                         (lambda (x)
1471                           (memq x (assoc (symbol-name
1472                                           (car (or method gnus-select-method)))
1473                                          gnus-valid-select-methods)))
1474                         '(mail post-mail))))
1475          (level (or (gnus-info-level info) gnus-level-killed))
1476          (score (or (gnus-info-score info) 0))
1477          (ticked (gnus-range-length (cdr (assq 'tick marked))))
1478          (group-age (gnus-group-timestamp-delta group))
1479          (inhibit-read-only t))
1480     ;; Eval the cars of the lists until we find a match.
1481     (while (and list
1482                 (not (eval (caar list))))
1483       (setq list (cdr list)))
1484     (let ((face (cdar list)))
1485       (unless (eq face (get-text-property beg 'face))
1486         (gnus-put-text-property-excluding-characters-with-faces
1487          beg end 'face
1488          (setq face (if (boundp face) (symbol-value face) face)))
1489         (gnus-extent-start-open beg)))
1490     (goto-char p)))
1491
1492 (defun gnus-group-update-group (group &optional visible-only)
1493   "Update all lines where GROUP appear.
1494 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1495 already."
1496   ;; Can't use `save-excursion' here, so we do it manually.
1497   (let ((buf (current-buffer))
1498         mark)
1499     (set-buffer gnus-group-buffer)
1500     (setq mark (point-marker))
1501     ;; The buffer may be narrowed.
1502     (save-restriction
1503       (widen)
1504       (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1505             (loc (point-min))
1506             found buffer-read-only)
1507         ;; Enter the current status into the dribble buffer.
1508         (let ((entry (gnus-gethash group gnus-newsrc-hashtb)))
1509           (when (and entry
1510                      (not (gnus-ephemeral-group-p group)))
1511             (gnus-dribble-enter
1512              (concat "(gnus-group-set-info '"
1513                      (gnus-prin1-to-string (nth 2 entry))
1514                      ")"))))
1515         ;; Find all group instances.  If topics are in use, each group
1516         ;; may be listed in more than once.
1517         (while (setq loc (text-property-any
1518                           loc (point-max) 'gnus-group ident))
1519           (setq found t)
1520           (goto-char loc)
1521           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1522             (gnus-delete-line)
1523             (gnus-group-insert-group-line-info group)
1524             (save-excursion
1525               (forward-line -1)
1526               (gnus-run-hooks 'gnus-group-update-group-hook)))
1527           (setq loc (1+ loc)))
1528         (unless (or found visible-only)
1529           ;; No such line in the buffer, find out where it's supposed to
1530           ;; go, and insert it there (or at the end of the buffer).
1531           (if gnus-goto-missing-group-function
1532               (funcall gnus-goto-missing-group-function group)
1533             (let ((entry (cddr (gnus-gethash group gnus-newsrc-hashtb))))
1534               (while (and entry (car entry)
1535                           (not
1536                            (gnus-goto-char
1537                             (text-property-any
1538                              (point-min) (point-max)
1539                              'gnus-group (gnus-intern-safe
1540                                           (caar entry) gnus-active-hashtb)))))
1541                 (setq entry (cdr entry)))
1542               (or entry (goto-char (point-max)))))
1543           ;; Finally insert the line.
1544           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1545             (gnus-group-insert-group-line-info group)
1546             (save-excursion
1547               (forward-line -1)
1548               (gnus-run-hooks 'gnus-group-update-group-hook))))
1549         (when gnus-group-update-group-function
1550           (funcall gnus-group-update-group-function group))
1551         (gnus-group-set-mode-line)))
1552     (goto-char mark)
1553     (set-marker mark nil)
1554     (set-buffer buf)))
1555
1556 (defun gnus-group-set-mode-line ()
1557   "Update the mode line in the group buffer."
1558   (when (memq 'group gnus-updated-mode-lines)
1559     ;; Yes, we want to keep this mode line updated.
1560     (save-excursion
1561       (set-buffer gnus-group-buffer)
1562       (let* ((gformat (or gnus-group-mode-line-format-spec
1563                           (gnus-set-format 'group-mode)))
1564              (gnus-tmp-news-server (cadr gnus-select-method))
1565              (gnus-tmp-news-method (car gnus-select-method))
1566              (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1567              (max-len 60)
1568              gnus-tmp-header            ;Dummy binding for user-defined formats
1569              ;; Get the resulting string.
1570              (modified
1571               (and gnus-dribble-buffer
1572                    (buffer-name gnus-dribble-buffer)
1573                    (buffer-modified-p gnus-dribble-buffer)
1574                    (save-excursion
1575                      (set-buffer gnus-dribble-buffer)
1576                      (not (zerop (buffer-size))))))
1577              (mode-string (eval gformat)))
1578         ;; Say whether the dribble buffer has been modified.
1579         (setq mode-line-modified
1580               (if modified (car gnus-mode-line-modified)
1581                 (cdr gnus-mode-line-modified)))
1582         ;; If the line is too long, we chop it off.
1583         (when (> (length mode-string) max-len)
1584           (setq mode-string (substring mode-string 0 (- max-len 4))))
1585         (prog1
1586             (setq mode-line-buffer-identification
1587                   (gnus-mode-line-buffer-identification
1588                    (list mode-string)))
1589           (set-buffer-modified-p modified))))))
1590
1591 (defun gnus-group-group-name ()
1592   "Get the name of the newsgroup on the current line."
1593   (let ((group (get-text-property (gnus-point-at-bol) 'gnus-group)))
1594     (when group
1595       (symbol-name group))))
1596
1597 (defun gnus-group-group-level ()
1598   "Get the level of the newsgroup on the current line."
1599   (get-text-property (gnus-point-at-bol) 'gnus-level))
1600
1601 (defun gnus-group-group-indentation ()
1602   "Get the indentation of the newsgroup on the current line."
1603   (or (get-text-property (gnus-point-at-bol) 'gnus-indentation)
1604       (and gnus-group-indentation-function
1605            (funcall gnus-group-indentation-function))
1606       ""))
1607
1608 (defun gnus-group-group-unread ()
1609   "Get the number of unread articles of the newsgroup on the current line."
1610   (get-text-property (gnus-point-at-bol) 'gnus-unread))
1611
1612 (defun gnus-group-new-mail (group)
1613   (if (nnmail-new-mail-p (gnus-group-real-name group))
1614       gnus-new-mail-mark
1615     ? ))
1616
1617 (defun gnus-group-level (group)
1618   "Return the estimated level of GROUP."
1619   (or (gnus-info-level (gnus-get-info group))
1620       (and (member group gnus-zombie-list) gnus-level-zombie)
1621       gnus-level-killed))
1622
1623 (defun gnus-group-search-forward (&optional backward all level first-too)
1624   "Find the next newsgroup with unread articles.
1625 If BACKWARD is non-nil, find the previous newsgroup instead.
1626 If ALL is non-nil, just find any newsgroup.
1627 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1628 group exists.
1629 If FIRST-TOO, the current line is also eligible as a target."
1630   (let ((way (if backward -1 1))
1631         (low gnus-level-killed)
1632         (beg (point))
1633         pos found lev)
1634     (if (and backward (progn (beginning-of-line)) (bobp))
1635         nil
1636       (unless first-too
1637         (forward-line way))
1638       (while (and
1639               (not (eobp))
1640               (not (setq
1641                     found
1642                     (and
1643                      (get-text-property (point) 'gnus-group)
1644                      (or all
1645                          (and
1646                           (let ((unread
1647                                  (get-text-property (point) 'gnus-unread)))
1648                             (and (numberp unread) (> unread 0)))
1649                           (setq lev (get-text-property (point)
1650                                                        'gnus-level))
1651                           (<= lev gnus-level-subscribed)))
1652                      (or (not level)
1653                          (and (setq lev (get-text-property (point)
1654                                                            'gnus-level))
1655                               (or (= lev level)
1656                                   (and (< lev low)
1657                                        (< level lev)
1658                                        (progn
1659                                          (setq low lev)
1660                                          (setq pos (point))
1661                                          nil))))))))
1662               (zerop (forward-line way)))))
1663     (if found
1664         (progn (gnus-group-position-point) t)
1665       (goto-char (or pos beg))
1666       (and pos t))))
1667
1668 ;;; Gnus group mode commands
1669
1670 ;; Group marking.
1671
1672 (defun gnus-group-mark-line-p ()
1673   (save-excursion
1674     (beginning-of-line)
1675     (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1676     (eq (char-after) gnus-process-mark)))
1677
1678 (defun gnus-group-mark-group (n &optional unmark no-advance)
1679   "Mark the current group."
1680   (interactive "p")
1681   (let ((buffer-read-only nil)
1682         group)
1683     (while (and (> n 0)
1684                 (not (eobp)))
1685       (when (setq group (gnus-group-group-name))
1686         ;; Go to the mark position.
1687         (beginning-of-line)
1688         (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1689         (subst-char-in-region
1690          (point) (1+ (point)) (char-after)
1691          (if unmark
1692              (progn
1693                (setq gnus-group-marked (delete group gnus-group-marked))
1694                ? )
1695            (setq gnus-group-marked
1696                  (cons group (delete group gnus-group-marked)))
1697            gnus-process-mark)))
1698       (unless no-advance
1699         (gnus-group-next-group 1))
1700       (decf n))
1701     (gnus-summary-position-point)
1702     n))
1703
1704 (defun gnus-group-unmark-group (n)
1705   "Remove the mark from the current group."
1706   (interactive "p")
1707   (gnus-group-mark-group n 'unmark)
1708   (gnus-group-position-point))
1709
1710 (defun gnus-group-unmark-all-groups ()
1711   "Unmark all groups."
1712   (interactive)
1713   (let ((groups gnus-group-marked))
1714     (save-excursion
1715       (while groups
1716         (gnus-group-remove-mark (pop groups)))))
1717   (gnus-group-position-point))
1718
1719 (defun gnus-group-mark-region (unmark beg end)
1720   "Mark all groups between point and mark.
1721 If UNMARK, remove the mark instead."
1722   (interactive "P\nr")
1723   (let ((num (count-lines beg end)))
1724     (save-excursion
1725       (goto-char beg)
1726       (- num (gnus-group-mark-group num unmark)))))
1727
1728 (defun gnus-group-mark-buffer (&optional unmark)
1729   "Mark all groups in the buffer.
1730 If UNMARK, remove the mark instead."
1731   (interactive "P")
1732   (gnus-group-mark-region unmark (point-min) (point-max)))
1733
1734 (defun gnus-group-mark-regexp (regexp)
1735   "Mark all groups that match some regexp."
1736   (interactive "sMark (regexp): ")
1737   (let ((alist (cdr gnus-newsrc-alist))
1738         group)
1739     (while alist
1740       (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1741         (gnus-group-set-mark group))))
1742   (gnus-group-position-point))
1743
1744 (defun gnus-group-remove-mark (group &optional test-marked)
1745   "Remove the process mark from GROUP and move point there.
1746 Return nil if the group isn't displayed."
1747   (if (gnus-group-goto-group group nil test-marked)
1748       (save-excursion
1749         (gnus-group-mark-group 1 'unmark t)
1750         t)
1751     (setq gnus-group-marked
1752           (delete group gnus-group-marked))
1753     nil))
1754
1755 (defun gnus-group-set-mark (group)
1756   "Set the process mark on GROUP."
1757   (if (gnus-group-goto-group group)
1758       (save-excursion
1759         (gnus-group-mark-group 1 nil t))
1760     (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1761
1762 (defun gnus-group-universal-argument (arg &optional groups func)
1763   "Perform any command on all groups according to the process/prefix convention."
1764   (interactive "P")
1765   (if (eq (setq func (or func
1766                          (key-binding
1767                           (read-key-sequence
1768                            (substitute-command-keys
1769                             "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1770           'undefined)
1771       (gnus-error 1 "Undefined key")
1772     (gnus-group-iterate arg
1773       (lambda (group)
1774         (command-execute func))))
1775   (gnus-group-position-point))
1776
1777 (defun gnus-group-process-prefix (n)
1778   "Return a list of groups to work on.
1779 Take into consideration N (the prefix) and the list of marked groups."
1780   (cond
1781    (n
1782     (setq n (prefix-numeric-value n))
1783     ;; There is a prefix, so we return a list of the N next
1784     ;; groups.
1785     (let ((way (if (< n 0) -1 1))
1786           (n (abs n))
1787           group groups)
1788       (save-excursion
1789         (while (> n 0)
1790           (if (setq group (gnus-group-group-name))
1791               (push group groups))
1792           (setq n (1- n))
1793           (gnus-group-next-group way)))
1794       (nreverse groups)))
1795    ((and (gnus-region-active-p) (mark))
1796     ;; Work on the region between point and mark.
1797     (let ((max (max (point) (mark)))
1798           groups)
1799       (save-excursion
1800         (goto-char (min (point) (mark)))
1801         (while
1802             (and
1803              (push (gnus-group-group-name) groups)
1804              (zerop (gnus-group-next-group 1))
1805              (< (point) max)))
1806         (nreverse groups))))
1807    (gnus-group-marked
1808     ;; No prefix, but a list of marked articles.
1809     (reverse gnus-group-marked))
1810    (t
1811     ;; Neither marked articles or a prefix, so we return the
1812     ;; current group.
1813     (let ((group (gnus-group-group-name)))
1814       (and group (list group))))))
1815
1816 ;;; !!!Surely gnus-group-iterate should be a macro instead?  I can't
1817 ;;; imagine why I went through these contortions...
1818 (eval-and-compile
1819   (let ((function (make-symbol "gnus-group-iterate-function"))
1820         (window (make-symbol "gnus-group-iterate-window"))
1821         (groups (make-symbol "gnus-group-iterate-groups"))
1822         (group (make-symbol "gnus-group-iterate-group")))
1823     (eval
1824      `(defun gnus-group-iterate (arg ,function)
1825         "Iterate FUNCTION over all process/prefixed groups.
1826 FUNCTION will be called with the group name as the parameter
1827 and with point over the group in question."
1828         (let ((,groups (gnus-group-process-prefix arg))
1829               (,window (selected-window))
1830               ,group)
1831           (while ,groups
1832             (setq ,group (car ,groups)
1833                   ,groups (cdr ,groups))
1834             (select-window ,window)
1835             (gnus-group-remove-mark ,group)
1836             (save-selected-window
1837               (save-excursion
1838                 (funcall ,function ,group)))))))))
1839
1840 (put 'gnus-group-iterate 'lisp-indent-function 1)
1841
1842 ;; Selecting groups.
1843
1844 (defun gnus-group-read-group (&optional all no-article group select-articles)
1845   "Read news in this newsgroup.
1846 If the prefix argument ALL is non-nil, already read articles become
1847 readable.  IF ALL is a number, fetch this number of articles.  If the
1848 optional argument NO-ARTICLE is non-nil, no article will be
1849 auto-selected upon group entry.  If GROUP is non-nil, fetch that
1850 group."
1851   (interactive "P")
1852   (let ((no-display (eq all 0))
1853         (group (or group (gnus-group-group-name)))
1854         number active marked entry)
1855     (when (eq all 0)
1856       (setq all nil))
1857     (unless group
1858       (error "No group on current line"))
1859     (setq marked (gnus-info-marks
1860                   (nth 2 (setq entry (gnus-gethash
1861                                       group gnus-newsrc-hashtb)))))
1862     ;; This group might be a dead group.  In that case we have to get
1863     ;; the number of unread articles from `gnus-active-hashtb'.
1864     (setq number
1865           (cond ((numberp all) all)
1866                 (entry (car entry))
1867                 ((setq active (gnus-active group))
1868                  (- (1+ (cdr active)) (car active)))))
1869     (gnus-summary-read-group
1870      group (or all (and (numberp number)
1871                         (zerop (+ number (gnus-range-length
1872                                           (cdr (assq 'tick marked)))
1873                                   (gnus-range-length
1874                                    (cdr (assq 'dormant marked)))))))
1875      no-article nil no-display nil select-articles)))
1876
1877 (defun gnus-group-select-group (&optional all)
1878   "Select this newsgroup.
1879 No article is selected automatically.
1880 If the group is opened, just switch the summary buffer.
1881 If ALL is non-nil, already read articles become readable.
1882 If ALL is a number, fetch this number of articles."
1883   (interactive "P")
1884   (when (and (eobp) (not (gnus-group-group-name)))
1885     (forward-line -1))
1886   (gnus-group-read-group all t))
1887
1888 (defun gnus-group-quick-select-group (&optional all)
1889   "Select the current group \"quickly\".
1890 This means that no highlighting or scoring will be performed.
1891 If ALL (the prefix argument) is 0, don't even generate the summary
1892 buffer.
1893
1894 This might be useful if you want to toggle threading
1895 before entering the group."
1896   (interactive "P")
1897   (require 'gnus-score)
1898   (let (gnus-visual
1899         gnus-score-find-score-files-function
1900         gnus-home-score-file
1901         gnus-apply-kill-hook
1902         gnus-summary-expunge-below)
1903     (gnus-group-read-group all t)))
1904
1905 (defun gnus-group-visible-select-group (&optional all)
1906   "Select the current group without hiding any articles."
1907   (interactive "P")
1908   (let ((gnus-inhibit-limiting t))
1909     (gnus-group-read-group all t)))
1910
1911 (defun gnus-group-select-group-ephemerally ()
1912   "Select the current group without doing any processing whatsoever.
1913 You will actually be entered into a group that's a copy of
1914 the current group; no changes you make while in this group will
1915 be permanent."
1916   (interactive)
1917   (require 'gnus-score)
1918   (let* (gnus-visual
1919          gnus-score-find-score-files-function gnus-apply-kill-hook
1920          gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
1921          gnus-summary-mode-hook gnus-select-group-hook
1922          (group (gnus-group-group-name))
1923          (method (gnus-find-method-for-group group)))
1924     (gnus-group-read-ephemeral-group
1925      (gnus-group-prefixed-name group method) method)))
1926
1927 ;;;###autoload
1928 (defun gnus-fetch-group (group &optional articles)
1929   "Start Gnus if necessary and enter GROUP.
1930 Returns whether the fetching was successful or not."
1931   (interactive (list (completing-read "Group name: " gnus-active-hashtb)))
1932   (unless (get-buffer gnus-group-buffer)
1933     (gnus-no-server))
1934   (gnus-group-read-group articles nil group))
1935
1936 ;;;###autoload
1937 (defun gnus-fetch-group-other-frame (group)
1938   "Pop up a frame and enter GROUP."
1939   (interactive "P")
1940   (let ((window (get-buffer-window gnus-group-buffer)))
1941     (cond (window
1942            (select-frame (window-frame window)))
1943           ((= (length (frame-list)) 1)
1944            (select-frame (make-frame)))
1945           (t
1946            (other-frame 1))))
1947   (gnus-fetch-group group))
1948
1949 (defvar gnus-ephemeral-group-server 0)
1950
1951 (defcustom gnus-large-ephemeral-newsgroup 200
1952   "The number of articles which indicates a large ephemeral newsgroup.
1953 Same as `gnus-large-newsgroup', but only used for ephemeral newsgroups.
1954
1955 If the number of articles in a newsgroup is greater than this value,
1956 confirmation is required for selecting the newsgroup.  If it is nil, no
1957 confirmation is required."
1958   :group 'gnus-group-select
1959   :type '(choice (const :tag "No limit" nil)
1960                  integer))
1961
1962 (defcustom gnus-fetch-old-ephemeral-headers nil
1963   "Same as `gnus-fetch-old-headers', but only used for ephemeral newsgroups."
1964   :group 'gnus-thread
1965   :type '(choice (const :tag "off" nil)
1966                  (const some)
1967                  number
1968                  (sexp :menu-tag "other" t)))
1969
1970 ;; Enter a group that is not in the group buffer.  Non-nil is returned
1971 ;; if selection was successful.
1972 (defun gnus-group-read-ephemeral-group (group method &optional activate
1973                                               quit-config request-only
1974                                               select-articles
1975                                               parameters)
1976   "Read GROUP from METHOD as an ephemeral group.
1977 If ACTIVATE, request the group first.
1978 If QUIT-CONFIG, use that window configuration when exiting from the
1979 ephemeral group.
1980 If REQUEST-ONLY, don't actually read the group; just request it.
1981 If SELECT-ARTICLES, only select those articles.
1982 If PARAMETERS, use those as the group parameters.
1983
1984 Return the name of the group if selection was successful."
1985   ;; Transform the select method into a unique server.
1986   (when (stringp method)
1987     (setq method (gnus-server-to-method method)))
1988   (setq method
1989         `(,(car method) ,(concat (cadr method) "-ephemeral")
1990           (,(intern (format "%s-address" (car method))) ,(cadr method))
1991           ,@(cddr method)))
1992   (let ((group (if (gnus-group-foreign-p group) group
1993                  (gnus-group-prefixed-name (gnus-group-real-name group)
1994                                            method))))
1995     (gnus-sethash
1996      group
1997      `(-1 nil (,group
1998                ,gnus-level-default-subscribed nil nil ,method
1999                ,(cons
2000                  (if quit-config
2001                      (cons 'quit-config quit-config)
2002                    (cons 'quit-config
2003                          (cons gnus-summary-buffer
2004                                gnus-current-window-configuration)))
2005                  parameters)))
2006      gnus-newsrc-hashtb)
2007     (push method gnus-ephemeral-servers)
2008     (set-buffer gnus-group-buffer)
2009     (unless (gnus-check-server method)
2010       (error "Unable to contact server: %s" (gnus-status-message method)))
2011     (when activate
2012       (gnus-activate-group group 'scan)
2013       (unless (gnus-request-group group)
2014         (error "Couldn't request group: %s"
2015                (nnheader-get-report (car method)))))
2016     (if request-only
2017         group
2018       (condition-case ()
2019           (when (let ((gnus-large-newsgroup gnus-large-ephemeral-newsgroup)
2020                       (gnus-fetch-old-headers
2021                        gnus-fetch-old-ephemeral-headers))
2022                   (gnus-group-read-group t t group select-articles))
2023             group)
2024         ;;(error nil)
2025         (quit
2026          (message "Quit reading the ephemeral group")
2027          nil)))))
2028
2029 (defun gnus-group-jump-to-group (group)
2030   "Jump to newsgroup GROUP."
2031   (interactive
2032    (list (mm-string-make-unibyte
2033           (completing-read
2034            "Group: " gnus-active-hashtb nil
2035            (gnus-read-active-file-p)
2036            gnus-group-jump-to-group-prompt
2037            'gnus-group-history))))
2038
2039   (when (equal group "")
2040     (error "Empty group name"))
2041
2042   (unless (gnus-ephemeral-group-p group)
2043     ;; Either go to the line in the group buffer...
2044     (unless (gnus-group-goto-group group)
2045       ;; ... or insert the line.
2046       (gnus-group-update-group group)
2047       (gnus-group-goto-group group)))
2048   ;; Adjust cursor point.
2049   (gnus-group-position-point))
2050
2051 (defun gnus-group-goto-group (group &optional far test-marked)
2052   "Goto to newsgroup GROUP.
2053 If FAR, it is likely that the group is not on the current line.
2054 If TEST-MARKED, the line must be marked."
2055   (when group
2056     (beginning-of-line)
2057     (cond
2058      ;; It's quite likely that we are on the right line, so
2059      ;; we check the current line first.
2060      ((and (not far)
2061            (eq (get-text-property (point) 'gnus-group)
2062                (gnus-intern-safe group gnus-active-hashtb))
2063            (or (not test-marked) (gnus-group-mark-line-p)))
2064       (point))
2065      ;; Previous and next line are also likely, so we check them as well.
2066      ((and (not far)
2067            (save-excursion
2068              (forward-line -1)
2069              (and (eq (get-text-property (point) 'gnus-group)
2070                       (gnus-intern-safe group gnus-active-hashtb))
2071                   (or (not test-marked) (gnus-group-mark-line-p)))))
2072       (forward-line -1)
2073       (point))
2074      ((and (not far)
2075            (save-excursion
2076              (forward-line 1)
2077              (and (eq (get-text-property (point) 'gnus-group)
2078                       (gnus-intern-safe group gnus-active-hashtb))
2079                   (or (not test-marked) (gnus-group-mark-line-p)))))
2080       (forward-line 1)
2081       (point))
2082      (test-marked
2083       (goto-char (point-min))
2084       (let (found)
2085         (while (and (not found)
2086                     (gnus-goto-char
2087                      (text-property-any
2088                       (point) (point-max)
2089                       'gnus-group
2090                       (gnus-intern-safe group gnus-active-hashtb))))
2091           (if (gnus-group-mark-line-p)
2092               (setq found t)
2093             (forward-line 1)))
2094         found))
2095      (t
2096       ;; Search through the entire buffer.
2097       (gnus-goto-char
2098        (text-property-any
2099         (point-min) (point-max)
2100         'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
2101
2102 (defun gnus-group-next-group (n &optional silent)
2103   "Go to next N'th newsgroup.
2104 If N is negative, search backward instead.
2105 Returns the difference between N and the number of skips actually
2106 done."
2107   (interactive "p")
2108   (gnus-group-next-unread-group n t nil silent))
2109
2110 (defun gnus-group-next-unread-group (n &optional all level silent)
2111   "Go to next N'th unread newsgroup.
2112 If N is negative, search backward instead.
2113 If ALL is non-nil, choose any newsgroup, unread or not.
2114 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
2115 such group can be found, the next group with a level higher than
2116 LEVEL.
2117 Returns the difference between N and the number of skips actually
2118 made."
2119   (interactive "p")
2120   (let ((backward (< n 0))
2121         (n (abs n)))
2122     (while (and (> n 0)
2123                 (gnus-group-search-forward
2124                  backward (or (not gnus-group-goto-unread) all) level))
2125       (setq n (1- n)))
2126     (when (and (/= 0 n)
2127                (not silent))
2128       (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
2129                     (if level " on this level or higher" "")))
2130     n))
2131
2132 (defun gnus-group-prev-group (n)
2133   "Go to previous N'th newsgroup.
2134 Returns the difference between N and the number of skips actually
2135 done."
2136   (interactive "p")
2137   (gnus-group-next-unread-group (- n) t))
2138
2139 (defun gnus-group-prev-unread-group (n)
2140   "Go to previous N'th unread newsgroup.
2141 Returns the difference between N and the number of skips actually
2142 done."
2143   (interactive "p")
2144   (gnus-group-next-unread-group (- n)))
2145
2146 (defun gnus-group-next-unread-group-same-level (n)
2147   "Go to next N'th unread newsgroup on the same level.
2148 If N is negative, search backward instead.
2149 Returns the difference between N and the number of skips actually
2150 done."
2151   (interactive "p")
2152   (gnus-group-next-unread-group n t (gnus-group-group-level))
2153   (gnus-group-position-point))
2154
2155 (defun gnus-group-prev-unread-group-same-level (n)
2156   "Go to next N'th unread newsgroup on the same level.
2157 Returns the difference between N and the number of skips actually
2158 done."
2159   (interactive "p")
2160   (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
2161   (gnus-group-position-point))
2162
2163 (defun gnus-group-best-unread-group (&optional exclude-group)
2164   "Go to the group with the highest level.
2165 If EXCLUDE-GROUP, do not go to that group."
2166   (interactive)
2167   (goto-char (point-min))
2168   (let ((best 100000)
2169         unread best-point)
2170     (while (not (eobp))
2171       (setq unread (get-text-property (point) 'gnus-unread))
2172       (when (and (numberp unread) (> unread 0))
2173         (when (and (get-text-property (point) 'gnus-level)
2174                    (< (get-text-property (point) 'gnus-level) best)
2175                    (or (not exclude-group)
2176                        (not (equal exclude-group (gnus-group-group-name)))))
2177           (setq best (get-text-property (point) 'gnus-level))
2178           (setq best-point (point))))
2179       (forward-line 1))
2180     (when best-point
2181       (goto-char best-point))
2182     (gnus-group-position-point)
2183     (and best-point (gnus-group-group-name))))
2184
2185 (defun gnus-group-first-unread-group ()
2186   "Go to the first group with unread articles."
2187   (interactive)
2188   (prog1
2189       (let ((opoint (point))
2190             unread)
2191         (goto-char (point-min))
2192         (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
2193                 (and (numberp unread)   ; Not a topic.
2194                      (not (zerop unread))) ; Has unread articles.
2195                 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
2196             (point)                     ; Success.
2197           (goto-char opoint)
2198           nil))                         ; Not success.
2199     (gnus-group-position-point)))
2200
2201 (defun gnus-group-enter-server-mode ()
2202   "Jump to the server buffer."
2203   (interactive)
2204   (gnus-enter-server-buffer))
2205
2206 (defun gnus-group-make-group (name &optional method address args)
2207   "Add a new newsgroup.
2208 The user will be prompted for a NAME, for a select METHOD, and an
2209 ADDRESS."
2210   (interactive
2211    (list
2212     (gnus-read-group "Group name: ")
2213     (gnus-read-method "From method: ")))
2214
2215   (when (stringp method)
2216     (setq method (or (gnus-server-to-method method) method)))
2217   (let* ((meth (gnus-method-simplify
2218                 (when (and method
2219                            (not (gnus-server-equal method gnus-select-method)))
2220                   (if address (list (intern method) address)
2221                     method))))
2222          (nname (if method (gnus-group-prefixed-name name meth) name))
2223          backend info)
2224     (when (gnus-gethash nname gnus-newsrc-hashtb)
2225       (error "Group %s already exists" nname))
2226     ;; Subscribe to the new group.
2227     (gnus-group-change-level
2228      (setq info (list t nname gnus-level-default-subscribed nil nil meth))
2229      gnus-level-default-subscribed gnus-level-killed
2230      (and (gnus-group-group-name)
2231           (gnus-gethash (gnus-group-group-name)
2232                         gnus-newsrc-hashtb))
2233      t)
2234     ;; Make it active.
2235     (gnus-set-active nname (cons 1 0))
2236     (unless (gnus-ephemeral-group-p name)
2237       (gnus-dribble-enter
2238        (concat "(gnus-group-set-info '"
2239                (gnus-prin1-to-string (cdr info)) ")")))
2240     ;; Insert the line.
2241     (gnus-group-insert-group-line-info nname)
2242     (forward-line -1)
2243     (gnus-group-position-point)
2244
2245     ;; Load the back end and try to make the back end create
2246     ;; the group as well.
2247     (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
2248                                                   nil meth))))
2249                  gnus-valid-select-methods)
2250       (require backend))
2251     (gnus-check-server meth)
2252     (when (gnus-check-backend-function 'request-create-group nname)
2253       (unless (gnus-request-create-group nname nil args)
2254         (error "Could not create group on server: %s"
2255                (nnheader-get-report backend))))
2256     t))
2257
2258 (defun gnus-group-delete-groups (&optional arg)
2259   "Delete the current group.  Only meaningful with editable groups."
2260   (interactive "P")
2261   (let ((n (length (gnus-group-process-prefix arg))))
2262     (when (gnus-yes-or-no-p
2263            (if (= n 1)
2264                "Delete this 1 group? "
2265              (format "Delete these %d groups? " n)))
2266       (gnus-group-iterate arg
2267         (lambda (group)
2268           (gnus-group-delete-group group nil t))))))
2269
2270 (eval-when-compile (defvar gnus-cache-active-altered))
2271
2272 (defun gnus-group-delete-group (group &optional force no-prompt)
2273   "Delete the current group.  Only meaningful with editable groups.
2274 If FORCE (the prefix) is non-nil, all the articles in the group will
2275 be deleted.  This is \"deleted\" as in \"removed forever from the face
2276 of the Earth\".  There is no undo.  The user will be prompted before
2277 doing the deletion.
2278 Note that you also have to specify FORCE if you want the group to
2279 be removed from the server, even when it's empty."
2280   (interactive
2281    (list (gnus-group-group-name)
2282          current-prefix-arg))
2283   (unless group
2284     (error "No group to delete"))
2285   (unless (gnus-check-backend-function 'request-delete-group group)
2286     (error "This back end does not support group deletion"))
2287   (prog1
2288       (if (and (not no-prompt)
2289                (not (gnus-yes-or-no-p
2290                      (format
2291                       "Do you really want to delete %s%s? "
2292                       group (if force " and all its contents" "")))))
2293           ()                            ; Whew!
2294         (gnus-message 6 "Deleting group %s..." group)
2295         (if (not (gnus-request-delete-group group force))
2296             (gnus-error 3 "Couldn't delete group %s" group)
2297           (gnus-message 6 "Deleting group %s...done" group)
2298           (gnus-group-goto-group group)
2299           (gnus-group-kill-group 1 t)
2300           (gnus-sethash group nil gnus-active-hashtb)
2301           (if (boundp 'gnus-cache-active-hashtb)
2302               (when gnus-cache-active-hashtb
2303                 (gnus-sethash group nil gnus-cache-active-hashtb)
2304                 (setq gnus-cache-active-altered t)))
2305           t))
2306     (gnus-group-position-point)))
2307
2308 (defun gnus-group-rename-group (group new-name)
2309   "Rename group from GROUP to NEW-NAME.
2310 When used interactively, GROUP is the group under point
2311 and NEW-NAME will be prompted for."
2312   (interactive
2313    (list
2314     (gnus-group-group-name)
2315     (progn
2316       (unless (gnus-check-backend-function
2317                'request-rename-group (gnus-group-group-name))
2318         (error "This back end does not support renaming groups"))
2319       (gnus-read-group "Rename group to: "
2320                        (gnus-group-real-name (gnus-group-group-name))))))
2321
2322   (unless (gnus-check-backend-function 'request-rename-group group)
2323     (error "This back end does not support renaming groups"))
2324   (unless group
2325     (error "No group to rename"))
2326   (when (equal (gnus-group-real-name group) new-name)
2327     (error "Can't rename to the same name"))
2328
2329   ;; We find the proper prefixed name.
2330   (setq new-name
2331         (if (gnus-group-native-p group)
2332             ;; Native group.
2333             new-name
2334           ;; Foreign group.
2335           (gnus-group-prefixed-name
2336            (gnus-group-real-name new-name)
2337            (gnus-info-method (gnus-get-info group)))))
2338
2339   (when (gnus-active new-name)
2340     (error "The group %s already exists" new-name))
2341
2342   (gnus-message 6 "Renaming group %s to %s..." group new-name)
2343   (prog1
2344       (if (progn
2345             (gnus-group-goto-group group)
2346             (not (when (< (gnus-group-group-level) gnus-level-zombie)
2347                    (gnus-request-rename-group group new-name))))
2348           (gnus-error 3 "Couldn't rename group %s to %s" group new-name)
2349         ;; We rename the group internally by killing it...
2350         (gnus-group-kill-group)
2351         ;; ... changing its name ...
2352         (setcar (cdar gnus-list-of-killed-groups) new-name)
2353         ;; ... and then yanking it.  Magic!
2354         (gnus-group-yank-group)
2355         (gnus-set-active new-name (gnus-active group))
2356         (gnus-message 6 "Renaming group %s to %s...done" group new-name)
2357         new-name)
2358     (setq gnus-killed-list (delete group gnus-killed-list))
2359     (gnus-set-active group nil)
2360     (gnus-dribble-touch)
2361     (gnus-group-position-point)))
2362
2363 (defun gnus-group-edit-group (group &optional part)
2364   "Edit the group on the current line."
2365   (interactive (list (gnus-group-group-name)))
2366   (let ((part (or part 'info))
2367         info)
2368     (unless group
2369       (error "No group on current line"))
2370     (unless (setq info (gnus-get-info group))
2371       (error "Killed group; can't be edited"))
2372     (ignore-errors
2373       (gnus-close-group group))
2374     (gnus-edit-form
2375      ;; Find the proper form to edit.
2376      (cond ((eq part 'method)
2377             (or (gnus-info-method info) "native"))
2378            ((eq part 'params)
2379             (gnus-info-params info))
2380            (t info))
2381      ;; The proper documentation.
2382      (format
2383       "Editing the %s for `%s'."
2384       (cond
2385        ((eq part 'method) "select method")
2386        ((eq part 'params) "group parameters")
2387        (t "group info"))
2388       (gnus-group-decoded-name group))
2389      `(lambda (form)
2390         (gnus-group-edit-group-done ',part ,group form)))
2391     (local-set-key
2392      "\C-c\C-i"
2393      (gnus-create-info-command
2394       (cond
2395        ((eq part 'method)
2396         "(gnus)Select Methods")
2397        ((eq part 'params)
2398         "(gnus)Group Parameters")
2399        (t
2400         "(gnus)Group Info"))))))
2401
2402 (defun gnus-group-edit-group-method (group)
2403   "Edit the select method of GROUP."
2404   (interactive (list (gnus-group-group-name)))
2405   (gnus-group-edit-group group 'method))
2406
2407 (defun gnus-group-edit-group-parameters (group)
2408   "Edit the group parameters of GROUP."
2409   (interactive (list (gnus-group-group-name)))
2410   (gnus-group-edit-group group 'params))
2411
2412 (defun gnus-group-edit-group-done (part group form)
2413   "Update variables."
2414   (let* ((method (cond ((eq part 'info) (nth 4 form))
2415                        ((eq part 'method) form)
2416                        (t nil)))
2417          (info (cond ((eq part 'info) form)
2418                      ((eq part 'method) (gnus-get-info group))
2419                      (t nil)))
2420          (new-group (if info
2421                         (if (or (not method)
2422                                 (gnus-server-equal
2423                                  gnus-select-method method))
2424                             (gnus-group-real-name (car info))
2425                           (gnus-group-prefixed-name
2426                            (gnus-group-real-name (car info)) method))
2427                       nil)))
2428     (when (and new-group
2429                (not (equal new-group group)))
2430       (when (gnus-group-goto-group group)
2431         (gnus-group-kill-group 1))
2432       (gnus-activate-group new-group))
2433     ;; Set the info.
2434     (if (not (and info new-group))
2435         (gnus-group-set-info form (or new-group group) part)
2436       (setq info (gnus-copy-sequence info))
2437       (setcar info new-group)
2438       (unless (gnus-server-equal method "native")
2439         (unless (nthcdr 3 info)
2440           (nconc info (list nil nil)))
2441         (unless (nthcdr 4 info)
2442           (nconc info (list nil)))
2443         (gnus-info-set-method info method))
2444       (gnus-group-set-info info))
2445     (gnus-group-update-group (or new-group group))
2446     (gnus-group-position-point)))
2447
2448 (defun gnus-group-make-useful-group (group method)
2449   "Create one of the groups described in `gnus-useful-groups'."
2450   (interactive
2451    (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
2452                                         nil t)
2453                        gnus-useful-groups)))
2454      (list (cadr entry) (caddr entry))))
2455   (setq method (gnus-copy-sequence method))
2456   (let (entry)
2457     (while (setq entry (memq (assq 'eval method) method))
2458       (setcar entry (eval (cadar entry)))))
2459   (gnus-group-make-group group method))
2460
2461 (defun gnus-group-make-help-group (&optional noerror)
2462   "Create the Gnus documentation group.
2463 Optional argument NOERROR modifies the behavior of this function when the
2464 group already exists:
2465 - if not given, and error is signaled,
2466 - if t, stay silent,
2467 - if anything else, just print a message."
2468   (interactive)
2469   (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2470         (file (nnheader-find-etc-directory "gnus-tut.txt" t)))
2471     (if (gnus-gethash name gnus-newsrc-hashtb)
2472         (cond ((eq noerror nil)
2473                (error "Documentation group already exists"))
2474               ((eq noerror t)
2475                ;; stay silent
2476                )
2477               (t
2478                (gnus-message 1 "Documentation group already exists")))
2479       ;; else:
2480       (if (not file)
2481           (gnus-message 1 "Couldn't find doc group")
2482         (gnus-group-make-group
2483          (gnus-group-real-name name)
2484          (list 'nndoc "gnus-help"
2485                (list 'nndoc-address file)
2486                (list 'nndoc-article-type 'mbox))))
2487       ))
2488   (gnus-group-position-point))
2489
2490 (defun gnus-group-make-doc-group (file type)
2491   "Create a group that uses a single file as the source."
2492   (interactive
2493    (list (read-file-name "File name: ")
2494          (and current-prefix-arg 'ask)))
2495   (when (eq type 'ask)
2496     (let ((err "")
2497           char found)
2498       (while (not found)
2499         (message
2500          "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [mbdfag]: "
2501          err)
2502         (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2503                           ((= char ?b) 'babyl)
2504                           ((= char ?d) 'digest)
2505                           ((= char ?f) 'forward)
2506                           ((= char ?a) 'mmfd)
2507                           ((= char ?g) 'guess)
2508                           (t (setq err (format "%c unknown. " char))
2509                              nil))))
2510       (setq type found)))
2511   (let* ((file (expand-file-name file))
2512          (name (gnus-generate-new-group-name
2513                 (gnus-group-prefixed-name
2514                  (file-name-nondirectory file) '(nndoc "")))))
2515     (gnus-group-make-group
2516      (gnus-group-real-name name)
2517      (list 'nndoc file
2518            (list 'nndoc-address file)
2519            (list 'nndoc-article-type (or type 'guess))))))
2520
2521 (defvar nnweb-type-definition)
2522 (defvar gnus-group-web-type-history nil)
2523 (defvar gnus-group-web-search-history nil)
2524 (defun gnus-group-make-web-group (&optional solid)
2525   "Create an ephemeral nnweb group.
2526 If SOLID (the prefix), create a solid group."
2527   (interactive "P")
2528   (require 'nnweb)
2529   (let* ((group
2530           (if solid (gnus-read-group "Group name: ")
2531             (message-unique-id)))
2532          (default-type (or (car gnus-group-web-type-history)
2533                            (symbol-name (caar nnweb-type-definition))))
2534          (type
2535           (gnus-string-or
2536            (completing-read
2537             (format "Search engine type (default %s): " default-type)
2538             (mapcar (lambda (elem) (list (symbol-name (car elem))))
2539                     nnweb-type-definition)
2540             nil t nil 'gnus-group-web-type-history)
2541            default-type))
2542          (search
2543           (read-string
2544            "Search string: "
2545            (cons (or (car gnus-group-web-search-history) "") 0)
2546            'gnus-group-web-search-history))
2547          (method
2548           `(nnweb ,group (nnweb-search ,search)
2549                   (nnweb-type ,(intern type))
2550                   (nnweb-ephemeral-p t))))
2551     (if solid
2552         (progn
2553           (gnus-pull 'nnweb-ephemeral-p method)
2554           (gnus-group-make-group group method))
2555       (gnus-group-read-ephemeral-group
2556        group method t
2557        (cons (current-buffer)
2558              (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
2559
2560 (eval-when-compile (defvar nnrss-group-alist)
2561                    (defun nnrss-discover-feed (arg))
2562                    (defun nnrss-save-server-data (arg)))
2563 (defun gnus-group-make-rss-group (&optional url)
2564   "Given a URL, discover if there is an RSS feed.
2565 If there is, use Gnus to create an nnrss group"
2566   (interactive)
2567   (require 'nnrss)
2568   (if (not url)
2569       (setq url (read-from-minibuffer "URL to Search for RSS: ")))
2570   (let ((feedinfo (nnrss-discover-feed url)))
2571     (if feedinfo
2572         (let ((title (read-from-minibuffer "Title: "
2573                                            (cdr (assoc 'title
2574                                                        feedinfo))))
2575               (desc  (read-from-minibuffer "Description: "
2576                                            (cdr (assoc 'description
2577                                                        feedinfo))))
2578               (href (cdr (assoc 'href feedinfo))))
2579           (push (list title href desc)
2580                 nnrss-group-alist)
2581           (gnus-group-unsubscribe-group
2582            (concat "nnrss:" title))
2583           (nnrss-save-server-data nil))
2584       (error "No feeds found for %s" url))))
2585
2586 (defvar nnwarchive-type-definition)
2587 (defvar gnus-group-warchive-type-history nil)
2588 (defvar gnus-group-warchive-login-history nil)
2589 (defvar gnus-group-warchive-address-history nil)
2590
2591 (defun gnus-group-make-warchive-group ()
2592   "Create a nnwarchive group."
2593   (interactive)
2594   (require 'nnwarchive)
2595   (let* ((group (gnus-read-group "Group name: "))
2596          (default-type (or (car gnus-group-warchive-type-history)
2597                            (symbol-name (caar nnwarchive-type-definition))))
2598          (type
2599           (gnus-string-or
2600            (completing-read
2601             (format "Warchive type (default %s): " default-type)
2602             (mapcar (lambda (elem) (list (symbol-name (car elem))))
2603                     nnwarchive-type-definition)
2604             nil t nil 'gnus-group-warchive-type-history)
2605            default-type))
2606          (address (read-string "Warchive address: "
2607                                nil 'gnus-group-warchive-address-history))
2608          (default-login (or (car gnus-group-warchive-login-history)
2609                             user-mail-address))
2610          (login
2611           (gnus-string-or
2612            (read-string
2613             (format "Warchive login (default %s): " user-mail-address)
2614             default-login 'gnus-group-warchive-login-history)
2615            user-mail-address))
2616          (method
2617           `(nnwarchive ,address
2618                        (nnwarchive-type ,(intern type))
2619                        (nnwarchive-login ,login))))
2620     (gnus-group-make-group group method)))
2621
2622 (defun gnus-group-make-archive-group (&optional all)
2623   "Create the (ding) Gnus archive group of the most recent articles.
2624 Given a prefix, create a full group."
2625   (interactive "P")
2626   (let ((group (gnus-group-prefixed-name
2627                 (if all "ding.archives" "ding.recent") '(nndir ""))))
2628     (when (gnus-gethash group gnus-newsrc-hashtb)
2629       (error "Archive group already exists"))
2630     (gnus-group-make-group
2631      (gnus-group-real-name group)
2632      (list 'nndir (if all "hpc" "edu")
2633            (list 'nndir-directory
2634                  (if all gnus-group-archive-directory
2635                    gnus-group-recent-archive-directory))))
2636     (gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
2637
2638 (defun gnus-group-make-directory-group (dir)
2639   "Create an nndir group.
2640 The user will be prompted for a directory.  The contents of this
2641 directory will be used as a newsgroup.  The directory should contain
2642 mail messages or news articles in files that have numeric names."
2643   (interactive
2644    (list (read-file-name "Create group from directory: ")))
2645   (unless (file-exists-p dir)
2646     (error "No such directory"))
2647   (unless (file-directory-p dir)
2648     (error "Not a directory"))
2649   (let ((ext "")
2650         (i 0)
2651         group)
2652     (while (or (not group) (gnus-gethash group gnus-newsrc-hashtb))
2653       (setq group
2654             (gnus-group-prefixed-name
2655              (expand-file-name ext dir)
2656              '(nndir "")))
2657       (setq ext (format "<%d>" (setq i (1+ i)))))
2658     (gnus-group-make-group
2659      (gnus-group-real-name group)
2660      (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
2661
2662 (eval-when-compile (defvar nnkiboze-score-file))
2663 (defun gnus-group-make-kiboze-group (group address scores)
2664   "Create an nnkiboze group.
2665 The user will be prompted for a name, a regexp to match groups, and
2666 score file entries for articles to include in the group."
2667   (interactive
2668    (list
2669     (read-string "nnkiboze group name: ")
2670     (read-string "Source groups (regexp): ")
2671     (let ((headers (mapcar (lambda (group) (list group))
2672                            '("subject" "from" "number" "date" "message-id"
2673                              "references" "chars" "lines" "xref"
2674                              "followup" "all" "body" "head")))
2675           scores header regexp regexps)
2676       (while (not (equal "" (setq header (completing-read
2677                                           "Match on header: " headers nil t))))
2678         (setq regexps nil)
2679         (while (not (equal "" (setq regexp (read-string
2680                                             (format "Match on %s (regexp): "
2681                                                     header)))))
2682           (push (list regexp nil nil 'r) regexps))
2683         (push (cons header regexps) scores))
2684       scores)))
2685   (gnus-group-make-group group "nnkiboze" address)
2686   (let* ((nnkiboze-current-group group)
2687          (score-file (car (nnkiboze-score-file "")))
2688          (score-dir (file-name-directory score-file)))
2689     (unless (file-exists-p score-dir)
2690       (make-directory score-dir))
2691     (with-temp-file score-file
2692       (let (emacs-lisp-mode-hook)
2693         (pp scores (current-buffer))))))
2694
2695 (defun gnus-group-add-to-virtual (n vgroup)
2696   "Add the current group to a virtual group."
2697   (interactive
2698    (list current-prefix-arg
2699          (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
2700                           "nnvirtual:")))
2701   (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
2702     (error "%s is not an nnvirtual group" vgroup))
2703   (gnus-close-group vgroup)
2704   (let* ((groups (gnus-group-process-prefix n))
2705          (method (gnus-info-method (gnus-get-info vgroup))))
2706     (setcar (cdr method)
2707             (concat
2708              (nth 1 method) "\\|"
2709              (mapconcat
2710               (lambda (s)
2711                 (gnus-group-remove-mark s)
2712                 (concat "\\(^" (regexp-quote s) "$\\)"))
2713               groups "\\|"))))
2714   (gnus-group-position-point))
2715
2716 (defun gnus-group-make-empty-virtual (group)
2717   "Create a new, fresh, empty virtual group."
2718   (interactive "sCreate new, empty virtual group: ")
2719   (let* ((method (list 'nnvirtual "^$"))
2720          (pgroup (gnus-group-prefixed-name group method)))
2721     ;; Check whether it exists already.
2722     (when (gnus-gethash pgroup gnus-newsrc-hashtb)
2723       (error "Group %s already exists" pgroup))
2724     ;; Subscribe the new group after the group on the current line.
2725     (gnus-subscribe-group pgroup (gnus-group-group-name) method)
2726     (gnus-group-update-group pgroup)
2727     (forward-line -1)
2728     (gnus-group-position-point)))
2729
2730 (defun gnus-group-enter-directory (dir)
2731   "Enter an ephemeral nneething group."
2732   (interactive "DDirectory to read: ")
2733   (let* ((method (list 'nneething dir '(nneething-read-only t)))
2734          (leaf (gnus-group-prefixed-name
2735                 (file-name-nondirectory (directory-file-name dir))
2736                 method))
2737          (name (gnus-generate-new-group-name leaf)))
2738     (unless (gnus-group-read-ephemeral-group
2739              name method t
2740              (cons (current-buffer)
2741                    (if (eq major-mode 'gnus-summary-mode)
2742                        'summary 'group)))
2743       (error "Couldn't enter %s" dir))))
2744
2745 (eval-and-compile
2746   (autoload 'nnimap-expunge "nnimap")
2747   (autoload 'nnimap-acl-get "nnimap")
2748   (autoload 'nnimap-acl-edit "nnimap"))
2749
2750 (defun gnus-group-nnimap-expunge (group)
2751   "Expunge deleted articles in current nnimap GROUP."
2752   (interactive (list (gnus-group-group-name)))
2753   (let ((mailbox (gnus-group-real-name group)) method)
2754     (unless group
2755       (error "No group on current line"))
2756     (unless (gnus-get-info group)
2757       (error "Killed group; can't be edited"))
2758     (unless (eq 'nnimap (car (setq method (gnus-find-method-for-group group))))
2759       (error "%s is not an nnimap group" group))
2760     (nnimap-expunge mailbox (cadr method))))
2761
2762 (defun gnus-group-nnimap-edit-acl (group)
2763   "Edit the Access Control List of current nnimap GROUP."
2764   (interactive (list (gnus-group-group-name)))
2765   (let ((mailbox (gnus-group-real-name group)) method acl)
2766     (unless group
2767       (error "No group on current line"))
2768     (unless (gnus-get-info group)
2769       (error "Killed group; can't be edited"))
2770     (unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
2771       (error "%s is not an nnimap group" group))
2772     (unless (setq acl (nnimap-acl-get mailbox (cadr method)))
2773       (error "Server does not support ACL's"))
2774     (gnus-edit-form acl (format "Editing the access control list for `%s'.
2775
2776    An access control list is a list of (identifier . rights) elements.
2777
2778    The identifier string specifies the corresponding user.  The
2779    identifier \"anyone\" is reserved to refer to the universal identity.
2780
2781    Rights is a string listing a (possibly empty) set of alphanumeric
2782    characters, each character listing a set of operations which is being
2783    controlled.  Letters are reserved for ``standard'' rights, listed
2784    below.  Digits are reserved for implementation or site defined rights.
2785
2786    l - lookup (mailbox is visible to LIST/LSUB commands)
2787    r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
2788        SEARCH, COPY from mailbox)
2789    s - keep seen/unseen information across sessions (STORE \\SEEN flag)
2790    w - write (STORE flags other than \\SEEN and \\DELETED)
2791    i - insert (perform APPEND, COPY into mailbox)
2792    p - post (send mail to submission address for mailbox,
2793        not enforced by IMAP4 itself)
2794    c - create and delete mailbox (CREATE new sub-mailboxes in any
2795        implementation-defined hierarchy, RENAME or DELETE mailbox)
2796    d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
2797    a - administer (perform SETACL)" group)
2798                     `(lambda (form)
2799                        (nnimap-acl-edit
2800                         ,mailbox ',method ',acl form)))))
2801
2802 ;; Group sorting commands
2803 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
2804
2805 (defun gnus-group-sort-groups (func &optional reverse)
2806   "Sort the group buffer according to FUNC.
2807 When used interactively, the sorting function used will be
2808 determined by the `gnus-group-sort-function' variable.
2809 If REVERSE (the prefix), reverse the sorting order."
2810   (interactive (list gnus-group-sort-function current-prefix-arg))
2811   (funcall gnus-group-sort-alist-function
2812            (gnus-make-sort-function func) reverse)
2813   (gnus-group-unmark-all-groups)
2814   (gnus-group-list-groups)
2815   (gnus-dribble-touch))
2816
2817 (defun gnus-group-sort-flat (func reverse)
2818   ;; We peel off the dummy group from the alist.
2819   (when func
2820     (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
2821       (pop gnus-newsrc-alist))
2822     ;; Do the sorting.
2823     (setq gnus-newsrc-alist
2824           (sort gnus-newsrc-alist func))
2825     (when reverse
2826       (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
2827     ;; Regenerate the hash table.
2828     (gnus-make-hashtable-from-newsrc-alist)))
2829
2830 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
2831   "Sort the group buffer alphabetically by group name.
2832 If REVERSE, sort in reverse order."
2833   (interactive "P")
2834   (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
2835
2836 (defun gnus-group-sort-groups-by-real-name (&optional reverse)
2837   "Sort the group buffer alphabetically by real (unprefixed) group name.
2838 If REVERSE, sort in reverse order."
2839   (interactive "P")
2840   (gnus-group-sort-groups 'gnus-group-sort-by-real-name reverse))
2841
2842 (defun gnus-group-sort-groups-by-unread (&optional reverse)
2843   "Sort the group buffer by number of unread articles.
2844 If REVERSE, sort in reverse order."
2845   (interactive "P")
2846   (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
2847
2848 (defun gnus-group-sort-groups-by-level (&optional reverse)
2849   "Sort the group buffer by group level.
2850 If REVERSE, sort in reverse order."
2851   (interactive "P")
2852   (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
2853
2854 (defun gnus-group-sort-groups-by-score (&optional reverse)
2855   "Sort the group buffer by group score.
2856 If REVERSE, sort in reverse order."
2857   (interactive "P")
2858   (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
2859
2860 (defun gnus-group-sort-groups-by-rank (&optional reverse)
2861   "Sort the group buffer by group rank.
2862 If REVERSE, sort in reverse order."
2863   (interactive "P")
2864   (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
2865
2866 (defun gnus-group-sort-groups-by-method (&optional reverse)
2867   "Sort the group buffer alphabetically by back end name.
2868 If REVERSE, sort in reverse order."
2869   (interactive "P")
2870   (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
2871
2872 (defun gnus-group-sort-groups-by-server (&optional reverse)
2873   "Sort the group buffer alphabetically by server name.
2874 If REVERSE, sort in reverse order."
2875   (interactive "P")
2876   (gnus-group-sort-groups 'gnus-group-sort-by-server reverse))
2877
2878 ;;; Selected group sorting.
2879
2880 (defun gnus-group-sort-selected-groups (n func &optional reverse)
2881   "Sort the process/prefixed groups."
2882   (interactive (list current-prefix-arg gnus-group-sort-function))
2883   (let ((groups (gnus-group-process-prefix n)))
2884     (funcall gnus-group-sort-selected-function
2885              groups (gnus-make-sort-function func) reverse)
2886     (gnus-group-unmark-all-groups)
2887     (gnus-group-list-groups)
2888     (gnus-dribble-touch)))
2889
2890 (defun gnus-group-sort-selected-flat (groups func reverse)
2891   (let (entries infos)
2892     ;; First find all the group entries for these groups.
2893     (while groups
2894       (push (nthcdr 2 (gnus-gethash (pop groups) gnus-newsrc-hashtb))
2895             entries))
2896     ;; Then sort the infos.
2897     (setq infos
2898           (sort
2899            (mapcar
2900             (lambda (entry) (car entry))
2901             (setq entries (nreverse entries)))
2902            func))
2903     (when reverse
2904       (setq infos (nreverse infos)))
2905     ;; Go through all the infos and replace the old entries
2906     ;; with the new infos.
2907     (while infos
2908       (setcar (car entries) (pop infos))
2909       (pop entries))
2910     ;; Update the hashtable.
2911     (gnus-make-hashtable-from-newsrc-alist)))
2912
2913 (defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
2914   "Sort the group buffer alphabetically by group name.
2915 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
2916 sort in reverse order."
2917   (interactive (gnus-interactive "P\ny"))
2918   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
2919
2920 (defun gnus-group-sort-selected-groups-by-real-name (&optional n reverse)
2921   "Sort the group buffer alphabetically by real group name.
2922 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
2923 sort in reverse order."
2924   (interactive (gnus-interactive "P\ny"))
2925   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-real-name reverse))
2926
2927 (defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
2928   "Sort the group buffer by number of unread articles.
2929 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
2930 sort in reverse order."
2931   (interactive (gnus-interactive "P\ny"))
2932   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
2933
2934 (defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
2935   "Sort the group buffer by group level.
2936 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
2937 sort in reverse order."
2938   (interactive (gnus-interactive "P\ny"))
2939   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
2940
2941 (defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
2942   "Sort the group buffer by group score.
2943 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
2944 sort in reverse order."
2945   (interactive (gnus-interactive "P\ny"))
2946   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
2947
2948 (defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
2949   "Sort the group buffer by group rank.
2950 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
2951 sort in reverse order."
2952   (interactive (gnus-interactive "P\ny"))
2953   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
2954
2955 (defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
2956   "Sort the group buffer alphabetically by back end name.
2957 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
2958 sort in reverse order."
2959   (interactive (gnus-interactive "P\ny"))
2960   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
2961
2962 ;;; Sorting predicates.
2963
2964 (defun gnus-group-sort-by-alphabet (info1 info2)
2965   "Sort alphabetically."
2966   (string< (gnus-info-group info1) (gnus-info-group info2)))
2967
2968 (defun gnus-group-sort-by-real-name (info1 info2)
2969   "Sort alphabetically on real (unprefixed) names."
2970   (string< (gnus-group-real-name (gnus-info-group info1))
2971            (gnus-group-real-name (gnus-info-group info2))))
2972
2973 (defun gnus-group-sort-by-unread (info1 info2)
2974   "Sort by number of unread articles."
2975   (let ((n1 (car (gnus-gethash (gnus-info-group info1) gnus-newsrc-hashtb)))
2976         (n2 (car (gnus-gethash (gnus-info-group info2) gnus-newsrc-hashtb))))
2977     (< (or (and (numberp n1) n1) 0)
2978        (or (and (numberp n2) n2) 0))))
2979
2980 (defun gnus-group-sort-by-level (info1 info2)
2981   "Sort by level."
2982   (< (gnus-info-level info1) (gnus-info-level info2)))
2983
2984 (defun gnus-group-sort-by-method (info1 info2)
2985   "Sort alphabetically by back end name."
2986   (string< (car (gnus-find-method-for-group
2987                  (gnus-info-group info1) info1))
2988            (car (gnus-find-method-for-group
2989                  (gnus-info-group info2) info2))))
2990
2991 (defun gnus-group-sort-by-server (info1 info2)
2992   "Sort alphabetically by server name."
2993   (string< (gnus-method-to-full-server-name
2994             (gnus-find-method-for-group
2995              (gnus-info-group info1) info1))
2996            (gnus-method-to-full-server-name
2997             (gnus-find-method-for-group
2998              (gnus-info-group info2) info2))))
2999
3000 (defun gnus-group-sort-by-score (info1 info2)
3001   "Sort by group score."
3002   (> (gnus-info-score info1) (gnus-info-score info2)))
3003
3004 (defun gnus-group-sort-by-rank (info1 info2)
3005   "Sort by level and score."
3006   (let ((level1 (gnus-info-level info1))
3007         (level2 (gnus-info-level info2)))
3008     (or (< level1 level2)
3009         (and (= level1 level2)
3010              (> (gnus-info-score info1) (gnus-info-score info2))))))
3011
3012 ;;; Clearing data
3013
3014 (defun gnus-group-clear-data (&optional arg)
3015   "Clear all marks and read ranges from the current group."
3016   (interactive "P")
3017   (gnus-group-iterate arg
3018     (lambda (group)
3019       (let (info)
3020         (gnus-info-clear-data (setq info (gnus-get-info group)))
3021         (gnus-get-unread-articles-in-group info (gnus-active group) t)
3022         (when (gnus-group-goto-group group)
3023           (gnus-group-update-group-line))))))
3024
3025 (defun gnus-group-clear-data-on-native-groups ()
3026   "Clear all marks and read ranges from all native groups."
3027   (interactive)
3028   (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
3029     (let ((alist (cdr gnus-newsrc-alist))
3030           info)
3031       (while (setq info (pop alist))
3032         (when (gnus-group-native-p (gnus-info-group info))
3033           (gnus-info-clear-data info)))
3034       (gnus-get-unread-articles)
3035       (gnus-dribble-touch)
3036       (when (gnus-y-or-n-p
3037              "Move the cache away to avoid problems in the future? ")
3038         (call-interactively 'gnus-cache-move-cache)))))
3039
3040 (defun gnus-info-clear-data (info)
3041   "Clear all marks and read ranges from INFO."
3042   (let ((group (gnus-info-group info))
3043         action)
3044     (dolist (el (gnus-info-marks info))
3045       (push `(,(cdr el) add (,(car el))) action))
3046     (push `(,(gnus-info-read info) add (read)) action)
3047     (gnus-undo-register
3048       `(progn
3049          (gnus-request-set-mark ,group ',action)
3050          (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
3051          (gnus-info-set-read ',info ',(gnus-info-read info))
3052          (when (gnus-group-goto-group ,group)
3053            (gnus-get-unread-articles-in-group ',info ',(gnus-active group) t)
3054            (gnus-group-update-group-line))))
3055     (setq action (mapcar (lambda (el) (list (nth 0 el) 'del (nth 2 el)))
3056                          action))
3057     (gnus-request-set-mark group action)
3058     (gnus-info-set-read info nil)
3059     (when (gnus-info-marks info)
3060       (gnus-info-set-marks info nil))))
3061
3062 ;; Group catching up.
3063
3064 (defun gnus-group-catchup-current (&optional n all)
3065   "Mark all unread articles in the current newsgroup as read.
3066 If prefix argument N is numeric, the next N newsgroups will be
3067 caught up.  If ALL is non-nil, marked articles will also be marked as
3068 read.  Cross references (Xref: header) of articles are ignored.
3069 The number of newsgroups that this function was unable to catch
3070 up is returned."
3071   (interactive "P")
3072   (let ((groups (gnus-group-process-prefix n))
3073         (ret 0)
3074         group)
3075     (unless groups (error "No groups selected"))
3076     (if (not
3077          (or (not gnus-interactive-catchup) ;Without confirmation?
3078              gnus-expert-user
3079              (gnus-y-or-n-p
3080               (format
3081                (if all
3082                    "Do you really want to mark all articles in %s as read? "
3083                  "Mark all unread articles in %s as read? ")
3084                (if (= (length groups) 1)
3085                    (car groups)
3086                  (format "these %d groups" (length groups)))))))
3087         n
3088       (while (setq group (pop groups))
3089         (gnus-group-remove-mark group)
3090         ;; Virtual groups have to be given special treatment.
3091         (let ((method (gnus-find-method-for-group group)))
3092           (when (eq 'nnvirtual (car method))
3093             (nnvirtual-catchup-group
3094              (gnus-group-real-name group) (nth 1 method) all)))
3095         (if (>= (gnus-group-level group) gnus-level-zombie)
3096             (gnus-message 2 "Dead groups can't be caught up")
3097           (if (prog1
3098                   (gnus-group-goto-group group)
3099                 (gnus-group-catchup group all))
3100               (gnus-group-update-group-line)
3101             (setq ret (1+ ret)))))
3102       (gnus-group-next-unread-group 1)
3103       ret)))
3104
3105 (defun gnus-group-catchup-current-all (&optional n)
3106   "Mark all articles in current newsgroup as read.
3107 Cross references (Xref: header) of articles are ignored."
3108   (interactive "P")
3109   (gnus-group-catchup-current n 'all))
3110
3111 (defun gnus-group-catchup (group &optional all)
3112   "Mark all articles in GROUP as read.
3113 If ALL is non-nil, all articles are marked as read.
3114 The return value is the number of articles that were marked as read,
3115 or nil if no action could be taken."
3116   (let* ((entry (gnus-gethash group gnus-newsrc-hashtb))
3117          (num (car entry))
3118          (marks (nth 3 (nth 2 entry)))
3119          (unread (gnus-list-of-unread-articles group)))
3120     ;; Remove entries for this group.
3121     (nnmail-purge-split-history (gnus-group-real-name group))
3122     ;; Do the updating only if the newsgroup isn't killed.
3123     (if (not (numberp (car entry)))
3124         (gnus-message 1 "Can't catch up %s; non-active group" group)
3125       (gnus-update-read-articles group nil)
3126       (when all
3127         ;; Nix out the lists of marks and dormants.
3128         (gnus-request-set-mark group (list (list (cdr (assq 'tick marks))
3129                                                  'del '(tick))
3130                                            (list (cdr (assq 'dormant marks))
3131                                                  'del '(dormant))))
3132         (setq unread (gnus-uncompress-range
3133                       (gnus-range-add (gnus-range-add
3134                                        unread (cdr (assq 'dormant marks)))
3135                                       (cdr (assq 'tick marks)))))
3136         (gnus-add-marked-articles group 'tick nil nil 'force)
3137         (gnus-add-marked-articles group 'dormant nil nil 'force))
3138       ;; Do auto-expirable marks if that's required.
3139       (when (gnus-group-auto-expirable-p group)
3140         (gnus-add-marked-articles group 'expire unread)
3141         (gnus-request-set-mark group (list (list unread 'add '(expire)))))
3142       (let ((gnus-newsgroup-name group))
3143         (gnus-run-hooks 'gnus-group-catchup-group-hook))
3144       num)))
3145
3146 (defun gnus-group-expire-articles (&optional n)
3147   "Expire all expirable articles in the current newsgroup.
3148 Uses the process/prefix convention."
3149   (interactive "P")
3150   (let ((groups (gnus-group-process-prefix n))
3151         group)
3152     (unless groups
3153       (error "No groups to expire"))
3154     (while (setq group (pop groups))
3155       (gnus-group-remove-mark group)
3156       (gnus-group-expire-articles-1 group)
3157       (gnus-dribble-touch)
3158       (gnus-group-position-point))))
3159
3160 (defun gnus-group-expire-articles-1 (group)
3161   (when (gnus-check-backend-function 'request-expire-articles group)
3162     (gnus-message 6 "Expiring articles in %s..." group)
3163     (let* ((info (gnus-get-info group))
3164            (expirable (if (gnus-group-total-expirable-p group)
3165                           (cons nil (gnus-list-of-read-articles group))
3166                         (assq 'expire (gnus-info-marks info))))
3167            (expiry-wait (gnus-group-find-parameter group 'expiry-wait))
3168            (nnmail-expiry-target
3169             (or (gnus-group-find-parameter group 'expiry-target)
3170                 nnmail-expiry-target)))
3171       (when expirable
3172         (gnus-check-group group)
3173         (setcdr
3174          expirable
3175          (gnus-compress-sequence
3176           (if expiry-wait
3177               ;; We set the expiry variables to the group
3178               ;; parameter.
3179               (let ((nnmail-expiry-wait-function nil)
3180                     (nnmail-expiry-wait expiry-wait))
3181                 (gnus-request-expire-articles
3182                  (gnus-uncompress-sequence (cdr expirable)) group))
3183             ;; Just expire using the normal expiry values.
3184             (gnus-request-expire-articles
3185              (gnus-uncompress-sequence (cdr expirable)) group))))
3186         (gnus-close-group group))
3187       (gnus-message 6 "Expiring articles in %s...done" group)
3188       ;; Return the list of un-expired articles.
3189       (cdr expirable))))
3190
3191 (defun gnus-group-expire-all-groups ()
3192   "Expire all expirable articles in all newsgroups."
3193   (interactive)
3194   (save-excursion
3195     (gnus-message 5 "Expiring...")
3196     (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
3197                                      (cdr gnus-newsrc-alist))))
3198       (gnus-group-expire-articles nil)))
3199   (gnus-group-position-point)
3200   (gnus-message 5 "Expiring...done"))
3201
3202 (defun gnus-group-set-current-level (n level)
3203   "Set the level of the next N groups to LEVEL."
3204   (interactive
3205    (list
3206     current-prefix-arg
3207     (string-to-int
3208      (let ((s (read-string
3209                (format "Level (default %s): "
3210                        (or (gnus-group-group-level)
3211                            gnus-level-default-subscribed)))))
3212        (if (string-match "^\\s-*$" s)
3213            (int-to-string (or (gnus-group-group-level)
3214                               gnus-level-default-subscribed))
3215          s)))))
3216   (unless (and (>= level 1) (<= level gnus-level-killed))
3217     (error "Invalid level: %d" level))
3218   (let ((groups (gnus-group-process-prefix n))
3219         group)
3220     (while (setq group (pop groups))
3221       (gnus-group-remove-mark group)
3222       (gnus-message 6 "Changed level of %s from %d to %d"
3223                     group (or (gnus-group-group-level) gnus-level-killed)
3224                     level)
3225       (gnus-group-change-level
3226        group level (or (gnus-group-group-level) gnus-level-killed))
3227       (gnus-group-update-group-line)))
3228   (gnus-group-position-point))
3229
3230 (defun gnus-group-unsubscribe (&optional n)
3231   "Unsubscribe the current group."
3232   (interactive "P")
3233   (gnus-group-unsubscribe-current-group n 'unsubscribe))
3234
3235 (defun gnus-group-subscribe (&optional n)
3236   "Subscribe the current group."
3237   (interactive "P")
3238   (gnus-group-unsubscribe-current-group n 'subscribe))
3239
3240 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
3241   "Toggle subscription of the current group.
3242 If given numerical prefix, toggle the N next groups."
3243   (interactive "P")
3244   (dolist (group (gnus-group-process-prefix n))
3245     (gnus-group-remove-mark group)
3246     (gnus-group-unsubscribe-group
3247      group
3248      (cond
3249       ((eq do-sub 'unsubscribe)
3250        gnus-level-default-unsubscribed)
3251       ((eq do-sub 'subscribe)
3252        gnus-level-default-subscribed)
3253       ((<= (gnus-group-group-level) gnus-level-subscribed)
3254        gnus-level-default-unsubscribed)
3255       (t
3256        gnus-level-default-subscribed))
3257      t)
3258     (gnus-group-update-group-line))
3259   (gnus-group-next-group 1))
3260
3261 (defun gnus-group-unsubscribe-group (group &optional level silent)
3262   "Toggle subscription to GROUP.
3263 Killed newsgroups are subscribed.  If SILENT, don't try to update the
3264 group line."
3265   (interactive
3266    (list (completing-read
3267           "Group: " gnus-active-hashtb nil
3268           (gnus-read-active-file-p)
3269           nil
3270           'gnus-group-history)))
3271   (let ((newsrc (gnus-gethash group gnus-newsrc-hashtb)))
3272     (cond
3273      ((string-match "^[ \t]*$" group)
3274       (error "Empty group name"))
3275      (newsrc
3276       ;; Toggle subscription flag.
3277       (gnus-group-change-level
3278        newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
3279                                       gnus-level-subscribed)
3280                                   (1+ gnus-level-subscribed)
3281                                 gnus-level-default-subscribed)))
3282       (unless silent
3283         (gnus-group-update-group group)))
3284      ((and (stringp group)
3285            (or (not (gnus-read-active-file-p))
3286                (gnus-active group)))
3287       ;; Add new newsgroup.
3288       (gnus-group-change-level
3289        group
3290        (if level level gnus-level-default-subscribed)
3291        (or (and (member group gnus-zombie-list)
3292                 gnus-level-zombie)
3293            gnus-level-killed)
3294        (when (gnus-group-group-name)
3295          (gnus-gethash (gnus-group-group-name) gnus-newsrc-hashtb)))
3296       (unless silent
3297         (gnus-group-update-group group)))
3298      (t (error "No such newsgroup: %s" group)))
3299     (gnus-group-position-point)))
3300
3301 (defun gnus-group-transpose-groups (n)
3302   "Move the current newsgroup up N places.
3303 If given a negative prefix, move down instead.  The difference between
3304 N and the number of steps taken is returned."
3305   (interactive "p")
3306   (unless (gnus-group-group-name)
3307     (error "No group on current line"))
3308   (gnus-group-kill-group 1)
3309   (prog1
3310       (forward-line (- n))
3311     (gnus-group-yank-group)
3312     (gnus-group-position-point)))
3313
3314 (defun gnus-group-kill-all-zombies (&optional dummy)
3315   "Kill all zombie newsgroups.
3316 The optional DUMMY should always be nil."
3317   (interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
3318   (unless dummy
3319     (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
3320     (setq gnus-zombie-list nil)
3321     (gnus-dribble-touch)
3322     (gnus-group-list-groups)))
3323
3324 (defun gnus-group-kill-region (begin end)
3325   "Kill newsgroups in current region (excluding current point).
3326 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
3327   (interactive "r")
3328   (let ((lines
3329          ;; Count lines.
3330          (save-excursion
3331            (count-lines
3332             (progn
3333               (goto-char begin)
3334               (beginning-of-line)
3335               (point))
3336             (progn
3337               (goto-char end)
3338               (beginning-of-line)
3339               (point))))))
3340     (goto-char begin)
3341     (beginning-of-line)                 ;Important when LINES < 1
3342     (gnus-group-kill-group lines)))
3343
3344 (defun gnus-group-kill-group (&optional n discard)
3345   "Kill the next N groups.
3346 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
3347 However, only groups that were alive can be yanked; already killed
3348 groups or zombie groups can't be yanked.
3349 The return value is the name of the group that was killed, or a list
3350 of groups killed."
3351   (interactive "P")
3352   (let ((buffer-read-only nil)
3353         (groups (gnus-group-process-prefix n))
3354         group entry level out)
3355     (if (< (length groups) 10)
3356         ;; This is faster when there are few groups.
3357         (while groups
3358           (push (setq group (pop groups)) out)
3359           (gnus-group-remove-mark group)
3360           (setq level (gnus-group-group-level))
3361           (gnus-delete-line)
3362           (when (and (not discard)
3363                      (setq entry (gnus-gethash group gnus-newsrc-hashtb)))
3364             (gnus-undo-register
3365               `(progn
3366                  (gnus-group-goto-group ,(gnus-group-group-name))
3367                  (gnus-group-yank-group)))
3368             (push (cons (car entry) (nth 2 entry))
3369                   gnus-list-of-killed-groups))
3370           (gnus-group-change-level
3371            (if entry entry group) gnus-level-killed (if entry nil level))
3372           (message "Killed group %s" group))
3373       ;; If there are lots and lots of groups to be killed, we use
3374       ;; this thing instead.
3375       (dolist (group (nreverse groups))
3376         (gnus-group-remove-mark group)
3377         (gnus-delete-line)
3378         (push group gnus-killed-list)
3379         (setq gnus-newsrc-alist
3380               (delq (assoc group gnus-newsrc-alist)
3381                     gnus-newsrc-alist))
3382         (when gnus-group-change-level-function
3383           (funcall gnus-group-change-level-function
3384                    group gnus-level-killed 3))
3385         (cond
3386          ((setq entry (gnus-gethash group gnus-newsrc-hashtb))
3387           (push (cons (car entry) (nth 2 entry))
3388                 gnus-list-of-killed-groups)
3389           (setcdr (cdr entry) (cdddr entry)))
3390          ((member group gnus-zombie-list)
3391           (setq gnus-zombie-list (delete group gnus-zombie-list))))
3392         ;; There may be more than one instance displayed.
3393         (while (gnus-group-goto-group group)
3394           (gnus-delete-line)))
3395       (gnus-make-hashtable-from-newsrc-alist))
3396
3397     (gnus-group-position-point)
3398     (if (< (length out) 2) (car out) (nreverse out))))
3399
3400 (defun gnus-group-yank-group (&optional arg)
3401   "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
3402 The numeric ARG specifies how many newsgroups are to be yanked.  The
3403 name of the newsgroup yanked is returned, or (if several groups are
3404 yanked) a list of yanked groups is returned."
3405   (interactive "p")
3406   (setq arg (or arg 1))
3407   (let (info group prev out)
3408     (while (>= (decf arg) 0)
3409       (when (not (setq info (pop gnus-list-of-killed-groups)))
3410         (error "No more newsgroups to yank"))
3411       (push (setq group (nth 1 info)) out)
3412       ;; Find which newsgroup to insert this one before - search
3413       ;; backward until something suitable is found.  If there are no
3414       ;; other newsgroups in this buffer, just make this newsgroup the
3415       ;; first newsgroup.
3416       (setq prev (gnus-group-group-name))
3417       (gnus-group-change-level
3418        info (gnus-info-level (cdr info)) gnus-level-killed
3419        (and prev (gnus-gethash prev gnus-newsrc-hashtb))
3420        t)
3421       (gnus-group-insert-group-line-info group)
3422       (gnus-undo-register
3423         `(when (gnus-group-goto-group ,group)
3424            (gnus-group-kill-group 1))))
3425     (forward-line -1)
3426     (gnus-group-position-point)
3427     (if (< (length out) 2) (car out) (nreverse out))))
3428
3429 (defun gnus-group-kill-level (level)
3430   "Kill all groups that is on a certain LEVEL."
3431   (interactive "nKill all groups on level: ")
3432   (cond
3433    ((= level gnus-level-zombie)
3434     (setq gnus-killed-list
3435           (nconc gnus-zombie-list gnus-killed-list))
3436     (setq gnus-zombie-list nil))
3437    ((and (< level gnus-level-zombie)
3438          (> level 0)
3439          (or gnus-expert-user
3440              (gnus-yes-or-no-p
3441               (format
3442                "Do you really want to kill all groups on level %d? "
3443                level))))
3444     (let* ((prev gnus-newsrc-alist)
3445            (alist (cdr prev)))
3446       (while alist
3447         (if (= (gnus-info-level (car alist)) level)
3448             (progn
3449               (push (gnus-info-group (car alist)) gnus-killed-list)
3450               (setcdr prev (cdr alist)))
3451           (setq prev alist))
3452         (setq alist (cdr alist)))
3453       (gnus-make-hashtable-from-newsrc-alist)
3454       (gnus-group-list-groups)))
3455    (t
3456     (error "Can't kill; invalid level: %d" level))))
3457
3458 (defun gnus-group-list-all-groups (&optional arg)
3459   "List all newsgroups with level ARG or lower.
3460 Default is `gnus-level-unsubscribed', which lists all subscribed and most
3461 unsubscribed groups."
3462   (interactive "P")
3463   (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
3464
3465 ;; Redefine this to list ALL killed groups if prefix arg used.
3466 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
3467 (defun gnus-group-list-killed (&optional arg)
3468   "List all killed newsgroups in the group buffer.
3469 If ARG is non-nil, list ALL killed groups known to Gnus.  This may
3470 entail asking the server for the groups."
3471   (interactive "P")
3472   ;; Find all possible killed newsgroups if arg.
3473   (when arg
3474     (gnus-get-killed-groups))
3475   (if (not gnus-killed-list)
3476       (gnus-message 6 "No killed groups")
3477     (let (gnus-group-list-mode)
3478       (funcall gnus-group-prepare-function
3479                gnus-level-killed t gnus-level-killed))
3480     (goto-char (point-min)))
3481   (gnus-group-position-point))
3482
3483 (defun gnus-group-list-zombies ()
3484   "List all zombie newsgroups in the group buffer."
3485   (interactive)
3486   (if (not gnus-zombie-list)
3487       (gnus-message 6 "No zombie groups")
3488     (let (gnus-group-list-mode)
3489       (funcall gnus-group-prepare-function
3490                gnus-level-zombie t gnus-level-zombie))
3491     (goto-char (point-min)))
3492   (gnus-group-position-point))
3493
3494 (defun gnus-group-list-active ()
3495   "List all groups that are available from the server(s)."
3496   (interactive)
3497   ;; First we make sure that we have really read the active file.
3498   (unless (gnus-read-active-file-p)
3499     (let ((gnus-read-active-file t)
3500           (gnus-agent nil))             ; Trick the agent into ignoring the active file.
3501       (gnus-read-active-file)))
3502   ;; Find all groups and sort them.
3503   (let ((groups
3504          (sort
3505           (let (list)
3506             (mapatoms
3507              (lambda (sym)
3508                (and (boundp sym)
3509                     (symbol-value sym)
3510                     (push (symbol-name sym) list)))
3511              gnus-active-hashtb)
3512             list)
3513           'string<))
3514         (buffer-read-only nil)
3515         group)
3516     (erase-buffer)
3517     (while groups
3518       (setq group (pop groups))
3519       (gnus-add-text-properties
3520        (point) (prog1 (1+ (point))
3521                  (insert "       *: "
3522                          (gnus-group-decoded-name group)
3523                          "\n"))
3524        (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
3525              'gnus-unread t
3526              'gnus-level (inline (gnus-group-level group)))))
3527     (goto-char (point-min))))
3528
3529 (defun gnus-activate-all-groups (level)
3530   "Activate absolutely all groups."
3531   (interactive (list gnus-level-unsubscribed))
3532   (let ((gnus-activate-level level)
3533         (gnus-activate-foreign-newsgroups level))
3534     (gnus-group-get-new-news)))
3535
3536 (defun gnus-group-get-new-news (&optional arg)
3537   "Get newly arrived articles.
3538 If ARG is a number, it specifies which levels you are interested in
3539 re-scanning.  If ARG is non-nil and not a number, this will force
3540 \"hard\" re-reading of the active files from all servers."
3541   (interactive "P")
3542   (require 'nnmail)
3543   (let ((gnus-inhibit-demon t)
3544         ;; Binding this variable will inhibit multiple fetchings
3545         ;; of the same mail source.
3546         (nnmail-fetched-sources (list t)))
3547     (gnus-run-hooks 'gnus-get-top-new-news-hook)
3548     (gnus-run-hooks 'gnus-get-new-news-hook)
3549
3550     ;; Read any slave files.
3551     (unless gnus-slave
3552       (gnus-master-read-slave-newsrc))
3553
3554     ;; We might read in new NoCeM messages here.
3555     (when (and gnus-use-nocem
3556                (null arg))
3557       (gnus-nocem-scan-groups))
3558     ;; If ARG is not a number, then we read the active file.
3559     (when (and arg (not (numberp arg)))
3560       (let ((gnus-read-active-file t))
3561         (gnus-read-active-file))
3562       (setq arg nil)
3563
3564       ;; If the user wants it, we scan for new groups.
3565       (when (eq gnus-check-new-newsgroups 'always)
3566         (gnus-find-new-newsgroups)))
3567
3568     (setq arg (gnus-group-default-level arg t))
3569     (if (and gnus-read-active-file (not arg))
3570         (progn
3571           (gnus-read-active-file)
3572           (gnus-get-unread-articles arg))
3573       (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
3574         (gnus-get-unread-articles arg)))
3575     (gnus-run-hooks 'gnus-after-getting-new-news-hook)
3576     (gnus-group-list-groups (and (numberp arg)
3577                                  (max (car gnus-group-list-mode) arg)))))
3578
3579 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
3580   "Check for newly arrived news in the current group (and the N-1 next groups).
3581 The difference between N and the number of newsgroup checked is returned.
3582 If N is negative, this group and the N-1 previous groups will be checked."
3583   (interactive "P")
3584   (let* ((groups (gnus-group-process-prefix n))
3585          (ret (if (numberp n) (- n (length groups)) 0))
3586          (beg (unless n
3587                 (point)))
3588          group method
3589          (gnus-inhibit-demon t)
3590          ;; Binding this variable will inhibit multiple fetchings
3591          ;; of the same mail source.
3592          (nnmail-fetched-sources (list t)))
3593     (gnus-run-hooks 'gnus-get-new-news-hook)
3594     (while (setq group (pop groups))
3595       (gnus-group-remove-mark group)
3596       ;; Bypass any previous denials from the server.
3597       (gnus-remove-denial (setq method (gnus-find-method-for-group group)))
3598       (if (gnus-activate-group group (if dont-scan nil 'scan))
3599           (progn
3600             (gnus-get-unread-articles-in-group
3601              (gnus-get-info group) (gnus-active group) t)
3602             (unless (gnus-virtual-group-p group)
3603               (gnus-close-group group))
3604             (when gnus-agent
3605               (gnus-agent-save-group-info
3606                method (gnus-group-real-name group) (gnus-active group)))
3607             (gnus-group-update-group group))
3608         (if (eq (gnus-server-status (gnus-find-method-for-group group))
3609                 'denied)
3610             (gnus-error 3 "Server denied access")
3611           (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
3612     (when beg
3613       (goto-char beg))
3614     (when gnus-goto-next-group-when-activating
3615       (gnus-group-next-unread-group 1 t))
3616     (gnus-summary-position-point)
3617     ret))
3618
3619 (defun gnus-group-fetch-faq (group &optional faq-dir)
3620   "Fetch the FAQ for the current group.
3621 If given a prefix argument, prompt for the FAQ dir
3622 to use."
3623   (interactive
3624    (list
3625     (gnus-group-group-name)
3626     (when current-prefix-arg
3627       (completing-read
3628        "FAQ dir: " (and (listp gnus-group-faq-directory)
3629                         (mapcar #'list
3630                                 gnus-group-faq-directory))))))
3631   (unless group
3632     (error "No group name given"))
3633   (let ((dirs (or faq-dir gnus-group-faq-directory))
3634         dir found file)
3635     (unless (listp dirs)
3636       (setq dirs (list dirs)))
3637     (while (and (not found)
3638                 (setq dir (pop dirs)))
3639       (let ((name (gnus-group-real-name group)))
3640         (setq file (expand-file-name name dir)))
3641       (if (not (file-exists-p file))
3642           (gnus-message 1 "No such file: %s" file)
3643         (let ((enable-local-variables nil))
3644           (find-file file)
3645           (setq found t))))))
3646
3647 (defun gnus-group-fetch-charter (group)
3648   "Fetch the charter for the current group.
3649 If given a prefix argument, prompt for a group."
3650   (interactive
3651    (list (or (when current-prefix-arg
3652                (completing-read "Group: " gnus-active-hashtb))
3653              (gnus-group-group-name)
3654              gnus-newsgroup-name)))
3655   (unless group
3656     (error "No group name given"))
3657   (require 'mm-url)
3658   (condition-case nil (require 'url-http) (error nil))
3659   (let ((name (mm-url-form-encode-xwfu (gnus-group-real-name group)))
3660         url hierarchy)
3661     (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3662       (setq hierarchy (match-string 1 name))
3663       (if (and (setq url (cdr (assoc hierarchy gnus-group-charter-alist)))
3664                (if (fboundp 'url-http-file-exists-p)
3665                    (url-http-file-exists-p (eval url))
3666                  t))
3667           (browse-url (eval url))
3668         (setq url (concat "http://" hierarchy
3669                           ".news-admin.org/charters/" name))
3670         (if (and (fboundp 'url-http-file-exists-p)
3671                  (url-http-file-exists-p url))
3672             (browse-url url)
3673           (gnus-group-fetch-control group))))))
3674
3675 (defun gnus-group-fetch-control (group)
3676   "Fetch the archived control messages for the current group.
3677 If given a prefix argument, prompt for a group."
3678   (interactive
3679    (list (or (when current-prefix-arg
3680                (completing-read "Group: " gnus-active-hashtb))
3681              (gnus-group-group-name)
3682              gnus-newsgroup-name)))
3683   (unless group
3684     (error "No group name given"))
3685   (let ((name (gnus-group-real-name group))
3686         hierarchy)
3687     (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3688       (setq hierarchy (match-string 1 name))
3689       (if gnus-group-fetch-control-use-browse-url
3690           (browse-url (concat "ftp://ftp.isc.org/usenet/control/"
3691                               hierarchy "/" name ".Z"))
3692         (let ((enable-local-variables nil))
3693           (gnus-group-read-ephemeral-group
3694            group
3695            `(nndoc ,group (nndoc-address
3696                            ,(find-file-noselect
3697                              (concat "/ftp@ftp.isc.org:/usenet/control/"
3698                                      hierarchy "/" name ".Z")))
3699                    (nndoc-article-type mbox)) t nil nil))))))
3700
3701 (defun gnus-group-describe-group (force &optional group)
3702   "Display a description of the current newsgroup."
3703   (interactive (list current-prefix-arg (gnus-group-group-name)))
3704   (let* ((method (gnus-find-method-for-group group))
3705          (mname (gnus-group-prefixed-name "" method))
3706          desc)
3707     (when (and force
3708                gnus-description-hashtb)
3709       (gnus-sethash mname nil gnus-description-hashtb))
3710     (unless group
3711       (error "No group name given"))
3712     (when (or (and gnus-description-hashtb
3713                    ;; We check whether this group's method has been
3714                    ;; queried for a description file.
3715                    (gnus-gethash mname gnus-description-hashtb))
3716               (setq desc (gnus-group-get-description group))
3717               (gnus-read-descriptions-file method))
3718       (gnus-message 1
3719                     (or desc (gnus-gethash group gnus-description-hashtb)
3720                         "No description available")))))
3721
3722 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3723 (defun gnus-group-describe-all-groups (&optional force)
3724   "Pop up a buffer with descriptions of all newsgroups."
3725   (interactive "P")
3726   (when force
3727     (setq gnus-description-hashtb nil))
3728   (when (not (or gnus-description-hashtb
3729                  (gnus-read-all-descriptions-files)))
3730     (error "Couldn't request descriptions file"))
3731   (let ((buffer-read-only nil)
3732         b)
3733     (erase-buffer)
3734     (mapatoms
3735      (lambda (group)
3736        (setq b (point))
3737        (let ((charset (gnus-group-name-charset nil (symbol-name group))))
3738          (insert (format "      *: %-20s %s\n"
3739                          (gnus-group-name-decode
3740                           (symbol-name group) charset)
3741                          (gnus-group-name-decode
3742                           (symbol-value group) charset))))
3743        (gnus-add-text-properties
3744         b (1+ b) (list 'gnus-group group
3745                        'gnus-unread t 'gnus-marked nil
3746                        'gnus-level (1+ gnus-level-subscribed))))
3747      gnus-description-hashtb)
3748     (goto-char (point-min))
3749     (gnus-group-position-point)))
3750
3751 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
3752 (defun gnus-group-apropos (regexp &optional search-description)
3753   "List all newsgroups that have names that match a regexp."
3754   (interactive "sGnus apropos (regexp): ")
3755   (let ((prev "")
3756         (obuf (current-buffer))
3757         groups des)
3758     ;; Go through all newsgroups that are known to Gnus.
3759     (mapatoms
3760      (lambda (group)
3761        (and (symbol-name group)
3762             (string-match regexp (symbol-name group))
3763             (symbol-value group)
3764             (push (symbol-name group) groups)))
3765      gnus-active-hashtb)
3766     ;; Also go through all descriptions that are known to Gnus.
3767     (when search-description
3768       (mapatoms
3769        (lambda (group)
3770          (and (string-match regexp (symbol-value group))
3771               (push (symbol-name group) groups)))
3772        gnus-description-hashtb))
3773     (if (not groups)
3774         (gnus-message 3 "No groups matched \"%s\"." regexp)
3775       ;; Print out all the groups.
3776       (save-excursion
3777         (pop-to-buffer "*Gnus Help*")
3778         (buffer-disable-undo)
3779         (erase-buffer)
3780         (setq groups (sort groups 'string<))
3781         (while groups
3782           ;; Groups may be entered twice into the list of groups.
3783           (when (not (string= (car groups) prev))
3784             (setq prev (car groups))
3785             (let ((charset (gnus-group-name-charset nil prev)))
3786               (insert (gnus-group-name-decode prev charset) "\n")
3787               (when (and gnus-description-hashtb
3788                          (setq des (gnus-gethash (car groups)
3789                                                  gnus-description-hashtb)))
3790                 (insert "  " (gnus-group-name-decode des charset) "\n"))))
3791           (setq groups (cdr groups)))
3792         (goto-char (point-min))))
3793     (pop-to-buffer obuf)))
3794
3795 (defun gnus-group-description-apropos (regexp)
3796   "List all newsgroups that have names or descriptions that match REGEXP."
3797   (interactive "sGnus description apropos (regexp): ")
3798   (when (not (or gnus-description-hashtb
3799                  (gnus-read-all-descriptions-files)))
3800     (error "Couldn't request descriptions file"))
3801   (gnus-group-apropos regexp t))
3802
3803 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3804 (defun gnus-group-list-matching (level regexp &optional all lowest)
3805   "List all groups with unread articles that match REGEXP.
3806 If the prefix LEVEL is non-nil, it should be a number that says which
3807 level to cut off listing groups.
3808 If ALL, also list groups with no unread articles.
3809 If LOWEST, don't list groups with level lower than LOWEST.
3810
3811 This command may read the active file."
3812   (interactive "P\nsList newsgroups matching: ")
3813   ;; First make sure active file has been read.
3814   (when (and level
3815              (> (prefix-numeric-value level) gnus-level-killed))
3816     (gnus-get-killed-groups))
3817   (funcall gnus-group-prepare-function
3818    (or level gnus-level-subscribed) (and all t) (or lowest 1) regexp)
3819   (goto-char (point-min))
3820   (gnus-group-position-point))
3821
3822 (defun gnus-group-list-all-matching (level regexp &optional lowest)
3823   "List all groups that match REGEXP.
3824 If the prefix LEVEL is non-nil, it should be a number that says which
3825 level to cut off listing groups.
3826 If LOWEST, don't list groups with level lower than LOWEST."
3827   (interactive "P\nsList newsgroups matching: ")
3828   (when level
3829     (setq level (prefix-numeric-value level)))
3830   (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
3831
3832 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
3833 (defun gnus-group-save-newsrc (&optional force)
3834   "Save the Gnus startup files.
3835 If FORCE, force saving whether it is necessary or not."
3836   (interactive "P")
3837   (gnus-save-newsrc-file force))
3838
3839 (defun gnus-group-restart (&optional arg)
3840   "Force Gnus to read the .newsrc file."
3841   (interactive "P")
3842   (when (gnus-yes-or-no-p
3843          (format "Are you sure you want to restart Gnus? "))
3844     (gnus-save-newsrc-file)
3845     (gnus-clear-system)
3846     (gnus)))
3847
3848 (defun gnus-group-read-init-file ()
3849   "Read the Gnus elisp init file."
3850   (interactive)
3851   (gnus-read-init-file)
3852   (gnus-message 5 "Read %s" gnus-init-file))
3853
3854 (defun gnus-group-check-bogus-groups (&optional silent)
3855   "Check bogus newsgroups.
3856 If given a prefix, don't ask for confirmation before removing a bogus
3857 group."
3858   (interactive "P")
3859   (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
3860   (gnus-group-list-groups))
3861
3862 (defun gnus-group-find-new-groups (&optional arg)
3863   "Search for new groups and add them.
3864 Each new group will be treated with `gnus-subscribe-newsgroup-method'.
3865 With 1 C-u, use the `ask-server' method to query the server for new
3866 groups.
3867 With 2 C-u's, use most complete method possible to query the server
3868 for new groups, and subscribe the new groups as zombies."
3869   (interactive "p")
3870   (gnus-find-new-newsgroups (or arg 1))
3871   (gnus-group-list-groups))
3872
3873 (defun gnus-group-edit-global-kill (&optional article group)
3874   "Edit the global kill file.
3875 If GROUP, edit that local kill file instead."
3876   (interactive "P")
3877   (setq gnus-current-kill-article article)
3878   (gnus-kill-file-edit-file group)
3879   (gnus-message
3880    6
3881    (substitute-command-keys
3882     (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
3883             (if group "local" "global")))))
3884
3885 (defun gnus-group-edit-local-kill (article group)
3886   "Edit a local kill file."
3887   (interactive (list nil (gnus-group-group-name)))
3888   (gnus-group-edit-global-kill article group))
3889
3890 (defun gnus-group-force-update ()
3891   "Update `.newsrc' file."
3892   (interactive)
3893   (gnus-save-newsrc-file))
3894
3895 (defun gnus-group-suspend ()
3896   "Suspend the current Gnus session.
3897 In fact, cleanup buffers except for group mode buffer.
3898 The hook `gnus-suspend-gnus-hook' is called before actually suspending."
3899   (interactive)
3900   (gnus-run-hooks 'gnus-suspend-gnus-hook)
3901   (gnus-offer-save-summaries)
3902   ;; Kill Gnus buffers except for group mode buffer.
3903   (let ((group-buf (get-buffer gnus-group-buffer)))
3904     (mapcar (lambda (buf)
3905               (unless (or (member buf (list group-buf gnus-dribble-buffer))
3906                           (progn
3907                             (save-excursion
3908                               (set-buffer buf)
3909                               (eq major-mode 'message-mode))))
3910                 (gnus-kill-buffer buf)))
3911             (gnus-buffers))
3912     (gnus-kill-gnus-frames)
3913     (when group-buf
3914       (bury-buffer group-buf)
3915       (delete-windows-on group-buf t))))
3916
3917 (defun gnus-group-clear-dribble ()
3918   "Clear all information from the dribble buffer."
3919   (interactive)
3920   (gnus-dribble-clear)
3921   (gnus-message 7 "Cleared dribble buffer"))
3922
3923 (defun gnus-group-exit ()
3924   "Quit reading news after updating .newsrc.eld and .newsrc.
3925 The hook `gnus-exit-gnus-hook' is called before actually exiting."
3926   (interactive)
3927   (when
3928       (or noninteractive                ;For gnus-batch-kill
3929           (not gnus-interactive-exit)   ;Without confirmation
3930           gnus-expert-user
3931           (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
3932     (gnus-run-hooks 'gnus-exit-gnus-hook)
3933     ;; Offer to save data from non-quitted summary buffers.
3934     (gnus-offer-save-summaries)
3935     ;; Save the newsrc file(s).
3936     (gnus-save-newsrc-file)
3937     ;; Kill-em-all.
3938     (gnus-close-backends)
3939     ;; Reset everything.
3940     (gnus-clear-system)
3941     ;; Allow the user to do things after cleaning up.
3942     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
3943
3944 (defun gnus-group-quit ()
3945   "Quit reading news without updating .newsrc.eld or .newsrc.
3946 The hook `gnus-exit-gnus-hook' is called before actually exiting."
3947   (interactive)
3948   (when (or noninteractive              ;For gnus-batch-kill
3949             (zerop (buffer-size))
3950             (not (gnus-server-opened gnus-select-method))
3951             gnus-expert-user
3952             (not gnus-current-startup-file)
3953             (gnus-yes-or-no-p
3954              (format "Quit reading news without saving %s? "
3955                      (file-name-nondirectory gnus-current-startup-file))))
3956     (gnus-run-hooks 'gnus-exit-gnus-hook)
3957     (gnus-configure-windows 'group t)
3958     (when (and (gnus-buffer-live-p gnus-dribble-buffer)
3959                (not (zerop (save-excursion
3960                             (set-buffer gnus-dribble-buffer)
3961                             (buffer-size)))))
3962       (gnus-dribble-enter
3963        ";;; Gnus was exited on purpose without saving the .newsrc files."))
3964     (gnus-dribble-save)
3965     (gnus-close-backends)
3966     (gnus-clear-system)
3967     (gnus-kill-buffer gnus-group-buffer)
3968     ;; Allow the user to do things after cleaning up.
3969     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
3970
3971 (defun gnus-group-describe-briefly ()
3972   "Give a one line description of the group mode commands."
3973   (interactive)
3974   (gnus-message 7 (substitute-command-keys "\\<gnus-group-mode-map>\\[gnus-group-read-group]:Select  \\[gnus-group-next-unread-group]:Forward  \\[gnus-group-prev-unread-group]:Backward  \\[gnus-group-exit]:Exit  \\[gnus-info-find-node]:Run Info  \\[gnus-group-describe-briefly]:This help")))
3975
3976 (defun gnus-group-browse-foreign-server (method)
3977   "Browse a foreign news server.
3978 If called interactively, this function will ask for a select method
3979  (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
3980 If not, METHOD should be a list where the first element is the method
3981 and the second element is the address."
3982   (interactive
3983    (list (let ((how (completing-read
3984                      "Which back end: "
3985                      (append gnus-valid-select-methods gnus-server-alist)
3986                      nil t (cons "nntp" 0) 'gnus-method-history)))
3987            ;; We either got a back end name or a virtual server name.
3988            ;; If the first, we also need an address.
3989            (if (assoc how gnus-valid-select-methods)
3990                (list (intern how)
3991                      ;; Suggested by mapjph@bath.ac.uk.
3992                      (completing-read
3993                       "Address: "
3994                       (mapcar (lambda (server) (list server))
3995                               gnus-secondary-servers)))
3996              ;; We got a server name.
3997              how))))
3998   (gnus-browse-foreign-server method))
3999
4000 (defun gnus-group-set-info (info &optional method-only-group part)
4001   (when (or info part)
4002     (let* ((entry (gnus-gethash
4003                    (or method-only-group (gnus-info-group info))
4004                    gnus-newsrc-hashtb))
4005            (part-info info)
4006            (info (if method-only-group (nth 2 entry) info))
4007            method)
4008       (when method-only-group
4009         (unless entry
4010           (error "Trying to change non-existent group %s" method-only-group))
4011         ;; We have received parts of the actual group info - either the
4012         ;; select method or the group parameters.        We first check
4013         ;; whether we have to extend the info, and if so, do that.
4014         (let ((len (length info))
4015               (total (if (eq part 'method) 5 6)))
4016           (when (< len total)
4017             (setcdr (nthcdr (1- len) info)
4018                     (make-list (- total len) nil)))
4019           ;; Then we enter the new info.
4020           (setcar (nthcdr (1- total) info) part-info)))
4021       (unless entry
4022         ;; This is a new group, so we just create it.
4023         (save-excursion
4024           (set-buffer gnus-group-buffer)
4025           (setq method (gnus-info-method info))
4026           (when (gnus-server-equal method "native")
4027             (setq method nil))
4028           (save-excursion
4029             (set-buffer gnus-group-buffer)
4030             (if method
4031                 ;; It's a foreign group...
4032                 (gnus-group-make-group
4033                  (gnus-group-real-name (gnus-info-group info))
4034                  (if (stringp method) method
4035                    (prin1-to-string (car method)))
4036                  (and (consp method)
4037                       (nth 1 (gnus-info-method info))))
4038               ;; It's a native group.
4039               (gnus-group-make-group (gnus-info-group info))))
4040           (gnus-message 6 "Note: New group created")
4041           (setq entry
4042                 (gnus-gethash (gnus-group-prefixed-name
4043                                (gnus-group-real-name (gnus-info-group info))
4044                                (or (gnus-info-method info) gnus-select-method))
4045                               gnus-newsrc-hashtb))))
4046       ;; Whether it was a new group or not, we now have the entry, so we
4047       ;; can do the update.
4048       (if entry
4049           (progn
4050             (setcar (nthcdr 2 entry) info)
4051             (when (and (not (eq (car entry) t))
4052                        (gnus-active (gnus-info-group info)))
4053               (setcar entry (length
4054                              (gnus-list-of-unread-articles (car info))))))
4055         (error "No such group: %s" (gnus-info-group info))))))
4056
4057 (defun gnus-group-set-method-info (group select-method)
4058   (gnus-group-set-info select-method group 'method))
4059
4060 (defun gnus-group-set-params-info (group params)
4061   (gnus-group-set-info params group 'params))
4062
4063 (defun gnus-add-marked-articles (group type articles &optional info force)
4064   ;; Add ARTICLES of TYPE to the info of GROUP.
4065   ;; If INFO is non-nil, use that info.  If FORCE is non-nil, don't
4066   ;; add, but replace marked articles of TYPE with ARTICLES.
4067   (let ((info (or info (gnus-get-info group)))
4068         marked m)
4069     (or (not info)
4070         (and (not (setq marked (nthcdr 3 info)))
4071              (or (null articles)
4072                  (setcdr (nthcdr 2 info)
4073                          (list (list (cons type (gnus-compress-sequence
4074                                                  articles t)))))))
4075         (and (not (setq m (assq type (car marked))))
4076              (or (null articles)
4077                  (setcar marked
4078                          (cons (cons type (gnus-compress-sequence articles t) )
4079                                (car marked)))))
4080         (if force
4081             (if (null articles)
4082                 (setcar (nthcdr 3 info)
4083                         (gnus-delete-alist type (car marked)))
4084               (setcdr m (gnus-compress-sequence articles t)))
4085           (setcdr m (gnus-compress-sequence
4086                      (sort (nconc (gnus-uncompress-range (cdr m))
4087                                   (copy-sequence articles)) '<) t))))))
4088
4089 (defun gnus-add-mark (group mark article)
4090   "Mark ARTICLE in GROUP with MARK, whether the group is displayed or not."
4091   (let ((buffer (gnus-summary-buffer-name group)))
4092     (if (gnus-buffer-live-p buffer)
4093         (save-excursion
4094           (set-buffer (get-buffer buffer))
4095           (gnus-summary-add-mark article mark))
4096       (gnus-add-marked-articles group (cdr (assq mark gnus-article-mark-lists))
4097                                 (list article)))))
4098
4099 ;;;
4100 ;;; Group timestamps
4101 ;;;
4102
4103 (defun gnus-group-set-timestamp ()
4104   "Change the timestamp of the current group to the current time.
4105 This function can be used in hooks like `gnus-select-group-hook'
4106 or `gnus-group-catchup-group-hook'."
4107   (when gnus-newsgroup-name
4108     (let ((time (current-time)))
4109       (setcdr (cdr time) nil)
4110       (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
4111
4112 (defsubst gnus-group-timestamp (group)
4113   "Return the timestamp for GROUP."
4114   (gnus-group-get-parameter group 'timestamp t))
4115
4116 (defun gnus-group-timestamp-delta (group)
4117   "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
4118   (let* ((time (or (gnus-group-timestamp group)
4119                    (list 0 0)))
4120          (delta (subtract-time (current-time) time)))
4121     (+ (* (nth 0 delta) 65536.0)
4122        (nth 1 delta))))
4123
4124 (defun gnus-group-timestamp-string (group)
4125   "Return a string of the timestamp for GROUP."
4126   (let ((time (gnus-group-timestamp group)))
4127     (if (not time)
4128         ""
4129       (gnus-time-iso8601 time))))
4130
4131 (defun gnus-group-list-cached (level &optional lowest)
4132   "List all groups with cached articles.
4133 If the prefix LEVEL is non-nil, it should be a number that says which
4134 level to cut off listing groups.
4135 If LOWEST, don't list groups with level lower than LOWEST.
4136
4137 This command may read the active file."
4138   (interactive "P")
4139   (when level
4140     (setq level (prefix-numeric-value level)))
4141   (when (or (not level) (>= level gnus-level-zombie))
4142     (gnus-cache-open))
4143   (funcall gnus-group-prepare-function
4144            (or level gnus-level-subscribed)
4145            #'(lambda (info)
4146                (let ((marks (gnus-info-marks info)))
4147                  (assq 'cache marks)))
4148            lowest
4149            #'(lambda (group)
4150                (or (gnus-gethash group
4151                                  gnus-cache-active-hashtb)
4152                    ;; Cache active file might use "."
4153                    ;; instead of ":".
4154                    (gnus-gethash
4155                     (mapconcat 'identity
4156                                (split-string group ":")
4157                                ".")
4158                     gnus-cache-active-hashtb))))
4159   (goto-char (point-min))
4160   (gnus-group-position-point))
4161
4162 (defun gnus-group-list-dormant (level &optional lowest)
4163   "List all groups with dormant articles.
4164 If the prefix LEVEL is non-nil, it should be a number that says which
4165 level to cut off listing groups.
4166 If LOWEST, don't list groups with level lower than LOWEST.
4167
4168 This command may read the active file."
4169   (interactive "P")
4170   (when level
4171     (setq level (prefix-numeric-value level)))
4172   (when (or (not level) (>= level gnus-level-zombie))
4173     (gnus-cache-open))
4174   (funcall gnus-group-prepare-function
4175            (or level gnus-level-subscribed)
4176            #'(lambda (info)
4177                (let ((marks (gnus-info-marks info)))
4178                  (assq 'dormant marks)))
4179            lowest
4180            'ignore)
4181   (goto-char (point-min))
4182   (gnus-group-position-point))
4183
4184 (defun gnus-group-listed-groups ()
4185   "Return a list of listed groups."
4186   (let (point groups)
4187     (goto-char (point-min))
4188     (while (setq point (text-property-not-all (point) (point-max)
4189                                               'gnus-group nil))
4190       (goto-char point)
4191       (push (symbol-name (get-text-property point 'gnus-group)) groups)
4192       (forward-char 1))
4193     groups))
4194
4195 (defun gnus-group-list-plus (&optional args)
4196   "List groups plus the current selection."
4197   (interactive "P")
4198   (let ((gnus-group-listed-groups (gnus-group-listed-groups))
4199         (gnus-group-list-mode gnus-group-list-mode) ;; Save it.
4200         func)
4201     (push last-command-event unread-command-events)
4202     (if (featurep 'xemacs)
4203         (push (make-event 'key-press '(key ?A)) unread-command-events)
4204       (push ?A unread-command-events))
4205     (let (gnus-pick-mode keys)
4206       (setq keys (if (featurep 'xemacs)
4207                      (events-to-keys (read-key-sequence nil))
4208                    (read-key-sequence nil)))
4209       (setq func (lookup-key (current-local-map) keys)))
4210     (if (or (not func)
4211             (numberp func))
4212         (ding)
4213       (call-interactively func))))
4214
4215 (defun gnus-group-list-flush (&optional args)
4216   "Flush groups from the current selection."
4217   (interactive "P")
4218   (let ((gnus-group-list-option 'flush))
4219     (gnus-group-list-plus args)))
4220
4221 (defun gnus-group-list-limit (&optional args)
4222   "List groups limited within the current selection."
4223   (interactive "P")
4224   (let ((gnus-group-list-option 'limit))
4225     (gnus-group-list-plus args)))
4226
4227 (defun gnus-group-mark-article-read (group article)
4228   "Mark ARTICLE read."
4229   (let ((buffer (gnus-summary-buffer-name group))
4230         (mark gnus-read-mark)
4231         active n)
4232     (if (get-buffer buffer)
4233         (with-current-buffer buffer
4234           (setq active gnus-newsgroup-active)
4235           (gnus-activate-group group)
4236           (when gnus-newsgroup-prepared
4237             (when (and gnus-newsgroup-auto-expire
4238                        (memq mark gnus-auto-expirable-marks))
4239               (setq mark gnus-expirable-mark))
4240             (setq mark (gnus-request-update-mark
4241                         group article mark))
4242             (gnus-mark-article-as-read article mark)
4243             (setq gnus-newsgroup-active (gnus-active group))
4244             (when active
4245               (setq n (1+ (cdr active)))
4246               (while (<= n (cdr gnus-newsgroup-active))
4247                 (unless (eq n article)
4248                   (push n gnus-newsgroup-unselected))
4249                 (setq n (1+ n)))
4250               (setq gnus-newsgroup-unselected
4251                     (nreverse gnus-newsgroup-unselected)))))
4252       (gnus-activate-group group)
4253       (gnus-group-make-articles-read group (list article))
4254       (when (gnus-group-auto-expirable-p group)
4255         (gnus-add-marked-articles
4256          group 'expire (list article))))))
4257
4258 (provide 'gnus-group)
4259
4260 ;;; gnus-group.el ends here