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