git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus-group.el

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