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