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