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