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