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

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