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