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

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