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

   1 ;;; gnus-group.el --- group mode commands for Gnus
   2 ;; Copyright (C) 1996,97 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
   5 ;; Keywords: news
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (eval-when-compile (require 'cl))
  29
  30 (require 'gnus)
  31 (require 'gnus-start)
  32 (require 'nnmail)
  33 (require 'gnus-spec)
  34 (require 'gnus-int)
  35 (require 'gnus-range)
  36 (require 'gnus-win)
  37 (require 'gnus-undo)
  38
  39 (defcustom gnus-group-archive-directory
  40   "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list/"
  41   "*The address of the (ding) archives."
  42   :group 'gnus-group-foreign
  43   :type 'directory)
  44
  45 (defcustom gnus-group-recent-archive-directory
  46   "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list-recent/"
  47   "*The address of the most recent (ding) articles."
  48   :group 'gnus-group-foreign
  49   :type 'directory)
  50
  51 (defcustom gnus-no-groups-message "No news is no news"
  52   "*Message displayed by Gnus when no groups are available."
  53   :group 'gnus-start
  54   :type 'string)
  55
  56 (defcustom gnus-keep-same-level nil
  57   "*Non-nil means that the next newsgroup after the current will be on the same level.
  58 When you type, for instance, `n' after reading the last article in the
  59 current newsgroup, you will go to the next newsgroup.  If this variable
  60 is nil, the next newsgroup will be the next from the group
  61 buffer.
  62 If this variable is non-nil, Gnus will either put you in the
  63 next newsgroup with the same level, or, if no such newsgroup is
  64 available, the next newsgroup with the lowest possible level higher
  65 than the current level.
  66 If this variable is `best', Gnus will make the next newsgroup the one
  67 with the best level."
  68   :group 'gnus-group-levels
  69   :type '(choice (const nil)
  70                  (const best)
  71                  (sexp :tag "other" t)))
  72
  73 (defcustom gnus-group-goto-unread t
  74   "*If non-nil, movement commands will go to the next unread and subscribed group."
  75   :link '(custom-manual "(gnus)Group Maneuvering")
  76   :group 'gnus-group-various
  77   :type 'boolean)
  78
  79 (defcustom gnus-goto-next-group-when-activating t
  80   "*If non-nil, the \\<gnus-group-mode-map>\\[gnus-group-get-new-news-this-group] command will advance point to the next group."
  81   :link '(custom-manual "(gnus)Scanning New Messages")
  82   :group 'gnus-group-various
  83   :type 'boolean)
  84
  85 (defcustom gnus-permanently-visible-groups nil
  86   "*Regexp to match groups that should always be listed in the group buffer.
  87 This means that they will still be listed even when there are no
  88 unread articles in the groups.
  89
  90 If nil, no groups are permanently visible."
  91   :group 'gnus-group-listing
  92   :type 'regexp)
  93
  94 (defcustom gnus-list-groups-with-ticked-articles t
  95   "*If non-nil, list groups that have only ticked articles.
  96 If nil, only list groups that have unread articles."
  97   :group 'gnus-group-listing
  98   :type 'boolean)
  99
 100 (defcustom gnus-group-default-list-level gnus-level-subscribed
 101   "*Default listing level.
 102 Ignored if `gnus-group-use-permanent-levels' is non-nil."
 103   :group 'gnus-group-listing
 104   :type 'integer)
 105
 106 (defcustom gnus-group-list-inactive-groups t
 107   "*If non-nil, inactive groups will be listed."
 108   :group 'gnus-group-listing
 109   :group 'gnus-group-levels
 110   :type 'boolean)
 111
 112 (defcustom gnus-group-sort-function 'gnus-group-sort-by-alphabet
 113   "*Function used for sorting the group buffer.
 114 This function will be called with group info entries as the arguments
 115 for the groups to be sorted.  Pre-made functions include
 116 `gnus-group-sort-by-alphabet', `gnus-group-sort-by-real-name',
 117 `gnus-group-sort-by-unread', `gnus-group-sort-by-level',
 118 `gnus-group-sort-by-score', `gnus-group-sort-by-method', and
 119 `gnus-group-sort-by-rank'.
 120
 121 This variable can also be a list of sorting functions.  In that case,
 122 the most significant sort function should be the last function in the
 123 list."
 124   :group 'gnus-group-listing
 125   :link '(custom-manual "(gnus)Sorting Groups")
 126   :type '(radio (function-item gnus-group-sort-by-alphabet)
 127                 (function-item gnus-group-sort-by-real-name)
 128                 (function-item gnus-group-sort-by-unread)
 129                 (function-item gnus-group-sort-by-level)
 130                 (function-item gnus-group-sort-by-score)
 131                 (function-item gnus-group-sort-by-method)
 132                 (function-item gnus-group-sort-by-rank)
 133                 (function :tag "other" nil)))
 134
 135 (defcustom gnus-group-line-format "%M\%S\%p\%P\%5y: %(%g%)%l\n"
 136   "*Format of group lines.
 137 It works along the same lines as a normal formatting string,
 138 with some simple extensions.
 139
 140 %M    Only marked articles (character, \"*\" or \" \")
 141 %S    Whether the group is subscribed (character, \"U\", \"K\", \"Z\" or \" \")
 142 %L    Level of subscribedness (integer)
 143 %N    Number of unread articles (integer)
 144 %I    Number of dormant articles (integer)
 145 %i    Number of ticked and dormant (integer)
 146 %T    Number of ticked articles (integer)
 147 %R    Number of read articles (integer)
 148 %t    Estimated total number of articles (integer)
 149 %y    Number of unread, unticked articles (integer)
 150 %G    Group name (string)
 151 %g    Qualified group name (string)
 152 %D    Group description (string)
 153 %s    Select method (string)
 154 %o    Moderated group (char, \"m\")
 155 %p    Process mark (char)
 156 %O    Moderated group (string, \"(m)\" or \"\")
 157 %P    Topic indentation (string)
 158 %m    Whether there is new(ish) mail in the group (char, \"%\")
 159 %l    Whether there are GroupLens predictions for this group (string)
 160 %n    Select from where (string)
 161 %z    A string that look like `<%s:%n>' if a foreign select method is used
 162 %d    The date the group was last entered.
 163 %u    User defined specifier.  The next character in the format string should
 164       be a letter.  Gnus will call the function gnus-user-format-function-X,
 165       where X is the letter following %u.  The function will be passed the
 166       current header as argument.  The function should return a string, which
 167       will be inserted into the buffer just like information from any other
 168       group specifier.
 169
 170 Text between %( and %) will be highlighted with `gnus-mouse-face' when
 171 the mouse point move inside the area.  There can only be one such area.
 172
 173 Note that this format specification is not always respected.  For
 174 reasons of efficiency, when listing killed groups, this specification
 175 is ignored altogether.  If the spec is changed considerably, your
 176 output may end up looking strange when listing both alive and killed
 177 groups.
 178
 179 If you use %o or %O, reading the active file will be slower and quite
 180 a bit of extra memory will be used.  %D will also worsen performance.
 181 Also note that if you change the format specification to include any
 182 of these specs, you must probably re-start Gnus to see them go into
 183 effect."
 184   :group 'gnus-group-visual
 185   :type 'string)
 186
 187 (defcustom gnus-group-mode-line-format "Gnus: %%b {%M\%:%S}"
 188   "*The format specification for the group mode line.
 189 It works along the same lines as a normal formatting string,
 190 with some simple extensions:
 191
 192 %S   The native news server.
 193 %M   The native select method.
 194 %:   \":\" if %S isn't \"\"."
 195   :group 'gnus-group-visual
 196   :type 'string)
 197
 198 (defcustom gnus-group-mode-hook nil
 199   "Hook for Gnus group mode."
 200   :group 'gnus-group-various
 201   :options '(gnus-topic-mode)
 202   :type 'hook)
 203
 204 (defcustom gnus-group-menu-hook nil
 205   "Hook run after the creation of the group mode menu."
 206   :group 'gnus-group-various
 207   :type 'hook)
 208
 209 (defcustom gnus-group-catchup-group-hook nil
 210   "Hook run when catching up a group from the group buffer."
 211   :group 'gnus-group-various
 212   :link '(custom-manual "(gnus)Group Data")
 213   :type 'hook)
 214
 215 (defcustom gnus-group-update-group-hook nil
 216   "Hook called when updating group lines."
 217   :group 'gnus-group-visual
 218   :type 'hook)
 219
 220 (defcustom gnus-group-prepare-function 'gnus-group-prepare-flat
 221   "*A function that is called to generate the group buffer.
 222 The function is called with three arguments: The first is a number;
 223 all group with a level less or equal to that number should be listed,
 224 if the second is non-nil, empty groups should also be displayed.  If
 225 the third is non-nil, it is a number.  No groups with a level lower
 226 than this number should be displayed.
 227
 228 The only current function implemented is `gnus-group-prepare-flat'."
 229   :group 'gnus-group-listing
 230   :type 'function)
 231
 232 (defcustom gnus-group-prepare-hook nil
 233   "Hook called after the group buffer has been generated.
 234 If you want to modify the group buffer, you can use this hook."
 235   :group 'gnus-group-listing
 236   :type 'hook)
 237
 238 (defcustom gnus-suspend-gnus-hook nil
 239   "Hook called when suspending (not exiting) Gnus."
 240   :group 'gnus-exit
 241   :type 'hook)
 242
 243 (defcustom gnus-exit-gnus-hook nil
 244   "Hook called when exiting Gnus."
 245   :group 'gnus-exit
 246   :type 'hook)
 247
 248 (defcustom gnus-after-exiting-gnus-hook nil
 249   "Hook called after exiting Gnus."
 250   :group 'gnus-exit
 251   :type 'hook)
 252
 253 (defcustom gnus-group-update-hook '(gnus-group-highlight-line)
 254   "Hook called when a group line is changed.
 255 The hook will not be called if `gnus-visual' is nil.
 256
 257 The default function `gnus-group-highlight-line' will
 258 highlight the line according to the `gnus-group-highlight'
 259 variable."
 260   :group 'gnus-group-visual
 261   :type 'hook)
 262
 263 (defcustom gnus-useful-groups
 264   `(("(ding) mailing list mirrored at sunsite.auc.dk"
 265      "emacs.ding"
 266      (nntp "sunsite.auc.dk"
 267                         (nntp-address "sunsite.auc.dk")))
 268     ("Gnus help group"
 269      "gnus-help"
 270      (nndoc "gnus-help"
 271             (nndoc-article-type mbox)
 272             (eval `(nndoc-address
 273                     ,(let ((file (nnheader-find-etc-directory
 274                                   "gnus-tut.txt" t)))
 275                        (unless file
 276                          (error "Couldn't find doc group"))
 277                        file))))))
 278   "Alist of useful group-server pairs."
 279   :group 'gnus-group-listing
 280   :type '(repeat (list (string :tag "Description")
 281                        (string :tag "Name")
 282                        (sexp :tag "Method"))))
 283
 284 (defcustom gnus-group-highlight
 285   '(;; News.
 286     ((and (= unread 0) (not mailp) (eq level 1)) .
 287      gnus-group-news-1-empty-face)
 288     ((and (not mailp) (eq level 1)) .
 289      gnus-group-news-1-face)
 290     ((and (= unread 0) (not mailp) (eq level 2)) .
 291      gnus-group-news-2-empty-face)
 292     ((and (not mailp) (eq level 2)) .
 293      gnus-group-news-2-face)
 294     ((and (= unread 0) (not mailp) (eq level 3)) .
 295      gnus-group-news-3-empty-face)
 296     ((and (not mailp) (eq level 3)) .
 297      gnus-group-news-3-face)
 298     ((and (= unread 0) (not mailp)) .
 299      gnus-group-news-low-empty-face)
 300     ((and (not mailp)) .
 301      gnus-group-news-low-face)
 302     ;; Mail.
 303     ((and (= unread 0) (eq level 1)) .
 304      gnus-group-mail-1-empty-face)
 305     ((eq level 1) .
 306      gnus-group-mail-1-face)
 307     ((and (= unread 0) (eq level 2)) .
 308      gnus-group-mail-2-empty-face)
 309     ((eq level 2) .
 310      gnus-group-mail-2-face)
 311     ((and (= unread 0) (eq level 3)) .
 312      gnus-group-mail-3-empty-face)
 313     ((eq level 3) .
 314      gnus-group-mail-3-face)
 315     ((= unread 0) .
 316      gnus-group-mail-low-empty-face)
 317     (t .
 318      gnus-group-mail-low-face))
 319   "Controls the highlighting of group buffer lines.
 320
 321 Below is a list of `Form'/`Face' pairs.  When deciding how a a
 322 particular group line should be displayed, each form is
 323 evaluated.  The content of the face field after the first true form is
 324 used.  You can change how those group lines are displayed by
 325 editing the face field.
 326
 327 It is also possible to change and add form fields, but currently that
 328 requires an understanding of Lisp expressions.  Hopefully this will
 329 change in a future release.  For now, you can use the following
 330 variables in the Lisp expression:
 331
 332 group: The name of the group.
 333 unread: The number of unread articles in the group.
 334 method: The select method used.
 335 mailp: Whether it's a mail group or not.
 336 level: The level of the group.
 337 score: The score of the group.
 338 ticked: The number of ticked articles."
 339   :group 'gnus-group-visual
 340   :type '(repeat (cons (sexp :tag "Form") face)))
 341
 342 (defcustom gnus-new-mail-mark ?%
 343   "Mark used for groups with new mail."
 344   :group 'gnus-group-visual
 345   :type 'character)
 346
 347 ;;; Internal variables
 348
 349 (defvar gnus-group-sort-alist-function 'gnus-group-sort-flat
 350   "Function for sorting the group buffer.")
 351
 352 (defvar gnus-group-sort-selected-function 'gnus-group-sort-selected-flat
 353   "Function for sorting the selected groups in the group buffer.")
 354
 355 (defvar gnus-group-indentation-function nil)
 356 (defvar gnus-goto-missing-group-function nil)
 357 (defvar gnus-group-update-group-function nil)
 358 (defvar gnus-group-goto-next-group-function nil
 359   "Function to override finding the next group after listing groups.")
 360
 361 (defvar gnus-group-edit-buffer nil)
 362
 363 (defvar gnus-group-line-format-alist
 364   `((?M gnus-tmp-marked-mark ?c)
 365     (?S gnus-tmp-subscribed ?c)
 366     (?L gnus-tmp-level ?d)
 367     (?N (cond ((eq number t) "*" )
 368               ((numberp number)
 369                (int-to-string
 370                 (+ number
 371                    (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
 372                    (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))))))
 373               (t number)) ?s)
 374     (?R gnus-tmp-number-of-read ?s)
 375     (?t gnus-tmp-number-total ?d)
 376     (?y gnus-tmp-number-of-unread ?s)
 377     (?I (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked))) ?d)
 378     (?T (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))) ?d)
 379     (?i (+ (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
 380            (gnus-range-length (cdr (assq 'tick gnus-tmp-marked)))) ?d)
 381     (?g gnus-tmp-group ?s)
 382     (?G gnus-tmp-qualified-group ?s)
 383     (?c (gnus-short-group-name gnus-tmp-group) ?s)
 384     (?D gnus-tmp-newsgroup-description ?s)
 385     (?o gnus-tmp-moderated ?c)
 386     (?O gnus-tmp-moderated-string ?s)
 387     (?p gnus-tmp-process-marked ?c)
 388     (?s gnus-tmp-news-server ?s)
 389     (?n gnus-tmp-news-method ?s)
 390     (?P gnus-group-indentation ?s)
 391     (?l gnus-tmp-grouplens ?s)
 392     (?z gnus-tmp-news-method-string ?s)
 393     (?m (gnus-group-new-mail gnus-tmp-group) ?c)
 394     (?d (gnus-group-timestamp-string gnus-tmp-group) ?s)
 395     (?u gnus-tmp-user-defined ?s)))
 396
 397 (defvar gnus-group-mode-line-format-alist
 398   `((?S gnus-tmp-news-server ?s)
 399     (?M gnus-tmp-news-method ?s)
 400     (?u gnus-tmp-user-defined ?s)
 401     (?: gnus-tmp-colon ?s)))
 402
 403 (defvar gnus-topic-topology nil
 404   "The complete topic hierarchy.")
 405
 406 (defvar gnus-topic-alist nil
 407   "The complete topic-group alist.")
 408
 409 (defvar gnus-group-marked nil)
 410
 411 (defvar gnus-group-list-mode nil)
 412
 413 ;;;
 414 ;;; Gnus group mode
 415 ;;;
 416
 417 (put 'gnus-group-mode 'mode-class 'special)
 418
 419 (when t
 420   (gnus-define-keys gnus-group-mode-map
 421     " " gnus-group-read-group
 422     "=" gnus-group-select-group
 423     "\r" gnus-group-select-group
 424     "\M-\r" gnus-group-quick-select-group
 425     [(meta control return)] gnus-group-select-group-ephemerally
 426     "j" gnus-group-jump-to-group
 427     "n" gnus-group-next-unread-group
 428     "p" gnus-group-prev-unread-group
 429     "\177" gnus-group-prev-unread-group
 430     [delete] gnus-group-prev-unread-group
 431     "N" gnus-group-next-group
 432     "P" gnus-group-prev-group
 433     "\M-n" gnus-group-next-unread-group-same-level
 434     "\M-p" gnus-group-prev-unread-group-same-level
 435     "," gnus-group-best-unread-group
 436     "." gnus-group-first-unread-group
 437     "u" gnus-group-unsubscribe-current-group
 438     "U" gnus-group-unsubscribe-group
 439     "c" gnus-group-catchup-current
 440     "C" gnus-group-catchup-current-all
 441     "\M-c" gnus-group-clear-data
 442     "l" gnus-group-list-groups
 443     "L" gnus-group-list-all-groups
 444     "m" gnus-group-mail
 445     "g" gnus-group-get-new-news
 446     "\M-g" gnus-group-get-new-news-this-group
 447     "R" gnus-group-restart
 448     "r" gnus-group-read-init-file
 449     "B" gnus-group-browse-foreign-server
 450     "b" gnus-group-check-bogus-groups
 451     "F" gnus-group-find-new-groups
 452     "\C-c\C-d" gnus-group-describe-group
 453     "\M-d" gnus-group-describe-all-groups
 454     "\C-c\C-a" gnus-group-apropos
 455     "\C-c\M-\C-a" gnus-group-description-apropos
 456     "a" gnus-group-post-news
 457     "\ek" gnus-group-edit-local-kill
 458     "\eK" gnus-group-edit-global-kill
 459     "\C-k" gnus-group-kill-group
 460     "\C-y" gnus-group-yank-group
 461     "\C-w" gnus-group-kill-region
 462     "\C-x\C-t" gnus-group-transpose-groups
 463     "\C-c\C-l" gnus-group-list-killed
 464     "\C-c\C-x" gnus-group-expire-articles
 465     "\C-c\M-\C-x" gnus-group-expire-all-groups
 466     "V" gnus-version
 467     "s" gnus-group-save-newsrc
 468     "z" gnus-group-suspend
 469     "q" gnus-group-exit
 470     "Q" gnus-group-quit
 471     "?" gnus-group-describe-briefly
 472     "\C-c\C-i" gnus-info-find-node
 473     "\M-e" gnus-group-edit-group-method
 474     "^" gnus-group-enter-server-mode
 475     gnus-mouse-2 gnus-mouse-pick-group
 476     "<" beginning-of-buffer
 477     ">" end-of-buffer
 478     "\C-c\C-b" gnus-bug
 479     "\C-c\C-s" gnus-group-sort-groups
 480     "t" gnus-topic-mode
 481     "\C-c\M-g" gnus-activate-all-groups
 482     "\M-&" gnus-group-universal-argument
 483     "#" gnus-group-mark-group
 484     "\M-#" gnus-group-unmark-group)
 485
 486   (gnus-define-keys (gnus-group-mark-map "M" gnus-group-mode-map)
 487     "m" gnus-group-mark-group
 488     "u" gnus-group-unmark-group
 489     "w" gnus-group-mark-region
 490     "b" gnus-group-mark-buffer
 491     "r" gnus-group-mark-regexp
 492     "U" gnus-group-unmark-all-groups)
 493
 494   (gnus-define-keys (gnus-group-group-map "G" gnus-group-mode-map)
 495     "d" gnus-group-make-directory-group
 496     "h" gnus-group-make-help-group
 497     "u" gnus-group-make-useful-group
 498     "a" gnus-group-make-archive-group
 499     "k" gnus-group-make-kiboze-group
 500     "m" gnus-group-make-group
 501     "E" gnus-group-edit-group
 502     "e" gnus-group-edit-group-method
 503     "p" gnus-group-edit-group-parameters
 504     "v" gnus-group-add-to-virtual
 505     "V" gnus-group-make-empty-virtual
 506     "D" gnus-group-enter-directory
 507     "f" gnus-group-make-doc-group
 508     "w" gnus-group-make-web-group
 509     "r" gnus-group-rename-group
 510     "c" gnus-group-customize
 511     "\177" gnus-group-delete-group
 512     [delete] gnus-group-delete-group)
 513
 514   (gnus-define-keys (gnus-group-soup-map "s" gnus-group-group-map)
 515     "b" gnus-group-brew-soup
 516     "w" gnus-soup-save-areas
 517     "s" gnus-soup-send-replies
 518     "p" gnus-soup-pack-packet
 519     "r" nnsoup-pack-replies)
 520
 521   (gnus-define-keys (gnus-group-sort-map "S" gnus-group-group-map)
 522     "s" gnus-group-sort-groups
 523     "a" gnus-group-sort-groups-by-alphabet
 524     "u" gnus-group-sort-groups-by-unread
 525     "l" gnus-group-sort-groups-by-level
 526     "v" gnus-group-sort-groups-by-score
 527     "r" gnus-group-sort-groups-by-rank
 528     "m" gnus-group-sort-groups-by-method)
 529
 530   (gnus-define-keys (gnus-group-sort-selected-map "P" gnus-group-group-map)
 531     "s" gnus-group-sort-selected-groups
 532     "a" gnus-group-sort-selected-groups-by-alphabet
 533     "u" gnus-group-sort-selected-groups-by-unread
 534     "l" gnus-group-sort-selected-groups-by-level
 535     "v" gnus-group-sort-selected-groups-by-score
 536     "r" gnus-group-sort-selected-groups-by-rank
 537     "m" gnus-group-sort-selected-groups-by-method)
 538
 539   (gnus-define-keys (gnus-group-list-map "A" gnus-group-mode-map)
 540     "k" gnus-group-list-killed
 541     "z" gnus-group-list-zombies
 542     "s" gnus-group-list-groups
 543     "u" gnus-group-list-all-groups
 544     "A" gnus-group-list-active
 545     "a" gnus-group-apropos
 546     "d" gnus-group-description-apropos
 547     "m" gnus-group-list-matching
 548     "M" gnus-group-list-all-matching
 549     "l" gnus-group-list-level)
 550
 551   (gnus-define-keys (gnus-group-score-map "W" gnus-group-mode-map)
 552     "f" gnus-score-flush-cache)
 553
 554   (gnus-define-keys (gnus-group-help-map "H" gnus-group-mode-map)
 555     "d" gnus-group-describe-group
 556     "f" gnus-group-fetch-faq
 557     "v" gnus-version)
 558
 559   (gnus-define-keys (gnus-group-sub-map "S" gnus-group-mode-map)
 560     "l" gnus-group-set-current-level
 561     "t" gnus-group-unsubscribe-current-group
 562     "s" gnus-group-unsubscribe-group
 563     "k" gnus-group-kill-group
 564     "y" gnus-group-yank-group
 565     "w" gnus-group-kill-region
 566     "\C-k" gnus-group-kill-level
 567     "z" gnus-group-kill-all-zombies))
 568
 569 (defun gnus-group-make-menu-bar ()
 570   (gnus-turn-off-edit-menu 'group)
 571   (unless (boundp 'gnus-group-reading-menu)
 572
 573     (easy-menu-define
 574      gnus-group-reading-menu gnus-group-mode-map ""
 575      '("Group"
 576        ["Read" gnus-group-read-group (gnus-group-group-name)]
 577        ["Select" gnus-group-select-group (gnus-group-group-name)]
 578        ["See old articles" (gnus-group-select-group 'all)
 579         :keys "C-u SPC" :active (gnus-group-group-name)]
 580        ["Catch up" gnus-group-catchup-current (gnus-group-group-name)]
 581        ["Catch up all articles" gnus-group-catchup-current-all
 582         (gnus-group-group-name)]
 583        ["Check for new articles" gnus-group-get-new-news-this-group
 584         (gnus-group-group-name)]
 585        ["Toggle subscription" gnus-group-unsubscribe-current-group
 586         (gnus-group-group-name)]
 587        ["Kill" gnus-group-kill-group (gnus-group-group-name)]
 588        ["Yank" gnus-group-yank-group gnus-list-of-killed-groups]
 589        ["Describe" gnus-group-describe-group (gnus-group-group-name)]
 590        ["Fetch FAQ" gnus-group-fetch-faq (gnus-group-group-name)]
 591        ;; Actually one should check, if any of the marked groups gives t for
 592        ;; (gnus-check-backend-function 'request-expire-articles ...)
 593        ["Expire articles" gnus-group-expire-articles
 594         (or (and (gnus-group-group-name)
 595                  (gnus-check-backend-function
 596                   'request-expire-articles
 597                   (gnus-group-group-name))) gnus-group-marked)]
 598        ["Set group level" gnus-group-set-current-level
 599         (gnus-group-group-name)]
 600        ["Select quick" gnus-group-quick-select-group (gnus-group-group-name)]
 601        ["Customize" gnus-group-customize (gnus-group-group-name)]
 602        ("Edit"
 603         ["Parameters" gnus-group-edit-group-parameters
 604          (gnus-group-group-name)]
 605         ["Select method" gnus-group-edit-group-method
 606          (gnus-group-group-name)]
 607         ["Info" gnus-group-edit-group (gnus-group-group-name)]
 608         ["Local kill file" gnus-group-edit-local-kill (gnus-group-group-name)]
 609         ["Global kill file" gnus-group-edit-global-kill t])))
 610
 611     (easy-menu-define
 612      gnus-group-group-menu gnus-group-mode-map ""
 613      '("Groups"
 614        ("Listing"
 615         ["List unread subscribed groups" gnus-group-list-groups t]
 616         ["List (un)subscribed groups" gnus-group-list-all-groups t]
 617         ["List killed groups" gnus-group-list-killed gnus-killed-list]
 618         ["List zombie groups" gnus-group-list-zombies gnus-zombie-list]
 619         ["List level..." gnus-group-list-level t]
 620         ["Describe all groups" gnus-group-describe-all-groups t]
 621         ["Group apropos..." gnus-group-apropos t]
 622         ["Group and description apropos..." gnus-group-description-apropos t]
 623         ["List groups matching..." gnus-group-list-matching t]
 624         ["List all groups matching..." gnus-group-list-all-matching t]
 625         ["List active file" gnus-group-list-active t])
 626        ("Sort"
 627         ["Default sort" gnus-group-sort-groups t]
 628         ["Sort by method" gnus-group-sort-groups-by-method t]
 629         ["Sort by rank" gnus-group-sort-groups-by-rank t]
 630         ["Sort by score" gnus-group-sort-groups-by-score t]
 631         ["Sort by level" gnus-group-sort-groups-by-level t]
 632         ["Sort by unread" gnus-group-sort-groups-by-unread t]
 633         ["Sort by name" gnus-group-sort-groups-by-alphabet t])
 634        ("Sort process/prefixed"
 635         ["Default sort" gnus-group-sort-selected-groups
 636          (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
 637         ["Sort by method" gnus-group-sort-selected-groups-by-method
 638          (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
 639         ["Sort by rank" gnus-group-sort-selected-groups-by-rank
 640          (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
 641         ["Sort by score" gnus-group-sort-selected-groups-by-score
 642          (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
 643         ["Sort by level" gnus-group-sort-selected-groups-by-level
 644          (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
 645         ["Sort by unread" gnus-group-sort-selected-groups-by-unread
 646          (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))]
 647         ["Sort by name" gnus-group-sort-selected-groups-by-alphabet
 648          (or (not (boundp 'gnus-topic-mode)) (not gnus-topic-mode))])
 649        ("Mark"
 650         ["Mark group" gnus-group-mark-group
 651          (and (gnus-group-group-name)
 652               (not (memq (gnus-group-group-name) gnus-group-marked)))]
 653         ["Unmark group" gnus-group-unmark-group
 654          (and (gnus-group-group-name)
 655               (memq (gnus-group-group-name) gnus-group-marked))]
 656         ["Unmark all" gnus-group-unmark-all-groups gnus-group-marked]
 657         ["Mark regexp..." gnus-group-mark-regexp t]
 658         ["Mark region" gnus-group-mark-region t]
 659         ["Mark buffer" gnus-group-mark-buffer t]
 660         ["Execute command" gnus-group-universal-argument
 661          (or gnus-group-marked (gnus-group-group-name))])
 662        ("Subscribe"
 663         ["Subscribe to a group" gnus-group-unsubscribe-group t]
 664         ["Kill all newsgroups in region" gnus-group-kill-region t]
 665         ["Kill all zombie groups" gnus-group-kill-all-zombies
 666          gnus-zombie-list]
 667         ["Kill all groups on level..." gnus-group-kill-level t])
 668        ("Foreign groups"
 669         ["Make a foreign group" gnus-group-make-group t]
 670         ["Add a directory group" gnus-group-make-directory-group t]
 671         ["Add the help group" gnus-group-make-help-group t]
 672         ["Add the archive group" gnus-group-make-archive-group t]
 673         ["Make a doc group" gnus-group-make-doc-group t]
 674         ["Make a web group" gnus-group-make-web-group t]
 675         ["Make a kiboze group" gnus-group-make-kiboze-group t]
 676         ["Make a virtual group" gnus-group-make-empty-virtual t]
 677         ["Add a group to a virtual" gnus-group-add-to-virtual t]
 678         ["Rename group" gnus-group-rename-group
 679          (gnus-check-backend-function
 680           'request-rename-group (gnus-group-group-name))]
 681         ["Delete group" gnus-group-delete-group
 682          (gnus-check-backend-function
 683           'request-delete-group (gnus-group-group-name))])
 684        ("Move"
 685         ["Next" gnus-group-next-group t]
 686         ["Previous" gnus-group-prev-group t]
 687         ["Next unread" gnus-group-next-unread-group t]
 688         ["Previous unread" gnus-group-prev-unread-group t]
 689         ["Next unread same level" gnus-group-next-unread-group-same-level t]
 690         ["Previous unread same level"
 691          gnus-group-prev-unread-group-same-level t]
 692         ["Jump to group" gnus-group-jump-to-group t]
 693         ["First unread group" gnus-group-first-unread-group t]
 694         ["Best unread group" gnus-group-best-unread-group t])
 695        ["Delete bogus groups" gnus-group-check-bogus-groups t]
 696        ["Find new newsgroups" gnus-group-find-new-groups t]
 697        ["Transpose" gnus-group-transpose-groups
 698         (gnus-group-group-name)]
 699        ["Read a directory as a group..." gnus-group-enter-directory t]))
 700
 701     (easy-menu-define
 702      gnus-group-misc-menu gnus-group-mode-map ""
 703      '("Misc"
 704        ("SOUP"
 705         ["Pack replies" nnsoup-pack-replies (fboundp 'nnsoup-request-group)]
 706         ["Send replies" gnus-soup-send-replies
 707          (fboundp 'gnus-soup-pack-packet)]
 708         ["Pack packet" gnus-soup-pack-packet (fboundp 'gnus-soup-pack-packet)]
 709         ["Save areas" gnus-soup-save-areas (fboundp 'gnus-soup-pack-packet)]
 710         ["Brew SOUP" gnus-soup-brew-soup (fboundp 'gnus-soup-pack-packet)])
 711        ["Send a bug report" gnus-bug t]
 712        ["Send a mail" gnus-group-mail t]
 713        ["Post an article..." gnus-group-post-news t]
 714        ["Check for new news" gnus-group-get-new-news t]
 715        ["Activate all groups" gnus-activate-all-groups t]
 716        ["Restart Gnus" gnus-group-restart t]
 717        ["Read init file" gnus-group-read-init-file t]
 718        ["Browse foreign server" gnus-group-browse-foreign-server t]
 719        ["Enter server buffer" gnus-group-enter-server-mode t]
 720        ["Expire all expirable articles" gnus-group-expire-all-groups t]
 721        ["Generate any kiboze groups" nnkiboze-generate-groups t]
 722        ["Gnus version" gnus-version t]
 723        ["Save .newsrc files" gnus-group-save-newsrc t]
 724        ["Suspend Gnus" gnus-group-suspend t]
 725        ["Clear dribble buffer" gnus-group-clear-dribble t]
 726        ["Read manual" gnus-info-find-node t]
 727        ["Flush score cache" gnus-score-flush-cache t]
 728        ["Toggle topics" gnus-topic-mode t]
 729        ["Exit from Gnus" gnus-group-exit t]
 730        ["Exit without saving" gnus-group-quit t]))
 731
 732     (run-hooks 'gnus-group-menu-hook)))
 733
 734 (defun gnus-group-mode ()
 735   "Major mode for reading news.
 736
 737 All normal editing commands are switched off.
 738 \\<gnus-group-mode-map>
 739 The group buffer lists (some of) the groups available.  For instance,
 740 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
 741 lists all zombie groups.
 742
 743 Groups that are displayed can be entered with `\\[gnus-group-read-group]'.  To subscribe
 744 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
 745
 746 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
 747
 748 The following commands are available:
 749
 750 \\{gnus-group-mode-map}"
 751   (interactive)
 752   (when (gnus-visual-p 'group-menu 'menu)
 753     (gnus-group-make-menu-bar))
 754   (kill-all-local-variables)
 755   (gnus-simplify-mode-line)
 756   (setq major-mode 'gnus-group-mode)
 757   (setq mode-name "Group")
 758   (gnus-group-set-mode-line)
 759   (setq mode-line-process nil)
 760   (use-local-map gnus-group-mode-map)
 761   (buffer-disable-undo (current-buffer))
 762   (setq truncate-lines t)
 763   (setq buffer-read-only t)
 764   (gnus-set-default-directory)
 765   (gnus-update-format-specifications nil 'group 'group-mode)
 766   (gnus-update-group-mark-positions)
 767   (make-local-hook 'post-command-hook)
 768   (add-hook 'post-command-hook 'gnus-clear-inboxes-moved nil t)
 769   (when gnus-use-undo
 770     (gnus-undo-mode 1))
 771   (run-hooks 'gnus-group-mode-hook))
 772
 773 (defun gnus-update-group-mark-positions ()
 774   (save-excursion
 775     (let ((gnus-process-mark 128)
 776           (gnus-group-marked '("dummy.group"))
 777           (gnus-active-hashtb (make-vector 10 0)))
 778       (gnus-set-active "dummy.group" '(0 . 0))
 779       (gnus-set-work-buffer)
 780       (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
 781       (goto-char (point-min))
 782       (setq gnus-group-mark-positions
 783             (list (cons 'process (and (search-forward "\200" nil t)
 784                                       (- (point) 2))))))))
 785
 786 (defun gnus-clear-inboxes-moved ()
 787   (setq nnmail-moved-inboxes nil))
 788
 789 (defun gnus-mouse-pick-group (e)
 790   "Enter the group under the mouse pointer."
 791   (interactive "e")
 792   (mouse-set-point e)
 793   (gnus-group-read-group nil))
 794
 795 ;; Look at LEVEL and find out what the level is really supposed to be.
 796 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
 797 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
 798 (defun gnus-group-default-level (&optional level number-or-nil)
 799   (cond
 800    (gnus-group-use-permanent-levels
 801     (or (setq gnus-group-use-permanent-levels
 802               (or level (if (numberp gnus-group-use-permanent-levels)
 803                             gnus-group-use-permanent-levels
 804                           (or gnus-group-default-list-level
 805                               gnus-level-subscribed))))
 806         gnus-group-default-list-level gnus-level-subscribed))
 807    (number-or-nil
 808     level)
 809    (t
 810     (or level gnus-group-default-list-level gnus-level-subscribed))))
 811
 812 (defun gnus-group-setup-buffer ()
 813   (switch-to-buffer gnus-group-buffer)
 814   (unless (eq major-mode 'gnus-group-mode)
 815     (gnus-add-current-to-buffer-list)
 816     (gnus-group-mode)
 817     (when gnus-carpal
 818       (gnus-carpal-setup-buffer 'group))))
 819
 820 (defun gnus-group-list-groups (&optional level unread lowest)
 821   "List newsgroups with level LEVEL or lower that have unread articles.
 822 Default is all subscribed groups.
 823 If argument UNREAD is non-nil, groups with no unread articles are also
 824 listed.
 825
 826 Also see the `gnus-group-use-permanent-levels' variable."
 827   (interactive
 828    (list (if current-prefix-arg
 829              (prefix-numeric-value current-prefix-arg)
 830            (or
 831             (gnus-group-default-level nil t)
 832             gnus-group-default-list-level
 833             gnus-level-subscribed))))
 834   ;; Just do this here, for no particular good reason.
 835   (gnus-clear-inboxes-moved)
 836   (unless level
 837     (setq level (car gnus-group-list-mode)
 838           unread (cdr gnus-group-list-mode)))
 839   (setq level (gnus-group-default-level level))
 840   (gnus-group-setup-buffer)
 841   (gnus-update-format-specifications nil 'group 'group-mode)
 842   (let ((case-fold-search nil)
 843         (props (text-properties-at (gnus-point-at-bol)))
 844         (empty (= (point-min) (point-max)))
 845         (group (gnus-group-group-name))
 846         number)
 847     (set-buffer gnus-group-buffer)
 848     (setq number (funcall gnus-group-prepare-function level unread lowest))
 849     (when (or (and (numberp number)
 850                    (zerop number))
 851               (zerop (buffer-size)))
 852       ;; No groups in the buffer.
 853       (gnus-message 5 gnus-no-groups-message))
 854     ;; We have some groups displayed.
 855     (goto-char (point-max))
 856     (when (or (not gnus-group-goto-next-group-function)
 857               (not (funcall gnus-group-goto-next-group-function
 858                             group props)))
 859       (cond
 860        (empty
 861         (goto-char (point-min)))
 862        ((not group)
 863         ;; Go to the first group with unread articles.
 864         (gnus-group-search-forward t))
 865        (t
 866         ;; Find the right group to put point on.  If the current group
 867         ;; has disappeared in the new listing, try to find the next
 868         ;; one.  If no next one can be found, just leave point at the
 869         ;; first newsgroup in the buffer.
 870         (when (not (gnus-goto-char
 871                     (text-property-any
 872                      (point-min) (point-max)
 873                      'gnus-group (gnus-intern-safe
 874                                   group gnus-active-hashtb))))
 875           (let ((newsrc (cdddr (gnus-gethash group gnus-newsrc-hashtb))))
 876             (while (and newsrc
 877                         (not (gnus-goto-char
 878                               (text-property-any
 879                                (point-min) (point-max) 'gnus-group
 880                                (gnus-intern-safe
 881                                 (caar newsrc) gnus-active-hashtb)))))
 882               (setq newsrc (cdr newsrc)))
 883             (unless newsrc
 884               (goto-char (point-max))
 885               (forward-line -1)))))))
 886     ;; Adjust cursor point.
 887     (gnus-group-position-point)))
 888
 889 (defun gnus-group-list-level (level &optional all)
 890   "List groups on LEVEL.
 891 If ALL (the prefix), also list groups that have no unread articles."
 892   (interactive "nList groups on level: \nP")
 893   (gnus-group-list-groups level all level))
 894
 895 (defun gnus-group-prepare-flat (level &optional all lowest regexp)
 896   "List all newsgroups with unread articles of level LEVEL or lower.
 897 If ALL is non-nil, list groups that have no unread articles.
 898 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
 899 If REGEXP, only list groups matching REGEXP."
 900   (set-buffer gnus-group-buffer)
 901   (let ((buffer-read-only nil)
 902         (newsrc (cdr gnus-newsrc-alist))
 903         (lowest (or lowest 1))
 904         info clevel unread group params)
 905     (erase-buffer)
 906     (when (< lowest gnus-level-zombie)
 907       ;; List living groups.
 908       (while newsrc
 909         (setq info (car newsrc)
 910               group (gnus-info-group info)
 911               params (gnus-info-params info)
 912               newsrc (cdr newsrc)
 913               unread (car (gnus-gethash group gnus-newsrc-hashtb)))
 914         (and unread                     ; This group might be bogus
 915              (or (not regexp)
 916                  (string-match regexp group))
 917              (<= (setq clevel (gnus-info-level info)) level)
 918              (>= clevel lowest)
 919              (or all                    ; We list all groups?
 920                  (if (eq unread t)      ; Unactivated?
 921                      gnus-group-list-inactive-groups ; We list unactivated
 922                    (> unread 0))        ; We list groups with unread articles
 923                  (and gnus-list-groups-with-ticked-articles
 924                       (cdr (assq 'tick (gnus-info-marks info))))
 925                                         ; And groups with tickeds
 926                  ;; Check for permanent visibility.
 927                  (and gnus-permanently-visible-groups
 928                       (string-match gnus-permanently-visible-groups
 929                                     group))
 930                  (memq 'visible params)
 931                  (cdr (assq 'visible params)))
 932              (gnus-group-insert-group-line
 933               group (gnus-info-level info)
 934               (gnus-info-marks info) unread (gnus-info-method info)))))
 935
 936     ;; List dead groups.
 937     (and (>= level gnus-level-zombie) (<= lowest gnus-level-zombie)
 938          (gnus-group-prepare-flat-list-dead
 939           (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
 940           gnus-level-zombie ?Z
 941           regexp))
 942     (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)
 943          (gnus-group-prepare-flat-list-dead
 944           (setq gnus-killed-list (sort gnus-killed-list 'string<))
 945           gnus-level-killed ?K regexp))
 946
 947     (gnus-group-set-mode-line)
 948     (setq gnus-group-list-mode (cons level all))
 949     (run-hooks 'gnus-group-prepare-hook)
 950     t))
 951
 952 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
 953   ;; List zombies and killed lists somewhat faster, which was
 954   ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.  It does
 955   ;; this by ignoring the group format specification altogether.
 956   (let (group)
 957     (if regexp
 958         ;; This loop is used when listing groups that match some
 959         ;; regexp.
 960         (while groups
 961           (setq group (pop groups))
 962           (when (string-match regexp group)
 963             (gnus-add-text-properties
 964              (point) (prog1 (1+ (point))
 965                        (insert " " mark "     *: " group "\n"))
 966              (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
 967                    'gnus-unread t
 968                    'gnus-level level))))
 969       ;; This loop is used when listing all groups.
 970       (while groups
 971         (gnus-add-text-properties
 972          (point) (prog1 (1+ (point))
 973                    (insert " " mark "     *: "
 974                            (setq group (pop groups)) "\n"))
 975          (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
 976                'gnus-unread t
 977                'gnus-level level))))))
 978
 979 (defun gnus-group-update-group-line ()
 980   "Update the current line in the group buffer."
 981   (let* ((buffer-read-only nil)
 982          (group (gnus-group-group-name))
 983          (entry (and group (gnus-gethash group gnus-newsrc-hashtb)))
 984          gnus-group-indentation)
 985     (when group
 986       (and entry
 987            (not (gnus-ephemeral-group-p group))
 988            (gnus-dribble-enter
 989             (concat "(gnus-group-set-info '"
 990                     (gnus-prin1-to-string (nth 2 entry))
 991                     ")")))
 992       (setq gnus-group-indentation (gnus-group-group-indentation))
 993       (gnus-delete-line)
 994       (gnus-group-insert-group-line-info group)
 995       (forward-line -1)
 996       (gnus-group-position-point))))
 997
 998 (defun gnus-group-insert-group-line-info (group)
 999   "Insert GROUP on the current line."
1000   (let ((entry (gnus-gethash group gnus-newsrc-hashtb))
1001         (gnus-group-indentation (gnus-group-group-indentation))
1002         active info)
1003     (if entry
1004         (progn
1005           ;; (Un)subscribed group.
1006           (setq info (nth 2 entry))
1007           (gnus-group-insert-group-line
1008            group (gnus-info-level info) (gnus-info-marks info)
1009            (or (car entry) t) (gnus-info-method info)))
1010       ;; This group is dead.
1011       (gnus-group-insert-group-line
1012        group
1013        (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1014        nil
1015        (if (setq active (gnus-active group))
1016            (if (zerop (cdr active))
1017                0
1018              (- (1+ (cdr active)) (car active)))
1019          nil)
1020        nil))))
1021
1022 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1023                                                     gnus-tmp-marked number
1024                                                     gnus-tmp-method)
1025   "Insert a group line in the group buffer."
1026   (let* ((gnus-tmp-active (gnus-active gnus-tmp-group))
1027          (gnus-tmp-number-total
1028           (if gnus-tmp-active
1029               (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1030             0))
1031          (gnus-tmp-number-of-unread
1032           (if (numberp number) (int-to-string (max 0 number))
1033             "*"))
1034          (gnus-tmp-number-of-read
1035           (if (numberp number)
1036               (int-to-string (max 0 (- gnus-tmp-number-total number)))
1037             "*"))
1038          (gnus-tmp-subscribed
1039           (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1040                 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1041                 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1042                 (t ?K)))
1043          (gnus-tmp-qualified-group (gnus-group-real-name gnus-tmp-group))
1044          (gnus-tmp-newsgroup-description
1045           (if gnus-description-hashtb
1046               (or (gnus-gethash gnus-tmp-group gnus-description-hashtb) "")
1047             ""))
1048          (gnus-tmp-moderated
1049           (if (and gnus-moderated-hashtb
1050                    (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1051               ?m ? ))
1052          (gnus-tmp-moderated-string
1053           (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1054          (gnus-tmp-method
1055           (gnus-server-get-method gnus-tmp-group gnus-tmp-method)) ;
1056          (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1057          (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1058          (gnus-tmp-news-method-string
1059           (if gnus-tmp-method
1060               (format "(%s:%s)" (car gnus-tmp-method)
1061                       (cadr gnus-tmp-method)) ""))
1062          (gnus-tmp-marked-mark
1063           (if (and (numberp number)
1064                    (zerop number)
1065                    (cdr (assq 'tick gnus-tmp-marked)))
1066               ?* ? ))
1067          (gnus-tmp-process-marked
1068           (if (member gnus-tmp-group gnus-group-marked)
1069               gnus-process-mark ? ))
1070          (gnus-tmp-grouplens
1071           (or (and gnus-use-grouplens
1072                    (bbb-grouplens-group-p gnus-tmp-group))
1073               ""))
1074          (buffer-read-only nil)
1075          header gnus-tmp-header)        ; passed as parameter to user-funcs.
1076     (beginning-of-line)
1077     (gnus-add-text-properties
1078      (point)
1079      (prog1 (1+ (point))
1080        ;; Insert the text.
1081        (eval gnus-group-line-format-spec))
1082      `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1083                   gnus-unread ,(if (numberp number)
1084                                    (string-to-int gnus-tmp-number-of-unread)
1085                                  t)
1086                   gnus-marked ,gnus-tmp-marked-mark
1087                   gnus-indentation ,gnus-group-indentation
1088                   gnus-level ,gnus-tmp-level))
1089     (when (inline (gnus-visual-p 'group-highlight 'highlight))
1090       (forward-line -1)
1091       (run-hooks 'gnus-group-update-hook)
1092       (forward-line))
1093     ;; Allow XEmacs to remove front-sticky text properties.
1094     (gnus-group-remove-excess-properties)))
1095
1096 (defun gnus-group-highlight-line ()
1097   "Highlight the current line according to `gnus-group-highlight'."
1098   (let* ((list gnus-group-highlight)
1099          (p (point))
1100          (end (progn (end-of-line) (point)))
1101          ;; now find out where the line starts and leave point there.
1102          (beg (progn (beginning-of-line) (point)))
1103          (group (gnus-group-group-name))
1104          (entry (gnus-group-entry group))
1105          (unread (if (numberp (car entry)) (car entry) 0))
1106          (active (gnus-active group))
1107          (total (if active (1+ (- (cdr active) (car active))) 0))
1108          (info (nth 2 entry))
1109          (method (gnus-server-get-method group (gnus-info-method info)))
1110          (marked (gnus-info-marks info))
1111          (mailp (memq 'mail (assoc (symbol-name
1112                                     (car (or method gnus-select-method)))
1113                                    gnus-valid-select-methods)))
1114          (level (or (gnus-info-level info) 9))
1115          (score (or (gnus-info-score info) 0))
1116          (ticked (gnus-range-length (cdr (assq 'tick marked))))
1117          (group-age (gnus-group-timestamp-delta group))
1118          (inhibit-read-only t))
1119     ;; Eval the cars of the lists until we find a match.
1120     (while (and list
1121                 (not (eval (caar list))))
1122       (setq list (cdr list)))
1123     (let ((face (cdar list)))
1124       (unless (eq face (get-text-property beg 'face))
1125         (gnus-put-text-property
1126          beg end 'face
1127          (setq face (if (boundp face) (symbol-value face) face)))
1128         (gnus-extent-start-open beg)))
1129     (goto-char p)))
1130
1131 (defun gnus-group-update-group (group &optional visible-only)
1132   "Update all lines where GROUP appear.
1133 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1134 already."
1135   ;; Can't use `save-excursion' here, so we do it manually.
1136   (let ((buf (current-buffer))
1137         mark)
1138     (set-buffer gnus-group-buffer)
1139     (setq mark (point-marker))
1140     ;; The buffer may be narrowed.
1141     (save-restriction
1142       (widen)
1143       (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1144             (loc (point-min))
1145             found buffer-read-only)
1146         ;; Enter the current status into the dribble buffer.
1147         (let ((entry (gnus-gethash group gnus-newsrc-hashtb)))
1148           (when (and entry (not (gnus-ephemeral-group-p group)))
1149             (gnus-dribble-enter
1150              (concat "(gnus-group-set-info '"
1151                      (gnus-prin1-to-string (nth 2 entry))
1152                      ")"))))
1153         ;; Find all group instances.  If topics are in use, each group
1154         ;; may be listed in more than once.
1155         (while (setq loc (text-property-any
1156                           loc (point-max) 'gnus-group ident))
1157           (setq found t)
1158           (goto-char loc)
1159           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1160             (gnus-delete-line)
1161             (gnus-group-insert-group-line-info group)
1162             (save-excursion
1163               (forward-line -1)
1164               (run-hooks 'gnus-group-update-group-hook)))
1165           (setq loc (1+ loc)))
1166         (unless (or found visible-only)
1167           ;; No such line in the buffer, find out where it's supposed to
1168           ;; go, and insert it there (or at the end of the buffer).
1169           (if gnus-goto-missing-group-function
1170               (funcall gnus-goto-missing-group-function group)
1171             (let ((entry (cddr (gnus-gethash group gnus-newsrc-hashtb))))
1172               (while (and entry (car entry)
1173                           (not
1174                            (gnus-goto-char
1175                             (text-property-any
1176                              (point-min) (point-max)
1177                              'gnus-group (gnus-intern-safe
1178                                           (caar entry) gnus-active-hashtb)))))
1179                 (setq entry (cdr entry)))
1180               (or entry (goto-char (point-max)))))
1181           ;; Finally insert the line.
1182           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1183             (gnus-group-insert-group-line-info group)
1184             (save-excursion
1185               (forward-line -1)
1186               (run-hooks 'gnus-group-update-group-hook))))
1187         (when gnus-group-update-group-function
1188           (funcall gnus-group-update-group-function group))
1189         (gnus-group-set-mode-line)))
1190     (goto-char mark)
1191     (set-marker mark nil)
1192     (set-buffer buf)))
1193
1194 (defun gnus-group-set-mode-line ()
1195   "Update the mode line in the group buffer."
1196   (when (memq 'group gnus-updated-mode-lines)
1197     ;; Yes, we want to keep this mode line updated.
1198     (save-excursion
1199       (set-buffer gnus-group-buffer)
1200       (let* ((gformat (or gnus-group-mode-line-format-spec
1201                           (gnus-set-format 'group-mode)))
1202              (gnus-tmp-news-server (cadr gnus-select-method))
1203              (gnus-tmp-news-method (car gnus-select-method))
1204              (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1205              (max-len 60)
1206              gnus-tmp-header            ;Dummy binding for user-defined formats
1207              ;; Get the resulting string.
1208              (modified
1209               (and gnus-dribble-buffer
1210                    (buffer-name gnus-dribble-buffer)
1211                    (buffer-modified-p gnus-dribble-buffer)
1212                    (save-excursion
1213                      (set-buffer gnus-dribble-buffer)
1214                      (not (zerop (buffer-size))))))
1215              (mode-string (eval gformat)))
1216         ;; Say whether the dribble buffer has been modified.
1217         (setq mode-line-modified
1218               (if modified (car gnus-mode-line-modified)
1219                 (cdr gnus-mode-line-modified)))
1220         ;; If the line is too long, we chop it off.
1221         (when (> (length mode-string) max-len)
1222           (setq mode-string (substring mode-string 0 (- max-len 4))))
1223         (prog1
1224             (setq mode-line-buffer-identification
1225                   (gnus-mode-line-buffer-identification
1226                    (list mode-string)))
1227           (set-buffer-modified-p modified))))))
1228
1229 (defun gnus-group-group-name ()
1230   "Get the name of the newsgroup on the current line."
1231   (let ((group (get-text-property (gnus-point-at-bol) 'gnus-group)))
1232     (and group (symbol-name group))))
1233
1234 (defun gnus-group-group-level ()
1235   "Get the level of the newsgroup on the current line."
1236   (get-text-property (gnus-point-at-bol) 'gnus-level))
1237
1238 (defun gnus-group-group-indentation ()
1239   "Get the indentation of the newsgroup on the current line."
1240   (or (get-text-property (gnus-point-at-bol) 'gnus-indentation)
1241       (and gnus-group-indentation-function
1242            (funcall gnus-group-indentation-function))
1243       ""))
1244
1245 (defun gnus-group-group-unread ()
1246   "Get the number of unread articles of the newsgroup on the current line."
1247   (get-text-property (gnus-point-at-bol) 'gnus-unread))
1248
1249 (defun gnus-group-new-mail (group)
1250   (if (nnmail-new-mail-p (gnus-group-real-name group))
1251       gnus-new-mail-mark
1252     ? ))
1253
1254 (defun gnus-group-level (group)
1255   "Return the estimated level of GROUP."
1256   (or (gnus-info-level (gnus-get-info group))
1257       (and (member group gnus-zombie-list) 8)
1258       9))
1259
1260 (defun gnus-group-search-forward (&optional backward all level first-too)
1261   "Find the next newsgroup with unread articles.
1262 If BACKWARD is non-nil, find the previous newsgroup instead.
1263 If ALL is non-nil, just find any newsgroup.
1264 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1265 group exists.
1266 If FIRST-TOO, the current line is also eligible as a target."
1267   (let ((way (if backward -1 1))
1268         (low gnus-level-killed)
1269         (beg (point))
1270         pos found lev)
1271     (if (and backward (progn (beginning-of-line)) (bobp))
1272         nil
1273       (unless first-too
1274         (forward-line way))
1275       (while (and
1276               (not (eobp))
1277               (not (setq
1278                     found
1279                     (and
1280                      (get-text-property (point) 'gnus-group)
1281                      (or all
1282                          (and
1283                           (let ((unread
1284                                  (get-text-property (point) 'gnus-unread)))
1285                             (and (numberp unread) (> unread 0)))
1286                           (setq lev (get-text-property (point)
1287                                                        'gnus-level))
1288                           (<= lev gnus-level-subscribed)))
1289                      (or (not level)
1290                          (and (setq lev (get-text-property (point)
1291                                                            'gnus-level))
1292                               (or (= lev level)
1293                                   (and (< lev low)
1294                                        (< level lev)
1295                                        (progn
1296                                          (setq low lev)
1297                                          (setq pos (point))
1298                                          nil))))))))
1299               (zerop (forward-line way)))))
1300     (if found
1301         (progn (gnus-group-position-point) t)
1302       (goto-char (or pos beg))
1303       (and pos t))))
1304
1305 ;;; Gnus group mode commands
1306
1307 ;; Group marking.
1308
1309 (defun gnus-group-mark-group (n &optional unmark no-advance)
1310   "Mark the current group."
1311   (interactive "p")
1312   (let ((buffer-read-only nil)
1313         group)
1314     (while (and (> n 0)
1315                 (not (eobp)))
1316       (when (setq group (gnus-group-group-name))
1317         ;; Go to the mark position.
1318         (beginning-of-line)
1319         (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1320         (subst-char-in-region
1321          (point) (1+ (point)) (following-char)
1322          (if unmark
1323              (progn
1324                (setq gnus-group-marked (delete group gnus-group-marked))
1325                ? )
1326            (setq gnus-group-marked
1327                  (cons group (delete group gnus-group-marked)))
1328            gnus-process-mark)))
1329       (unless no-advance
1330         (gnus-group-next-group 1))
1331       (decf n))
1332     (gnus-summary-position-point)
1333     n))
1334
1335 (defun gnus-group-unmark-group (n)
1336   "Remove the mark from the current group."
1337   (interactive "p")
1338   (gnus-group-mark-group n 'unmark)
1339   (gnus-group-position-point))
1340
1341 (defun gnus-group-unmark-all-groups ()
1342   "Unmark all groups."
1343   (interactive)
1344   (let ((groups gnus-group-marked))
1345     (save-excursion
1346       (while groups
1347         (gnus-group-remove-mark (pop groups)))))
1348   (gnus-group-position-point))
1349
1350 (defun gnus-group-mark-region (unmark beg end)
1351   "Mark all groups between point and mark.
1352 If UNMARK, remove the mark instead."
1353   (interactive "P\nr")
1354   (let ((num (count-lines beg end)))
1355     (save-excursion
1356       (goto-char beg)
1357       (- num (gnus-group-mark-group num unmark)))))
1358
1359 (defun gnus-group-mark-buffer (&optional unmark)
1360   "Mark all groups in the buffer.
1361 If UNMARK, remove the mark instead."
1362   (interactive "P")
1363   (gnus-group-mark-region unmark (point-min) (point-max)))
1364
1365 (defun gnus-group-mark-regexp (regexp)
1366   "Mark all groups that match some regexp."
1367   (interactive "sMark (regexp): ")
1368   (let ((alist (cdr gnus-newsrc-alist))
1369         group)
1370     (while alist
1371       (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1372         (gnus-group-set-mark group))))
1373   (gnus-group-position-point))
1374
1375 (defun gnus-group-remove-mark (group)
1376   "Remove the process mark from GROUP and move point there.
1377 Return nil if the group isn't displayed."
1378   (if (gnus-group-goto-group group)
1379       (save-excursion
1380         (gnus-group-mark-group 1 'unmark t)
1381         t)
1382     (setq gnus-group-marked
1383           (delete group gnus-group-marked))
1384     nil))
1385
1386 (defun gnus-group-set-mark (group)
1387   "Set the process mark on GROUP."
1388   (if (gnus-group-goto-group group)
1389       (save-excursion
1390         (gnus-group-mark-group 1 nil t))
1391     (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1392
1393 (defun gnus-group-universal-argument (arg &optional groups func)
1394   "Perform any command on all groups according to the process/prefix convention."
1395   (interactive "P")
1396   (if (eq (setq func (or func
1397                          (key-binding
1398                           (read-key-sequence
1399                            (substitute-command-keys
1400                             "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1401           'undefined)
1402       (gnus-error 1 "Undefined key")
1403     (gnus-group-iterate arg
1404       (lambda (group)
1405         (command-execute func))))
1406   (gnus-group-position-point))
1407
1408 (defun gnus-group-process-prefix (n)
1409   "Return a list of groups to work on.
1410 Take into consideration N (the prefix) and the list of marked groups."
1411   (cond
1412    (n
1413     (setq n (prefix-numeric-value n))
1414     ;; There is a prefix, so we return a list of the N next
1415     ;; groups.
1416     (let ((way (if (< n 0) -1 1))
1417           (n (abs n))
1418           group groups)
1419       (save-excursion
1420         (while (and (> n 0)
1421                     (setq group (gnus-group-group-name)))
1422           (push group groups)
1423           (setq n (1- n))
1424           (gnus-group-next-group way)))
1425       (nreverse groups)))
1426    ((gnus-region-active-p)
1427     ;; Work on the region between point and mark.
1428     (let ((max (max (point) (mark)))
1429           groups)
1430       (save-excursion
1431         (goto-char (min (point) (mark)))
1432         (while
1433             (and
1434              (push (gnus-group-group-name) groups)
1435              (zerop (gnus-group-next-group 1))
1436              (< (point) max)))
1437         (nreverse groups))))
1438    (gnus-group-marked
1439     ;; No prefix, but a list of marked articles.
1440     (reverse gnus-group-marked))
1441    (t
1442     ;; Neither marked articles or a prefix, so we return the
1443     ;; current group.
1444     (let ((group (gnus-group-group-name)))
1445       (and group (list group))))))
1446
1447 ;;;!!! All the variables below should be gensymmed.
1448 (defun gnus-group-iterate (arg gnus-group-iterate-function)
1449   "Iterate FUNCTION over all process/prefixed groups.
1450   FUNCTION will be called with the group name as the paremeter
1451   and with point over the group in question."
1452   (let ((groups (gnus-group-process-prefix arg))
1453         (window (selected-window))
1454         group)
1455     (while (setq group (pop groups))
1456       (select-window window)
1457       (gnus-group-remove-mark group)
1458       (save-selected-window
1459         (save-excursion
1460           (funcall function group))))))
1461
1462 (put 'gnus-group-iterate 'lisp-indent-function 1)
1463
1464 ;; Selecting groups.
1465
1466 (defun gnus-group-read-group (&optional all no-article group)
1467   "Read news in this newsgroup.
1468 If the prefix argument ALL is non-nil, already read articles become
1469 readable.  IF ALL is a number, fetch this number of articles.  If the
1470 optional argument NO-ARTICLE is non-nil, no article will be
1471 auto-selected upon group entry.  If GROUP is non-nil, fetch that
1472 group."
1473   (interactive "P")
1474   (let ((no-display (eq all 0))
1475         (group (or group (gnus-group-group-name)))
1476         number active marked entry)
1477     (when (eq all 0)
1478       (setq all nil))
1479     (unless group
1480       (error "No group on current line"))
1481     (setq marked (gnus-info-marks
1482                   (nth 2 (setq entry (gnus-gethash
1483                                       group gnus-newsrc-hashtb)))))
1484     ;; This group might be a dead group.  In that case we have to get
1485     ;; the number of unread articles from `gnus-active-hashtb'.
1486     (setq number
1487           (cond ((numberp all) all)
1488                 (entry (car entry))
1489                 ((setq active (gnus-active group))
1490                  (- (1+ (cdr active)) (car active)))))
1491     (gnus-summary-read-group
1492      group (or all (and (numberp number)
1493                         (zerop (+ number (gnus-range-length
1494                                           (cdr (assq 'tick marked)))
1495                                   (gnus-range-length
1496                                    (cdr (assq 'dormant marked)))))))
1497      no-article nil no-display)))
1498
1499 (defun gnus-group-select-group (&optional all)
1500   "Select this newsgroup.
1501 No article is selected automatically.
1502 If ALL is non-nil, already read articles become readable.
1503 If ALL is a number, fetch this number of articles."
1504   (interactive "P")
1505   (gnus-group-read-group all t))
1506
1507 (defun gnus-group-quick-select-group (&optional all)
1508   "Select the current group \"quickly\".
1509 This means that no highlighting or scoring will be performed.
1510 If ALL (the prefix argument) is 0, don't even generate the summary
1511 buffer."
1512   (interactive "P")
1513   (require 'gnus-score)
1514   (let (gnus-visual
1515         gnus-score-find-score-files-function
1516         gnus-home-score-file
1517         gnus-apply-kill-hook
1518         gnus-summary-expunge-below)
1519     (gnus-group-read-group all t)))
1520
1521 (defun gnus-group-visible-select-group (&optional all)
1522   "Select the current group without hiding any articles."
1523   (interactive "P")
1524   (let ((gnus-inhibit-limiting t))
1525     (gnus-group-read-group all t)))
1526
1527 (defun gnus-group-select-group-ephemerally ()
1528   "Select the current group without doing any processing whatsoever.
1529 You will actually be entered into a group that's a copy of
1530 the current group; no changes you make while in this group will
1531 be permanent."
1532   (interactive)
1533   (require 'gnus-score)
1534   (let* (gnus-visual
1535          gnus-score-find-score-files-function gnus-apply-kill-hook
1536          gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
1537          gnus-summary-mode-hook gnus-select-group-hook
1538          (group (gnus-group-group-name))
1539          (method (gnus-find-method-for-group group)))
1540     (setq method
1541           `(,(car method) ,(concat (cadr method) "-ephemeral")
1542             (,(intern (format "%s-address" (car method))) ,(cadr method))
1543             ,@(cddr method)))
1544     (gnus-group-read-ephemeral-group
1545      (gnus-group-prefixed-name group method) method)))
1546
1547 ;;;###autoload
1548 (defun gnus-fetch-group (group)
1549   "Start Gnus if necessary and enter GROUP.
1550 Returns whether the fetching was successful or not."
1551   (interactive "sGroup name: ")
1552   (unless (get-buffer gnus-group-buffer)
1553     (gnus))
1554   (gnus-group-read-group nil nil group))
1555
1556 (defvar gnus-ephemeral-group-server 0)
1557
1558 ;; Enter a group that is not in the group buffer.  Non-nil is returned
1559 ;; if selection was successful.
1560 (defun gnus-group-read-ephemeral-group (group method &optional activate
1561                                               quit-config request-only)
1562   "Read GROUP from METHOD as an ephemeral group.
1563 If ACTIVATE, request the group first.
1564 If QUIT-CONFIG, use that window configuration when exiting from the
1565 ephemeral group.
1566 If REQUEST-ONLY, don't actually read the group; just request it.
1567
1568 Return the name of the group is selection was successful."
1569   ;; Transform the select method into a unique server.
1570   (let ((saddr (intern (format "%s-address" (car method)))))
1571     (setq method (gnus-copy-sequence method))
1572     (require (car method))
1573     (when (boundp saddr)
1574       (unless (assq saddr method)
1575         (nconc method `((,saddr ,(cadr method))))
1576         (setf (cadr method) (format "%s-%d" (cadr method)
1577                                     (incf gnus-ephemeral-group-server))))))
1578   (let ((group (if (gnus-group-foreign-p group) group
1579                  (gnus-group-prefixed-name group method))))
1580     (gnus-sethash
1581      group
1582      `(-1 nil (,group
1583                ,gnus-level-default-subscribed nil nil ,method
1584                ((quit-config .
1585                              ,(if quit-config quit-config
1586                                 (cons gnus-summary-buffer
1587                                       gnus-current-window-configuration))))))
1588      gnus-newsrc-hashtb)
1589     (set-buffer gnus-group-buffer)
1590     (unless (gnus-check-server method)
1591       (error "Unable to contact server: %s" (gnus-status-message method)))
1592     (when activate
1593       (gnus-activate-group group 'scan)
1594       (unless (gnus-request-group group)
1595         (error "Couldn't request group: %s"
1596                (nnheader-get-report (car method)))))
1597     (if request-only
1598         group
1599       (condition-case ()
1600           (when (gnus-group-read-group t t group)
1601             group)
1602         ;;(error nil)
1603         (quit nil)))))
1604
1605 (defun gnus-group-jump-to-group (group)
1606   "Jump to newsgroup GROUP."
1607   (interactive
1608    (list (completing-read
1609           "Group: " gnus-active-hashtb nil
1610           (gnus-read-active-file-p)
1611           nil
1612           'gnus-group-history)))
1613
1614   (when (equal group "")
1615     (error "Empty group name"))
1616
1617   (unless (gnus-ephemeral-group-p group)
1618     ;; Either go to the line in the group buffer...
1619     (unless (gnus-group-goto-group group)
1620       ;; ... or insert the line.
1621       (gnus-group-update-group group)
1622       (gnus-group-goto-group group)))
1623   ;; Adjust cursor point.
1624   (gnus-group-position-point))
1625
1626 (defun gnus-group-goto-group (group &optional far)
1627   "Goto to newsgroup GROUP.
1628 If FAR, it is likely that the group is not on the current line."
1629   (when group
1630     (if far
1631         (gnus-goto-char
1632          (text-property-any
1633           (point-min) (point-max)
1634           'gnus-group (gnus-intern-safe group gnus-active-hashtb)))
1635       (beginning-of-line)
1636       (cond
1637        ;; It's quite likely that we are on the right line, so
1638        ;; we check the current line first.
1639        ((eq (get-text-property (point) 'gnus-group)
1640             (gnus-intern-safe group gnus-active-hashtb))
1641         (point))
1642        ;; Previous and next line are also likely, so we check them as well.
1643        ((save-excursion
1644           (forward-line -1)
1645           (eq (get-text-property (point) 'gnus-group)
1646               (gnus-intern-safe group gnus-active-hashtb)))
1647         (forward-line -1)
1648         (point))
1649        ((save-excursion
1650           (forward-line 1)
1651           (eq (get-text-property (point) 'gnus-group)
1652               (gnus-intern-safe group gnus-active-hashtb)))
1653         (forward-line 1)
1654         (point))
1655        (t
1656         ;; Search through the entire buffer.
1657         (gnus-goto-char
1658          (text-property-any
1659           (point-min) (point-max)
1660           'gnus-group (gnus-intern-safe group gnus-active-hashtb))))))))
1661
1662 (defun gnus-group-next-group (n &optional silent)
1663   "Go to next N'th newsgroup.
1664 If N is negative, search backward instead.
1665 Returns the difference between N and the number of skips actually
1666 done."
1667   (interactive "p")
1668   (gnus-group-next-unread-group n t nil silent))
1669
1670 (defun gnus-group-next-unread-group (n &optional all level silent)
1671   "Go to next N'th unread newsgroup.
1672 If N is negative, search backward instead.
1673 If ALL is non-nil, choose any newsgroup, unread or not.
1674 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
1675 such group can be found, the next group with a level higher than
1676 LEVEL.
1677 Returns the difference between N and the number of skips actually
1678 made."
1679   (interactive "p")
1680   (let ((backward (< n 0))
1681         (n (abs n)))
1682     (while (and (> n 0)
1683                 (gnus-group-search-forward
1684                  backward (or (not gnus-group-goto-unread) all) level))
1685       (setq n (1- n)))
1686     (when (and (/= 0 n)
1687                (not silent))
1688       (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
1689                     (if level " on this level or higher" "")))
1690     n))
1691
1692 (defun gnus-group-prev-group (n)
1693   "Go to previous N'th newsgroup.
1694 Returns the difference between N and the number of skips actually
1695 done."
1696   (interactive "p")
1697   (gnus-group-next-unread-group (- n) t))
1698
1699 (defun gnus-group-prev-unread-group (n)
1700   "Go to previous N'th unread newsgroup.
1701 Returns the difference between N and the number of skips actually
1702 done."
1703   (interactive "p")
1704   (gnus-group-next-unread-group (- n)))
1705
1706 (defun gnus-group-next-unread-group-same-level (n)
1707   "Go to next N'th unread newsgroup on the same level.
1708 If N is negative, search backward instead.
1709 Returns the difference between N and the number of skips actually
1710 done."
1711   (interactive "p")
1712   (gnus-group-next-unread-group n t (gnus-group-group-level))
1713   (gnus-group-position-point))
1714
1715 (defun gnus-group-prev-unread-group-same-level (n)
1716   "Go to next N'th unread newsgroup on the same level.
1717 Returns the difference between N and the number of skips actually
1718 done."
1719   (interactive "p")
1720   (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
1721   (gnus-group-position-point))
1722
1723 (defun gnus-group-best-unread-group (&optional exclude-group)
1724   "Go to the group with the highest level.
1725 If EXCLUDE-GROUP, do not go to that group."
1726   (interactive)
1727   (goto-char (point-min))
1728   (let ((best 100000)
1729         unread best-point)
1730     (while (not (eobp))
1731       (setq unread (get-text-property (point) 'gnus-unread))
1732       (when (and (numberp unread) (> unread 0))
1733         (when (and (get-text-property (point) 'gnus-level)
1734                    (< (get-text-property (point) 'gnus-level) best)
1735                    (or (not exclude-group)
1736                        (not (equal exclude-group (gnus-group-group-name)))))
1737           (setq best (get-text-property (point) 'gnus-level))
1738           (setq best-point (point))))
1739       (forward-line 1))
1740     (when best-point
1741       (goto-char best-point))
1742     (gnus-summary-position-point)
1743     (and best-point (gnus-group-group-name))))
1744
1745 (defun gnus-group-first-unread-group ()
1746   "Go to the first group with unread articles."
1747   (interactive)
1748   (prog1
1749       (let ((opoint (point))
1750             unread)
1751         (goto-char (point-min))
1752         (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
1753                 (and (numberp unread)   ; Not a topic.
1754                      (not (zerop unread))) ; Has unread articles.
1755                 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
1756             (point)                     ; Success.
1757           (goto-char opoint)
1758           nil))                         ; Not success.
1759     (gnus-group-position-point)))
1760
1761 (defun gnus-group-enter-server-mode ()
1762   "Jump to the server buffer."
1763   (interactive)
1764   (gnus-enter-server-buffer))
1765
1766 (defun gnus-group-make-group (name &optional method address args)
1767   "Add a new newsgroup.
1768 The user will be prompted for a NAME, for a select METHOD, and an
1769 ADDRESS."
1770   (interactive
1771    (list
1772     (gnus-read-group "Group name: ")
1773     (gnus-read-method "From method: ")))
1774
1775   (let* ((meth (when (and method
1776                           (not (gnus-server-equal method gnus-select-method)))
1777                  (if address (list (intern method) address)
1778                    method)))
1779          (nname (if method (gnus-group-prefixed-name name meth) name))
1780          backend info)
1781     (when (gnus-gethash nname gnus-newsrc-hashtb)
1782       (error "Group %s already exists" nname))
1783     ;; Subscribe to the new group.
1784     (gnus-group-change-level
1785      (setq info (list t nname gnus-level-default-subscribed nil nil meth))
1786      gnus-level-default-subscribed gnus-level-killed
1787      (and (gnus-group-group-name)
1788           (gnus-gethash (gnus-group-group-name)
1789                         gnus-newsrc-hashtb))
1790      t)
1791     ;; Make it active.
1792     (gnus-set-active nname (cons 1 0))
1793     (unless (gnus-ephemeral-group-p name)
1794       (gnus-dribble-enter
1795        (concat "(gnus-group-set-info '"
1796                (gnus-prin1-to-string (cdr info)) ")")))
1797     ;; Insert the line.
1798     (gnus-group-insert-group-line-info nname)
1799     (forward-line -1)
1800     (gnus-group-position-point)
1801
1802     ;; Load the backend and try to make the backend create
1803     ;; the group as well.
1804     (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
1805                                                   nil meth))))
1806                  gnus-valid-select-methods)
1807       (require backend))
1808     (gnus-check-server meth)
1809     (when (gnus-check-backend-function 'request-create-group nname)
1810       (gnus-request-create-group nname nil args))
1811     t))
1812
1813 (defun gnus-group-delete-group (group &optional force)
1814   "Delete the current group.  Only meaningful with mail groups.
1815 If FORCE (the prefix) is non-nil, all the articles in the group will
1816 be deleted.  This is \"deleted\" as in \"removed forever from the face
1817 of the Earth\".  There is no undo.  The user will be prompted before
1818 doing the deletion."
1819   (interactive
1820    (list (gnus-group-group-name)
1821          current-prefix-arg))
1822   (unless group
1823     (error "No group to rename"))
1824   (unless (gnus-check-backend-function 'request-delete-group group)
1825     (error "This backend does not support group deletion"))
1826   (prog1
1827       (if (not (gnus-yes-or-no-p
1828                 (format
1829                  "Do you really want to delete %s%s? "
1830                  group (if force " and all its contents" ""))))
1831           ()                            ; Whew!
1832         (gnus-message 6 "Deleting group %s..." group)
1833         (if (not (gnus-request-delete-group group force))
1834             (gnus-error 3 "Couldn't delete group %s" group)
1835           (gnus-message 6 "Deleting group %s...done" group)
1836           (gnus-group-goto-group group)
1837           (gnus-group-kill-group 1 t)
1838           (gnus-sethash group nil gnus-active-hashtb)
1839           t))
1840     (gnus-group-position-point)))
1841
1842 (defun gnus-group-rename-group (group new-name)
1843   "Rename group from GROUP to NEW-NAME.
1844 When used interactively, GROUP is the group under point
1845 and NEW-NAME will be prompted for."
1846   (interactive
1847    (list
1848     (gnus-group-group-name)
1849     (progn
1850       (unless (gnus-check-backend-function
1851                'request-rename-group (gnus-group-group-name))
1852         (error "This backend does not support renaming groups"))
1853       (gnus-read-group "Rename group to: "
1854                        (gnus-group-real-name (gnus-group-group-name))))))
1855
1856   (unless (gnus-check-backend-function 'request-rename-group group)
1857     (error "This backend does not support renaming groups"))
1858   (unless group
1859     (error "No group to rename"))
1860   (when (equal (gnus-group-real-name group) new-name)
1861     (error "Can't rename to the same name"))
1862
1863   ;; We find the proper prefixed name.
1864   (setq new-name
1865         (if (gnus-group-native-p group)
1866             ;; Native group.
1867             new-name
1868           ;; Foreign group.
1869           (gnus-group-prefixed-name
1870            (gnus-group-real-name new-name)
1871            (gnus-info-method (gnus-get-info group)))))
1872
1873   (gnus-message 6 "Renaming group %s to %s..." group new-name)
1874   (prog1
1875       (if (not (gnus-request-rename-group group new-name))
1876           (gnus-error 3 "Couldn't rename group %s to %s" group new-name)
1877         ;; We rename the group internally by killing it...
1878         (gnus-group-goto-group group)
1879         (gnus-group-kill-group)
1880         ;; ... changing its name ...
1881         (setcar (cdar gnus-list-of-killed-groups) new-name)
1882         ;; ... and then yanking it.  Magic!
1883         (gnus-group-yank-group)
1884         (gnus-set-active new-name (gnus-active group))
1885         (gnus-message 6 "Renaming group %s to %s...done" group new-name)
1886         new-name)
1887     (gnus-group-position-point)))
1888
1889 (defun gnus-group-edit-group (group &optional part)
1890   "Edit the group on the current line."
1891   (interactive (list (gnus-group-group-name)))
1892   (let ((part (or part 'info))
1893         info)
1894     (unless group
1895       (error "No group on current line"))
1896     (unless (setq info (gnus-get-info group))
1897       (error "Killed group; can't be edited"))
1898     (ignore-errors
1899       (gnus-close-group group))
1900     (gnus-edit-form
1901      ;; Find the proper form to edit.
1902      (cond ((eq part 'method)
1903             (or (gnus-info-method info) "native"))
1904            ((eq part 'params)
1905             (gnus-info-params info))
1906            (t info))
1907      ;; The proper documentation.
1908      (format
1909       "Editing the %s for `%s'."
1910       (cond
1911        ((eq part 'method) "select method")
1912        ((eq part 'params) "group parameters")
1913        (t "group info"))
1914       group)
1915      `(lambda (form)
1916         (gnus-group-edit-group-done ',part ,group form)))))
1917
1918 (defun gnus-group-edit-group-method (group)
1919   "Edit the select method of GROUP."
1920   (interactive (list (gnus-group-group-name)))
1921   (gnus-group-edit-group group 'method))
1922
1923 (defun gnus-group-edit-group-parameters (group)
1924   "Edit the group parameters of GROUP."
1925   (interactive (list (gnus-group-group-name)))
1926   (gnus-group-edit-group group 'params))
1927
1928 (defun gnus-group-edit-group-done (part group form)
1929   "Update variables."
1930   (let* ((method (cond ((eq part 'info) (nth 4 form))
1931                        ((eq part 'method) form)
1932                        (t nil)))
1933          (info (cond ((eq part 'info) form)
1934                      ((eq part 'method) (gnus-get-info group))
1935                      (t nil)))
1936          (new-group (if info
1937                         (if (or (not method)
1938                                 (gnus-server-equal
1939                                  gnus-select-method method))
1940                             (gnus-group-real-name (car info))
1941                           (gnus-group-prefixed-name
1942                            (gnus-group-real-name (car info)) method))
1943                       nil)))
1944     (when (and new-group
1945                (not (equal new-group group)))
1946       (when (gnus-group-goto-group group)
1947         (gnus-group-kill-group 1))
1948       (gnus-activate-group new-group))
1949     ;; Set the info.
1950     (if (not (and info new-group))
1951         (gnus-group-set-info form (or new-group group) part)
1952       (setq info (gnus-copy-sequence info))
1953       (setcar info new-group)
1954       (unless (gnus-server-equal method "native")
1955         (unless (nthcdr 3 info)
1956           (nconc info (list nil nil)))
1957         (unless (nthcdr 4 info)
1958           (nconc info (list nil)))
1959         (gnus-info-set-method info method))
1960       (gnus-group-set-info info))
1961     (gnus-group-update-group (or new-group group))
1962     (gnus-group-position-point)))
1963
1964 (defun gnus-group-make-useful-group (group method)
1965   (interactive
1966    (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
1967                                         nil t)
1968                        gnus-useful-groups)))
1969      (list (cadr entry) (caddr entry))))
1970   (setq method (gnus-copy-sequence method))
1971   (let (entry)
1972     (while (setq entry (memq (assq 'eval method) method))
1973       (setcar entry (eval (cadar entry)))))
1974   (gnus-group-make-group group method))
1975
1976 (defun gnus-group-make-help-group ()
1977   "Create the Gnus documentation group."
1978   (interactive)
1979   (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
1980         (file (nnheader-find-etc-directory "gnus-tut.txt" t))
1981         dir)
1982     (when (gnus-gethash name gnus-newsrc-hashtb)
1983       (error "Documentation group already exists"))
1984     (if (not file)
1985         (gnus-message 1 "Couldn't find doc group")
1986       (gnus-group-make-group
1987        (gnus-group-real-name name)
1988        (list 'nndoc "gnus-help"
1989              (list 'nndoc-address file)
1990              (list 'nndoc-article-type 'mbox)))))
1991   (gnus-group-position-point))
1992
1993 (defun gnus-group-make-doc-group (file type)
1994   "Create a group that uses a single file as the source."
1995   (interactive
1996    (list (read-file-name "File name: ")
1997          (and current-prefix-arg 'ask)))
1998   (when (eq type 'ask)
1999     (let ((err "")
2000           char found)
2001       (while (not found)
2002         (message
2003          "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [mbdfag]: "
2004          err)
2005         (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2006                           ((= char ?b) 'babyl)
2007                           ((= char ?d) 'digest)
2008                           ((= char ?f) 'forward)
2009                           ((= char ?a) 'mmfd)
2010                           (t (setq err (format "%c unknown. " char))
2011                              nil))))
2012       (setq type found)))
2013   (let* ((file (expand-file-name file))
2014          (name (gnus-generate-new-group-name
2015                 (gnus-group-prefixed-name
2016                  (file-name-nondirectory file) '(nndoc "")))))
2017     (gnus-group-make-group
2018      (gnus-group-real-name name)
2019      (list 'nndoc file
2020            (list 'nndoc-address file)
2021            (list 'nndoc-article-type (or type 'guess))))))
2022
2023 (defvar nnweb-type-definition)
2024 (defvar gnus-group-web-type-history nil)
2025 (defvar gnus-group-web-search-history nil)
2026 (defun gnus-group-make-web-group (&optional solid)
2027   "Create an ephemeral nnweb group.
2028 If SOLID (the prefix), create a solid group."
2029   (interactive "P")
2030   (require 'nnweb)
2031   (let* ((group
2032           (if solid (gnus-read-group "Group name: ")
2033             (message-unique-id)))
2034          (default-type (or (car gnus-group-web-type-history)
2035                            (symbol-name (caar nnweb-type-definition))))
2036          (type
2037           (gnus-string-or
2038            (completing-read
2039             (format "Search engine type (default %s): " default-type)
2040             (mapcar (lambda (elem) (list (symbol-name (car elem))))
2041                     nnweb-type-definition)
2042             nil t nil 'gnus-group-web-type-history)
2043            default-type))
2044          (search
2045           (read-string
2046            "Search string: "
2047            (cons (or (car gnus-group-web-search-history) "") 0)
2048            'gnus-group-web-search-history))
2049          (method
2050           `(nnweb ,group (nnweb-search ,search)
2051                   (nnweb-type ,(intern type))
2052                   (nnweb-ephemeral-p t))))
2053     (if solid
2054         (gnus-group-make-group group "nnweb" "" `(,(intern type) ,search))
2055       (gnus-group-read-ephemeral-group
2056        group method t
2057        (cons (current-buffer)
2058              (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
2059
2060 (defun gnus-group-make-archive-group (&optional all)
2061   "Create the (ding) Gnus archive group of the most recent articles.
2062 Given a prefix, create a full group."
2063   (interactive "P")
2064   (let ((group (gnus-group-prefixed-name
2065                 (if all "ding.archives" "ding.recent") '(nndir ""))))
2066     (when (gnus-gethash group gnus-newsrc-hashtb)
2067       (error "Archive group already exists"))
2068     (gnus-group-make-group
2069      (gnus-group-real-name group)
2070      (list 'nndir (if all "hpc" "edu")
2071            (list 'nndir-directory
2072                  (if all gnus-group-archive-directory
2073                    gnus-group-recent-archive-directory))))
2074     (gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
2075
2076 (defun gnus-group-make-directory-group (dir)
2077   "Create an nndir group.
2078 The user will be prompted for a directory.  The contents of this
2079 directory will be used as a newsgroup.  The directory should contain
2080 mail messages or news articles in files that have numeric names."
2081   (interactive
2082    (list (read-file-name "Create group from directory: ")))
2083   (unless (file-exists-p dir)
2084     (error "No such directory"))
2085   (unless (file-directory-p dir)
2086     (error "Not a directory"))
2087   (let ((ext "")
2088         (i 0)
2089         group)
2090     (while (or (not group) (gnus-gethash group gnus-newsrc-hashtb))
2091       (setq group
2092             (gnus-group-prefixed-name
2093              (concat (file-name-as-directory (directory-file-name dir))
2094                      ext)
2095              '(nndir "")))
2096       (setq ext (format "<%d>" (setq i (1+ i)))))
2097     (gnus-group-make-group
2098      (gnus-group-real-name group)
2099      (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
2100
2101 (defun gnus-group-make-kiboze-group (group address scores)
2102   "Create an nnkiboze group.
2103 The user will be prompted for a name, a regexp to match groups, and
2104 score file entries for articles to include in the group."
2105   (interactive
2106    (list
2107     (read-string "nnkiboze group name: ")
2108     (read-string "Source groups (regexp): ")
2109     (let ((headers (mapcar (lambda (group) (list group))
2110                            '("subject" "from" "number" "date" "message-id"
2111                              "references" "chars" "lines" "xref"
2112                              "followup" "all" "body" "head")))
2113           scores header regexp regexps)
2114       (while (not (equal "" (setq header (completing-read
2115                                           "Match on header: " headers nil t))))
2116         (setq regexps nil)
2117         (while (not (equal "" (setq regexp (read-string
2118                                             (format "Match on %s (string): "
2119                                                     header)))))
2120           (push (list regexp nil nil 'r) regexps))
2121         (push (cons header regexps) scores))
2122       scores)))
2123   (gnus-group-make-group group "nnkiboze" address)
2124   (nnheader-temp-write (gnus-score-file-name (concat "nnkiboze:" group))
2125     (let (emacs-lisp-mode-hook)
2126       (pp scores (current-buffer)))))
2127
2128 (defun gnus-group-add-to-virtual (n vgroup)
2129   "Add the current group to a virtual group."
2130   (interactive
2131    (list current-prefix-arg
2132          (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
2133                           "nnvirtual:")))
2134   (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
2135     (error "%s is not an nnvirtual group" vgroup))
2136   (gnus-close-group vgroup)
2137   (let* ((groups (gnus-group-process-prefix n))
2138          (method (gnus-info-method (gnus-get-info vgroup))))
2139     (setcar (cdr method)
2140             (concat
2141              (nth 1 method) "\\|"
2142              (mapconcat
2143               (lambda (s)
2144                 (gnus-group-remove-mark s)
2145                 (concat "\\(^" (regexp-quote s) "$\\)"))
2146               groups "\\|"))))
2147   (gnus-group-position-point))
2148
2149 (defun gnus-group-make-empty-virtual (group)
2150   "Create a new, fresh, empty virtual group."
2151   (interactive "sCreate new, empty virtual group: ")
2152   (let* ((method (list 'nnvirtual "^$"))
2153          (pgroup (gnus-group-prefixed-name group method)))
2154     ;; Check whether it exists already.
2155     (when (gnus-gethash pgroup gnus-newsrc-hashtb)
2156       (error "Group %s already exists" pgroup))
2157     ;; Subscribe the new group after the group on the current line.
2158     (gnus-subscribe-group pgroup (gnus-group-group-name) method)
2159     (gnus-group-update-group pgroup)
2160     (forward-line -1)
2161     (gnus-group-position-point)))
2162
2163 (defun gnus-group-enter-directory (dir)
2164   "Enter an ephemeral nneething group."
2165   (interactive "DDirectory to read: ")
2166   (let* ((method (list 'nneething dir '(nneething-read-only t)))
2167          (leaf (gnus-group-prefixed-name
2168                 (file-name-nondirectory (directory-file-name dir))
2169                 method))
2170          (name (gnus-generate-new-group-name leaf)))
2171     (unless (gnus-group-read-ephemeral-group
2172              name method t
2173              (cons (current-buffer)
2174                    (if (eq major-mode 'gnus-summary-mode)
2175                        'summary 'group)))
2176       (error "Couldn't enter %s" dir))))
2177
2178 ;; Group sorting commands
2179 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
2180
2181 (defun gnus-group-sort-groups (func &optional reverse)
2182   "Sort the group buffer according to FUNC.
2183 When used interactively, the sorting function used will be
2184 determined by the `gnus-group-sort-function' variable.
2185 If REVERSE (the prefix), reverse the sorting order."
2186   (interactive (list gnus-group-sort-function current-prefix-arg))
2187   (funcall gnus-group-sort-alist-function
2188            (gnus-make-sort-function func) reverse)
2189   (gnus-group-list-groups)
2190   (gnus-dribble-touch))
2191
2192 (defun gnus-group-sort-flat (func reverse)
2193   ;; We peel off the dummy group from the alist.
2194   (when func
2195     (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
2196       (pop gnus-newsrc-alist))
2197     ;; Do the sorting.
2198     (setq gnus-newsrc-alist
2199           (sort gnus-newsrc-alist func))
2200     (when reverse
2201       (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
2202     ;; Regenerate the hash table.
2203     (gnus-make-hashtable-from-newsrc-alist)))
2204
2205 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
2206   "Sort the group buffer alphabetically by group name.
2207 If REVERSE, sort in reverse order."
2208   (interactive "P")
2209   (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
2210
2211 (defun gnus-group-sort-groups-by-unread (&optional reverse)
2212   "Sort the group buffer by number of unread articles.
2213 If REVERSE, sort in reverse order."
2214   (interactive "P")
2215   (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
2216
2217 (defun gnus-group-sort-groups-by-level (&optional reverse)
2218   "Sort the group buffer by group level.
2219 If REVERSE, sort in reverse order."
2220   (interactive "P")
2221   (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
2222
2223 (defun gnus-group-sort-groups-by-score (&optional reverse)
2224   "Sort the group buffer by group score.
2225 If REVERSE, sort in reverse order."
2226   (interactive "P")
2227   (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
2228
2229 (defun gnus-group-sort-groups-by-rank (&optional reverse)
2230   "Sort the group buffer by group rank.
2231 If REVERSE, sort in reverse order."
2232   (interactive "P")
2233   (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
2234
2235 (defun gnus-group-sort-groups-by-method (&optional reverse)
2236   "Sort the group buffer alphabetically by backend name.
2237 If REVERSE, sort in reverse order."
2238   (interactive "P")
2239   (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
2240
2241 ;;; Selected group sorting.
2242
2243 (defun gnus-group-sort-selected-groups (n func &optional reverse)
2244   "Sort the process/prefixed groups."
2245   (interactive (list current-prefix-arg gnus-group-sort-function))
2246   (let ((groups (gnus-group-process-prefix n)))
2247     (funcall gnus-group-sort-selected-function
2248              groups (gnus-make-sort-function func) reverse)
2249     (gnus-group-list-groups)))
2250
2251 (defun gnus-group-sort-selected-flat (groups func reverse)
2252   (let (entries infos)
2253     ;; First find all the group entries for these groups.
2254     (while groups
2255       (push (nthcdr 2 (gnus-gethash (pop groups) gnus-newsrc-hashtb))
2256             entries))
2257     ;; Then sort the infos.
2258     (setq infos
2259           (sort
2260            (mapcar
2261             (lambda (entry) (car entry))
2262             (setq entries (nreverse entries)))
2263            func))
2264     (when reverse
2265       (setq infos (nreverse infos)))
2266     ;; Go through all the infos and replace the old entries
2267     ;; with the new infos.
2268     (while infos
2269       (setcar entries (pop infos))
2270       (pop entries))
2271     ;; Update the hashtable.
2272     (gnus-make-hashtable-from-newsrc-alist)))
2273
2274 (defun gnus-group-sort-selected-groups-by-alphabet (&optional reverse)
2275   "Sort the group buffer alphabetically by group name.
2276 If REVERSE, sort in reverse order."
2277   (interactive "P")
2278   (gnus-group-sort-selected-groups 'gnus-group-sort-by-alphabet reverse))
2279
2280 (defun gnus-group-sort-selected-groups-by-unread (&optional reverse)
2281   "Sort the group buffer by number of unread articles.
2282 If REVERSE, sort in reverse order."
2283   (interactive "P")
2284   (gnus-group-sort-selected-groups 'gnus-group-sort-by-unread reverse))
2285
2286 (defun gnus-group-sort-selected-groups-by-level (&optional reverse)
2287   "Sort the group buffer by group level.
2288 If REVERSE, sort in reverse order."
2289   (interactive "P")
2290   (gnus-group-sort-selected-groups 'gnus-group-sort-by-level reverse))
2291
2292 (defun gnus-group-sort-selected-groups-by-score (&optional reverse)
2293   "Sort the group buffer by group score.
2294 If REVERSE, sort in reverse order."
2295   (interactive "P")
2296   (gnus-group-sort-selected-groups 'gnus-group-sort-by-score reverse))
2297
2298 (defun gnus-group-sort-selected-groups-by-rank (&optional reverse)
2299   "Sort the group buffer by group rank.
2300 If REVERSE, sort in reverse order."
2301   (interactive "P")
2302   (gnus-group-sort-selected-groups 'gnus-group-sort-by-rank reverse))
2303
2304 (defun gnus-group-sort-selected-groups-by-method (&optional reverse)
2305   "Sort the group buffer alphabetically by backend name.
2306 If REVERSE, sort in reverse order."
2307   (interactive "P")
2308   (gnus-group-sort-selected-groups 'gnus-group-sort-by-method reverse))
2309
2310 ;;; Sorting predicates.
2311
2312 (defun gnus-group-sort-by-alphabet (info1 info2)
2313   "Sort alphabetically."
2314   (string< (gnus-info-group info1) (gnus-info-group info2)))
2315
2316 (defun gnus-group-sort-by-real-name (info1 info2)
2317   "Sort alphabetically on real (unprefixed) names."
2318   (string< (gnus-group-real-name (gnus-info-group info1))
2319            (gnus-group-real-name (gnus-info-group info2))))
2320
2321 (defun gnus-group-sort-by-unread (info1 info2)
2322   "Sort by number of unread articles."
2323   (let ((n1 (car (gnus-gethash (gnus-info-group info1) gnus-newsrc-hashtb)))
2324         (n2 (car (gnus-gethash (gnus-info-group info2) gnus-newsrc-hashtb))))
2325     (< (or (and (numberp n1) n1) 0)
2326        (or (and (numberp n2) n2) 0))))
2327
2328 (defun gnus-group-sort-by-level (info1 info2)
2329   "Sort by level."
2330   (< (gnus-info-level info1) (gnus-info-level info2)))
2331
2332 (defun gnus-group-sort-by-method (info1 info2)
2333   "Sort alphabetically by backend name."
2334   (string< (symbol-name (car (gnus-find-method-for-group
2335                               (gnus-info-group info1) info1)))
2336            (symbol-name (car (gnus-find-method-for-group
2337                               (gnus-info-group info2) info2)))))
2338
2339 (defun gnus-group-sort-by-score (info1 info2)
2340   "Sort by group score."
2341   (< (gnus-info-score info1) (gnus-info-score info2)))
2342
2343 (defun gnus-group-sort-by-rank (info1 info2)
2344   "Sort by level and score."
2345   (let ((level1 (gnus-info-level info1))
2346         (level2 (gnus-info-level info2)))
2347     (or (< level1 level2)
2348         (and (= level1 level2)
2349              (> (gnus-info-score info1) (gnus-info-score info2))))))
2350
2351 ;;; Clearing data
2352
2353 (defun gnus-group-clear-data (&optional arg)
2354   "Clear all marks and read ranges from the current group."
2355   (interactive "P")
2356   (gnus-group-iterate arg
2357     (lambda (group)
2358       (let (info)
2359         (gnus-info-clear-data (setq info (gnus-get-info group)))
2360         (gnus-get-unread-articles-in-group info (gnus-active group) t)
2361         (when (gnus-group-goto-group group)
2362           (gnus-group-update-group-line))))))
2363
2364 (defun gnus-group-clear-data-on-native-groups ()
2365   "Clear all marks and read ranges from all native groups."
2366   (interactive)
2367   (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
2368     (let ((alist (cdr gnus-newsrc-alist))
2369           info)
2370       (while (setq info (pop alist))
2371         (when (gnus-group-native-p (gnus-info-group info))
2372           (gnus-info-clear-data info)))
2373       (gnus-get-unread-articles)
2374       (gnus-dribble-enter "")
2375       (when (gnus-y-or-n-p
2376              "Move the cache away to avoid problems in the future? ")
2377         (call-interactively 'gnus-cache-move-cache)))))
2378
2379 (defun gnus-info-clear-data (info)
2380   "Clear all marks and read ranges from INFO."
2381   (let ((group (gnus-info-group info)))
2382     (gnus-undo-register
2383       `(progn
2384          (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
2385          (gnus-info-set-read ',info ',(gnus-info-read info))
2386          (when (gnus-group-goto-group ,group)
2387            (gnus-group-update-group-line))))
2388     (gnus-info-set-read info nil)
2389     (when (gnus-info-marks info)
2390       (gnus-info-set-marks info nil))))
2391
2392 ;; Group catching up.
2393
2394 (defun gnus-group-catchup-current (&optional n all)
2395   "Mark all articles not marked as unread in current newsgroup as read.
2396 If prefix argument N is numeric, the ARG next newsgroups will be
2397 caught up.  If ALL is non-nil, marked articles will also be marked as
2398 read.  Cross references (Xref: header) of articles are ignored.
2399 The difference between N and actual number of newsgroups that were
2400 caught up is returned."
2401   (interactive "P")
2402   (unless (gnus-group-group-name)
2403     (error "No group on the current line"))
2404   (let ((groups (gnus-group-process-prefix n))
2405         (ret 0))
2406     (if (not
2407          (or (not gnus-interactive-catchup) ;Without confirmation?
2408              gnus-expert-user
2409              (gnus-y-or-n-p
2410               (format
2411                (if all
2412                    "Do you really want to mark all articles in %s as read? "
2413                  "Mark all unread articles in %s as read? ")
2414                (if (= (length groups) 1)
2415                    (car groups)
2416                  (format "these %d groups" (length groups)))))))
2417         n
2418       (while groups
2419         ;; Virtual groups have to be given special treatment.
2420         (let ((method (gnus-find-method-for-group (car groups))))
2421           (when (eq 'nnvirtual (car method))
2422             (nnvirtual-catchup-group
2423              (gnus-group-real-name (car groups)) (nth 1 method) all)))
2424         (gnus-group-remove-mark (car groups))
2425         (if (>= (gnus-group-group-level) gnus-level-zombie)
2426             (gnus-message 2 "Dead groups can't be caught up")
2427           (if (prog1
2428                   (gnus-group-goto-group (car groups))
2429                 (gnus-group-catchup (car groups) all))
2430               (gnus-group-update-group-line)
2431             (setq ret (1+ ret))))
2432         (setq groups (cdr groups)))
2433       (gnus-group-next-unread-group 1)
2434       ret)))
2435
2436 (defun gnus-group-catchup-current-all (&optional n)
2437   "Mark all articles in current newsgroup as read.
2438 Cross references (Xref: header) of articles are ignored."
2439   (interactive "P")
2440   (gnus-group-catchup-current n 'all))
2441
2442 (defun gnus-group-catchup (group &optional all)
2443   "Mark all articles in GROUP as read.
2444 If ALL is non-nil, all articles are marked as read.
2445 The return value is the number of articles that were marked as read,
2446 or nil if no action could be taken."
2447   (let* ((entry (gnus-gethash group gnus-newsrc-hashtb))
2448          (num (car entry)))
2449     ;; Do the updating only if the newsgroup isn't killed.
2450     (if (not (numberp (car entry)))
2451         (gnus-message 1 "Can't catch up %s; non-active group" group)
2452       ;; Do auto-expirable marks if that's required.
2453       (when (gnus-group-auto-expirable-p group)
2454         (gnus-add-marked-articles
2455          group 'expire (gnus-list-of-unread-articles group))
2456         (when all
2457           (let ((marks (nth 3 (nth 2 entry))))
2458             (gnus-add-marked-articles
2459              group 'expire (gnus-uncompress-range (cdr (assq 'tick marks))))
2460             (gnus-add-marked-articles
2461              group 'expire (gnus-uncompress-range (cdr (assq 'tick marks)))))))
2462       (when entry
2463         (gnus-update-read-articles group nil)
2464         ;; Also nix out the lists of marks and dormants.
2465         (when all
2466           (gnus-add-marked-articles group 'tick nil nil 'force)
2467           (gnus-add-marked-articles group 'dormant nil nil 'force))
2468         (let ((gnus-newsgroup-name group))
2469           (run-hooks 'gnus-group-catchup-group-hook))
2470         num))))
2471
2472 (defun gnus-group-expire-articles (&optional n)
2473   "Expire all expirable articles in the current newsgroup."
2474   (interactive "P")
2475   (let ((groups (gnus-group-process-prefix n))
2476         group)
2477     (unless groups
2478       (error "No groups to expire"))
2479     (while (setq group (pop groups))
2480       (gnus-group-remove-mark group)
2481       (when (gnus-check-backend-function 'request-expire-articles group)
2482         (gnus-message 6 "Expiring articles in %s..." group)
2483         (let* ((info (gnus-get-info group))
2484                (expirable (if (gnus-group-total-expirable-p group)
2485                               (cons nil (gnus-list-of-read-articles group))
2486                             (assq 'expire (gnus-info-marks info))))
2487                (expiry-wait (gnus-group-find-parameter group 'expiry-wait)))
2488           (when expirable
2489             (setcdr
2490              expirable
2491              (gnus-compress-sequence
2492               (if expiry-wait
2493                   ;; We set the expiry variables to the group
2494                   ;; parameter.
2495                   (let ((nnmail-expiry-wait-function nil)
2496                         (nnmail-expiry-wait expiry-wait))
2497                     (gnus-request-expire-articles
2498                      (gnus-uncompress-sequence (cdr expirable)) group))
2499                 ;; Just expire using the normal expiry values.
2500                 (gnus-request-expire-articles
2501                  (gnus-uncompress-sequence (cdr expirable)) group))))
2502             (gnus-close-group group))
2503           (gnus-message 6 "Expiring articles in %s...done" group)))
2504       (gnus-dribble-touch)
2505       (gnus-group-position-point))))
2506
2507 (defun gnus-group-expire-all-groups ()
2508   "Expire all expirable articles in all newsgroups."
2509   (interactive)
2510   (save-excursion
2511     (gnus-message 5 "Expiring...")
2512     (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
2513                                      (cdr gnus-newsrc-alist))))
2514       (gnus-group-expire-articles nil)))
2515   (gnus-group-position-point)
2516   (gnus-message 5 "Expiring...done"))
2517
2518 (defun gnus-group-set-current-level (n level)
2519   "Set the level of the next N groups to LEVEL."
2520   (interactive
2521    (list
2522     current-prefix-arg
2523     (string-to-int
2524      (let ((s (read-string
2525                (format "Level (default %s): "
2526                        (or (gnus-group-group-level)
2527                            gnus-level-default-subscribed)))))
2528        (if (string-match "^\\s-*$" s)
2529            (int-to-string (or (gnus-group-group-level)
2530                               gnus-level-default-subscribed))
2531          s)))))
2532   (unless (and (>= level 1) (<= level gnus-level-killed))
2533     (error "Illegal level: %d" level))
2534   (let ((groups (gnus-group-process-prefix n))
2535         group)
2536     (while (setq group (pop groups))
2537       (gnus-group-remove-mark group)
2538       (gnus-message 6 "Changed level of %s from %d to %d"
2539                     group (or (gnus-group-group-level) gnus-level-killed)
2540                     level)
2541       (gnus-group-change-level
2542        group level (or (gnus-group-group-level) gnus-level-killed))
2543       (gnus-group-update-group-line)))
2544   (gnus-group-position-point))
2545
2546 (defun gnus-group-unsubscribe (&optional n)
2547   "Unsubscribe the current group."
2548   (interactive "P")
2549   (gnus-group-unsubscribe-current-group n 'unsubscribe))
2550
2551 (defun gnus-group-subscribe (&optional n)
2552   "Subscribe the current group."
2553   (interactive "P")
2554   (gnus-group-unsubscribe-current-group n 'subscribe))
2555
2556 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
2557   "Toggle subscription of the current group.
2558 If given numerical prefix, toggle the N next groups."
2559   (interactive "P")
2560   (let ((groups (gnus-group-process-prefix n))
2561         group)
2562     (while groups
2563       (setq group (car groups)
2564             groups (cdr groups))
2565       (gnus-group-remove-mark group)
2566       (gnus-group-unsubscribe-group
2567        group
2568        (cond
2569         ((eq do-sub 'unsubscribe)
2570          gnus-level-default-unsubscribed)
2571         ((eq do-sub 'subscribe)
2572          gnus-level-default-subscribed)
2573         ((<= (gnus-group-group-level) gnus-level-subscribed)
2574          gnus-level-default-unsubscribed)
2575         (t
2576          gnus-level-default-subscribed))
2577        t)
2578       (gnus-group-update-group-line))
2579     (gnus-group-next-group 1)))
2580
2581 (defun gnus-group-unsubscribe-group (group &optional level silent)
2582   "Toggle subscription to GROUP.
2583 Killed newsgroups are subscribed.  If SILENT, don't try to update the
2584 group line."
2585   (interactive
2586    (list (completing-read
2587           "Group: " gnus-active-hashtb nil
2588           (gnus-read-active-file-p)
2589           nil
2590           'gnus-group-history)))
2591   (let ((newsrc (gnus-gethash group gnus-newsrc-hashtb)))
2592     (cond
2593      ((string-match "^[ \t]$" group)
2594       (error "Empty group name"))
2595      (newsrc
2596       ;; Toggle subscription flag.
2597       (gnus-group-change-level
2598        newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
2599                                       gnus-level-subscribed)
2600                                   (1+ gnus-level-subscribed)
2601                                 gnus-level-default-subscribed)))
2602       (unless silent
2603         (gnus-group-update-group group)))
2604      ((and (stringp group)
2605            (or (not (gnus-read-active-file-p))
2606                (gnus-active group)))
2607       ;; Add new newsgroup.
2608       (gnus-group-change-level
2609        group
2610        (if level level gnus-level-default-subscribed)
2611        (or (and (member group gnus-zombie-list)
2612                 gnus-level-zombie)
2613            gnus-level-killed)
2614        (when (gnus-group-group-name)
2615          (gnus-gethash (gnus-group-group-name) gnus-newsrc-hashtb)))
2616       (unless silent
2617         (gnus-group-update-group group)))
2618      (t (error "No such newsgroup: %s" group)))
2619     (gnus-group-position-point)))
2620
2621 (defun gnus-group-transpose-groups (n)
2622   "Move the current newsgroup up N places.
2623 If given a negative prefix, move down instead.  The difference between
2624 N and the number of steps taken is returned."
2625   (interactive "p")
2626   (unless (gnus-group-group-name)
2627     (error "No group on current line"))
2628   (gnus-group-kill-group 1)
2629   (prog1
2630       (forward-line (- n))
2631     (gnus-group-yank-group)
2632     (gnus-group-position-point)))
2633
2634 (defun gnus-group-kill-all-zombies ()
2635   "Kill all zombie newsgroups."
2636   (interactive)
2637   (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
2638   (setq gnus-zombie-list nil)
2639   (gnus-dribble-touch)
2640   (gnus-group-list-groups))
2641
2642 (defun gnus-group-kill-region (begin end)
2643   "Kill newsgroups in current region (excluding current point).
2644 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
2645   (interactive "r")
2646   (let ((lines
2647          ;; Count lines.
2648          (save-excursion
2649            (count-lines
2650             (progn
2651               (goto-char begin)
2652               (beginning-of-line)
2653               (point))
2654             (progn
2655               (goto-char end)
2656               (beginning-of-line)
2657               (point))))))
2658     (goto-char begin)
2659     (beginning-of-line)                 ;Important when LINES < 1
2660     (gnus-group-kill-group lines)))
2661
2662 (defun gnus-group-kill-group (&optional n discard)
2663   "Kill the next N groups.
2664 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
2665 However, only groups that were alive can be yanked; already killed
2666 groups or zombie groups can't be yanked.
2667 The return value is the name of the group that was killed, or a list
2668 of groups killed."
2669   (interactive "P")
2670   (let ((buffer-read-only nil)
2671         (groups (gnus-group-process-prefix n))
2672         group entry level out)
2673     (if (< (length groups) 10)
2674         ;; This is faster when there are few groups.
2675         (while groups
2676           (push (setq group (pop groups)) out)
2677           (gnus-group-remove-mark group)
2678           (setq level (gnus-group-group-level))
2679           (gnus-delete-line)
2680           (when (and (not discard)
2681                      (setq entry (gnus-gethash group gnus-newsrc-hashtb)))
2682             (gnus-undo-register
2683               `(progn
2684                  (gnus-group-goto-group ,(gnus-group-group-name))
2685                  (gnus-group-yank-group)))
2686             (push (cons (car entry) (nth 2 entry))
2687                   gnus-list-of-killed-groups))
2688           (gnus-group-change-level
2689            (if entry entry group) gnus-level-killed (if entry nil level)))
2690       ;; If there are lots and lots of groups to be killed, we use
2691       ;; this thing instead.
2692       (let (entry)
2693         (setq groups (nreverse groups))
2694         (while groups
2695           (gnus-group-remove-mark (setq group (pop groups)))
2696           (gnus-delete-line)
2697           (push group gnus-killed-list)
2698           (setq gnus-newsrc-alist
2699                 (delq (assoc group gnus-newsrc-alist)
2700                       gnus-newsrc-alist))
2701           (when gnus-group-change-level-function
2702             (funcall gnus-group-change-level-function group 9 3))
2703           (cond
2704            ((setq entry (gnus-gethash group gnus-newsrc-hashtb))
2705             (push (cons (car entry) (nth 2 entry))
2706                   gnus-list-of-killed-groups)
2707             (setcdr (cdr entry) (cdddr entry)))
2708            ((member group gnus-zombie-list)
2709             (setq gnus-zombie-list (delete group gnus-zombie-list)))))
2710         (gnus-make-hashtable-from-newsrc-alist)))
2711
2712     (gnus-group-position-point)
2713     (if (< (length out) 2) (car out) (nreverse out))))
2714
2715 (defun gnus-group-yank-group (&optional arg)
2716   "Yank the last newsgroups killed with \\[gnus-group-kill-group],
2717 inserting it before the current newsgroup.  The numeric ARG specifies
2718 how many newsgroups are to be yanked.  The name of the newsgroup yanked
2719 is returned, or (if several groups are yanked) a list of yanked groups
2720 is returned."
2721   (interactive "p")
2722   (setq arg (or arg 1))
2723   (let (info group prev out)
2724     (while (>= (decf arg) 0)
2725       (when (not (setq info (pop gnus-list-of-killed-groups)))
2726         (error "No more newsgroups to yank"))
2727       (push (setq group (nth 1 info)) out)
2728       ;; Find which newsgroup to insert this one before - search
2729       ;; backward until something suitable is found.  If there are no
2730       ;; other newsgroups in this buffer, just make this newsgroup the
2731       ;; first newsgroup.
2732       (setq prev (gnus-group-group-name))
2733       (gnus-group-change-level
2734        info (gnus-info-level (cdr info)) gnus-level-killed
2735        (and prev (gnus-gethash prev gnus-newsrc-hashtb))
2736        t)
2737       (gnus-group-insert-group-line-info group)
2738       (gnus-undo-register
2739         `(when (gnus-group-goto-group ,group)
2740            (gnus-group-kill-group 1))))
2741     (forward-line -1)
2742     (gnus-group-position-point)
2743     (if (< (length out) 2) (car out) (nreverse out))))
2744
2745 (defun gnus-group-kill-level (level)
2746   "Kill all groups that is on a certain LEVEL."
2747   (interactive "nKill all groups on level: ")
2748   (cond
2749    ((= level gnus-level-zombie)
2750     (setq gnus-killed-list
2751           (nconc gnus-zombie-list gnus-killed-list))
2752     (setq gnus-zombie-list nil))
2753    ((and (< level gnus-level-zombie)
2754          (> level 0)
2755          (or gnus-expert-user
2756              (gnus-yes-or-no-p
2757               (format
2758                "Do you really want to kill all groups on level %d? "
2759                level))))
2760     (let* ((prev gnus-newsrc-alist)
2761            (alist (cdr prev)))
2762       (while alist
2763         (if (= (gnus-info-level (car alist)) level)
2764             (progn
2765               (push (gnus-info-group (car alist)) gnus-killed-list)
2766               (setcdr prev (cdr alist)))
2767           (setq prev alist))
2768         (setq alist (cdr alist)))
2769       (gnus-make-hashtable-from-newsrc-alist)
2770       (gnus-group-list-groups)))
2771    (t
2772     (error "Can't kill; illegal level: %d" level))))
2773
2774 (defun gnus-group-list-all-groups (&optional arg)
2775   "List all newsgroups with level ARG or lower.
2776 Default is gnus-level-unsubscribed, which lists all subscribed and most
2777 unsubscribed groups."
2778   (interactive "P")
2779   (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
2780
2781 ;; Redefine this to list ALL killed groups if prefix arg used.
2782 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
2783 (defun gnus-group-list-killed (&optional arg)
2784   "List all killed newsgroups in the group buffer.
2785 If ARG is non-nil, list ALL killed groups known to Gnus.  This may
2786 entail asking the server for the groups."
2787   (interactive "P")
2788   ;; Find all possible killed newsgroups if arg.
2789   (when arg
2790     (gnus-get-killed-groups))
2791   (if (not gnus-killed-list)
2792       (gnus-message 6 "No killed groups")
2793     (let (gnus-group-list-mode)
2794       (funcall gnus-group-prepare-function
2795                gnus-level-killed t gnus-level-killed))
2796     (goto-char (point-min)))
2797   (gnus-group-position-point))
2798
2799 (defun gnus-group-list-zombies ()
2800   "List all zombie newsgroups in the group buffer."
2801   (interactive)
2802   (if (not gnus-zombie-list)
2803       (gnus-message 6 "No zombie groups")
2804     (let (gnus-group-list-mode)
2805       (funcall gnus-group-prepare-function
2806                gnus-level-zombie t gnus-level-zombie))
2807     (goto-char (point-min)))
2808   (gnus-group-position-point))
2809
2810 (defun gnus-group-list-active ()
2811   "List all groups that are available from the server(s)."
2812   (interactive)
2813   ;; First we make sure that we have really read the active file.
2814   (unless (gnus-read-active-file-p)
2815     (let ((gnus-read-active-file t))
2816       (gnus-read-active-file)))
2817   ;; Find all groups and sort them.
2818   (let ((groups
2819          (sort
2820           (let (list)
2821             (mapatoms
2822              (lambda (sym)
2823                (and (boundp sym)
2824                     (symbol-value sym)
2825                     (push (symbol-name sym) list)))
2826              gnus-active-hashtb)
2827             list)
2828           'string<))
2829         (buffer-read-only nil)
2830         group)
2831     (erase-buffer)
2832     (while groups
2833       (gnus-add-text-properties
2834        (point) (prog1 (1+ (point))
2835                  (insert "       *: "
2836                          (setq group (pop groups)) "\n"))
2837        (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
2838              'gnus-unread t
2839              'gnus-level (inline (gnus-group-level group)))))
2840     (goto-char (point-min))))
2841
2842 (defun gnus-activate-all-groups (level)
2843   "Activate absolutely all groups."
2844   (interactive (list 7))
2845   (let ((gnus-activate-level level)
2846         (gnus-activate-foreign-newsgroups level))
2847     (gnus-group-get-new-news)))
2848
2849 (defun gnus-group-get-new-news (&optional arg)
2850   "Get newly arrived articles.
2851 If ARG is a number, it specifies which levels you are interested in
2852 re-scanning.  If ARG is non-nil and not a number, this will force
2853 \"hard\" re-reading of the active files from all servers."
2854   (interactive "P")
2855   (let ((gnus-inhibit-demon t))
2856     (run-hooks 'gnus-get-new-news-hook)
2857
2858     ;; Read any slave files.
2859     (unless gnus-slave
2860       (gnus-master-read-slave-newsrc))
2861
2862     ;; We might read in new NoCeM messages here.
2863     (when (and gnus-use-nocem
2864                (null arg))
2865       (gnus-nocem-scan-groups))
2866     ;; If ARG is not a number, then we read the active file.
2867     (when (and arg (not (numberp arg)))
2868       (let ((gnus-read-active-file t))
2869         (gnus-read-active-file))
2870       (setq arg nil)
2871
2872       ;; If the user wants it, we scan for new groups.
2873       (when (eq gnus-check-new-newsgroups 'always)
2874         (gnus-find-new-newsgroups)))
2875
2876     (setq arg (gnus-group-default-level arg t))
2877     (if (and gnus-read-active-file (not arg))
2878         (progn
2879           (gnus-read-active-file)
2880           (gnus-get-unread-articles arg))
2881       (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
2882         (gnus-get-unread-articles arg)))
2883     (run-hooks 'gnus-after-getting-new-news-hook)
2884     (gnus-group-list-groups (and (numberp arg)
2885                                  (max (car gnus-group-list-mode) arg)))))
2886
2887 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
2888   "Check for newly arrived news in the current group (and the N-1 next groups).
2889 The difference between N and the number of newsgroup checked is returned.
2890 If N is negative, this group and the N-1 previous groups will be checked."
2891   (interactive "P")
2892   (let* ((groups (gnus-group-process-prefix n))
2893          (ret (if (numberp n) (- n (length groups)) 0))
2894          (beg (unless n
2895                 (point)))
2896          group)
2897     (while (setq group (pop groups))
2898       (gnus-group-remove-mark group)
2899       ;; Bypass any previous denials from the server.
2900       (gnus-remove-denial (gnus-find-method-for-group group))
2901       (if (gnus-activate-group group (if dont-scan nil 'scan))
2902           (progn
2903             (gnus-get-unread-articles-in-group
2904              (gnus-get-info group) (gnus-active group) t)
2905             (unless (gnus-virtual-group-p group)
2906               (gnus-close-group group))
2907             (gnus-group-update-group group))
2908         (if (eq (gnus-server-status (gnus-find-method-for-group group))
2909                 'denied)
2910             (gnus-error 3 "Server denied access")
2911           (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
2912     (when beg
2913       (goto-char beg))
2914     (when gnus-goto-next-group-when-activating
2915       (gnus-group-next-unread-group 1 t))
2916     (gnus-summary-position-point)
2917     ret))
2918
2919 (defun gnus-group-fetch-faq (group &optional faq-dir)
2920   "Fetch the FAQ for the current group.
2921 If given a prefix argument, prompt for the FAQ dir
2922 to use."
2923   (interactive
2924    (list
2925     (gnus-group-group-name)
2926     (when current-prefix-arg
2927       (completing-read
2928        "Faq dir: " (and (listp gnus-group-faq-directory)
2929                         (mapcar (lambda (file) (list file))
2930                                 gnus-group-faq-directory))))))
2931   (unless group
2932     (error "No group name given"))
2933   (let ((dirs (or faq-dir gnus-group-faq-directory))
2934         dir found file)
2935     (unless (listp dirs)
2936       (setq dirs (list dirs)))
2937     (while (and (not found)
2938                 (setq dir (pop dirs)))
2939       (setq file (concat (file-name-as-directory dir)
2940                          (gnus-group-real-name group)))
2941       (if (not (file-exists-p file))
2942           (gnus-message 1 "No such file: %s" file)
2943         (let ((enable-local-variables nil))
2944           (find-file file)
2945           (setq found t))))))
2946
2947 (defun gnus-group-describe-group (force &optional group)
2948   "Display a description of the current newsgroup."
2949   (interactive (list current-prefix-arg (gnus-group-group-name)))
2950   (let* ((method (gnus-find-method-for-group group))
2951          (mname (gnus-group-prefixed-name "" method))
2952          desc)
2953     (when (and force
2954                gnus-description-hashtb)
2955       (gnus-sethash mname nil gnus-description-hashtb))
2956     (unless group
2957       (error "No group name given"))
2958     (when (or (and gnus-description-hashtb
2959                    ;; We check whether this group's method has been
2960                    ;; queried for a description file.
2961                    (gnus-gethash mname gnus-description-hashtb))
2962               (setq desc (gnus-group-get-description group))
2963               (gnus-read-descriptions-file method))
2964       (gnus-message 1
2965                     (or desc (gnus-gethash group gnus-description-hashtb)
2966                         "No description available")))))
2967
2968 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
2969 (defun gnus-group-describe-all-groups (&optional force)
2970   "Pop up a buffer with descriptions of all newsgroups."
2971   (interactive "P")
2972   (when force
2973     (setq gnus-description-hashtb nil))
2974   (when (not (or gnus-description-hashtb
2975                  (gnus-read-all-descriptions-files)))
2976     (error "Couldn't request descriptions file"))
2977   (let ((buffer-read-only nil)
2978         b)
2979     (erase-buffer)
2980     (mapatoms
2981      (lambda (group)
2982        (setq b (point))
2983        (insert (format "      *: %-20s %s\n" (symbol-name group)
2984                        (symbol-value group)))
2985        (gnus-add-text-properties
2986         b (1+ b) (list 'gnus-group group
2987                        'gnus-unread t 'gnus-marked nil
2988                        'gnus-level (1+ gnus-level-subscribed))))
2989      gnus-description-hashtb)
2990     (goto-char (point-min))
2991     (gnus-group-position-point)))
2992
2993 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
2994 (defun gnus-group-apropos (regexp &optional search-description)
2995   "List all newsgroups that have names that match a regexp."
2996   (interactive "sGnus apropos (regexp): ")
2997   (let ((prev "")
2998         (obuf (current-buffer))
2999         groups des)
3000     ;; Go through all newsgroups that are known to Gnus.
3001     (mapatoms
3002      (lambda (group)
3003        (and (symbol-name group)
3004             (string-match regexp (symbol-name group))
3005             (push (symbol-name group) groups)))
3006      gnus-active-hashtb)
3007     ;; Also go through all descriptions that are known to Gnus.
3008     (when search-description
3009       (mapatoms
3010        (lambda (group)
3011          (and (string-match regexp (symbol-value group))
3012               (gnus-active (symbol-name group))
3013               (push (symbol-name group) groups)))
3014        gnus-description-hashtb))
3015     (if (not groups)
3016         (gnus-message 3 "No groups matched \"%s\"." regexp)
3017       ;; Print out all the groups.
3018       (save-excursion
3019         (pop-to-buffer "*Gnus Help*")
3020         (buffer-disable-undo (current-buffer))
3021         (erase-buffer)
3022         (setq groups (sort groups 'string<))
3023         (while groups
3024           ;; Groups may be entered twice into the list of groups.
3025           (when (not (string= (car groups) prev))
3026             (insert (setq prev (car groups)) "\n")
3027             (when (and gnus-description-hashtb
3028                        (setq des (gnus-gethash (car groups)
3029                                                gnus-description-hashtb)))
3030               (insert "  " des "\n")))
3031           (setq groups (cdr groups)))
3032         (goto-char (point-min))))
3033     (pop-to-buffer obuf)))
3034
3035 (defun gnus-group-description-apropos (regexp)
3036   "List all newsgroups that have names or descriptions that match a regexp."
3037   (interactive "sGnus description apropos (regexp): ")
3038   (when (not (or gnus-description-hashtb
3039                  (gnus-read-all-descriptions-files)))
3040     (error "Couldn't request descriptions file"))
3041   (gnus-group-apropos regexp t))
3042
3043 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3044 (defun gnus-group-list-matching (level regexp &optional all lowest)
3045   "List all groups with unread articles that match REGEXP.
3046 If the prefix LEVEL is non-nil, it should be a number that says which
3047 level to cut off listing groups.
3048 If ALL, also list groups with no unread articles.
3049 If LOWEST, don't list groups with level lower than LOWEST.
3050
3051 This command may read the active file."
3052   (interactive "P\nsList newsgroups matching: ")
3053   ;; First make sure active file has been read.
3054   (when (and level
3055              (> (prefix-numeric-value level) gnus-level-killed))
3056     (gnus-get-killed-groups))
3057   (gnus-group-prepare-flat
3058    (or level gnus-level-subscribed) all (or lowest 1) regexp)
3059   (goto-char (point-min))
3060   (gnus-group-position-point))
3061
3062 (defun gnus-group-list-all-matching (level regexp &optional lowest)
3063   "List all groups that match REGEXP.
3064 If the prefix LEVEL is non-nil, it should be a number that says which
3065 level to cut off listing groups.
3066 If LOWEST, don't list groups with level lower than LOWEST."
3067   (interactive "P\nsList newsgroups matching: ")
3068   (when level
3069     (setq level (prefix-numeric-value level)))
3070   (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
3071
3072 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
3073 (defun gnus-group-save-newsrc (&optional force)
3074   "Save the Gnus startup files.
3075 If FORCE, force saving whether it is necessary or not."
3076   (interactive "P")
3077   (gnus-save-newsrc-file force))
3078
3079 (defun gnus-group-restart (&optional arg)
3080   "Force Gnus to read the .newsrc file."
3081   (interactive "P")
3082   (when (gnus-yes-or-no-p
3083          (format "Are you sure you want to restart Gnus? "))
3084     (gnus-save-newsrc-file)
3085     (gnus-clear-system)
3086     (gnus)))
3087
3088 (defun gnus-group-read-init-file ()
3089   "Read the Gnus elisp init file."
3090   (interactive)
3091   (gnus-read-init-file)
3092   (gnus-message 5 "Read %s" gnus-init-file))
3093
3094 (defun gnus-group-check-bogus-groups (&optional silent)
3095   "Check bogus newsgroups.
3096 If given a prefix, don't ask for confirmation before removing a bogus
3097 group."
3098   (interactive "P")
3099   (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
3100   (gnus-group-list-groups))
3101
3102 (defun gnus-group-find-new-groups (&optional arg)
3103   "Search for new groups and add them.
3104 Each new group will be treated with `gnus-subscribe-newsgroup-method.'
3105 If ARG (the prefix), use the `ask-server' method to query
3106 the server for new groups."
3107   (interactive "P")
3108   (gnus-find-new-newsgroups arg)
3109   (gnus-group-list-groups))
3110
3111 (defun gnus-group-edit-global-kill (&optional article group)
3112   "Edit the global kill file.
3113 If GROUP, edit that local kill file instead."
3114   (interactive "P")
3115   (setq gnus-current-kill-article article)
3116   (gnus-kill-file-edit-file group)
3117   (gnus-message
3118    6
3119    (substitute-command-keys
3120     (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
3121             (if group "local" "global")))))
3122
3123 (defun gnus-group-edit-local-kill (article group)
3124   "Edit a local kill file."
3125   (interactive (list nil (gnus-group-group-name)))
3126   (gnus-group-edit-global-kill article group))
3127
3128 (defun gnus-group-force-update ()
3129   "Update `.newsrc' file."
3130   (interactive)
3131   (gnus-save-newsrc-file))
3132
3133 (defun gnus-group-suspend ()
3134   "Suspend the current Gnus session.
3135 In fact, cleanup buffers except for group mode buffer.
3136 The hook gnus-suspend-gnus-hook is called before actually suspending."
3137   (interactive)
3138   (run-hooks 'gnus-suspend-gnus-hook)
3139   ;; Kill Gnus buffers except for group mode buffer.
3140   (let* ((group-buf (get-buffer gnus-group-buffer))
3141          ;; Do this on a separate list in case the user does a ^G before we finish
3142          (gnus-buffer-list
3143           (delete group-buf (delete gnus-dribble-buffer
3144                                     (append gnus-buffer-list nil)))))
3145     (while gnus-buffer-list
3146       (gnus-kill-buffer (pop gnus-buffer-list)))
3147     (gnus-kill-gnus-frames)
3148     (when group-buf
3149       (setq gnus-buffer-list (list group-buf))
3150       (bury-buffer group-buf)
3151       (delete-windows-on group-buf t))))
3152
3153 (defun gnus-group-clear-dribble ()
3154   "Clear all information from the dribble buffer."
3155   (interactive)
3156   (gnus-dribble-clear)
3157   (gnus-message 7 "Cleared dribble buffer"))
3158
3159 (defun gnus-group-exit ()
3160   "Quit reading news after updating .newsrc.eld and .newsrc.
3161 The hook `gnus-exit-gnus-hook' is called before actually exiting."
3162   (interactive)
3163   (when
3164       (or noninteractive                ;For gnus-batch-kill
3165           (not gnus-interactive-exit)   ;Without confirmation
3166           gnus-expert-user
3167           (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
3168     (run-hooks 'gnus-exit-gnus-hook)
3169     ;; Offer to save data from non-quitted summary buffers.
3170     (gnus-offer-save-summaries)
3171     ;; Save the newsrc file(s).
3172     (gnus-save-newsrc-file)
3173     ;; Kill-em-all.
3174     (gnus-close-backends)
3175     ;; Reset everything.
3176     (gnus-clear-system)
3177     ;; Allow the user to do things after cleaning up.
3178     (run-hooks 'gnus-after-exiting-gnus-hook)))
3179
3180 (defun gnus-group-quit ()
3181   "Quit reading news without updating .newsrc.eld or .newsrc.
3182 The hook `gnus-exit-gnus-hook' is called before actually exiting."
3183   (interactive)
3184   (when (or noninteractive              ;For gnus-batch-kill
3185             (zerop (buffer-size))
3186             (not (gnus-server-opened gnus-select-method))
3187             gnus-expert-user
3188             (not gnus-current-startup-file)
3189             (gnus-yes-or-no-p
3190              (format "Quit reading news without saving %s? "
3191                      (file-name-nondirectory gnus-current-startup-file))))
3192     (run-hooks 'gnus-exit-gnus-hook)
3193     (gnus-configure-windows 'group t)
3194     (gnus-dribble-save)
3195     (gnus-close-backends)
3196     (gnus-clear-system)
3197     (gnus-kill-buffer gnus-group-buffer)
3198     ;; Allow the user to do things after cleaning up.
3199     (run-hooks 'gnus-after-exiting-gnus-hook)))
3200
3201 (defun gnus-group-describe-briefly ()
3202   "Give a one line description of the group mode commands."
3203   (interactive)
3204   (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")))
3205
3206 (defun gnus-group-browse-foreign-server (method)
3207   "Browse a foreign news server.
3208 If called interactively, this function will ask for a select method
3209  (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
3210 If not, METHOD should be a list where the first element is the method
3211 and the second element is the address."
3212   (interactive
3213    (list (let ((how (completing-read
3214                      "Which backend: "
3215                      (append gnus-valid-select-methods gnus-server-alist)
3216                      nil t (cons "nntp" 0) 'gnus-method-history)))
3217            ;; We either got a backend name or a virtual server name.
3218            ;; If the first, we also need an address.
3219            (if (assoc how gnus-valid-select-methods)
3220                (list (intern how)
3221                      ;; Suggested by mapjph@bath.ac.uk.
3222                      (completing-read
3223                       "Address: "
3224                       (mapcar (lambda (server) (list server))
3225                               gnus-secondary-servers)))
3226              ;; We got a server name.
3227              how))))
3228   (gnus-browse-foreign-server method))
3229
3230 (defun gnus-group-set-info (info &optional method-only-group part)
3231   (let* ((entry (gnus-gethash
3232                  (or method-only-group (gnus-info-group info))
3233                  gnus-newsrc-hashtb))
3234          (part-info info)
3235          (info (if method-only-group (nth 2 entry) info))
3236          method)
3237     (when method-only-group
3238       (unless entry
3239         (error "Trying to change non-existent group %s" method-only-group))
3240       ;; We have received parts of the actual group info - either the
3241       ;; select method or the group parameters.  We first check
3242       ;; whether we have to extend the info, and if so, do that.
3243       (let ((len (length info))
3244             (total (if (eq part 'method) 5 6)))
3245         (when (< len total)
3246           (setcdr (nthcdr (1- len) info)
3247                   (make-list (- total len) nil)))
3248         ;; Then we enter the new info.
3249         (setcar (nthcdr (1- total) info) part-info)))
3250     (unless entry
3251       ;; This is a new group, so we just create it.
3252       (save-excursion
3253         (set-buffer gnus-group-buffer)
3254         (setq method (gnus-info-method info))
3255         (when (gnus-server-equal method "native")
3256           (setq method nil))
3257         (save-excursion
3258           (set-buffer gnus-group-buffer)
3259           (if method
3260               ;; It's a foreign group...
3261               (gnus-group-make-group
3262                (gnus-group-real-name (gnus-info-group info))
3263                (if (stringp method) method
3264                  (prin1-to-string (car method)))
3265                (and (consp method)
3266                     (nth 1 (gnus-info-method info))))
3267             ;; It's a native group.
3268             (gnus-group-make-group (gnus-info-group info))))
3269         (gnus-message 6 "Note: New group created")
3270         (setq entry
3271               (gnus-gethash (gnus-group-prefixed-name
3272                              (gnus-group-real-name (gnus-info-group info))
3273                              (or (gnus-info-method info) gnus-select-method))
3274                             gnus-newsrc-hashtb))))
3275     ;; Whether it was a new group or not, we now have the entry, so we
3276     ;; can do the update.
3277     (if entry
3278         (progn
3279           (setcar (nthcdr 2 entry) info)
3280           (when (and (not (eq (car entry) t))
3281                      (gnus-active (gnus-info-group info)))
3282             (setcar entry (length (gnus-list-of-unread-articles (car info))))))
3283       (error "No such group: %s" (gnus-info-group info)))))
3284
3285 (defun gnus-group-set-method-info (group select-method)
3286   (gnus-group-set-info select-method group 'method))
3287
3288 (defun gnus-group-set-params-info (group params)
3289   (gnus-group-set-info params group 'params))
3290
3291 (defun gnus-add-marked-articles (group type articles &optional info force)
3292   ;; Add ARTICLES of TYPE to the info of GROUP.
3293   ;; If INFO is non-nil, use that info.  If FORCE is non-nil, don't
3294   ;; add, but replace marked articles of TYPE with ARTICLES.
3295   (let ((info (or info (gnus-get-info group)))
3296         (uncompressed '(score bookmark killed))
3297         marked m)
3298     (or (not info)
3299         (and (not (setq marked (nthcdr 3 info)))
3300              (or (null articles)
3301                  (setcdr (nthcdr 2 info)
3302                          (list (list (cons type (gnus-compress-sequence
3303                                                  articles t)))))))
3304         (and (not (setq m (assq type (car marked))))
3305              (or (null articles)
3306                  (setcar marked
3307                          (cons (cons type (gnus-compress-sequence articles t) )
3308                                (car marked)))))
3309         (if force
3310             (if (null articles)
3311                 (setcar (nthcdr 3 info)
3312                         (delq (assq type (car marked)) (car marked)))
3313               (setcdr m (gnus-compress-sequence articles t)))
3314           (setcdr m (gnus-compress-sequence
3315                      (sort (nconc (gnus-uncompress-range (cdr m))
3316                                   (copy-sequence articles)) '<) t))))))
3317
3318 ;;;
3319 ;;; Group timestamps
3320 ;;;
3321
3322 (defun gnus-group-set-timestamp ()
3323   "Change the timestamp of the current group to the current time.
3324 This function can be used in hooks like `gnus-select-group-hook'
3325 or `gnus-group-catchup-group-hook'."
3326   (when gnus-newsgroup-name
3327     (let ((time (current-time)))
3328       (setcdr (cdr time) nil)
3329       (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
3330
3331 (defsubst gnus-group-timestamp (group)
3332   "Return the timestamp for GROUP."
3333   (gnus-group-get-parameter group 'timestamp))
3334
3335 (defun gnus-group-timestamp-delta (group)
3336   "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
3337   (let* ((time (or (gnus-group-timestamp group)
3338                   (list 0 0)))
3339          (delta (gnus-time-minus (current-time) time)))
3340     (+ (* (nth 0 delta) 65536.0)
3341        (nth 1 delta))))
3342
3343 (defun gnus-group-timestamp-string (group)
3344   "Return a string of the timestamp for GROUP."
3345   (let ((time (gnus-group-timestamp group)))
3346     (if (not time)
3347         ""
3348       (gnus-time-iso8601 time))))
3349
3350 (provide 'gnus-group)
3351
3352 ;;; gnus-group.el ends here