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