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