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