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

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