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