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