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