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