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