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