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

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