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