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

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