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