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