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