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