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