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

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