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