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