2c87ec9fbc066631cb231e195212bf1805eb4270
[gnus] / lisp / gnus-group.el
1 ;;; gnus-group.el --- group mode commands for Gnus
2
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;;   2005, 2006 Free Software Foundation, Inc.
5
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
25
26 ;;; Commentary:
27
28 ;;; Code:
29
30 (eval-when-compile
31   (require 'cl)
32   (defvar tool-bar-mode))
33
34 (require 'gnus)
35 (require 'gnus-start)
36 (require 'nnmail)
37 (require 'gnus-spec)
38 (require 'gnus-int)
39 (require 'gnus-range)
40 (require 'gnus-win)
41 (require 'gnus-undo)
42 (require 'gmm-utils)
43 (require 'time-date)
44 (require 'gnus-ems)
45
46 (eval-when-compile
47   (require 'mm-url)
48   (let ((features (cons 'gnus-group features)))
49     (require 'gnus-sum))
50   (unless (boundp 'gnus-cache-active-hashtb)
51     (defvar gnus-cache-active-hashtb nil)))
52
53 (autoload 'gnus-agent-total-fetched-for "gnus-agent")
54 (autoload 'gnus-cache-total-fetched-for "gnus-cache")
55
56 (defcustom gnus-group-archive-directory
57   "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list/"
58   "*The address of the (ding) archives."
59   :group 'gnus-group-foreign
60   :type 'directory)
61
62 (defcustom gnus-group-recent-archive-directory
63   "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list-recent/"
64   "*The address of the most recent (ding) articles."
65   :group 'gnus-group-foreign
66   :type 'directory)
67
68 (defcustom gnus-no-groups-message "No Gnus is good news"
69   "*Message displayed by Gnus when no groups are available."
70   :group 'gnus-start
71   :type 'string)
72
73 (defcustom gnus-keep-same-level nil
74   "*Non-nil means that the next newsgroup after the current will be on the same level.
75 When you type, for instance, `n' after reading the last article in the
76 current newsgroup, you will go to the next newsgroup.  If this variable
77 is nil, the next newsgroup will be the next from the group
78 buffer.
79 If this variable is non-nil, Gnus will either put you in the
80 next newsgroup with the same level, or, if no such newsgroup is
81 available, the next newsgroup with the lowest possible level higher
82 than the current level.
83 If this variable is `best', Gnus will make the next newsgroup the one
84 with the best level."
85   :group 'gnus-group-levels
86   :type '(choice (const nil)
87                  (const best)
88                  (sexp :tag "other" t)))
89
90 (defcustom gnus-group-goto-unread t
91   "*If non-nil, movement commands will go to the next unread and subscribed group."
92   :link '(custom-manual "(gnus)Group Maneuvering")
93   :group 'gnus-group-various
94   :type 'boolean)
95
96 (defcustom gnus-goto-next-group-when-activating t
97   "*If non-nil, the \\<gnus-group-mode-map>\\[gnus-group-get-new-news-this-group] command will advance point to the next group."
98   :link '(custom-manual "(gnus)Scanning New Messages")
99   :group 'gnus-group-various
100   :type 'boolean)
101
102 (defcustom gnus-permanently-visible-groups nil
103   "*Regexp to match groups that should always be listed in the group buffer.
104 This means that they will still be listed even when there are no
105 unread articles in the groups.
106
107 If nil, no groups are permanently visible."
108   :group 'gnus-group-listing
109   :type '(choice regexp (const nil)))
110
111 (defcustom gnus-list-groups-with-ticked-articles t
112   "*If non-nil, list groups that have only ticked articles.
113 If nil, only list groups that have unread articles."
114   :group 'gnus-group-listing
115   :type 'boolean)
116
117 (defcustom gnus-group-default-list-level gnus-level-subscribed
118   "*Default listing level.
119 Ignored if `gnus-group-use-permanent-levels' is non-nil."
120   :group 'gnus-group-listing
121   :type 'integer)
122
123 (defcustom gnus-group-list-inactive-groups t
124   "*If non-nil, inactive groups will be listed."
125   :group 'gnus-group-listing
126   :group 'gnus-group-levels
127   :type 'boolean)
128
129 (defcustom gnus-group-sort-function 'gnus-group-sort-by-alphabet
130   "*Function used for sorting the group buffer.
131 This function will be called with group info entries as the arguments
132 for the groups to be sorted.  Pre-made functions include
133 `gnus-group-sort-by-alphabet', `gnus-group-sort-by-real-name',
134 `gnus-group-sort-by-unread', `gnus-group-sort-by-level',
135 `gnus-group-sort-by-score', `gnus-group-sort-by-method',
136 `gnus-group-sort-by-server', and `gnus-group-sort-by-rank'.
137
138 This variable can also be a list of sorting functions.  In that case,
139 the most significant sort function should be the last function in the
140 list."
141   :group 'gnus-group-listing
142   :link '(custom-manual "(gnus)Sorting Groups")
143   :type '(repeat :value-to-internal (lambda (widget value)
144                                       (if (listp value) value (list value)))
145                  :match (lambda (widget value)
146                           (or (symbolp value)
147                               (widget-editable-list-match widget value)))
148                  (choice (function-item gnus-group-sort-by-alphabet)
149                          (function-item gnus-group-sort-by-real-name)
150                          (function-item gnus-group-sort-by-unread)
151                          (function-item gnus-group-sort-by-level)
152                          (function-item gnus-group-sort-by-score)
153                          (function-item gnus-group-sort-by-method)
154                          (function-item gnus-group-sort-by-server)
155                          (function-item gnus-group-sort-by-rank)
156                          (function :tag "other" nil))))
157
158 (defcustom gnus-group-line-format "%M\%S\%p\%P\%5y:%B%(%g%)%O\n"
159   "*Format of group lines.
160 It works along the same lines as a normal formatting string,
161 with some simple extensions.
162
163 %M    Only marked articles (character, \"*\" or \" \")
164 %S    Whether the group is subscribed (character, \"U\", \"K\", \"Z\" or \" \")
165 %L    Level of subscribedness (integer)
166 %N    Number of unread articles (integer)
167 %I    Number of dormant articles (integer)
168 %i    Number of ticked and dormant (integer)
169 %T    Number of ticked articles (integer)
170 %R    Number of read articles (integer)
171 %U    Number of unseen articles (integer)
172 %t    Estimated total number of articles (integer)
173 %y    Number of unread, unticked articles (integer)
174 %G    Group name (string)
175 %g    Qualified group name (string)
176 %c    Short (collapsed) group name.  See `gnus-group-uncollapsed-levels'.
177 %C    Group comment (string)
178 %D    Group description (string)
179 %s    Select method (string)
180 %o    Moderated group (char, \"m\")
181 %p    Process mark (char)
182 %B    Whether a summary buffer for the group is open (char, \"*\")
183 %O    Moderated group (string, \"(m)\" or \"\")
184 %P    Topic indentation (string)
185 %m    Whether there is new(ish) mail in the group (char, \"%\")
186 %n    Select from where (string)
187 %z    A string that look like `<%s:%n>' if a foreign select method is used
188 %d    The date the group was last entered.
189 %E    Icon as defined by `gnus-group-icon-list'.
190 %F    The disk space used by the articles fetched by both the cache and agent.
191 %u    User defined specifier.  The next character in the format string should
192       be a letter.  Gnus will call the function gnus-user-format-function-X,
193       where X is the letter following %u.  The function will be passed a
194       single dummy parameter as argument.  The function should return a
195       string, which will be inserted into the buffer just like information
196       from any other group specifier.
197
198 Note that this format specification is not always respected.  For
199 reasons of efficiency, when listing killed groups, this specification
200 is ignored altogether.  If the spec is changed considerably, your
201 output may end up looking strange when listing both alive and killed
202 groups.
203
204 If you use %o or %O, reading the active file will be slower and quite
205 a bit of extra memory will be used.  %D and %F will also worsen
206 performance.  Also note that if you change the format specification to
207 include any of these specs, you must probably re-start Gnus to see
208 them go into effect.
209
210 General format specifiers can also be used.
211 See Info node `(gnus)Formatting Variables'."
212   :link '(custom-manual "(gnus)Formatting Variables")
213   :group 'gnus-group-visual
214   :type 'string)
215
216 (defcustom gnus-group-mode-line-format "Gnus: %%b {%M\%:%S}"
217   "*The format specification for the group mode line.
218 It works along the same lines as a normal formatting string,
219 with some simple extensions:
220
221 %S   The native news server.
222 %M   The native select method.
223 %:   \":\" if %S isn't \"\"."
224   :group 'gnus-group-visual
225   :type 'string)
226
227 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
228 (when (featurep 'xemacs)
229   (add-hook 'gnus-group-mode-hook 'gnus-xmas-group-menu-add)
230   (add-hook 'gnus-group-mode-hook 'gnus-xmas-setup-group-toolbar))
231
232 (defcustom gnus-group-menu-hook nil
233   "Hook run after the creation of the group mode menu."
234   :group 'gnus-group-various
235   :type 'hook)
236
237 (defcustom gnus-group-catchup-group-hook nil
238   "Hook run when catching up a group from the group buffer."
239   :group 'gnus-group-various
240   :link '(custom-manual "(gnus)Group Data")
241   :type 'hook)
242
243 (defcustom gnus-group-update-group-hook nil
244   "Hook called when updating group lines."
245   :group 'gnus-group-visual
246   :type 'hook)
247
248 (defcustom gnus-group-prepare-function 'gnus-group-prepare-flat
249   "*A function that is called to generate the group buffer.
250 The function is called with three arguments: The first is a number;
251 all group with a level less or equal to that number should be listed,
252 if the second is non-nil, empty groups should also be displayed.  If
253 the third is non-nil, it is a number.  No groups with a level lower
254 than this number should be displayed.
255
256 The only current function implemented is `gnus-group-prepare-flat'."
257   :group 'gnus-group-listing
258   :type 'function)
259
260 (defcustom gnus-group-prepare-hook nil
261   "Hook called after the group buffer has been generated.
262 If you want to modify the group buffer, you can use this hook."
263   :group 'gnus-group-listing
264   :type 'hook)
265
266 (defcustom gnus-suspend-gnus-hook nil
267   "Hook called when suspending (not exiting) Gnus."
268   :group 'gnus-exit
269   :type 'hook)
270
271 (defcustom gnus-exit-gnus-hook nil
272   "Hook called when exiting Gnus."
273   :group 'gnus-exit
274   :type 'hook)
275
276 (defcustom gnus-after-exiting-gnus-hook nil
277   "Hook called after exiting Gnus."
278   :group 'gnus-exit
279   :type 'hook)
280
281 (defcustom gnus-group-update-hook '(gnus-group-highlight-line)
282   "Hook called when a group line is changed.
283 The hook will not be called if `gnus-visual' is nil.
284
285 The default function `gnus-group-highlight-line' will
286 highlight the line according to the `gnus-group-highlight'
287 variable."
288   :group 'gnus-group-visual
289   :type 'hook)
290
291 (defcustom gnus-useful-groups
292   '(("(ding) mailing list mirrored at gmane.org"
293      "gmane.emacs.gnus.general"
294      (nntp "Gmane"
295            (nntp-address "news.gmane.org")))
296     ("Gnus bug archive"
297      "gnus.gnus-bug"
298      (nntp "news.gnus.org"
299            (nntp-address "news.gnus.org")))
300     ("Local Gnus help group"
301      "gnus-help"
302      (nndoc "gnus-help"
303             (nndoc-article-type mbox)
304             (eval `(nndoc-address
305                     ,(let ((file (nnheader-find-etc-directory
306                                   "gnus-tut.txt" t)))
307                        (unless file
308                          (error "Couldn't find doc group"))
309                        file))))))
310   "*Alist of useful group-server pairs."
311   :group 'gnus-group-listing
312   :type '(repeat (list (string :tag "Description")
313                        (string :tag "Name")
314                        (sexp :tag "Method"))))
315
316 (defcustom gnus-group-highlight
317   '(;; Mail.
318     ((and mailp (= unread 0) (eq level 1)) .
319      gnus-group-mail-1-empty)
320     ((and mailp (eq level 1)) .
321      gnus-group-mail-1)
322     ((and mailp (= unread 0) (eq level 2)) .
323      gnus-group-mail-2-empty)
324     ((and mailp (eq level 2)) .
325      gnus-group-mail-2)
326     ((and mailp (= unread 0) (eq level 3)) .
327      gnus-group-mail-3-empty)
328     ((and mailp (eq level 3)) .
329      gnus-group-mail-3)
330     ((and mailp (= unread 0)) .
331      gnus-group-mail-low-empty)
332     ((and mailp) .
333      gnus-group-mail-low)
334     ;; News.
335     ((and (= unread 0) (eq level 1)) .
336      gnus-group-news-1-empty)
337     ((and (eq level 1)) .
338      gnus-group-news-1)
339     ((and (= unread 0) (eq level 2)) .
340      gnus-group-news-2-empty)
341     ((and (eq level 2)) .
342      gnus-group-news-2)
343     ((and (= unread 0) (eq level 3)) .
344      gnus-group-news-3-empty)
345     ((and (eq level 3)) .
346      gnus-group-news-3)
347     ((and (= unread 0) (eq level 4)) .
348      gnus-group-news-4-empty)
349     ((and (eq level 4)) .
350      gnus-group-news-4)
351     ((and (= unread 0) (eq level 5)) .
352      gnus-group-news-5-empty)
353     ((and (eq level 5)) .
354      gnus-group-news-5)
355     ((and (= unread 0) (eq level 6)) .
356      gnus-group-news-6-empty)
357     ((and (eq level 6)) .
358      gnus-group-news-6)
359     ((and (= unread 0)) .
360      gnus-group-news-low-empty)
361     (t .
362      gnus-group-news-low))
363   "*Controls the highlighting of group buffer lines.
364
365 Below is a list of `Form'/`Face' pairs.  When deciding how a a
366 particular group line should be displayed, each form is
367 evaluated.  The content of the face field after the first true form is
368 used.  You can change how those group lines are displayed by
369 editing the face field.
370
371 It is also possible to change and add form fields, but currently that
372 requires an understanding of Lisp expressions.  Hopefully this will
373 change in a future release.  For now, you can use the following
374 variables in the Lisp expression:
375
376 group: The name of the group.
377 unread: The number of unread articles in the group.
378 method: The select method used.
379 mailp: Whether it's a mail group or not.
380 level: The level of the group.
381 score: The score of the group.
382 ticked: The number of ticked articles."
383   :group 'gnus-group-visual
384   :type '(repeat (cons (sexp :tag "Form") face)))
385
386 (defcustom gnus-new-mail-mark ?%
387   "Mark used for groups with new mail."
388   :group 'gnus-group-visual
389   :type 'character)
390
391 (defgroup gnus-group-icons nil
392   "Add Icons to your group buffer."
393   :group 'gnus-group-visual)
394
395 (defcustom gnus-group-icon-list
396   nil
397   "*Controls the insertion of icons into group buffer lines.
398
399 Below is a list of `Form'/`File' pairs.  When deciding how a
400 particular group line should be displayed, each form is evaluated.
401 The icon from the file field after the first true form is used.  You
402 can change how those group lines are displayed by editing the file
403 field.  The File will either be found in the
404 `gnus-group-glyph-directory' or by designating absolute name of the
405 file.
406
407 It is also possible to change and add form fields, but currently that
408 requires an understanding of Lisp expressions.  Hopefully this will
409 change in a future release.  For now, you can use the following
410 variables in the Lisp expression:
411
412 group: The name of the group.
413 unread: The number of unread articles in the group.
414 method: The select method used.
415 mailp: Whether it's a mail group or not.
416 newsp: Whether it's a news group or not
417 level: The level of the group.
418 score: The score of the group.
419 ticked: The number of ticked articles."
420   :group 'gnus-group-icons
421   :type '(repeat (cons (sexp :tag "Form") file)))
422
423 (defcustom gnus-group-name-charset-method-alist nil
424   "Alist of method and the charset for group names.
425
426 For example:
427     (((nntp \"news.com.cn\") . cn-gb-2312))"
428   :version "21.1"
429   :group 'gnus-charset
430   :type '(repeat (cons (sexp :tag "Method") (symbol :tag "Charset"))))
431
432 (defcustom gnus-group-name-charset-group-alist
433   (if (or (and (fboundp 'find-coding-system) (find-coding-system 'utf-8))
434           (mm-coding-system-p 'utf-8))
435       '((".*" . utf-8))
436     nil)
437   "Alist of group regexp and the charset for group names.
438
439 For example:
440     ((\"\\.com\\.cn:\" . cn-gb-2312))"
441   :group 'gnus-charset
442   :type '(repeat (cons (regexp :tag "Group") (symbol :tag "Charset"))))
443
444 (defcustom gnus-group-jump-to-group-prompt nil
445   "Default prompt for `gnus-group-jump-to-group'.
446
447 If non-nil, the value should be a string or an alist.  If it is a string,
448 e.g. \"nnml:\", in which case `gnus-group-jump-to-group' offers \"Group:
449 nnml:\" in the minibuffer prompt.
450
451 If it is an alist, it must consist of \(NUMBER .  PROMPT\) pairs, for example:
452 \((1 .  \"\") (2 .  \"nnfolder+archive:\")).  The element with number 0 is
453 used when no prefix argument is given to `gnus-group-jump-to-group'."
454   :version "22.1"
455   :group 'gnus-group-various
456   :type '(choice (string :tag "Prompt string")
457                  (const :tag "Empty" nil)
458                  (repeat (cons (integer :tag "Argument")
459                                (string :tag "Prompt string")))))
460
461 (defvar gnus-group-listing-limit 1000
462   "*A limit of the number of groups when listing.
463 If the number of groups is larger than the limit, list them in a
464 simple manner.")
465
466 ;;; Internal variables
467
468 (defvar gnus-group-is-exiting-p nil)
469 (defvar gnus-group-is-exiting-without-update-p nil)
470 (defvar gnus-group-sort-alist-function 'gnus-group-sort-flat
471   "Function for sorting the group buffer.")
472
473 (defvar gnus-group-sort-selected-function 'gnus-group-sort-selected-flat
474   "Function for sorting the selected groups in the group buffer.")
475
476 (defvar gnus-group-indentation-function nil)
477 (defvar gnus-goto-missing-group-function nil)
478 (defvar gnus-group-update-group-function nil)
479 (defvar gnus-group-goto-next-group-function nil
480   "Function to override finding the next group after listing groups.")
481
482 (defvar gnus-group-edit-buffer nil)
483
484 (defvar gnus-group-line-format-alist
485   `((?M gnus-tmp-marked-mark ?c)
486     (?S gnus-tmp-subscribed ?c)
487     (?L gnus-tmp-level ?d)
488     (?N (cond ((eq number t) "*" )
489               ((numberp number)
490                (int-to-string
491                 (+ number
492                    (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
493                    (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))))))
494               (t number)) ?s)
495     (?R gnus-tmp-number-of-read ?s)
496     (?U (gnus-number-of-unseen-articles-in-group gnus-tmp-group) ?d)
497     (?t gnus-tmp-number-total ?d)
498     (?y gnus-tmp-number-of-unread ?s)
499     (?I (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked))) ?d)
500     (?T (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))) ?d)
501     (?i (+ (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
502            (gnus-range-length (cdr (assq 'tick gnus-tmp-marked)))) ?d)
503     (?g (if (boundp 'gnus-tmp-decoded-group)
504             gnus-tmp-decoded-group
505           gnus-tmp-group)
506         ?s)
507     (?G gnus-tmp-qualified-group ?s)
508     (?c (gnus-short-group-name (if (boundp 'gnus-tmp-decoded-group)
509                                    gnus-tmp-decoded-group
510                                  gnus-tmp-group))
511         ?s)
512     (?C gnus-tmp-comment ?s)
513     (?D gnus-tmp-newsgroup-description ?s)
514     (?o gnus-tmp-moderated ?c)
515     (?O gnus-tmp-moderated-string ?s)
516     (?p gnus-tmp-process-marked ?c)
517     (?s gnus-tmp-news-server ?s)
518     (?n ,(if (featurep 'xemacs)
519              '(symbol-name gnus-tmp-news-method)
520            'gnus-tmp-news-method)
521         ?s)
522     (?P gnus-group-indentation ?s)
523     (?E gnus-tmp-group-icon ?s)
524     (?B gnus-tmp-summary-live ?c)
525     (?z gnus-tmp-news-method-string ?s)
526     (?m (gnus-group-new-mail gnus-tmp-group) ?c)
527     (?d (gnus-group-timestamp-string gnus-tmp-group) ?s)
528     (?u gnus-tmp-user-defined ?s)
529     (?F (gnus-total-fetched-for gnus-tmp-group) ?s)
530     ))
531
532 (defvar gnus-group-mode-line-format-alist
533   `((?S gnus-tmp-news-server ?s)
534     (?M gnus-tmp-news-method ?s)
535     (?u gnus-tmp-user-defined ?s)
536     (?: gnus-tmp-colon ?s)))
537
538 (defvar gnus-topic-topology nil
539   "The complete topic hierarchy.")
540
541 (defvar gnus-topic-alist nil
542   "The complete topic-group alist.")
543
544 (defvar gnus-group-marked nil)
545
546 (defvar gnus-group-list-mode nil)
547
548
549 (defvar gnus-group-icon-cache nil)
550
551 (defvar gnus-group-listed-groups nil)
552 (defvar gnus-group-list-option nil)
553
554 ;;;
555 ;;; Gnus group mode
556 ;;;
557
558 (put 'gnus-group-mode 'mode-class 'special)
559
560 (gnus-define-keys gnus-group-mode-map
561   " " gnus-group-read-group
562   "=" gnus-group-select-group
563   "\r" gnus-group-select-group
564   "\M-\r" gnus-group-quick-select-group
565   "\M- " gnus-group-visible-select-group
566   [(meta control return)] gnus-group-select-group-ephemerally
567   "j" gnus-group-jump-to-group
568   "n" gnus-group-next-unread-group
569   "p" gnus-group-prev-unread-group
570   "\177" gnus-group-prev-unread-group
571   [delete] gnus-group-prev-unread-group
572   [backspace] gnus-group-prev-unread-group
573   "N" gnus-group-next-group
574   "P" gnus-group-prev-group
575   "\M-n" gnus-group-next-unread-group-same-level
576   "\M-p" gnus-group-prev-unread-group-same-level
577   "," gnus-group-best-unread-group
578   "." gnus-group-first-unread-group
579   "u" gnus-group-unsubscribe-current-group
580   "U" gnus-group-unsubscribe-group
581   "c" gnus-group-catchup-current
582   "C" gnus-group-catchup-current-all
583   "\M-c" gnus-group-clear-data
584   "l" gnus-group-list-groups
585   "L" gnus-group-list-all-groups
586   "m" gnus-group-mail
587   "i" gnus-group-news
588   "g" gnus-group-get-new-news
589   "\M-g" gnus-group-get-new-news-this-group
590   "R" gnus-group-restart
591   "r" gnus-group-read-init-file
592   "B" gnus-group-browse-foreign-server
593   "b" gnus-group-check-bogus-groups
594   "F" gnus-group-find-new-groups
595   "\C-c\C-d" gnus-group-describe-group
596   "\M-d" gnus-group-describe-all-groups
597   "\C-c\C-a" gnus-group-apropos
598   "\C-c\M-\C-a" gnus-group-description-apropos
599   "a" gnus-group-post-news
600   "\ek" gnus-group-edit-local-kill
601   "\eK" gnus-group-edit-global-kill
602   "\C-k" gnus-group-kill-group
603   "\C-y" gnus-group-yank-group
604   "\C-w" gnus-group-kill-region
605   "\C-x\C-t" gnus-group-transpose-groups
606   "\C-c\C-l" gnus-group-list-killed
607   "\C-c\C-x" gnus-group-expire-articles
608   "\C-c\M-\C-x" gnus-group-expire-all-groups
609   "V" gnus-version
610   "s" gnus-group-save-newsrc
611   "z" gnus-group-suspend
612   "q" gnus-group-exit
613   "Q" gnus-group-quit
614   "?" gnus-group-describe-briefly
615   "\C-c\C-i" gnus-info-find-node
616   "\M-e" gnus-group-edit-group-method
617   "^" gnus-group-enter-server-mode
618   gnus-mouse-2 gnus-mouse-pick-group
619   [follow-link] mouse-face
620   "<" beginning-of-buffer
621   ">" end-of-buffer
622   "\C-c\C-b" gnus-bug
623   "\C-c\C-s" gnus-group-sort-groups
624   "t" gnus-topic-mode
625   "\C-c\M-g" gnus-activate-all-groups
626   "\M-&" gnus-group-universal-argument
627   "#" gnus-group-mark-group
628   "\M-#" gnus-group-unmark-group)
629
630 (gnus-define-keys (gnus-group-mark-map "M" gnus-group-mode-map)
631   "m" gnus-group-mark-group
632   "u" gnus-group-unmark-group
633   "w" gnus-group-mark-region
634   "b" gnus-group-mark-buffer
635   "r" gnus-group-mark-regexp
636   "U" gnus-group-unmark-all-groups)
637
638 (gnus-define-keys (gnus-group-sieve-map "D" gnus-group-mode-map)
639   "u" gnus-sieve-update
640   "g" gnus-sieve-generate)
641
642 (gnus-define-keys (gnus-group-group-map "G" gnus-group-mode-map)
643   "d" gnus-group-make-directory-group
644   "h" gnus-group-make-help-group
645   "u" gnus-group-make-useful-group
646   "a" gnus-group-make-archive-group
647   "k" gnus-group-make-kiboze-group
648   "l" gnus-group-nnimap-edit-acl
649   "m" gnus-group-make-group
650   "E" gnus-group-edit-group
651   "e" gnus-group-edit-group-method
652   "p" gnus-group-edit-group-parameters
653   "v" gnus-group-add-to-virtual
654   "V" gnus-group-make-empty-virtual
655   "D" gnus-group-enter-directory
656   "f" gnus-group-make-doc-group
657   "w" gnus-group-make-web-group
658   "M" gnus-group-read-ephemeral-group
659   "r" gnus-group-rename-group
660   "R" gnus-group-make-rss-group
661   "c" gnus-group-customize
662   "z" gnus-group-compact-group
663   "x" gnus-group-nnimap-expunge
664   "\177" gnus-group-delete-group
665   [delete] gnus-group-delete-group)
666
667 (gnus-define-keys (gnus-group-soup-map "s" gnus-group-group-map)
668   "b" gnus-group-brew-soup
669   "w" gnus-soup-save-areas
670   "s" gnus-soup-send-replies
671   "p" gnus-soup-pack-packet
672   "r" nnsoup-pack-replies)
673
674 (gnus-define-keys (gnus-group-sort-map "S" gnus-group-group-map)
675   "s" gnus-group-sort-groups
676   "a" gnus-group-sort-groups-by-alphabet
677   "u" gnus-group-sort-groups-by-unread
678   "l" gnus-group-sort-groups-by-level
679   "v" gnus-group-sort-groups-by-score
680   "r" gnus-group-sort-groups-by-rank
681   "m" gnus-group-sort-groups-by-method
682   "n" gnus-group-sort-groups-by-real-name)
683
684 (gnus-define-keys (gnus-group-sort-selected-map "P" gnus-group-group-map)
685   "s" gnus-group-sort-selected-groups
686   "a" gnus-group-sort-selected-groups-by-alphabet
687   "u" gnus-group-sort-selected-groups-by-unread
688   "l" gnus-group-sort-selected-groups-by-level
689   "v" gnus-group-sort-selected-groups-by-score
690   "r" gnus-group-sort-selected-groups-by-rank
691   "m" gnus-group-sort-selected-groups-by-method
692   "n" gnus-group-sort-selected-groups-by-real-name)
693
694 (gnus-define-keys (gnus-group-list-map "A" gnus-group-mode-map)
695   "k" gnus-group-list-killed
696   "z" gnus-group-list-zombies
697   "s" gnus-group-list-groups
698   "u" gnus-group-list-all-groups
699   "A" gnus-group-list-active
700   "a" gnus-group-apropos
701   "d" gnus-group-description-apropos
702   "m" gnus-group-list-matching
703   "M" gnus-group-list-all-matching
704   "l" gnus-group-list-level
705   "c" gnus-group-list-cached
706   "?" gnus-group-list-dormant)
707
708 (gnus-define-keys (gnus-group-list-limit-map "/" gnus-group-list-map)
709   "k"  gnus-group-list-limit
710   "z"  gnus-group-list-limit
711   "s"  gnus-group-list-limit
712   "u"  gnus-group-list-limit
713   "A"  gnus-group-list-limit
714   "m"  gnus-group-list-limit
715   "M"  gnus-group-list-limit
716   "l"  gnus-group-list-limit
717   "c"  gnus-group-list-limit
718   "?"  gnus-group-list-limit)
719
720 (gnus-define-keys (gnus-group-list-flush-map "f" gnus-group-list-map)
721   "k"  gnus-group-list-flush
722   "z"  gnus-group-list-flush
723   "s"  gnus-group-list-flush
724   "u"  gnus-group-list-flush
725   "A"  gnus-group-list-flush
726   "m"  gnus-group-list-flush
727   "M"  gnus-group-list-flush
728   "l"  gnus-group-list-flush
729   "c"  gnus-group-list-flush
730   "?"  gnus-group-list-flush)
731
732 (gnus-define-keys (gnus-group-list-plus-map "p" gnus-group-list-map)
733   "k"  gnus-group-list-plus
734   "z"  gnus-group-list-plus
735   "s"  gnus-group-list-plus
736   "u"  gnus-group-list-plus
737   "A"  gnus-group-list-plus
738   "m"  gnus-group-list-plus
739   "M"  gnus-group-list-plus
740   "l"  gnus-group-list-plus
741   "c"  gnus-group-list-plus
742   "?"  gnus-group-list-plus)
743
744 (gnus-define-keys (gnus-group-score-map "W" gnus-group-mode-map)
745   "f" gnus-score-flush-cache
746   "e" gnus-score-edit-all-score)
747
748 (gnus-define-keys (gnus-group-help-map "H" gnus-group-mode-map)
749   "c" gnus-group-fetch-charter
750   "C" gnus-group-fetch-control
751   "d" gnus-group-describe-group
752   "f" gnus-group-fetch-faq
753   "v" gnus-version)
754
755 (gnus-define-keys (gnus-group-sub-map "S" gnus-group-mode-map)
756   "l" gnus-group-set-current-level
757   "t" gnus-group-unsubscribe-current-group
758   "s" gnus-group-unsubscribe-group
759   "k" gnus-group-kill-group
760   "y" gnus-group-yank-group
761   "w" gnus-group-kill-region
762   "\C-k" gnus-group-kill-level
763   "z" gnus-group-kill-all-zombies)
764
765 (defun gnus-topic-mode-p ()
766   "Return non-nil in `gnus-topic-mode'."
767   (and (boundp 'gnus-topic-mode)
768        (symbol-value 'gnus-topic-mode)))
769
770 (defun gnus-group-make-menu-bar ()
771   (gnus-turn-off-edit-menu 'group)
772   (unless (boundp 'gnus-group-reading-menu)
773
774     (easy-menu-define
775      gnus-group-reading-menu gnus-group-mode-map ""
776      `("Group"
777        ["Read" gnus-group-read-group
778         :included (not (gnus-topic-mode-p))
779         :active (gnus-group-group-name)]
780        ["Read " gnus-topic-read-group
781         :included (gnus-topic-mode-p)]
782        ["Select" gnus-group-select-group
783         :included (not (gnus-topic-mode-p))
784         :active (gnus-group-group-name)]
785        ["Select " gnus-topic-select-group
786         :included (gnus-topic-mode-p)]
787        ["See old articles" (gnus-group-select-group 'all)
788         :keys "C-u SPC" :active (gnus-group-group-name)]
789        ["Catch up" gnus-group-catchup-current
790         :included (not (gnus-topic-mode-p))
791         :active (gnus-group-group-name)
792         ,@(if (featurep 'xemacs) nil
793             '(:help "Mark unread articles in the current group as read"))]
794        ["Catch up " gnus-topic-catchup-articles
795         :included (gnus-topic-mode-p)
796         ,@(if (featurep 'xemacs) nil
797             '(:help "Mark unread articles in the current group or topic as read"))]
798        ["Catch up all articles" gnus-group-catchup-current-all
799         (gnus-group-group-name)]
800        ["Check for new articles" gnus-group-get-new-news-this-group
801         :included (not (gnus-topic-mode-p))
802         :active (gnus-group-group-name)
803         ,@(if (featurep 'xemacs) nil
804             '(:help "Check for new messages in current group"))]
805        ["Check for new articles " gnus-topic-get-new-news-this-topic
806         :included (gnus-topic-mode-p)
807         ,@(if (featurep 'xemacs) nil
808             '(:help "Check for new messages in current group or topic"))]
809        ["Toggle subscription" gnus-group-unsubscribe-current-group
810         (gnus-group-group-name)]
811        ["Kill" gnus-group-kill-group :active (gnus-group-group-name)
812         ,@(if (featurep 'xemacs) nil
813               '(:help "Kill (remove) current group"))]
814        ["Yank" gnus-group-yank-group gnus-list-of-killed-groups]
815        ["Describe" gnus-group-describe-group :active (gnus-group-group-name)
816         ,@(if (featurep 'xemacs) nil
817             '(:help "Display description of the current group"))]
818        ["Fetch FAQ" gnus-group-fetch-faq (gnus-group-group-name)]
819        ["Fetch charter" gnus-group-fetch-charter
820         :active (gnus-group-group-name)
821         ,@(if (featurep 'xemacs) nil
822             '(:help "Display the charter of the current group"))]
823        ["Fetch control message" gnus-group-fetch-control
824         :active (gnus-group-group-name)
825         ,@(if (featurep 'xemacs) nil
826             '(:help "Display the archived control message for the current group"))]
827        ;; Actually one should check, if any of the marked groups gives t for
828        ;; (gnus-check-backend-function 'request-expire-articles ...)
829        ["Expire articles" gnus-group-expire-articles
830         :included (not (gnus-topic-mode-p))
831         :active (or (and (gnus-group-group-name)
832                          (gnus-check-backend-function
833                           'request-expire-articles
834                           (gnus-group-group-name))) gnus-group-marked)]
835        ["Expire articles " gnus-topic-expire-articles
836         :included (gnus-topic-mode-p)]
837        ["Set group level..." gnus-group-set-current-level
838         (gnus-group-group-name)]
839        ["Select quick" gnus-group-quick-select-group (gnus-group-group-name)]
840        ["Customize" gnus-group-customize (gnus-group-group-name)]
841        ["Compact" gnus-group-compact-group
842         :active (gnus-group-group-name)]
843        ("Edit"
844         ["Parameters" gnus-group-edit-group-parameters
845          :included (not (gnus-topic-mode-p))
846          :active (gnus-group-group-name)]
847         ["Parameters " gnus-topic-edit-parameters
848          :included (gnus-topic-mode-p)]
849         ["Select method" gnus-group-edit-group-method
850          (gnus-group-group-name)]
851         ["Info" gnus-group-edit-group (gnus-group-group-name)]
852         ["Local kill file" gnus-group-edit-local-kill (gnus-group-group-name)]
853         ["Global kill file" gnus-group-edit-global-kill t])))
854
855     (easy-menu-define
856      gnus-group-group-menu gnus-group-mode-map ""
857      '("Groups"
858        ("Listing"
859         ["List unread subscribed groups" gnus-group-list-groups t]
860         ["List (un)subscribed groups" gnus-group-list-all-groups t]
861         ["List killed groups" gnus-group-list-killed gnus-killed-list]
862         ["List zombie groups" gnus-group-list-zombies gnus-zombie-list]
863         ["List level..." gnus-group-list-level t]
864         ["Describe all groups" gnus-group-describe-all-groups t]
865         ["Group apropos..." gnus-group-apropos t]
866         ["Group and description apropos..." gnus-group-description-apropos t]
867         ["List groups matching..." gnus-group-list-matching t]
868         ["List all groups matching..." gnus-group-list-all-matching t]
869         ["List active file" gnus-group-list-active t]
870         ["List groups with cached" gnus-group-list-cached t]
871         ["List groups with dormant" gnus-group-list-dormant t])
872        ("Sort"
873         ["Default sort" gnus-group-sort-groups t]
874         ["Sort by method" gnus-group-sort-groups-by-method t]
875         ["Sort by rank" gnus-group-sort-groups-by-rank t]
876         ["Sort by score" gnus-group-sort-groups-by-score t]
877         ["Sort by level" gnus-group-sort-groups-by-level t]
878         ["Sort by unread" gnus-group-sort-groups-by-unread t]
879         ["Sort by name" gnus-group-sort-groups-by-alphabet t]
880         ["Sort by real name" gnus-group-sort-groups-by-real-name t])
881        ("Sort process/prefixed"
882         ["Default sort" gnus-group-sort-selected-groups
883          (not (gnus-topic-mode-p))]
884         ["Sort by method" gnus-group-sort-selected-groups-by-method
885          (not (gnus-topic-mode-p))]
886         ["Sort by rank" gnus-group-sort-selected-groups-by-rank
887          (not (gnus-topic-mode-p))]
888         ["Sort by score" gnus-group-sort-selected-groups-by-score
889          (not (gnus-topic-mode-p))]
890         ["Sort by level" gnus-group-sort-selected-groups-by-level
891          (not (gnus-topic-mode-p))]
892         ["Sort by unread" gnus-group-sort-selected-groups-by-unread
893          (not (gnus-topic-mode-p))]
894         ["Sort by name" gnus-group-sort-selected-groups-by-alphabet
895          (not (gnus-topic-mode-p))]
896         ["Sort by real name" gnus-group-sort-selected-groups-by-real-name
897          (not (gnus-topic-mode-p))])
898        ("Mark"
899         ["Mark group" gnus-group-mark-group
900          (and (gnus-group-group-name)
901               (not (memq (gnus-group-group-name) gnus-group-marked)))]
902         ["Unmark group" gnus-group-unmark-group
903          (and (gnus-group-group-name)
904               (memq (gnus-group-group-name) gnus-group-marked))]
905         ["Unmark all" gnus-group-unmark-all-groups gnus-group-marked]
906         ["Mark regexp..." gnus-group-mark-regexp t]
907         ["Mark region" gnus-group-mark-region :active (gnus-mark-active-p)]
908         ["Mark buffer" gnus-group-mark-buffer t]
909         ["Execute command" gnus-group-universal-argument
910          (or gnus-group-marked (gnus-group-group-name))])
911        ("Subscribe"
912         ["Subscribe to a group..." gnus-group-unsubscribe-group t]
913         ["Kill all newsgroups in region" gnus-group-kill-region
914          :active (gnus-mark-active-p)]
915         ["Kill all zombie groups" gnus-group-kill-all-zombies
916          gnus-zombie-list]
917         ["Kill all groups on level..." gnus-group-kill-level t])
918        ("Foreign groups"
919         ["Make a foreign group..." gnus-group-make-group t]
920         ["Add a directory group..." gnus-group-make-directory-group t]
921         ["Add the help group" gnus-group-make-help-group t]
922         ["Add the archive group" gnus-group-make-archive-group t]
923         ["Make a doc group..." gnus-group-make-doc-group t]
924         ["Make a web group..." gnus-group-make-web-group t]
925         ["Make a kiboze group..." gnus-group-make-kiboze-group t]
926         ["Make a virtual group..." gnus-group-make-empty-virtual t]
927         ["Add a group to a virtual..." gnus-group-add-to-virtual t]
928         ["Make an ephemeral group..." gnus-group-read-ephemeral-group t]
929         ["Make an RSS group..." gnus-group-make-rss-group t]
930         ["Rename group..." gnus-group-rename-group
931          (gnus-check-backend-function
932           'request-rename-group (gnus-group-group-name))]
933         ["Delete group" gnus-group-delete-group
934          (gnus-check-backend-function
935           'request-delete-group (gnus-group-group-name))])
936        ("Move"
937         ["Next" gnus-group-next-group t]
938         ["Previous" gnus-group-prev-group t]
939         ["Next unread" gnus-group-next-unread-group t]
940         ["Previous unread" gnus-group-prev-unread-group t]
941         ["Next unread same level" gnus-group-next-unread-group-same-level t]
942         ["Previous unread same level"
943          gnus-group-prev-unread-group-same-level t]
944         ["Jump to group..." gnus-group-jump-to-group t]
945         ["First unread group" gnus-group-first-unread-group t]
946         ["Best unread group" gnus-group-best-unread-group t])
947        ("Sieve"
948         ["Generate" gnus-sieve-generate t]
949         ["Generate and update" gnus-sieve-update t])
950        ["Delete bogus groups" gnus-group-check-bogus-groups t]
951        ["Find new newsgroups" gnus-group-find-new-groups t]
952        ["Transpose" gnus-group-transpose-groups
953         (gnus-group-group-name)]
954        ["Read a directory as a group..." gnus-group-enter-directory t]))
955
956     (easy-menu-define
957      gnus-group-misc-menu gnus-group-mode-map ""
958      `("Gnus"
959        ("SOUP"
960         ["Pack replies" nnsoup-pack-replies (fboundp 'nnsoup-request-group)]
961         ["Send replies" gnus-soup-send-replies
962          (fboundp 'gnus-soup-pack-packet)]
963         ["Pack packet" gnus-soup-pack-packet (fboundp 'gnus-soup-pack-packet)]
964         ["Save areas" gnus-soup-save-areas (fboundp 'gnus-soup-pack-packet)]
965         ["Brew SOUP" gnus-group-brew-soup (fboundp 'gnus-soup-pack-packet)])
966        ["Send a mail" gnus-group-mail t]
967        ["Send a message (mail or news)" gnus-group-post-news t]
968        ["Create a local message" gnus-group-news t]
969        ["Check for new news" gnus-group-get-new-news
970         ,@(if (featurep 'xemacs) '(t)
971             '(:help "Get newly arrived articles"))
972         ]
973        ["Send queued messages" gnus-delay-send-queue
974         ,@(if (featurep 'xemacs) '(t)
975             '(:help "Send all messages that are scheduled to be sent now"))
976         ]
977        ["Activate all groups" gnus-activate-all-groups t]
978        ["Restart Gnus" gnus-group-restart t]
979        ["Read init file" gnus-group-read-init-file t]
980        ["Browse foreign server..." gnus-group-browse-foreign-server t]
981        ["Enter server buffer" gnus-group-enter-server-mode t]
982        ["Expire all expirable articles" gnus-group-expire-all-groups t]
983        ["Generate any kiboze groups" nnkiboze-generate-groups t]
984        ["Gnus version" gnus-version t]
985        ["Save .newsrc files" gnus-group-save-newsrc t]
986        ["Suspend Gnus" gnus-group-suspend t]
987        ["Clear dribble buffer" gnus-group-clear-dribble t]
988        ["Read manual" gnus-info-find-node t]
989        ["Flush score cache" gnus-score-flush-cache t]
990        ["Toggle topics" gnus-topic-mode t]
991        ["Send a bug report" gnus-bug t]
992        ["Exit from Gnus" gnus-group-exit
993         ,@(if (featurep 'xemacs) '(t)
994             '(:help "Quit reading news"))]
995        ["Exit without saving" gnus-group-quit t]))
996
997     (gnus-run-hooks 'gnus-group-menu-hook)))
998
999
1000 (defvar gnus-group-tool-bar-map nil)
1001
1002 ;; Work around for Emacs not updating the tool bar automatically, see
1003 ; http://www.google.com/groups?as_umsgid=v9u0an3hti.fsf@marauder.physik.uni-ulm.de
1004 ;; Don't make this customizable yet.
1005 (defvar gnus-group-redraw-when-idle 2
1006   "When non-nil, redraw the Group buffer frame when idle.
1007 Internal variable.")
1008
1009 (defun gnus-group-redraw-check ()
1010   "Check if we need to redraw the frame."
1011   (when gnus-group-redraw-when-idle
1012     (run-with-idle-timer gnus-group-redraw-when-idle
1013                          nil 'force-window-update)))
1014
1015 (defun gnus-group-tool-bar-update (&optional symbol value)
1016   "Update group buffer toolbar.
1017 Setter function for custom variables."
1018   (when symbol
1019     (set-default symbol value))
1020   ;; (setq-default gnus-group-tool-bar-map nil)
1021   ;; (use-local-map gnus-group-mode-map)
1022   (when (gnus-alive-p)
1023     (with-current-buffer gnus-group-buffer
1024       (gnus-group-make-tool-bar t))))
1025
1026 (defcustom gnus-group-tool-bar (if (eq gmm-tool-bar-style 'gnome)
1027                                    'gnus-group-tool-bar-gnome
1028                                  'gnus-group-tool-bar-retro)
1029   "Specifies the Gnus group tool bar.
1030
1031 It can be either a list or a symbol refering to a list.  See
1032 `gmm-tool-bar-from-list' for the format of the list.  The
1033 default key map is `gnus-group-mode-map'.
1034
1035 Pre-defined symbols include `gnus-group-tool-bar-gnome' and
1036 `gnus-group-tool-bar-retro'."
1037   :type '(choice (const :tag "GNOME style" gnus-group-tool-bar-gnome)
1038                  (const :tag "Retro look" gnus-group-tool-bar-retro)
1039                  (repeat :tag "User defined list" gmm-tool-bar-item)
1040                  (symbol))
1041   :version "23.0" ;; No Gnus
1042   :initialize 'custom-initialize-default
1043   :set 'gnus-group-tool-bar-update
1044   :group 'gnus-group)
1045
1046 (defcustom gnus-group-tool-bar-gnome
1047   '((gnus-group-post-news "mail/compose")
1048     ;; Some useful agent icons?  I don't use the agent so agent users should
1049     ;; suggest useful commands:
1050     (gnus-agent-toggle-plugged "connect" t
1051                                :visible (and gnus-agent (not gnus-plugged)))
1052     (gnus-agent-toggle-plugged "disconnect" t
1053                                :visible (and gnus-agent gnus-plugged))
1054     ;; FIXME: gnus-agent-toggle-plugged (in gnus-agent-group-make-menu-bar)
1055     ;; should have a better help text.
1056     (gnus-group-send-queue "mail/outbox" t
1057                            :visible (and gnus-agent gnus-plugged)
1058                            :help "Send articles from the queue group")
1059     (gnus-group-get-new-news "mail/inbox" nil
1060                              :visible (or (not gnus-agent)
1061                                           gnus-plugged))
1062     ;; FIXME: gnus-*-read-group should have a better help text.
1063     (gnus-topic-read-group "open" nil :visible gnus-topic-mode)
1064     (gnus-group-read-group "open" nil :visible (not gnus-topic-mode))
1065     ;; (gnus-group-find-new-groups "???" nil)
1066     (gnus-group-save-newsrc "save")
1067     (gnus-group-describe-group "describe")
1068     (gnus-group-unsubscribe-current-group "gnus/toggle-subscription")
1069     (gnus-group-prev-unread-group "left-arrow")
1070     (gnus-group-next-unread-group "right-arrow")
1071     (gnus-group-exit "exit")
1072     (gmm-customize-mode "preferences" t :help "Edit mode preferences")
1073     (gnus-info-find-node "help"))
1074   "List of functions for the group tool bar (GNOME style).
1075
1076 See `gmm-tool-bar-from-list' for the format of the list."
1077   :type '(repeat gmm-tool-bar-item)
1078   :version "23.0" ;; No Gnus
1079   :initialize 'custom-initialize-default
1080   :set 'gnus-group-tool-bar-update
1081   :group 'gnus-group)
1082
1083 (defcustom gnus-group-tool-bar-retro
1084   '((gnus-group-get-new-news "gnus/get-news")
1085     (gnus-group-get-new-news-this-group "gnus/gnntg")
1086     (gnus-group-catchup-current "gnus/catchup")
1087     (gnus-group-describe-group "gnus/describe-group")
1088     (gnus-group-subscribe "gnus/subscribe" t
1089                           :help "Subscribe to the current group")
1090     (gnus-group-unsubscribe "gnus/unsubscribe" t
1091                             :help "Unsubscribe from the current group")
1092     (gnus-group-exit "gnus/exit-gnus" gnus-group-mode-map))
1093   "List of functions for the group tool bar (retro look).
1094
1095 See `gmm-tool-bar-from-list' for the format of the list."
1096   :type '(repeat gmm-tool-bar-item)
1097   :version "23.0" ;; No Gnus
1098   :initialize 'custom-initialize-default
1099   :set 'gnus-group-tool-bar-update
1100   :group 'gnus-group)
1101
1102 ;; FIXME: Moving through the Group buffer (in topic mode) e.g. with C-n
1103 ;; doesn't update the state (enabled/disabled) of the icon
1104 ;; `gnus-group-describe-group'.  After `C-l' the state is correct.
1105 ;; See the following report on emacs-devel
1106 ;; <http://thread.gmane.org/v9acdmrcse.fsf@marauder.physik.uni-ulm.de>:
1107 ;; From: Reiner Steib
1108 ;; Subject: tool bar icons not updated according to :active condition
1109 ;; Newsgroups: gmane.emacs.devel
1110 ;; Date: Mon, 23 Jan 2006 19:59:13 +0100
1111 ;; Message-ID: <v9acdmrcse.fsf@marauder.physik.uni-ulm.de>
1112
1113 (defcustom gnus-group-tool-bar-zap-list t
1114   "List of icon items from the global tool bar.
1115 These items are not displayed in the Gnus group mode tool bar.
1116
1117 See `gmm-tool-bar-from-list' for the format of the list."
1118   :type 'gmm-tool-bar-zap-list
1119   :version "23.0" ;; No Gnus
1120   :initialize 'custom-initialize-default
1121   :set 'gnus-group-tool-bar-update
1122   :group 'gnus-group)
1123
1124 (defun gnus-group-make-tool-bar (&optional force)
1125   "Make a group mode tool bar from `gnus-group-tool-bar'.
1126 When FORCE, rebuild the tool bar."
1127   (when (and (not (featurep 'xemacs))
1128              (boundp 'tool-bar-mode)
1129              tool-bar-mode
1130              ;; The Gnus 5.10.6 code checked (default-value 'tool-bar-mode).
1131              ;; Why?  --rsteib
1132              (or (not gnus-group-tool-bar-map) force))
1133     (when gnus-group-redraw-when-idle
1134       (add-to-list (make-local-variable 'post-command-hook)
1135                    'gnus-group-redraw-check))
1136     (let* ((load-path
1137             (gmm-image-load-path "gnus" "gnus/toggle-subscription.xpm"
1138                                  'load-path))
1139            (image-load-path
1140             (gmm-image-load-path "gnus" "gnus/toggle-subscription.xpm"
1141                                  'image-load-path))
1142            (map (gmm-tool-bar-from-list gnus-group-tool-bar
1143                                         gnus-group-tool-bar-zap-list
1144                                         'gnus-group-mode-map)))
1145       (if map
1146           (set (make-local-variable 'tool-bar-map) map))))
1147   gnus-group-tool-bar-map)
1148
1149 (defun gnus-group-mode ()
1150   "Major mode for reading news.
1151
1152 All normal editing commands are switched off.
1153 \\<gnus-group-mode-map>
1154 The group buffer lists (some of) the groups available.  For instance,
1155 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
1156 lists all zombie groups.
1157
1158 Groups that are displayed can be entered with `\\[gnus-group-read-group]'.  To subscribe
1159 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
1160
1161 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
1162
1163 The following commands are available:
1164
1165 \\{gnus-group-mode-map}"
1166   (interactive)
1167   (kill-all-local-variables)
1168   (when (gnus-visual-p 'group-menu 'menu)
1169     (gnus-group-make-menu-bar)
1170     (gnus-group-make-tool-bar))
1171   (gnus-simplify-mode-line)
1172   (setq major-mode 'gnus-group-mode)
1173   (setq mode-name "Group")
1174   (gnus-group-set-mode-line)
1175   (setq mode-line-process nil)
1176   (use-local-map gnus-group-mode-map)
1177   (buffer-disable-undo)
1178   (setq truncate-lines t)
1179   (setq buffer-read-only t
1180         show-trailing-whitespace nil)
1181   (gnus-set-default-directory)
1182   (gnus-update-format-specifications nil 'group 'group-mode)
1183   (gnus-update-group-mark-positions)
1184   (when gnus-use-undo
1185     (gnus-undo-mode 1))
1186   (when gnus-slave
1187     (gnus-slave-mode))
1188   (gnus-run-mode-hooks 'gnus-group-mode-hook))
1189
1190 (defun gnus-update-group-mark-positions ()
1191   (save-excursion
1192     (let ((gnus-process-mark ?\200)
1193           (gnus-group-update-hook nil)
1194           (gnus-group-marked '("dummy.group"))
1195           (gnus-active-hashtb (make-vector 10 0))
1196           (topic ""))
1197       (gnus-set-active "dummy.group" '(0 . 0))
1198       (gnus-set-work-buffer)
1199       (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
1200       (goto-char (point-min))
1201       (setq gnus-group-mark-positions
1202             (list (cons 'process (and (search-forward
1203                                        (mm-string-as-multibyte "\200") nil t)
1204                                       (- (point) 2))))))))
1205
1206 (defun gnus-mouse-pick-group (e)
1207   "Enter the group under the mouse pointer."
1208   (interactive "e")
1209   (mouse-set-point e)
1210   (gnus-group-read-group nil))
1211
1212 ;; Look at LEVEL and find out what the level is really supposed to be.
1213 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
1214 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
1215 (defun gnus-group-default-level (&optional level number-or-nil)
1216   (cond
1217    (gnus-group-use-permanent-levels
1218     (or (setq gnus-group-use-permanent-levels
1219               (or level (if (numberp gnus-group-use-permanent-levels)
1220                             gnus-group-use-permanent-levels
1221                           (or gnus-group-default-list-level
1222                               gnus-level-subscribed))))
1223         gnus-group-default-list-level gnus-level-subscribed))
1224    (number-or-nil
1225     level)
1226    (t
1227     (or level gnus-group-default-list-level gnus-level-subscribed))))
1228
1229 (defun gnus-group-setup-buffer ()
1230   (set-buffer (gnus-get-buffer-create gnus-group-buffer))
1231   (unless (eq major-mode 'gnus-group-mode)
1232     (gnus-group-mode)
1233     (when gnus-carpal
1234       (gnus-carpal-setup-buffer 'group))))
1235
1236 (defun gnus-group-name-charset (method group)
1237   (if (null method)
1238       (setq method (gnus-find-method-for-group group)))
1239   (let ((item (assoc method gnus-group-name-charset-method-alist))
1240         (alist gnus-group-name-charset-group-alist)
1241         result)
1242     (if item
1243         (cdr item)
1244       (while (setq item (pop alist))
1245         (if (string-match (car item) group)
1246             (setq alist nil
1247                   result (cdr item))))
1248       result)))
1249
1250 (defun gnus-group-name-decode (string charset)
1251   ;; Fixme: Don't decode in unibyte mode.
1252   (if (and string charset (featurep 'mule))
1253       (mm-decode-coding-string string charset)
1254     string))
1255
1256 (defun gnus-group-decoded-name (string)
1257   (let ((charset (gnus-group-name-charset nil string)))
1258     (gnus-group-name-decode string charset)))
1259
1260 (defun gnus-group-list-groups (&optional level unread lowest)
1261   "List newsgroups with level LEVEL or lower that have unread articles.
1262 Default is all subscribed groups.
1263 If argument UNREAD is non-nil, groups with no unread articles are also
1264 listed.
1265
1266 Also see the `gnus-group-use-permanent-levels' variable."
1267   (interactive
1268    (list (if current-prefix-arg
1269              (prefix-numeric-value current-prefix-arg)
1270            (or
1271             (gnus-group-default-level nil t)
1272             gnus-group-default-list-level
1273             gnus-level-subscribed))))
1274   (unless level
1275     (setq level (car gnus-group-list-mode)
1276           unread (cdr gnus-group-list-mode)))
1277   (setq level (gnus-group-default-level level))
1278   (gnus-group-setup-buffer)
1279   (gnus-update-format-specifications nil 'group 'group-mode)
1280   (let ((case-fold-search nil)
1281         (props (text-properties-at (point-at-bol)))
1282         (empty (= (point-min) (point-max)))
1283         (group (gnus-group-group-name))
1284         number)
1285     (set-buffer gnus-group-buffer)
1286     (setq number (funcall gnus-group-prepare-function level unread lowest))
1287     (when (or (and (numberp number)
1288                    (zerop number))
1289               (zerop (buffer-size)))
1290       ;; No groups in the buffer.
1291       (gnus-message 5 gnus-no-groups-message))
1292     ;; We have some groups displayed.
1293     (goto-char (point-max))
1294     (when (or (not gnus-group-goto-next-group-function)
1295               (not (funcall gnus-group-goto-next-group-function
1296                             group props)))
1297       (cond
1298        (empty
1299         (goto-char (point-min)))
1300        ((not group)
1301         ;; Go to the first group with unread articles.
1302         (gnus-group-search-forward t))
1303        (t
1304         ;; Find the right group to put point on.  If the current group
1305         ;; has disappeared in the new listing, try to find the next
1306         ;; one.  If no next one can be found, just leave point at the
1307         ;; first newsgroup in the buffer.
1308         (when (not (gnus-goto-char
1309                     (text-property-any
1310                      (point-min) (point-max)
1311                      'gnus-group (gnus-intern-safe
1312                                   group gnus-active-hashtb))))
1313           (let ((newsrc (cdddr (gnus-group-entry group))))
1314             (while (and newsrc
1315                         (not (gnus-goto-char
1316                               (text-property-any
1317                                (point-min) (point-max) 'gnus-group
1318                                (gnus-intern-safe
1319                                 (caar newsrc) gnus-active-hashtb)))))
1320               (setq newsrc (cdr newsrc)))
1321             (unless newsrc
1322               (goto-char (point-max))
1323               (forward-line -1)))))))
1324     ;; Adjust cursor point.
1325     (gnus-group-position-point)))
1326
1327 (defun gnus-group-list-level (level &optional all)
1328   "List groups on LEVEL.
1329 If ALL (the prefix), also list groups that have no unread articles."
1330   (interactive "nList groups on level: \nP")
1331   (gnus-group-list-groups level all level))
1332
1333 (defun gnus-group-prepare-logic (group test)
1334   (or (and gnus-group-listed-groups
1335            (null gnus-group-list-option)
1336            (member group gnus-group-listed-groups))
1337       (cond
1338        ((null gnus-group-listed-groups) test)
1339        ((null gnus-group-list-option) test)
1340        (t (and (member group gnus-group-listed-groups)
1341                (if (eq gnus-group-list-option 'flush)
1342                    (not test)
1343                  test))))))
1344
1345 (defun gnus-group-prepare-flat (level &optional predicate lowest regexp)
1346   "List all newsgroups with unread articles of level LEVEL or lower.
1347 If PREDICATE is a function, list groups that the function returns non-nil;
1348 if it is t, list groups that have no unread articles.
1349 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
1350 If REGEXP is a function, list dead groups that the function returns non-nil;
1351 if it is a string, only list groups matching REGEXP."
1352   (set-buffer gnus-group-buffer)
1353   (let ((buffer-read-only nil)
1354         (newsrc (cdr gnus-newsrc-alist))
1355         (lowest (or lowest 1))
1356         (not-in-list (and gnus-group-listed-groups
1357                           (copy-sequence gnus-group-listed-groups)))
1358         info clevel unread group params)
1359     (erase-buffer)
1360     (when (or (< lowest gnus-level-zombie)
1361               gnus-group-listed-groups)
1362       ;; List living groups.
1363       (while newsrc
1364         (setq info (car newsrc)
1365               group (gnus-info-group info)
1366               params (gnus-info-params info)
1367               newsrc (cdr newsrc)
1368               unread (gnus-group-unread group))
1369         (when not-in-list
1370           (setq not-in-list (delete group not-in-list)))
1371         (when (gnus-group-prepare-logic
1372                group
1373                (and unread              ; This group might be unchecked
1374                     (or (not (stringp regexp))
1375                         (string-match regexp group))
1376                     (<= (setq clevel (gnus-info-level info)) level)
1377                     (>= clevel lowest)
1378                     (cond
1379                      ((functionp predicate)
1380                       (funcall predicate info))
1381                      (predicate t)      ; We list all groups?
1382                      (t
1383                       (or
1384                        (if (eq unread t) ; Unactivated?
1385                            gnus-group-list-inactive-groups
1386                                         ; We list unactivated
1387                          (> unread 0))
1388                                         ; We list groups with unread articles
1389                        (and gnus-list-groups-with-ticked-articles
1390                             (cdr (assq 'tick (gnus-info-marks info))))
1391                                         ; And groups with tickeds
1392                        ;; Check for permanent visibility.
1393                        (and gnus-permanently-visible-groups
1394                             (string-match gnus-permanently-visible-groups
1395                                           group))
1396                        (memq 'visible params)
1397                        (cdr (assq 'visible params)))))))
1398           (gnus-group-insert-group-line
1399            group (gnus-info-level info)
1400            (gnus-info-marks info) unread (gnus-info-method info)))))
1401
1402     ;; List dead groups.
1403     (when (or gnus-group-listed-groups
1404               (and (>= level gnus-level-zombie)
1405                    (<= lowest gnus-level-zombie)))
1406       (gnus-group-prepare-flat-list-dead
1407        (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
1408        gnus-level-zombie ?Z
1409        regexp))
1410     (when not-in-list
1411       (dolist (group gnus-zombie-list)
1412         (setq not-in-list (delete group not-in-list))))
1413     (when (or gnus-group-listed-groups
1414               (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)))
1415       (gnus-group-prepare-flat-list-dead
1416        (gnus-union
1417         not-in-list
1418         (setq gnus-killed-list (sort gnus-killed-list 'string<)))
1419        gnus-level-killed ?K regexp))
1420
1421     (gnus-group-set-mode-line)
1422     (setq gnus-group-list-mode (cons level predicate))
1423     (gnus-run-hooks 'gnus-group-prepare-hook)
1424     t))
1425
1426 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
1427   ;; List zombies and killed lists somewhat faster, which was
1428   ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.  It does
1429   ;; this by ignoring the group format specification altogether.
1430   (let (group)
1431     (if (> (length groups) gnus-group-listing-limit)
1432         (while groups
1433           (setq group (pop groups))
1434           (when (gnus-group-prepare-logic
1435                  group
1436                  (or (not regexp)
1437                      (and (stringp regexp) (string-match regexp group))
1438                      (and (functionp regexp) (funcall regexp group))))
1439             (gnus-add-text-properties
1440              (point) (prog1 (1+ (point))
1441                        (insert " " mark "     *: "
1442                                (gnus-group-decoded-name group)
1443                                "\n"))
1444              (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1445                    'gnus-unread t
1446                    'gnus-level level))))
1447       (while groups
1448         (setq group (pop groups))
1449         (when (gnus-group-prepare-logic
1450                group
1451                (or (not regexp)
1452                    (and (stringp regexp) (string-match regexp group))
1453                    (and (functionp regexp) (funcall regexp group))))
1454           (gnus-group-insert-group-line
1455            group level nil
1456            (let ((active (gnus-active group)))
1457              (if active
1458                  (if (zerop (cdr active))
1459                      0
1460                    (- (1+ (cdr active)) (car active)))
1461                nil))
1462            (gnus-method-simplify (gnus-find-method-for-group group))))))))
1463
1464 (defun gnus-group-update-group-line ()
1465   "Update the current line in the group buffer."
1466   (let* ((buffer-read-only nil)
1467          (group (gnus-group-group-name))
1468          (entry (and group (gnus-group-entry group)))
1469          gnus-group-indentation)
1470     (when group
1471       (and entry
1472            (not (gnus-ephemeral-group-p group))
1473            (gnus-dribble-enter
1474             (concat "(gnus-group-set-info '"
1475                     (gnus-prin1-to-string (nth 2 entry))
1476                     ")")))
1477       (setq gnus-group-indentation (gnus-group-group-indentation))
1478       (gnus-delete-line)
1479       (gnus-group-insert-group-line-info group)
1480       (forward-line -1)
1481       (gnus-group-position-point))))
1482
1483 (defun gnus-group-insert-group-line-info (group)
1484   "Insert GROUP on the current line."
1485   (let ((entry (gnus-group-entry group))
1486         (gnus-group-indentation (gnus-group-group-indentation))
1487         active info)
1488     (if entry
1489         (progn
1490           ;; (Un)subscribed group.
1491           (setq info (nth 2 entry))
1492           (gnus-group-insert-group-line
1493            group (gnus-info-level info) (gnus-info-marks info)
1494            (or (car entry) t) (gnus-info-method info)))
1495       ;; This group is dead.
1496       (gnus-group-insert-group-line
1497        group
1498        (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1499        nil
1500        (if (setq active (gnus-active group))
1501            (if (zerop (cdr active))
1502                0
1503              (- (1+ (cdr active)) (car active)))
1504          nil)
1505        (gnus-method-simplify (gnus-find-method-for-group group))))))
1506
1507 (defun gnus-number-of-unseen-articles-in-group (group)
1508   (let* ((info (nth 2 (gnus-group-entry group)))
1509          (marked (gnus-info-marks info))
1510          (seen (cdr (assq 'seen marked)))
1511          (active (gnus-active group)))
1512     (if (not active)
1513         0
1514       (length (gnus-uncompress-range
1515                (gnus-range-difference
1516                 (gnus-range-difference (list active) (gnus-info-read info))
1517                 seen))))))
1518
1519 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1520                                                     gnus-tmp-marked number
1521                                                     gnus-tmp-method)
1522   "Insert a group line in the group buffer."
1523   (let* ((gnus-tmp-method
1524           (gnus-server-get-method gnus-tmp-group gnus-tmp-method))
1525          (group-name-charset (gnus-group-name-charset gnus-tmp-method
1526                                                       gnus-tmp-group))
1527          (gnus-tmp-active (gnus-active gnus-tmp-group))
1528          (gnus-tmp-number-total
1529           (if gnus-tmp-active
1530               (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1531             0))
1532          (gnus-tmp-number-of-unread
1533           (if (numberp number) (int-to-string (max 0 number))
1534             "*"))
1535          (gnus-tmp-number-of-read
1536           (if (numberp number)
1537               (int-to-string (max 0 (- gnus-tmp-number-total number)))
1538             "*"))
1539          (gnus-tmp-subscribed
1540           (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1541                 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1542                 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1543                 (t ?K)))
1544          (gnus-tmp-qualified-group
1545           (gnus-group-name-decode (gnus-group-real-name gnus-tmp-group)
1546                                   group-name-charset))
1547          (gnus-tmp-comment
1548           (or (gnus-group-get-parameter gnus-tmp-group 'comment t)
1549               gnus-tmp-group))
1550          (gnus-tmp-newsgroup-description
1551           (if gnus-description-hashtb
1552               (or (gnus-group-name-decode
1553                    (gnus-gethash gnus-tmp-group gnus-description-hashtb)
1554                    group-name-charset) "")
1555             ""))
1556          (gnus-tmp-moderated
1557           (if (and gnus-moderated-hashtb
1558                    (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1559               ?m ? ))
1560          (gnus-tmp-moderated-string
1561           (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1562          (gnus-tmp-group-icon "==&&==")
1563          (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1564          (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1565          (gnus-tmp-news-method-string
1566           (if gnus-tmp-method
1567               (format "(%s:%s)" (car gnus-tmp-method)
1568                       (cadr gnus-tmp-method)) ""))
1569          (gnus-tmp-marked-mark
1570           (if (and (numberp number)
1571                    (zerop number)
1572                    (cdr (assq 'tick gnus-tmp-marked)))
1573               ?* ? ))
1574          (gnus-tmp-summary-live
1575           (if (and (not gnus-group-is-exiting-p)
1576                    (gnus-buffer-live-p (gnus-summary-buffer-name
1577                                         gnus-tmp-group)))
1578               ?* ? ))
1579          (gnus-tmp-process-marked
1580           (if (member gnus-tmp-group gnus-group-marked)
1581               gnus-process-mark ? ))
1582          (buffer-read-only nil)
1583          header gnus-tmp-header)        ; passed as parameter to user-funcs.
1584     (beginning-of-line)
1585     (gnus-add-text-properties
1586      (point)
1587      (prog1 (1+ (point))
1588        ;; Insert the text.
1589        (let ((gnus-tmp-decoded-group (gnus-group-name-decode
1590                                       gnus-tmp-group group-name-charset)))
1591          (eval gnus-group-line-format-spec)))
1592      `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1593                   gnus-unread ,(if (numberp number)
1594                                    (string-to-number gnus-tmp-number-of-unread)
1595                                  t)
1596                   gnus-marked ,gnus-tmp-marked-mark
1597                   gnus-indentation ,gnus-group-indentation
1598                   gnus-level ,gnus-tmp-level))
1599     (forward-line -1)
1600     (when (inline (gnus-visual-p 'group-highlight 'highlight))
1601       (gnus-run-hooks 'gnus-group-update-hook))
1602     (forward-line)
1603     ;; Allow XEmacs to remove front-sticky text properties.
1604     (gnus-group-remove-excess-properties)))
1605
1606 (defun gnus-group-highlight-line ()
1607   "Highlight the current line according to `gnus-group-highlight'."
1608   (let* ((list gnus-group-highlight)
1609          (p (point))
1610          (end (point-at-eol))
1611          ;; now find out where the line starts and leave point there.
1612          (beg (progn (beginning-of-line) (point)))
1613          (group (gnus-group-group-name))
1614          (entry (gnus-group-entry group))
1615          (unread (if (numberp (car entry)) (car entry) 0))
1616          (active (gnus-active group))
1617          (total (if active (1+ (- (cdr active) (car active))) 0))
1618          (info (nth 2 entry))
1619          (method (inline (gnus-server-get-method group (gnus-info-method info))))
1620          (marked (gnus-info-marks info))
1621          (mailp (apply 'append
1622                        (mapcar
1623                         (lambda (x)
1624                           (memq x (assoc (symbol-name
1625                                           (car (or method gnus-select-method)))
1626                                          gnus-valid-select-methods)))
1627                         '(mail post-mail))))
1628          (level (or (gnus-info-level info) gnus-level-killed))
1629          (score (or (gnus-info-score info) 0))
1630          (ticked (gnus-range-length (cdr (assq 'tick marked))))
1631          (group-age (gnus-group-timestamp-delta group))
1632          (inhibit-read-only t))
1633     ;; Eval the cars of the lists until we find a match.
1634     (while (and list
1635                 (not (eval (caar list))))
1636       (setq list (cdr list)))
1637     (let ((face (cdar list)))
1638       (unless (eq face (get-text-property beg 'face))
1639         (gnus-put-text-property-excluding-characters-with-faces
1640          beg end 'face
1641          (setq face (if (boundp face) (symbol-value face) face)))
1642         (gnus-extent-start-open beg)))
1643     (goto-char p)))
1644
1645 (defun gnus-group-update-group (group &optional visible-only)
1646   "Update all lines where GROUP appear.
1647 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1648 already."
1649   ;; Can't use `save-excursion' here, so we do it manually.
1650   (let ((buf (current-buffer))
1651         mark)
1652     (set-buffer gnus-group-buffer)
1653     (setq mark (point-marker))
1654     ;; The buffer may be narrowed.
1655     (save-restriction
1656       (widen)
1657       (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1658             (loc (point-min))
1659             found buffer-read-only)
1660         ;; Enter the current status into the dribble buffer.
1661         (let ((entry (gnus-group-entry group)))
1662           (when (and entry
1663                      (not (gnus-ephemeral-group-p group)))
1664             (gnus-dribble-enter
1665              (concat "(gnus-group-set-info '"
1666                      (gnus-prin1-to-string (nth 2 entry))
1667                      ")"))))
1668         ;; Find all group instances.  If topics are in use, each group
1669         ;; may be listed in more than once.
1670         (while (setq loc (text-property-any
1671                           loc (point-max) 'gnus-group ident))
1672           (setq found t)
1673           (goto-char loc)
1674           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1675             (gnus-delete-line)
1676             (gnus-group-insert-group-line-info group)
1677             (save-excursion
1678               (forward-line -1)
1679               (gnus-run-hooks 'gnus-group-update-group-hook)))
1680           (setq loc (1+ loc)))
1681         (unless (or found visible-only)
1682           ;; No such line in the buffer, find out where it's supposed to
1683           ;; go, and insert it there (or at the end of the buffer).
1684           (if gnus-goto-missing-group-function
1685               (funcall gnus-goto-missing-group-function group)
1686             (let ((entry (cddr (gnus-group-entry group))))
1687               (while (and entry (car entry)
1688                           (not
1689                            (gnus-goto-char
1690                             (text-property-any
1691                              (point-min) (point-max)
1692                              'gnus-group (gnus-intern-safe
1693                                           (caar entry) gnus-active-hashtb)))))
1694                 (setq entry (cdr entry)))
1695               (or entry (goto-char (point-max)))))
1696           ;; Finally insert the line.
1697           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1698             (gnus-group-insert-group-line-info group)
1699             (save-excursion
1700               (forward-line -1)
1701               (gnus-run-hooks 'gnus-group-update-group-hook))))
1702         (when gnus-group-update-group-function
1703           (funcall gnus-group-update-group-function group))
1704         (gnus-group-set-mode-line)))
1705     (goto-char mark)
1706     (set-marker mark nil)
1707     (set-buffer buf)))
1708
1709 (defun gnus-group-set-mode-line ()
1710   "Update the mode line in the group buffer."
1711   (when (memq 'group gnus-updated-mode-lines)
1712     ;; Yes, we want to keep this mode line updated.
1713     (save-excursion
1714       (set-buffer gnus-group-buffer)
1715       (let* ((gformat (or gnus-group-mode-line-format-spec
1716                           (gnus-set-format 'group-mode)))
1717              (gnus-tmp-news-server (cadr gnus-select-method))
1718              (gnus-tmp-news-method (car gnus-select-method))
1719              (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1720              (max-len 60)
1721              gnus-tmp-header            ;Dummy binding for user-defined formats
1722              ;; Get the resulting string.
1723              (modified
1724               (and gnus-dribble-buffer
1725                    (buffer-name gnus-dribble-buffer)
1726                    (buffer-modified-p gnus-dribble-buffer)
1727                    (save-excursion
1728                      (set-buffer gnus-dribble-buffer)
1729                      (not (zerop (buffer-size))))))
1730              (mode-string (eval gformat)))
1731         ;; Say whether the dribble buffer has been modified.
1732         (setq mode-line-modified
1733               (if modified (car gnus-mode-line-modified)
1734                 (cdr gnus-mode-line-modified)))
1735         ;; If the line is too long, we chop it off.
1736         (when (> (length mode-string) max-len)
1737           (setq mode-string (substring mode-string 0 (- max-len 4))))
1738         (prog1
1739             (setq mode-line-buffer-identification
1740                   (gnus-mode-line-buffer-identification
1741                    (list mode-string)))
1742           (set-buffer-modified-p modified))))))
1743
1744 (defun gnus-group-group-name ()
1745   "Get the name of the newsgroup on the current line."
1746   (let ((group (get-text-property (point-at-bol) 'gnus-group)))
1747     (when group
1748       (symbol-name group))))
1749
1750 (defun gnus-group-group-level ()
1751   "Get the level of the newsgroup on the current line."
1752   (get-text-property (point-at-bol) 'gnus-level))
1753
1754 (defun gnus-group-group-indentation ()
1755   "Get the indentation of the newsgroup on the current line."
1756   (or (get-text-property (point-at-bol) 'gnus-indentation)
1757       (and gnus-group-indentation-function
1758            (funcall gnus-group-indentation-function))
1759       ""))
1760
1761 (defun gnus-group-group-unread ()
1762   "Get the number of unread articles of the newsgroup on the current line."
1763   (get-text-property (point-at-bol) 'gnus-unread))
1764
1765 (defun gnus-group-new-mail (group)
1766   (if (nnmail-new-mail-p (gnus-group-real-name group))
1767       gnus-new-mail-mark
1768     ? ))
1769
1770 (defun gnus-group-level (group)
1771   "Return the estimated level of GROUP."
1772   (or (gnus-info-level (gnus-get-info group))
1773       (and (member group gnus-zombie-list) gnus-level-zombie)
1774       gnus-level-killed))
1775
1776 (defun gnus-group-search-forward (&optional backward all level first-too)
1777   "Find the next newsgroup with unread articles.
1778 If BACKWARD is non-nil, find the previous newsgroup instead.
1779 If ALL is non-nil, just find any newsgroup.
1780 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1781 group exists.
1782 If FIRST-TOO, the current line is also eligible as a target."
1783   (let ((way (if backward -1 1))
1784         (low gnus-level-killed)
1785         (beg (point))
1786         pos found lev)
1787     (if (and backward (progn (beginning-of-line)) (bobp))
1788         nil
1789       (unless first-too
1790         (forward-line way))
1791       (while (and
1792               (not (eobp))
1793               (not (setq
1794                     found
1795                     (and
1796                      (get-text-property (point) 'gnus-group)
1797                      (or all
1798                          (and
1799                           (let ((unread
1800                                  (get-text-property (point) 'gnus-unread)))
1801                             (and (numberp unread) (> unread 0)))
1802                           (setq lev (get-text-property (point)
1803                                                        'gnus-level))
1804                           (<= lev gnus-level-subscribed)))
1805                      (or (not level)
1806                          (and (setq lev (get-text-property (point)
1807                                                            'gnus-level))
1808                               (or (= lev level)
1809                                   (and (< lev low)
1810                                        (< level lev)
1811                                        (progn
1812                                          (setq low lev)
1813                                          (setq pos (point))
1814                                          nil))))))))
1815               (zerop (forward-line way)))))
1816     (if found
1817         (progn (gnus-group-position-point) t)
1818       (goto-char (or pos beg))
1819       (and pos t))))
1820
1821 (defun gnus-total-fetched-for (group)
1822   (let* ((size-in-cache (or (gnus-cache-total-fetched-for group) 0))
1823          (size-in-agent (or (gnus-agent-total-fetched-for group) 0))
1824          (size (+ size-in-cache size-in-agent))
1825          (suffix '("B" "K" "M" "G"))
1826          (scale 1024.0)
1827          (cutoff scale))
1828     (while (> size cutoff)
1829       (setq size (/ size scale)
1830             suffix (cdr suffix)))
1831     (format "%5.1f%s" size (car suffix))))
1832
1833 ;;; Gnus group mode commands
1834
1835 ;; Group marking.
1836
1837 (defun gnus-group-mark-line-p ()
1838   (save-excursion
1839     (beginning-of-line)
1840     (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1841     (eq (char-after) gnus-process-mark)))
1842
1843 (defun gnus-group-mark-group (n &optional unmark no-advance)
1844   "Mark the current group."
1845   (interactive "p")
1846   (let ((buffer-read-only nil)
1847         group)
1848     (while (and (> n 0)
1849                 (not (eobp)))
1850       (when (setq group (gnus-group-group-name))
1851         ;; Go to the mark position.
1852         (beginning-of-line)
1853         (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1854         (delete-char 1)
1855         (if unmark
1856             (progn
1857               (setq gnus-group-marked (delete group gnus-group-marked))
1858               (insert-char ? 1 t))
1859            (setq gnus-group-marked
1860                  (cons group (delete group gnus-group-marked)))
1861            (insert-char gnus-process-mark 1 t)))
1862       (unless no-advance
1863         (gnus-group-next-group 1))
1864       (decf n))
1865     (gnus-summary-position-point)
1866     n))
1867
1868 (defun gnus-group-unmark-group (n)
1869   "Remove the mark from the current group."
1870   (interactive "p")
1871   (gnus-group-mark-group n 'unmark)
1872   (gnus-group-position-point))
1873
1874 (defun gnus-group-unmark-all-groups ()
1875   "Unmark all groups."
1876   (interactive)
1877   (save-excursion
1878     (mapc 'gnus-group-remove-mark gnus-group-marked))
1879   (gnus-group-position-point))
1880
1881 (defun gnus-group-mark-region (unmark beg end)
1882   "Mark all groups between point and mark.
1883 If UNMARK, remove the mark instead."
1884   (interactive "P\nr")
1885   (let ((num (count-lines beg end)))
1886     (save-excursion
1887       (goto-char beg)
1888       (- num (gnus-group-mark-group num unmark)))))
1889
1890 (defun gnus-group-mark-buffer (&optional unmark)
1891   "Mark all groups in the buffer.
1892 If UNMARK, remove the mark instead."
1893   (interactive "P")
1894   (gnus-group-mark-region unmark (point-min) (point-max)))
1895
1896 (defun gnus-group-mark-regexp (regexp)
1897   "Mark all groups that match some regexp."
1898   (interactive "sMark (regexp): ")
1899   (let ((alist (cdr gnus-newsrc-alist))
1900         group)
1901     (save-excursion
1902       (while alist
1903         (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1904           (gnus-group-jump-to-group group)
1905           (gnus-group-set-mark group)))))
1906   (gnus-group-position-point))
1907
1908 (defun gnus-group-remove-mark (group &optional test-marked)
1909   "Remove the process mark from GROUP and move point there.
1910 Return nil if the group isn't displayed."
1911   (if (gnus-group-goto-group group nil test-marked)
1912       (save-excursion
1913         (gnus-group-mark-group 1 'unmark t)
1914         t)
1915     (setq gnus-group-marked
1916           (delete group gnus-group-marked))
1917     nil))
1918
1919 (defun gnus-group-set-mark (group)
1920   "Set the process mark on GROUP."
1921   (if (gnus-group-goto-group group)
1922       (save-excursion
1923         (gnus-group-mark-group 1 nil t))
1924     (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1925
1926 (defun gnus-group-universal-argument (arg &optional groups func)
1927   "Perform any command on all groups according to the process/prefix convention."
1928   (interactive "P")
1929   (if (eq (setq func (or func
1930                          (key-binding
1931                           (read-key-sequence
1932                            (substitute-command-keys
1933                             "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1934           'undefined)
1935       (gnus-error 1 "Undefined key")
1936     (gnus-group-iterate arg
1937       (lambda (group)
1938         (command-execute func))))
1939   (gnus-group-position-point))
1940
1941 (defun gnus-group-process-prefix (n)
1942   "Return a list of groups to work on.
1943 Take into consideration N (the prefix) and the list of marked groups."
1944   (cond
1945    (n
1946     (setq n (prefix-numeric-value n))
1947     ;; There is a prefix, so we return a list of the N next
1948     ;; groups.
1949     (let ((way (if (< n 0) -1 1))
1950           (n (abs n))
1951           group groups)
1952       (save-excursion
1953         (while (> n 0)
1954           (if (setq group (gnus-group-group-name))
1955               (push group groups))
1956           (setq n (1- n))
1957           (gnus-group-next-group way)))
1958       (nreverse groups)))
1959    ((and (gnus-region-active-p) (mark))
1960     ;; Work on the region between point and mark.
1961     (let ((max (max (point) (mark)))
1962           groups)
1963       (save-excursion
1964         (goto-char (min (point) (mark)))
1965         (while
1966             (and
1967              (push (gnus-group-group-name) groups)
1968              (zerop (gnus-group-next-group 1))
1969              (< (point) max)))
1970         (nreverse groups))))
1971    (gnus-group-marked
1972     ;; No prefix, but a list of marked articles.
1973     (reverse gnus-group-marked))
1974    (t
1975     ;; Neither marked articles or a prefix, so we return the
1976     ;; current group.
1977     (let ((group (gnus-group-group-name)))
1978       (and group (list group))))))
1979
1980 ;;; !!!Surely gnus-group-iterate should be a macro instead?  I can't
1981 ;;; imagine why I went through these contortions...
1982 (eval-and-compile
1983   (let ((function (make-symbol "gnus-group-iterate-function"))
1984         (window (make-symbol "gnus-group-iterate-window"))
1985         (groups (make-symbol "gnus-group-iterate-groups"))
1986         (group (make-symbol "gnus-group-iterate-group")))
1987     (eval
1988      `(defun gnus-group-iterate (arg ,function)
1989         "Iterate FUNCTION over all process/prefixed groups.
1990 FUNCTION will be called with the group name as the parameter
1991 and with point over the group in question."
1992         (let ((,groups (gnus-group-process-prefix arg))
1993               (,window (selected-window))
1994               ,group)
1995           (while ,groups
1996             (setq ,group (car ,groups)
1997                   ,groups (cdr ,groups))
1998             (select-window ,window)
1999             (gnus-group-remove-mark ,group)
2000             (save-selected-window
2001               (save-excursion
2002                 (funcall ,function ,group)))))))))
2003
2004 (put 'gnus-group-iterate 'lisp-indent-function 1)
2005
2006 ;; Selecting groups.
2007
2008 (defun gnus-group-read-group (&optional all no-article group select-articles)
2009   "Read news in this newsgroup.
2010 If the prefix argument ALL is non-nil, already read articles become
2011 readable.  IF ALL is a number, fetch this number of articles.  If the
2012 optional argument NO-ARTICLE is non-nil, no article will be
2013 auto-selected upon group entry.  If GROUP is non-nil, fetch that
2014 group."
2015   (interactive "P")
2016   (let ((no-display (eq all 0))
2017         (group (or group (gnus-group-group-name)))
2018         number active marked entry)
2019     (when (eq all 0)
2020       (setq all nil))
2021     (unless group
2022       (error "No group on current line"))
2023     (setq marked (gnus-info-marks
2024                   (nth 2 (setq entry (gnus-group-entry group)))))
2025     ;; This group might be a dead group.  In that case we have to get
2026     ;; the number of unread articles from `gnus-active-hashtb'.
2027     (setq number
2028           (cond ((numberp all) all)
2029                 (entry (car entry))
2030                 ((setq active (gnus-active group))
2031                  (- (1+ (cdr active)) (car active)))))
2032     (gnus-summary-read-group
2033      group (or all (and (numberp number)
2034                         (zerop (+ number (gnus-range-length
2035                                           (cdr (assq 'tick marked)))
2036                                   (gnus-range-length
2037                                    (cdr (assq 'dormant marked)))))))
2038      no-article nil no-display nil select-articles)))
2039
2040 (defun gnus-group-select-group (&optional all)
2041   "Select this newsgroup.
2042 No article is selected automatically.
2043 If the group is opened, just switch the summary buffer.
2044 If ALL is non-nil, already read articles become readable.
2045 If ALL is a positive number, fetch this number of the latest
2046 articles in the group.
2047 If ALL is a negative number, fetch this number of the earliest
2048 articles in the group."
2049   (interactive "P")
2050   (when (and (eobp) (not (gnus-group-group-name)))
2051     (forward-line -1))
2052   (gnus-group-read-group all t))
2053
2054 (defun gnus-group-quick-select-group (&optional all)
2055   "Select the current group \"quickly\".
2056 This means that no highlighting or scoring will be performed.
2057 If ALL (the prefix argument) is 0, don't even generate the summary
2058 buffer.
2059
2060 This might be useful if you want to toggle threading
2061 before entering the group."
2062   (interactive "P")
2063   (require 'gnus-score)
2064   (let (gnus-visual
2065         gnus-score-find-score-files-function
2066         gnus-home-score-file
2067         gnus-apply-kill-hook
2068         gnus-summary-expunge-below)
2069     (gnus-group-read-group all t)))
2070
2071 (defun gnus-group-visible-select-group (&optional all)
2072   "Select the current group without hiding any articles."
2073   (interactive "P")
2074   (let ((gnus-inhibit-limiting t))
2075     (gnus-group-read-group all t)))
2076
2077 (defun gnus-group-select-group-ephemerally ()
2078   "Select the current group without doing any processing whatsoever.
2079 You will actually be entered into a group that's a copy of
2080 the current group; no changes you make while in this group will
2081 be permanent."
2082   (interactive)
2083   (require 'gnus-score)
2084   (let* (gnus-visual
2085          gnus-score-find-score-files-function gnus-apply-kill-hook
2086          gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
2087          gnus-summary-mode-hook gnus-select-group-hook
2088          (group (gnus-group-group-name))
2089          (method (gnus-find-method-for-group group)))
2090     (gnus-group-read-ephemeral-group
2091      (gnus-group-prefixed-name group method) method)))
2092
2093 ;;;###autoload
2094 (defun gnus-fetch-group (group &optional articles)
2095   "Start Gnus if necessary and enter GROUP.
2096 Returns whether the fetching was successful or not."
2097   (interactive (list (completing-read "Group name: " gnus-active-hashtb)))
2098   (unless (get-buffer gnus-group-buffer)
2099     (gnus-no-server))
2100   (gnus-group-read-group articles nil group))
2101
2102 ;;;###autoload
2103 (defun gnus-fetch-group-other-frame (group)
2104   "Pop up a frame and enter GROUP."
2105   (interactive "P")
2106   (let ((window (get-buffer-window gnus-group-buffer)))
2107     (cond (window
2108            (select-frame (window-frame window)))
2109           ((= (length (frame-list)) 1)
2110            (select-frame (make-frame)))
2111           (t
2112            (other-frame 1))))
2113   (gnus-fetch-group group))
2114
2115 (defvar gnus-ephemeral-group-server 0)
2116
2117 (defcustom gnus-large-ephemeral-newsgroup 200
2118   "The number of articles which indicates a large ephemeral newsgroup.
2119 Same as `gnus-large-newsgroup', but only used for ephemeral newsgroups.
2120
2121 If the number of articles in a newsgroup is greater than this value,
2122 confirmation is required for selecting the newsgroup.  If it is nil, no
2123 confirmation is required."
2124   :version "22.1"
2125   :group 'gnus-group-select
2126   :type '(choice (const :tag "No limit" nil)
2127                  integer))
2128
2129 (defcustom gnus-fetch-old-ephemeral-headers nil
2130   "Same as `gnus-fetch-old-headers', but only used for ephemeral newsgroups."
2131   :version "22.1"
2132   :group 'gnus-thread
2133   :type '(choice (const :tag "off" nil)
2134                  (const some)
2135                  number
2136                  (sexp :menu-tag "other" t)))
2137
2138 ;; Enter a group that is not in the group buffer.  Non-nil is returned
2139 ;; if selection was successful.
2140 (defun gnus-group-read-ephemeral-group (group method &optional activate
2141                                               quit-config request-only
2142                                               select-articles
2143                                               parameters
2144                                               number)
2145   "Read GROUP from METHOD as an ephemeral group.
2146 If ACTIVATE, request the group first.
2147 If QUIT-CONFIG, use that window configuration when exiting from the
2148 ephemeral group.
2149 If REQUEST-ONLY, don't actually read the group; just request it.
2150 If SELECT-ARTICLES, only select those articles.
2151 If PARAMETERS, use those as the group parameters.
2152 If NUMBER, fetch this number of articles.
2153
2154 Return the name of the group if selection was successful."
2155   (interactive
2156    (list
2157     ;; (gnus-read-group "Group name: ")
2158     (completing-read
2159      "Group: " gnus-active-hashtb
2160      nil nil nil
2161      'gnus-group-history)
2162     (gnus-read-method "From method: ")))
2163   ;; Transform the select method into a unique server.
2164   (when (stringp method)
2165     (setq method (gnus-server-to-method method)))
2166   (setq method
2167         `(,(car method) ,(concat (cadr method) "-ephemeral")
2168           (,(intern (format "%s-address" (car method))) ,(cadr method))
2169           ,@(cddr method)))
2170   (let ((group (if (gnus-group-foreign-p group) group
2171                  (gnus-group-prefixed-name (gnus-group-real-name group)
2172                                            method))))
2173     (gnus-sethash
2174      group
2175      `(-1 nil (,group
2176                ,gnus-level-default-subscribed nil nil ,method
2177                ,(cons
2178                  (if quit-config
2179                      (cons 'quit-config quit-config)
2180                    (cons 'quit-config
2181                          (cons gnus-summary-buffer
2182                                gnus-current-window-configuration)))
2183                  parameters)))
2184      gnus-newsrc-hashtb)
2185     (push method gnus-ephemeral-servers)
2186     (set-buffer gnus-group-buffer)
2187     (unless (gnus-check-server method)
2188       (error "Unable to contact server: %s" (gnus-status-message method)))
2189     (when activate
2190       (gnus-activate-group group 'scan)
2191       (unless (gnus-request-group group)
2192         (error "Couldn't request group: %s"
2193                (nnheader-get-report (car method)))))
2194     (if request-only
2195         group
2196       (condition-case ()
2197           (when (let ((gnus-large-newsgroup gnus-large-ephemeral-newsgroup)
2198                       (gnus-fetch-old-headers
2199                        gnus-fetch-old-ephemeral-headers))
2200                   (gnus-group-read-group (or number t) t group select-articles))
2201             group)
2202         ;;(error nil)
2203         (quit
2204          (message "Quit reading the ephemeral group")
2205          nil)))))
2206
2207 (defun gnus-group-jump-to-group (group &optional prompt)
2208   "Jump to newsgroup GROUP.
2209
2210 If PROMPT (the prefix) is a number, use the prompt specified in
2211 `gnus-group-jump-to-group-prompt'."
2212   (interactive
2213    (list (mm-string-make-unibyte
2214           (completing-read
2215            "Group: " gnus-active-hashtb nil
2216            (gnus-read-active-file-p)
2217            (if current-prefix-arg
2218                (cdr (assq current-prefix-arg gnus-group-jump-to-group-prompt))
2219              (or (and (stringp gnus-group-jump-to-group-prompt)
2220                       gnus-group-jump-to-group-prompt)
2221                  (let ((p (cdr (assq 0 gnus-group-jump-to-group-prompt))))
2222                    (and (stringp p) p))))
2223            'gnus-group-history))))
2224
2225   (when (equal group "")
2226     (error "Empty group name"))
2227
2228   (unless (gnus-ephemeral-group-p group)
2229     ;; Either go to the line in the group buffer...
2230     (unless (gnus-group-goto-group group)
2231       ;; ... or insert the line.
2232       (gnus-group-update-group group)
2233       (gnus-group-goto-group group)))
2234   ;; Adjust cursor point.
2235   (gnus-group-position-point))
2236
2237 (defun gnus-group-goto-group (group &optional far test-marked)
2238   "Goto to newsgroup GROUP.
2239 If FAR, it is likely that the group is not on the current line.
2240 If TEST-MARKED, the line must be marked."
2241   (when group
2242     (beginning-of-line)
2243     (cond
2244      ;; It's quite likely that we are on the right line, so
2245      ;; we check the current line first.
2246      ((and (not far)
2247            (eq (get-text-property (point) 'gnus-group)
2248                (gnus-intern-safe group gnus-active-hashtb))
2249            (or (not test-marked) (gnus-group-mark-line-p)))
2250       (point))
2251      ;; Previous and next line are also likely, so we check them as well.
2252      ((and (not far)
2253            (save-excursion
2254              (forward-line -1)
2255              (and (eq (get-text-property (point) 'gnus-group)
2256                       (gnus-intern-safe group gnus-active-hashtb))
2257                   (or (not test-marked) (gnus-group-mark-line-p)))))
2258       (forward-line -1)
2259       (point))
2260      ((and (not far)
2261            (save-excursion
2262              (forward-line 1)
2263              (and (eq (get-text-property (point) 'gnus-group)
2264                       (gnus-intern-safe group gnus-active-hashtb))
2265                   (or (not test-marked) (gnus-group-mark-line-p)))))
2266       (forward-line 1)
2267       (point))
2268      (test-marked
2269       (goto-char (point-min))
2270       (let (found)
2271         (while (and (not found)
2272                     (gnus-goto-char
2273                      (text-property-any
2274                       (point) (point-max)
2275                       'gnus-group
2276                       (gnus-intern-safe group gnus-active-hashtb))))
2277           (if (gnus-group-mark-line-p)
2278               (setq found t)
2279             (forward-line 1)))
2280         found))
2281      (t
2282       ;; Search through the entire buffer.
2283       (gnus-goto-char
2284        (text-property-any
2285         (point-min) (point-max)
2286         'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
2287
2288 (defun gnus-group-next-group (n &optional silent)
2289   "Go to next N'th newsgroup.
2290 If N is negative, search backward instead.
2291 Returns the difference between N and the number of skips actually
2292 done."
2293   (interactive "p")
2294   (gnus-group-next-unread-group n t nil silent))
2295
2296 (defun gnus-group-next-unread-group (n &optional all level silent)
2297   "Go to next N'th unread newsgroup.
2298 If N is negative, search backward instead.
2299 If ALL is non-nil, choose any newsgroup, unread or not.
2300 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
2301 such group can be found, the next group with a level higher than
2302 LEVEL.
2303 Returns the difference between N and the number of skips actually
2304 made."
2305   (interactive "p")
2306   (let ((backward (< n 0))
2307         (n (abs n)))
2308     (while (and (> n 0)
2309                 (gnus-group-search-forward
2310                  backward (or (not gnus-group-goto-unread) all) level))
2311       (setq n (1- n)))
2312     (when (and (/= 0 n)
2313                (not silent))
2314       (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
2315                     (if level " on this level or higher" "")))
2316     n))
2317
2318 (defun gnus-group-prev-group (n)
2319   "Go to previous N'th newsgroup.
2320 Returns the difference between N and the number of skips actually
2321 done."
2322   (interactive "p")
2323   (gnus-group-next-unread-group (- n) t))
2324
2325 (defun gnus-group-prev-unread-group (n)
2326   "Go to previous N'th unread newsgroup.
2327 Returns the difference between N and the number of skips actually
2328 done."
2329   (interactive "p")
2330   (gnus-group-next-unread-group (- n)))
2331
2332 (defun gnus-group-next-unread-group-same-level (n)
2333   "Go to next N'th unread newsgroup on the same level.
2334 If N is negative, search backward instead.
2335 Returns the difference between N and the number of skips actually
2336 done."
2337   (interactive "p")
2338   (gnus-group-next-unread-group n t (gnus-group-group-level))
2339   (gnus-group-position-point))
2340
2341 (defun gnus-group-prev-unread-group-same-level (n)
2342   "Go to next N'th unread newsgroup on the same level.
2343 Returns the difference between N and the number of skips actually
2344 done."
2345   (interactive "p")
2346   (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
2347   (gnus-group-position-point))
2348
2349 (defun gnus-group-best-unread-group (&optional exclude-group)
2350   "Go to the group with the highest level.
2351 If EXCLUDE-GROUP, do not go to that group."
2352   (interactive)
2353   (goto-char (point-min))
2354   (let ((best 100000)
2355         unread best-point)
2356     (while (not (eobp))
2357       (setq unread (get-text-property (point) 'gnus-unread))
2358       (when (and (numberp unread) (> unread 0))
2359         (when (and (get-text-property (point) 'gnus-level)
2360                    (< (get-text-property (point) 'gnus-level) best)
2361                    (or (not exclude-group)
2362                        (not (equal exclude-group (gnus-group-group-name)))))
2363           (setq best (get-text-property (point) 'gnus-level))
2364           (setq best-point (point))))
2365       (forward-line 1))
2366     (when best-point
2367       (goto-char best-point))
2368     (gnus-group-position-point)
2369     (and best-point (gnus-group-group-name))))
2370
2371 ;; Is there something like an after-point-motion-hook?
2372 ;; (inhibit-point-motion-hooks?).  Is there a tool-bar-update function?
2373
2374 ;; (defun gnus-group-menu-bar-update ()
2375 ;;   (let* ((buf (list (with-current-buffer gnus-group-buffer
2376 ;;                    (current-buffer))))
2377 ;;       (name (buffer-name (car buf))))
2378 ;;     (setcdr buf
2379 ;;          (if (> (length name) 27)
2380 ;;              (concat (substring name 0 12)
2381 ;;                      "..."
2382 ;;                      (substring name -12))
2383 ;;            name))
2384 ;;     (menu-bar-update-buffers-1 buf)))
2385
2386 ;; (defun gnus-group-position-point ()
2387 ;;   (gnus-goto-colon)
2388 ;;   (gnus-group-menu-bar-update))
2389
2390 (defun gnus-group-first-unread-group ()
2391   "Go to the first group with unread articles."
2392   (interactive)
2393   (prog1
2394       (let ((opoint (point))
2395             unread)
2396         (goto-char (point-min))
2397         (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
2398                 (and (numberp unread)   ; Not a topic.
2399                      (not (zerop unread))) ; Has unread articles.
2400                 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
2401             (point)                     ; Success.
2402           (goto-char opoint)
2403           nil))                         ; Not success.
2404     (gnus-group-position-point)))
2405
2406 (defun gnus-group-enter-server-mode ()
2407   "Jump to the server buffer."
2408   (interactive)
2409   (gnus-enter-server-buffer))
2410
2411 (defun gnus-group-make-group-simple (&optional group)
2412   "Add a new newsgroup.
2413 The user will be prompted for GROUP."
2414   (interactive
2415    (list (completing-read "Group: " gnus-active-hashtb
2416                           nil nil nil 'gnus-group-history)))
2417   (gnus-group-make-group
2418    (gnus-group-real-name group)
2419    (gnus-group-server group)))
2420
2421 (defun gnus-group-make-group (name &optional method address args)
2422   "Add a new newsgroup.
2423 The user will be prompted for a NAME, for a select METHOD, and an
2424 ADDRESS."
2425   (interactive
2426    (list
2427     (gnus-read-group "Group name: ")
2428     (gnus-read-method "From method: ")))
2429
2430   (when (stringp method)
2431     (setq method (or (gnus-server-to-method method) method)))
2432   (let* ((meth (gnus-method-simplify
2433                 (when (and method
2434                            (not (gnus-server-equal method gnus-select-method)))
2435                   (if address (list (intern method) address)
2436                     method))))
2437          (nname (if method (gnus-group-prefixed-name name meth) name))
2438          backend info)
2439     (when (gnus-group-entry nname)
2440       (error "Group %s already exists" (gnus-group-decoded-name nname)))
2441     ;; Subscribe to the new group.
2442     (gnus-group-change-level
2443      (setq info (list t nname gnus-level-default-subscribed nil nil meth))
2444      gnus-level-default-subscribed gnus-level-killed
2445      (and (gnus-group-group-name)
2446           (gnus-group-entry (gnus-group-group-name)))
2447      t)
2448     ;; Make it active.
2449     (gnus-set-active nname (cons 1 0))
2450     (unless (gnus-ephemeral-group-p name)
2451       (gnus-dribble-enter
2452        (concat "(gnus-group-set-info '"
2453                (gnus-prin1-to-string (cdr info)) ")")))
2454     ;; Insert the line.
2455     (gnus-group-insert-group-line-info nname)
2456     (forward-line -1)
2457     (gnus-group-position-point)
2458
2459     ;; Load the back end and try to make the back end create
2460     ;; the group as well.
2461     (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
2462                                                   nil meth))))
2463                  gnus-valid-select-methods)
2464       (require backend))
2465     (gnus-check-server meth)
2466     (when (gnus-check-backend-function 'request-create-group nname)
2467       (unless (gnus-request-create-group nname nil args)
2468         (error "Could not create group on server: %s"
2469                (nnheader-get-report backend))))
2470     t))
2471
2472 (defun gnus-group-delete-groups (&optional arg)
2473   "Delete the current group.  Only meaningful with editable groups."
2474   (interactive "P")
2475   (let ((n (length (gnus-group-process-prefix arg))))
2476     (when (gnus-yes-or-no-p
2477            (if (= n 1)
2478                "Delete this 1 group? "
2479              (format "Delete these %d groups? " n)))
2480       (gnus-group-iterate arg
2481         (lambda (group)
2482           (gnus-group-delete-group group nil t))))))
2483
2484 (defun gnus-group-delete-group (group &optional force no-prompt)
2485   "Delete the current group.  Only meaningful with editable groups.
2486 If FORCE (the prefix) is non-nil, all the articles in the group will
2487 be deleted.  This is \"deleted\" as in \"removed forever from the face
2488 of the Earth\".  There is no undo.  The user will be prompted before
2489 doing the deletion.
2490 Note that you also have to specify FORCE if you want the group to
2491 be removed from the server, even when it's empty."
2492   (interactive
2493    (list (gnus-group-group-name)
2494          current-prefix-arg))
2495   (unless group
2496     (error "No group to delete"))
2497   (unless (gnus-check-backend-function 'request-delete-group group)
2498     (error "This back end does not support group deletion"))
2499   (prog1
2500       (let ((group-decoded (gnus-group-decoded-name group)))
2501         (if (and (not no-prompt)
2502                  (not (gnus-yes-or-no-p
2503                        (format
2504                         "Do you really want to delete %s%s? "
2505                         group-decoded (if force " and all its contents" "")))))
2506             ()                          ; Whew!
2507           (gnus-message 6 "Deleting group %s..." group-decoded)
2508           (if (not (gnus-request-delete-group group force))
2509               (gnus-error 3 "Couldn't delete group %s" group-decoded)
2510             (gnus-message 6 "Deleting group %s...done" group-decoded)
2511             (gnus-group-goto-group group)
2512             (gnus-group-kill-group 1 t)
2513             (gnus-set-active group nil)
2514             t)))
2515     (gnus-group-position-point)))
2516
2517 (defun gnus-group-rename-group (group new-name)
2518   "Rename group from GROUP to NEW-NAME.
2519 When used interactively, GROUP is the group under point
2520 and NEW-NAME will be prompted for."
2521   (interactive
2522    (list
2523     (gnus-group-group-name)
2524     (progn
2525       (unless (gnus-check-backend-function
2526                'request-rename-group (gnus-group-group-name))
2527         (error "This back end does not support renaming groups"))
2528       (gnus-read-group "Rename group to: "
2529                        (gnus-group-real-name (gnus-group-group-name))))))
2530
2531   (unless (gnus-check-backend-function 'request-rename-group group)
2532     (error "This back end does not support renaming groups"))
2533   (unless group
2534     (error "No group to rename"))
2535   (when (equal (gnus-group-real-name group) new-name)
2536     (error "Can't rename to the same name"))
2537
2538   ;; We find the proper prefixed name.
2539   (setq new-name
2540         (if (gnus-group-native-p group)
2541             ;; Native group.
2542             new-name
2543           ;; Foreign group.
2544           (gnus-group-prefixed-name
2545            (gnus-group-real-name new-name)
2546            (gnus-info-method (gnus-get-info group)))))
2547
2548   (when (gnus-active new-name)
2549     (error "The group %s already exists" new-name))
2550
2551   (gnus-message 6 "Renaming group %s to %s..." group new-name)
2552   (prog1
2553       (if (progn
2554             (gnus-group-goto-group group)
2555             (not (when (< (gnus-group-group-level) gnus-level-zombie)
2556                    (gnus-request-rename-group group new-name))))
2557           (gnus-error 3 "Couldn't rename group %s to %s" group new-name)
2558         ;; We rename the group internally by killing it...
2559         (gnus-group-kill-group)
2560         ;; ... changing its name ...
2561         (setcar (cdar gnus-list-of-killed-groups) new-name)
2562         ;; ... and then yanking it.  Magic!
2563         (gnus-group-yank-group)
2564         (gnus-set-active new-name (gnus-active group))
2565         (gnus-message 6 "Renaming group %s to %s...done" group new-name)
2566         new-name)
2567     (setq gnus-killed-list (delete group gnus-killed-list))
2568     (gnus-set-active group nil)
2569     (gnus-dribble-touch)
2570     (gnus-group-position-point)))
2571
2572 (defun gnus-group-edit-group (group &optional part)
2573   "Edit the group on the current line."
2574   (interactive (list (gnus-group-group-name)))
2575   (let ((part (or part 'info))
2576         info)
2577     (unless group
2578       (error "No group on current line"))
2579     (unless (setq info (gnus-get-info group))
2580       (error "Killed group; can't be edited"))
2581     (ignore-errors
2582       (gnus-close-group group))
2583     (gnus-edit-form
2584      ;; Find the proper form to edit.
2585      (cond ((eq part 'method)
2586             (or (gnus-info-method info) "native"))
2587            ((eq part 'params)
2588             (gnus-info-params info))
2589            (t info))
2590      ;; The proper documentation.
2591      (format
2592       "Editing the %s for `%s'."
2593       (cond
2594        ((eq part 'method) "select method")
2595        ((eq part 'params) "group parameters")
2596        (t "group info"))
2597       (gnus-group-decoded-name group))
2598      `(lambda (form)
2599         (gnus-group-edit-group-done ',part ,group form)))
2600     (local-set-key
2601      "\C-c\C-i"
2602      (gnus-create-info-command
2603       (cond
2604        ((eq part 'method)
2605         "(gnus)Select Methods")
2606        ((eq part 'params)
2607         "(gnus)Group Parameters")
2608        (t
2609         "(gnus)Group Info"))))))
2610
2611 (defun gnus-group-edit-group-method (group)
2612   "Edit the select method of GROUP."
2613   (interactive (list (gnus-group-group-name)))
2614   (gnus-group-edit-group group 'method))
2615
2616 (defun gnus-group-edit-group-parameters (group)
2617   "Edit the group parameters of GROUP."
2618   (interactive (list (gnus-group-group-name)))
2619   (gnus-group-edit-group group 'params))
2620
2621 (defun gnus-group-edit-group-done (part group form)
2622   "Update variables."
2623   (let* ((method (cond ((eq part 'info) (nth 4 form))
2624                        ((eq part 'method) form)
2625                        (t nil)))
2626          (info (cond ((eq part 'info) form)
2627                      ((eq part 'method) (gnus-get-info group))
2628                      (t nil)))
2629          (new-group (if info
2630                         (if (or (not method)
2631                                 (gnus-server-equal
2632                                  gnus-select-method method))
2633                             (gnus-group-real-name (car info))
2634                           (gnus-group-prefixed-name
2635                            (gnus-group-real-name (car info)) method))
2636                       nil)))
2637     (when (and new-group
2638                (not (equal new-group group)))
2639       (when (gnus-group-goto-group group)
2640         (gnus-group-kill-group 1))
2641       (gnus-activate-group new-group))
2642     ;; Set the info.
2643     (if (not (and info new-group))
2644         (gnus-group-set-info form (or new-group group) part)
2645       (setq info (gnus-copy-sequence info))
2646       (setcar info new-group)
2647       (unless (gnus-server-equal method "native")
2648         (unless (nthcdr 3 info)
2649           (nconc info (list nil nil)))
2650         (unless (nthcdr 4 info)
2651           (nconc info (list nil)))
2652         (gnus-info-set-method info method))
2653       (gnus-group-set-info info))
2654     (gnus-group-update-group (or new-group group))
2655     (gnus-group-position-point)))
2656
2657 (defun gnus-group-make-useful-group (group method)
2658   "Create one of the groups described in `gnus-useful-groups'."
2659   (interactive
2660    (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
2661                                         nil t)
2662                        gnus-useful-groups)))
2663      (list (cadr entry) (caddr entry))))
2664   (setq method (gnus-copy-sequence method))
2665   (let (entry)
2666     (while (setq entry (memq (assq 'eval method) method))
2667       (setcar entry (eval (cadar entry)))))
2668   (gnus-group-make-group group method))
2669
2670 (defun gnus-group-make-help-group (&optional noerror)
2671   "Create the Gnus documentation group.
2672 Optional argument NOERROR modifies the behavior of this function when the
2673 group already exists:
2674 - if not given, and error is signaled,
2675 - if t, stay silent,
2676 - if anything else, just print a message."
2677   (interactive)
2678   (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2679         (file (nnheader-find-etc-directory "gnus-tut.txt" t)))
2680     (if (gnus-group-entry name)
2681         (cond ((eq noerror nil)
2682                (error "Documentation group already exists"))
2683               ((eq noerror t)
2684                ;; stay silent
2685                )
2686               (t
2687                (gnus-message 1 "Documentation group already exists")))
2688       ;; else:
2689       (if (not file)
2690           (gnus-message 1 "Couldn't find doc group")
2691         (gnus-group-make-group
2692          (gnus-group-real-name name)
2693          (list 'nndoc "gnus-help"
2694                (list 'nndoc-address file)
2695                (list 'nndoc-article-type 'mbox))))
2696       ))
2697   (gnus-group-position-point))
2698
2699 (defun gnus-group-make-doc-group (file type)
2700   "Create a group that uses a single file as the source.
2701
2702 If called with a prefix argument, ask for the file type."
2703   (interactive
2704    (list (read-file-name "File name: ")
2705          (and current-prefix-arg 'ask)))
2706   (when (eq type 'ask)
2707     (let ((err "")
2708           char found)
2709       (while (not found)
2710         (message
2711          "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [m, b, d, f, a, g]: "
2712          err)
2713         (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2714                           ((= char ?b) 'babyl)
2715                           ((= char ?d) 'digest)
2716                           ((= char ?f) 'forward)
2717                           ((= char ?a) 'mmfd)
2718                           ((= char ?g) 'guess)
2719                           (t (setq err (format "%c unknown. " char))
2720                              nil))))
2721       (setq type found)))
2722   (let* ((file (expand-file-name file))
2723          (name (gnus-generate-new-group-name
2724                 (gnus-group-prefixed-name
2725                  (file-name-nondirectory file) '(nndoc "")))))
2726     (gnus-group-make-group
2727      (gnus-group-real-name name)
2728      (list 'nndoc file
2729            (list 'nndoc-address file)
2730            (list 'nndoc-article-type (or type 'guess))))))
2731
2732 (defvar nnweb-type-definition)
2733 (defvar gnus-group-web-type-history nil)
2734 (defvar gnus-group-web-search-history nil)
2735 (defun gnus-group-make-web-group (&optional solid)
2736   "Create an ephemeral nnweb group.
2737 If SOLID (the prefix), create a solid group."
2738   (interactive "P")
2739   (require 'nnweb)
2740   (let* ((group
2741           (if solid (gnus-read-group "Group name: ")
2742             (message-unique-id)))
2743          (default-type (or (car gnus-group-web-type-history)
2744                            (symbol-name (caar nnweb-type-definition))))
2745          (type
2746           (gnus-string-or
2747            (completing-read
2748             (format "Search engine type (default %s): " default-type)
2749             (mapcar (lambda (elem) (list (symbol-name (car elem))))
2750                     nnweb-type-definition)
2751             nil t nil 'gnus-group-web-type-history)
2752            default-type))
2753          (search
2754           (read-string
2755            "Search string: "
2756            (cons (or (car gnus-group-web-search-history) "") 0)
2757            'gnus-group-web-search-history))
2758          (method
2759           `(nnweb ,group (nnweb-search ,search)
2760                   (nnweb-type ,(intern type))
2761                   (nnweb-ephemeral-p t))))
2762     (if solid
2763         (progn
2764           (gnus-pull 'nnweb-ephemeral-p method)
2765           (gnus-group-make-group group method))
2766       (gnus-group-read-ephemeral-group
2767        group method t
2768        (cons (current-buffer)
2769              (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
2770
2771 (eval-when-compile
2772   (defvar nnrss-group-alist)
2773   (defun nnrss-discover-feed (arg))
2774   (defun nnrss-save-server-data (arg)))
2775 (defun gnus-group-make-rss-group (&optional url)
2776   "Given a URL, discover if there is an RSS feed.
2777 If there is, use Gnus to create an nnrss group"
2778   (interactive)
2779   (require 'nnrss)
2780   (if (not url)
2781       (setq url (read-from-minibuffer "URL to Search for RSS: ")))
2782   (let ((feedinfo (nnrss-discover-feed url)))
2783     (if feedinfo
2784         (let ((title (gnus-newsgroup-savable-name
2785                       (read-from-minibuffer "Title: "
2786                                             (gnus-newsgroup-savable-name
2787                                              (or (cdr (assoc 'title
2788                                                              feedinfo))
2789                                                  "")))))
2790               (desc  (read-from-minibuffer "Description: "
2791                                            (cdr (assoc 'description
2792                                                        feedinfo))))
2793               (href (cdr (assoc 'href feedinfo)))
2794               (encodable (mm-coding-system-p 'utf-8)))
2795           (when encodable
2796             ;; Unify non-ASCII text.
2797             (setq title (mm-decode-coding-string
2798                          (mm-encode-coding-string title 'utf-8) 'utf-8)))
2799           (gnus-group-make-group (if encodable
2800                                      (mm-encode-coding-string title 'utf-8)
2801                                    title)
2802                                  '(nnrss ""))
2803           (push (list title href desc) nnrss-group-alist)
2804           (nnrss-save-server-data nil))
2805       (error "No feeds found for %s" url))))
2806
2807 (defvar nnwarchive-type-definition)
2808 (defvar gnus-group-warchive-type-history nil)
2809 (defvar gnus-group-warchive-login-history nil)
2810 (defvar gnus-group-warchive-address-history nil)
2811
2812 (defun gnus-group-make-warchive-group ()
2813   "Create a nnwarchive group."
2814   (interactive)
2815   (require 'nnwarchive)
2816   (let* ((group (gnus-read-group "Group name: "))
2817          (default-type (or (car gnus-group-warchive-type-history)
2818                            (symbol-name (caar nnwarchive-type-definition))))
2819          (type
2820           (gnus-string-or
2821            (completing-read
2822             (format "Warchive type (default %s): " default-type)
2823             (mapcar (lambda (elem) (list (symbol-name (car elem))))
2824                     nnwarchive-type-definition)
2825             nil t nil 'gnus-group-warchive-type-history)
2826            default-type))
2827          (address (read-string "Warchive address: "
2828                                nil 'gnus-group-warchive-address-history))
2829          (default-login (or (car gnus-group-warchive-login-history)
2830                             user-mail-address))
2831          (login
2832           (gnus-string-or
2833            (read-string
2834             (format "Warchive login (default %s): " user-mail-address)
2835             default-login 'gnus-group-warchive-login-history)
2836            user-mail-address))
2837          (method
2838           `(nnwarchive ,address
2839                        (nnwarchive-type ,(intern type))
2840                        (nnwarchive-login ,login))))
2841     (gnus-group-make-group group method)))
2842
2843 (defun gnus-group-make-archive-group (&optional all)
2844   "Create the (ding) Gnus archive group of the most recent articles.
2845 Given a prefix, create a full group."
2846   (interactive "P")
2847   (let ((group (gnus-group-prefixed-name
2848                 (if all "ding.archives" "ding.recent") '(nndir ""))))
2849     (when (gnus-group-entry group)
2850       (error "Archive group already exists"))
2851     (gnus-group-make-group
2852      (gnus-group-real-name group)
2853      (list 'nndir (if all "hpc" "edu")
2854            (list 'nndir-directory
2855                  (if all gnus-group-archive-directory
2856                    gnus-group-recent-archive-directory))))
2857     (gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
2858
2859 (defun gnus-group-make-directory-group (dir)
2860   "Create an nndir group.
2861 The user will be prompted for a directory.  The contents of this
2862 directory will be used as a newsgroup.  The directory should contain
2863 mail messages or news articles in files that have numeric names."
2864   (interactive
2865    (list (read-file-name "Create group from directory: ")))
2866   (unless (file-exists-p dir)
2867     (error "No such directory"))
2868   (unless (file-directory-p dir)
2869     (error "Not a directory"))
2870   (let ((ext "")
2871         (i 0)
2872         group)
2873     (while (or (not group) (gnus-group-entry group))
2874       (setq group
2875             (gnus-group-prefixed-name
2876              (expand-file-name ext dir)
2877              '(nndir "")))
2878       (setq ext (format "<%d>" (setq i (1+ i)))))
2879     (gnus-group-make-group
2880      (gnus-group-real-name group)
2881      (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
2882
2883 (defvar nnkiboze-score-file)
2884 (defun gnus-group-make-kiboze-group (group address scores)
2885   "Create an nnkiboze group.
2886 The user will be prompted for a name, a regexp to match groups, and
2887 score file entries for articles to include in the group."
2888   (interactive
2889    (list
2890     (read-string "nnkiboze group name: ")
2891     (read-string "Source groups (regexp): ")
2892     (let ((headers (mapcar 'list
2893                            '("subject" "from" "number" "date" "message-id"
2894                              "references" "chars" "lines" "xref"
2895                              "followup" "all" "body" "head")))
2896           scores header regexp regexps)
2897       (while (not (equal "" (setq header (completing-read
2898                                           "Match on header: " headers nil t))))
2899         (setq regexps nil)
2900         (while (not (equal "" (setq regexp (read-string
2901                                             (format "Match on %s (regexp): "
2902                                                     header)))))
2903           (push (list regexp nil nil 'r) regexps))
2904         (push (cons header regexps) scores))
2905       scores)))
2906   (gnus-group-make-group group "nnkiboze" address)
2907   (let* ((nnkiboze-current-group group)
2908          (score-file (car (nnkiboze-score-file "")))
2909          (score-dir (file-name-directory score-file)))
2910     (unless (file-exists-p score-dir)
2911       (make-directory score-dir))
2912     (with-temp-file score-file
2913       (let (emacs-lisp-mode-hook)
2914         (gnus-pp scores)))))
2915
2916 (defun gnus-group-add-to-virtual (n vgroup)
2917   "Add the current group to a virtual group."
2918   (interactive
2919    (list current-prefix-arg
2920          (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
2921                           "nnvirtual:")))
2922   (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
2923     (error "%s is not an nnvirtual group" vgroup))
2924   (gnus-close-group vgroup)
2925   (let* ((groups (gnus-group-process-prefix n))
2926          (method (gnus-info-method (gnus-get-info vgroup))))
2927     (setcar (cdr method)
2928             (concat
2929              (nth 1 method) "\\|"
2930              (mapconcat
2931               (lambda (s)
2932                 (gnus-group-remove-mark s)
2933                 (concat "\\(^" (regexp-quote s) "$\\)"))
2934               groups "\\|"))))
2935   (gnus-group-position-point))
2936
2937 (defun gnus-group-make-empty-virtual (group)
2938   "Create a new, fresh, empty virtual group."
2939   (interactive "sCreate new, empty virtual group: ")
2940   (let* ((method (list 'nnvirtual "^$"))
2941          (pgroup (gnus-group-prefixed-name group method)))
2942     ;; Check whether it exists already.
2943     (when (gnus-group-entry pgroup)
2944       (error "Group %s already exists" pgroup))
2945     ;; Subscribe the new group after the group on the current line.
2946     (gnus-subscribe-group pgroup (gnus-group-group-name) method)
2947     (gnus-group-update-group pgroup)
2948     (forward-line -1)
2949     (gnus-group-position-point)))
2950
2951 (defun gnus-group-enter-directory (dir)
2952   "Enter an ephemeral nneething group."
2953   (interactive "DDirectory to read: ")
2954   (let* ((method (list 'nneething dir '(nneething-read-only t)))
2955          (leaf (gnus-group-prefixed-name
2956                 (file-name-nondirectory (directory-file-name dir))
2957                 method))
2958          (name (gnus-generate-new-group-name leaf)))
2959     (unless (gnus-group-read-ephemeral-group
2960              name method t
2961              (cons (current-buffer)
2962                    (if (eq major-mode 'gnus-summary-mode)
2963                        'summary 'group)))
2964       (error "Couldn't enter %s" dir))))
2965
2966 (eval-and-compile
2967   (autoload 'nnimap-expunge "nnimap")
2968   (autoload 'nnimap-acl-get "nnimap")
2969   (autoload 'nnimap-acl-edit "nnimap"))
2970
2971 (defun gnus-group-nnimap-expunge (group)
2972   "Expunge deleted articles in current nnimap GROUP."
2973   (interactive (list (gnus-group-group-name)))
2974   (let ((mailbox (gnus-group-real-name group)) method)
2975     (unless group
2976       (error "No group on current line"))
2977     (unless (gnus-get-info group)
2978       (error "Killed group; can't be edited"))
2979     (unless (eq 'nnimap (car (setq method (gnus-find-method-for-group group))))
2980       (error "%s is not an nnimap group" group))
2981     (nnimap-expunge mailbox (cadr method))))
2982
2983 (defun gnus-group-nnimap-edit-acl (group)
2984   "Edit the Access Control List of current nnimap GROUP."
2985   (interactive (list (gnus-group-group-name)))
2986   (let ((mailbox (gnus-group-real-name group)) method acl)
2987     (unless group
2988       (error "No group on current line"))
2989     (unless (gnus-get-info group)
2990       (error "Killed group; can't be edited"))
2991     (unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
2992       (error "%s is not an nnimap group" group))
2993     (unless (setq acl (nnimap-acl-get mailbox (cadr method)))
2994       (error "Server does not support ACL's"))
2995     (gnus-edit-form acl (format "Editing the access control list for `%s'.
2996
2997    An access control list is a list of (identifier . rights) elements.
2998
2999    The identifier string specifies the corresponding user.  The
3000    identifier \"anyone\" is reserved to refer to the universal identity.
3001
3002    Rights is a string listing a (possibly empty) set of alphanumeric
3003    characters, each character listing a set of operations which is being
3004    controlled.  Letters are reserved for ``standard'' rights, listed
3005    below.  Digits are reserved for implementation or site defined rights.
3006
3007    l - lookup (mailbox is visible to LIST/LSUB commands)
3008    r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
3009        SEARCH, COPY from mailbox)
3010    s - keep seen/unseen information across sessions (STORE \\SEEN flag)
3011    w - write (STORE flags other than \\SEEN and \\DELETED)
3012    i - insert (perform APPEND, COPY into mailbox)
3013    p - post (send mail to submission address for mailbox,
3014        not enforced by IMAP4 itself)
3015    c - create and delete mailbox (CREATE new sub-mailboxes in any
3016        implementation-defined hierarchy, RENAME or DELETE mailbox)
3017    d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
3018    a - administer (perform SETACL)" group)
3019                     `(lambda (form)
3020                        (nnimap-acl-edit
3021                         ,mailbox ',method ',acl form)))))
3022
3023 ;; Group sorting commands
3024 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
3025
3026 (defun gnus-group-sort-groups (func &optional reverse)
3027   "Sort the group buffer according to FUNC.
3028 When used interactively, the sorting function used will be
3029 determined by the `gnus-group-sort-function' variable.
3030 If REVERSE (the prefix), reverse the sorting order."
3031   (interactive (list gnus-group-sort-function current-prefix-arg))
3032   (funcall gnus-group-sort-alist-function
3033            (gnus-make-sort-function func) reverse)
3034   (gnus-group-unmark-all-groups)
3035   (gnus-group-list-groups)
3036   (gnus-dribble-touch))
3037
3038 (defun gnus-group-sort-flat (func reverse)
3039   ;; We peel off the dummy group from the alist.
3040   (when func
3041     (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
3042       (pop gnus-newsrc-alist))
3043     ;; Do the sorting.
3044     (setq gnus-newsrc-alist
3045           (sort gnus-newsrc-alist func))
3046     (when reverse
3047       (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
3048     ;; Regenerate the hash table.
3049     (gnus-make-hashtable-from-newsrc-alist)))
3050
3051 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
3052   "Sort the group buffer alphabetically by group name.
3053 If REVERSE, sort in reverse order."
3054   (interactive "P")
3055   (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
3056
3057 (defun gnus-group-sort-groups-by-real-name (&optional reverse)
3058   "Sort the group buffer alphabetically by real (unprefixed) group name.
3059 If REVERSE, sort in reverse order."
3060   (interactive "P")
3061   (gnus-group-sort-groups 'gnus-group-sort-by-real-name reverse))
3062
3063 (defun gnus-group-sort-groups-by-unread (&optional reverse)
3064   "Sort the group buffer by number of unread articles.
3065 If REVERSE, sort in reverse order."
3066   (interactive "P")
3067   (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
3068
3069 (defun gnus-group-sort-groups-by-level (&optional reverse)
3070   "Sort the group buffer by group level.
3071 If REVERSE, sort in reverse order."
3072   (interactive "P")
3073   (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
3074
3075 (defun gnus-group-sort-groups-by-score (&optional reverse)
3076   "Sort the group buffer by group score.
3077 If REVERSE, sort in reverse order."
3078   (interactive "P")
3079   (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
3080
3081 (defun gnus-group-sort-groups-by-rank (&optional reverse)
3082   "Sort the group buffer by group rank.
3083 If REVERSE, sort in reverse order."
3084   (interactive "P")
3085   (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
3086
3087 (defun gnus-group-sort-groups-by-method (&optional reverse)
3088   "Sort the group buffer alphabetically by back end name.
3089 If REVERSE, sort in reverse order."
3090   (interactive "P")
3091   (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
3092
3093 (defun gnus-group-sort-groups-by-server (&optional reverse)
3094   "Sort the group buffer alphabetically by server name.
3095 If REVERSE, sort in reverse order."
3096   (interactive "P")
3097   (gnus-group-sort-groups 'gnus-group-sort-by-server reverse))
3098
3099 ;;; Selected group sorting.
3100
3101 (defun gnus-group-sort-selected-groups (n func &optional reverse)
3102   "Sort the process/prefixed groups."
3103   (interactive (list current-prefix-arg gnus-group-sort-function))
3104   (let ((groups (gnus-group-process-prefix n)))
3105     (funcall gnus-group-sort-selected-function
3106              groups (gnus-make-sort-function func) reverse)
3107     (gnus-group-unmark-all-groups)
3108     (gnus-group-list-groups)
3109     (gnus-dribble-touch)))
3110
3111 (defun gnus-group-sort-selected-flat (groups func reverse)
3112   (let (entries infos)
3113     ;; First find all the group entries for these groups.
3114     (while groups
3115       (push (nthcdr 2 (gnus-group-entry (pop groups)))
3116             entries))
3117     ;; Then sort the infos.
3118     (setq infos
3119           (sort
3120            (mapcar
3121             (lambda (entry) (car entry))
3122             (setq entries (nreverse entries)))
3123            func))
3124     (when reverse
3125       (setq infos (nreverse infos)))
3126     ;; Go through all the infos and replace the old entries
3127     ;; with the new infos.
3128     (while infos
3129       (setcar (car entries) (pop infos))
3130       (pop entries))
3131     ;; Update the hashtable.
3132     (gnus-make-hashtable-from-newsrc-alist)))
3133
3134 (defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
3135   "Sort the group buffer alphabetically by group name.
3136 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3137 sort in reverse order."
3138   (interactive (gnus-interactive "P\ny"))
3139   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
3140
3141 (defun gnus-group-sort-selected-groups-by-real-name (&optional n reverse)
3142   "Sort the group buffer alphabetically by real group name.
3143 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3144 sort in reverse order."
3145   (interactive (gnus-interactive "P\ny"))
3146   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-real-name reverse))
3147
3148 (defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
3149   "Sort the group buffer by number of unread articles.
3150 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3151 sort in reverse order."
3152   (interactive (gnus-interactive "P\ny"))
3153   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
3154
3155 (defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
3156   "Sort the group buffer by group level.
3157 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3158 sort in reverse order."
3159   (interactive (gnus-interactive "P\ny"))
3160   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
3161
3162 (defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
3163   "Sort the group buffer by group score.
3164 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3165 sort in reverse order."
3166   (interactive (gnus-interactive "P\ny"))
3167   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
3168
3169 (defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
3170   "Sort the group buffer by group rank.
3171 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3172 sort in reverse order."
3173   (interactive (gnus-interactive "P\ny"))
3174   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
3175
3176 (defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
3177   "Sort the group buffer alphabetically by back end name.
3178 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3179 sort in reverse order."
3180   (interactive (gnus-interactive "P\ny"))
3181   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
3182
3183 ;;; Sorting predicates.
3184
3185 (defun gnus-group-sort-by-alphabet (info1 info2)
3186   "Sort alphabetically."
3187   (string< (gnus-info-group info1) (gnus-info-group info2)))
3188
3189 (defun gnus-group-sort-by-real-name (info1 info2)
3190   "Sort alphabetically on real (unprefixed) names."
3191   (string< (gnus-group-real-name (gnus-info-group info1))
3192            (gnus-group-real-name (gnus-info-group info2))))
3193
3194 (defun gnus-group-sort-by-unread (info1 info2)
3195   "Sort by number of unread articles."
3196   (let ((n1 (gnus-group-unread (gnus-info-group info1)))
3197         (n2 (gnus-group-unread (gnus-info-group info1))))
3198     (< (or (and (numberp n1) n1) 0)
3199        (or (and (numberp n2) n2) 0))))
3200
3201 (defun gnus-group-sort-by-level (info1 info2)
3202   "Sort by level."
3203   (< (gnus-info-level info1) (gnus-info-level info2)))
3204
3205 (defun gnus-group-sort-by-method (info1 info2)
3206   "Sort alphabetically by back end name."
3207   (string< (car (gnus-find-method-for-group
3208                  (gnus-info-group info1) info1))
3209            (car (gnus-find-method-for-group
3210                  (gnus-info-group info2) info2))))
3211
3212 (defun gnus-group-sort-by-server (info1 info2)
3213   "Sort alphabetically by server name."
3214   (string< (gnus-method-to-full-server-name
3215             (gnus-find-method-for-group
3216              (gnus-info-group info1) info1))
3217            (gnus-method-to-full-server-name
3218             (gnus-find-method-for-group
3219              (gnus-info-group info2) info2))))
3220
3221 (defun gnus-group-sort-by-score (info1 info2)
3222   "Sort by group score."
3223   (> (gnus-info-score info1) (gnus-info-score info2)))
3224
3225 (defun gnus-group-sort-by-rank (info1 info2)
3226   "Sort by level and score."
3227   (let ((level1 (gnus-info-level info1))
3228         (level2 (gnus-info-level info2)))
3229     (or (< level1 level2)
3230         (and (= level1 level2)
3231              (> (gnus-info-score info1) (gnus-info-score info2))))))
3232
3233 ;;; Clearing data
3234
3235 (defun gnus-group-clear-data (&optional arg)
3236   "Clear all marks and read ranges from the current group.
3237 Obeys the process/prefix convention."
3238   (interactive "P")
3239   (gnus-group-iterate arg
3240     (lambda (group)
3241       (let (info)
3242         (gnus-info-clear-data (setq info (gnus-get-info group)))
3243         (gnus-get-unread-articles-in-group info (gnus-active group) t)
3244         (when (gnus-group-goto-group group)
3245           (gnus-group-update-group-line))))))
3246
3247 (defun gnus-group-clear-data-on-native-groups ()
3248   "Clear all marks and read ranges from all native groups."
3249   (interactive)
3250   (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
3251     (let ((alist (cdr gnus-newsrc-alist))
3252           info)
3253       (while (setq info (pop alist))
3254         (when (gnus-group-native-p (gnus-info-group info))
3255           (gnus-info-clear-data info)))
3256       (gnus-get-unread-articles)
3257       (gnus-dribble-touch)
3258       (when (gnus-y-or-n-p
3259              "Move the cache away to avoid problems in the future? ")
3260         (call-interactively 'gnus-cache-move-cache)))))
3261
3262 (defun gnus-info-clear-data (info)
3263   "Clear all marks and read ranges from INFO."
3264   (let ((group (gnus-info-group info))
3265         action)
3266     (dolist (el (gnus-info-marks info))
3267       (push `(,(cdr el) add (,(car el))) action))
3268     (push `(,(gnus-info-read info) add (read)) action)
3269     (gnus-undo-register
3270       `(progn
3271          (gnus-request-set-mark ,group ',action)
3272          (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
3273          (gnus-info-set-read ',info ',(gnus-info-read info))
3274          (when (gnus-group-goto-group ,group)
3275            (gnus-get-unread-articles-in-group ',info ',(gnus-active group) t)
3276            (gnus-group-update-group-line))))
3277     (setq action (mapcar (lambda (el) (list (nth 0 el) 'del (nth 2 el)))
3278                          action))
3279     (gnus-request-set-mark group action)
3280     (gnus-info-set-read info nil)
3281     (when (gnus-info-marks info)
3282       (gnus-info-set-marks info nil))))
3283
3284 ;; Group catching up.
3285
3286 (defun gnus-group-catchup-current (&optional n all)
3287   "Mark all unread articles in the current newsgroup as read.
3288 If prefix argument N is numeric, the next N newsgroups will be
3289 caught up.  If ALL is non-nil, marked articles will also be marked as
3290 read.  Cross references (Xref: header) of articles are ignored.
3291 The number of newsgroups that this function was unable to catch
3292 up is returned."
3293   (interactive "P")
3294   (let ((groups (gnus-group-process-prefix n))
3295         (ret 0)
3296         group)
3297     (unless groups (error "No groups selected"))
3298     (if (not
3299          (or (not gnus-interactive-catchup) ;Without confirmation?
3300              gnus-expert-user
3301              (gnus-y-or-n-p
3302               (format
3303                (if all
3304                    "Do you really want to mark all articles in %s as read? "
3305                  "Mark all unread articles in %s as read? ")
3306                (if (= (length groups) 1)
3307                    (gnus-group-decoded-name (car groups))
3308                  (format "these %d groups" (length groups)))))))
3309         n
3310       (while (setq group (pop groups))
3311         (gnus-group-remove-mark group)
3312         ;; Virtual groups have to be given special treatment.
3313         (let ((method (gnus-find-method-for-group group)))
3314           (when (eq 'nnvirtual (car method))
3315             (nnvirtual-catchup-group
3316              (gnus-group-real-name group) (nth 1 method) all)))
3317         (if (>= (gnus-group-level group) gnus-level-zombie)
3318             (gnus-message 2 "Dead groups can't be caught up")
3319           (if (prog1
3320                   (gnus-group-goto-group group)
3321                 (gnus-group-catchup group all))
3322               (gnus-group-update-group-line)
3323             (setq ret (1+ ret)))))
3324       (gnus-group-next-unread-group 1)
3325       ret)))
3326
3327 (defun gnus-group-catchup-current-all (&optional n)
3328   "Mark all articles in current newsgroup as read.
3329 Cross references (Xref: header) of articles are ignored."
3330   (interactive "P")
3331   (gnus-group-catchup-current n 'all))
3332
3333 (defun gnus-group-catchup (group &optional all)
3334   "Mark all articles in GROUP as read.
3335 If ALL is non-nil, all articles are marked as read.
3336 The return value is the number of articles that were marked as read,
3337 or nil if no action could be taken."
3338   (let* ((entry (gnus-group-entry group))
3339          (num (car entry))
3340          (marks (gnus-info-marks (nth 2 entry)))
3341          (unread (gnus-sequence-of-unread-articles group)))
3342     ;; Remove entries for this group.
3343     (nnmail-purge-split-history (gnus-group-real-name group))
3344     ;; Do the updating only if the newsgroup isn't killed.
3345     (if (not (numberp (car entry)))
3346         (gnus-message 1 "Can't catch up %s; non-active group" group)
3347       (gnus-update-read-articles group nil)
3348       (when all
3349         ;; Nix out the lists of marks and dormants.
3350         (gnus-request-set-mark group (list (list (cdr (assq 'tick marks))
3351                                                  'del '(tick))
3352                                            (list (cdr (assq 'dormant marks))
3353                                                  'del '(dormant))))
3354         (setq unread (gnus-range-add (gnus-range-add
3355                                       unread (cdr (assq 'dormant marks)))
3356                                      (cdr (assq 'tick marks))))
3357         (gnus-add-marked-articles group 'tick nil nil 'force)
3358         (gnus-add-marked-articles group 'dormant nil nil 'force))
3359       ;; Do auto-expirable marks if that's required.
3360       (when (gnus-group-auto-expirable-p group)
3361         (gnus-range-map (lambda (article)
3362                           (gnus-add-marked-articles group 'expire (list article))
3363                           (gnus-request-set-mark group (list (list (list article) 'add '(expire)))))
3364                         unread))
3365       (let ((gnus-newsgroup-name group))
3366         (gnus-run-hooks 'gnus-group-catchup-group-hook))
3367       num)))
3368
3369 (defun gnus-group-expire-articles (&optional n)
3370   "Expire all expirable articles in the current newsgroup.
3371 Uses the process/prefix convention."
3372   (interactive "P")
3373   (let ((groups (gnus-group-process-prefix n))
3374         group)
3375     (unless groups
3376       (error "No groups to expire"))
3377     (while (setq group (pop groups))
3378       (gnus-group-remove-mark group)
3379       (gnus-group-expire-articles-1 group)
3380       (gnus-dribble-touch)
3381       (gnus-group-position-point))))
3382
3383 (defun gnus-group-expire-articles-1 (group)
3384   (when (gnus-check-backend-function 'request-expire-articles group)
3385     (gnus-message 6 "Expiring articles in %s..."
3386                   (gnus-group-decoded-name group))
3387     (let* ((info (gnus-get-info group))
3388            (expirable (if (gnus-group-total-expirable-p group)
3389                           (cons nil (gnus-list-of-read-articles group))
3390                         (assq 'expire (gnus-info-marks info))))
3391            (expiry-wait (gnus-group-find-parameter group 'expiry-wait))
3392            (nnmail-expiry-target
3393             (or (gnus-group-find-parameter group 'expiry-target)
3394                 nnmail-expiry-target)))
3395       (when expirable
3396         (gnus-check-group group)
3397         (setcdr
3398          expirable
3399          (gnus-compress-sequence
3400           (if expiry-wait
3401               ;; We set the expiry variables to the group
3402               ;; parameter.
3403               (let ((nnmail-expiry-wait-function nil)
3404                     (nnmail-expiry-wait expiry-wait))
3405                 (gnus-request-expire-articles
3406                  (gnus-uncompress-sequence (cdr expirable)) group))
3407             ;; Just expire using the normal expiry values.
3408             (gnus-request-expire-articles
3409              (gnus-uncompress-sequence (cdr expirable)) group))))
3410         (gnus-close-group group))
3411       (gnus-message 6 "Expiring articles in %s...done"
3412                     (gnus-group-decoded-name group))
3413       ;; Return the list of un-expired articles.
3414       (cdr expirable))))
3415
3416 (defun gnus-group-expire-all-groups ()
3417   "Expire all expirable articles in all newsgroups."
3418   (interactive)
3419   (save-excursion
3420     (gnus-message 5 "Expiring...")
3421     (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
3422                                      (cdr gnus-newsrc-alist))))
3423       (gnus-group-expire-articles nil)))
3424   (gnus-group-position-point)
3425   (gnus-message 5 "Expiring...done"))
3426
3427 (defun gnus-group-set-current-level (n level)
3428   "Set the level of the next N groups to LEVEL."
3429   (interactive
3430    (list
3431     current-prefix-arg
3432     (progn
3433       (unless (gnus-group-process-prefix current-prefix-arg)
3434         (error "No group on the current line"))
3435       (string-to-number
3436        (let ((s (read-string
3437                  (format "Level (default %s): "
3438                          (or (gnus-group-group-level)
3439                              gnus-level-default-subscribed)))))
3440          (if (string-match "^\\s-*$" s)
3441              (int-to-string (or (gnus-group-group-level)
3442                                 gnus-level-default-subscribed))
3443            s))))))
3444   (unless (and (>= level 1) (<= level gnus-level-killed))
3445     (error "Invalid level: %d" level))
3446   (dolist (group (gnus-group-process-prefix n))
3447     (gnus-group-remove-mark group)
3448     (gnus-message 6 "Changed level of %s from %d to %d"
3449                   (gnus-group-decoded-name group)
3450                   (or (gnus-group-group-level) gnus-level-killed)
3451                   level)
3452     (gnus-group-change-level
3453      group level (or (gnus-group-group-level) gnus-level-killed))
3454     (gnus-group-update-group-line))
3455   (gnus-group-position-point))
3456
3457 (defun gnus-group-unsubscribe (&optional n)
3458   "Unsubscribe the current group."
3459   (interactive "P")
3460   (gnus-group-unsubscribe-current-group n 'unsubscribe))
3461
3462 (defun gnus-group-subscribe (&optional n)
3463   "Subscribe the current group."
3464   (interactive "P")
3465   (gnus-group-unsubscribe-current-group n 'subscribe))
3466
3467 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
3468   "Toggle subscription of the current group.
3469 If given numerical prefix, toggle the N next groups."
3470   (interactive "P")
3471   (dolist (group (gnus-group-process-prefix n))
3472     (gnus-group-remove-mark group)
3473     (gnus-group-unsubscribe-group
3474      group
3475      (cond
3476       ((eq do-sub 'unsubscribe)
3477        gnus-level-default-unsubscribed)
3478       ((eq do-sub 'subscribe)
3479        gnus-level-default-subscribed)
3480       ((<= (gnus-group-group-level) gnus-level-subscribed)
3481        gnus-level-default-unsubscribed)
3482       (t
3483        gnus-level-default-subscribed))
3484      t)
3485     (gnus-group-update-group-line))
3486   (gnus-group-next-group 1))
3487
3488 (defun gnus-group-unsubscribe-group (group &optional level silent)
3489   "Toggle subscription to GROUP.
3490 Killed newsgroups are subscribed.  If SILENT, don't try to update the
3491 group line."
3492   (interactive
3493    (list (completing-read
3494           "Group: " gnus-active-hashtb nil
3495           (gnus-read-active-file-p)
3496           nil
3497           'gnus-group-history)))
3498   (let ((newsrc (gnus-group-entry group)))
3499     (cond
3500      ((string-match "^[ \t]*$" group)
3501       (error "Empty group name"))
3502      (newsrc
3503       ;; Toggle subscription flag.
3504       (gnus-group-change-level
3505        newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
3506                                       gnus-level-subscribed)
3507                                   (1+ gnus-level-subscribed)
3508                                 gnus-level-default-subscribed)))
3509       (unless silent
3510         (gnus-group-update-group group)))
3511      ((and (stringp group)
3512            (or (not (gnus-read-active-file-p))
3513                (gnus-active group)))
3514       ;; Add new newsgroup.
3515       (gnus-group-change-level
3516        group
3517        (if level level gnus-level-default-subscribed)
3518        (or (and (member group gnus-zombie-list)
3519                 gnus-level-zombie)
3520            gnus-level-killed)
3521        (when (gnus-group-group-name)
3522          (gnus-group-entry (gnus-group-group-name))))
3523       (unless silent
3524         (gnus-group-update-group group)))
3525      (t (error "No such newsgroup: %s" group)))
3526     (gnus-group-position-point)))
3527
3528 (defun gnus-group-transpose-groups (n)
3529   "Move the current newsgroup up N places.
3530 If given a negative prefix, move down instead.  The difference between
3531 N and the number of steps taken is returned."
3532   (interactive "p")
3533   (unless (gnus-group-group-name)
3534     (error "No group on current line"))
3535   (gnus-group-kill-group 1)
3536   (prog1
3537       (forward-line (- n))
3538     (gnus-group-yank-group)
3539     (gnus-group-position-point)))
3540
3541 (defun gnus-group-kill-all-zombies (&optional dummy)
3542   "Kill all zombie newsgroups.
3543 The optional DUMMY should always be nil."
3544   (interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
3545   (unless dummy
3546     (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
3547     (setq gnus-zombie-list nil)
3548     (gnus-dribble-touch)
3549     (gnus-group-list-groups)))
3550
3551 (defun gnus-group-kill-region (begin end)
3552   "Kill newsgroups in current region (excluding current point).
3553 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
3554   (interactive "r")
3555   (let ((lines
3556          ;; Count lines.
3557          (save-excursion
3558            (count-lines
3559             (progn
3560               (goto-char begin)
3561               (point-at-bol))
3562             (progn
3563               (goto-char end)
3564               (point-at-bol))))))
3565     (goto-char begin)
3566     (beginning-of-line)                 ;Important when LINES < 1
3567     (gnus-group-kill-group lines)))
3568
3569 (defun gnus-group-kill-group (&optional n discard)
3570   "Kill the next N groups.
3571 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
3572 However, only groups that were alive can be yanked; already killed
3573 groups or zombie groups can't be yanked.
3574 The return value is the name of the group that was killed, or a list
3575 of groups killed."
3576   (interactive "P")
3577   (let ((buffer-read-only nil)
3578         (groups (gnus-group-process-prefix n))
3579         group entry level out)
3580     (if (< (length groups) 10)
3581         ;; This is faster when there are few groups.
3582         (while groups
3583           (push (setq group (pop groups)) out)
3584           (gnus-group-remove-mark group)
3585           (setq level (gnus-group-group-level))
3586           (gnus-delete-line)
3587           (when (and (not discard)
3588                      (setq entry (gnus-group-entry group)))
3589             (gnus-undo-register
3590               `(progn
3591                  (gnus-group-goto-group ,(gnus-group-group-name))
3592                  (gnus-group-yank-group)))
3593             (push (cons (car entry) (nth 2 entry))
3594                   gnus-list-of-killed-groups))
3595           (gnus-group-change-level
3596            (if entry entry group) gnus-level-killed (if entry nil level))
3597           (message "Killed group %s" (gnus-group-decoded-name group)))
3598       ;; If there are lots and lots of groups to be killed, we use
3599       ;; this thing instead.
3600       (dolist (group (nreverse groups))
3601         (gnus-group-remove-mark group)
3602         (gnus-delete-line)
3603         (push group gnus-killed-list)
3604         (setq gnus-newsrc-alist
3605               (delq (assoc group gnus-newsrc-alist)
3606                     gnus-newsrc-alist))
3607         (when gnus-group-change-level-function
3608           (funcall gnus-group-change-level-function
3609                    group gnus-level-killed 3))
3610         (cond
3611          ((setq entry (gnus-group-entry group))
3612           (push (cons (car entry) (nth 2 entry))
3613                 gnus-list-of-killed-groups)
3614           (setcdr (cdr entry) (cdddr entry)))
3615          ((member group gnus-zombie-list)
3616           (setq gnus-zombie-list (delete group gnus-zombie-list))))
3617         ;; There may be more than one instance displayed.
3618         (while (gnus-group-goto-group group)
3619           (gnus-delete-line)))
3620       (gnus-make-hashtable-from-newsrc-alist))
3621
3622     (gnus-group-position-point)
3623     (if (< (length out) 2) (car out) (nreverse out))))
3624
3625 (defun gnus-group-yank-group (&optional arg)
3626   "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
3627 The numeric ARG specifies how many newsgroups are to be yanked.  The
3628 name of the newsgroup yanked is returned, or (if several groups are
3629 yanked) a list of yanked groups is returned."
3630   (interactive "p")
3631   (setq arg (or arg 1))
3632   (let (info group prev out)
3633     (while (>= (decf arg) 0)
3634       (when (not (setq info (pop gnus-list-of-killed-groups)))
3635         (error "No more newsgroups to yank"))
3636       (push (setq group (nth 1 info)) out)
3637       ;; Find which newsgroup to insert this one before - search
3638       ;; backward until something suitable is found.  If there are no
3639       ;; other newsgroups in this buffer, just make this newsgroup the
3640       ;; first newsgroup.
3641       (setq prev (gnus-group-group-name))
3642       (gnus-group-change-level
3643        info (gnus-info-level (cdr info)) gnus-level-killed
3644        (and prev (gnus-group-entry prev))
3645        t)
3646       (gnus-group-insert-group-line-info group)
3647       (gnus-undo-register
3648         `(when (gnus-group-goto-group ,group)
3649            (gnus-group-kill-group 1))))
3650     (forward-line -1)
3651     (gnus-group-position-point)
3652     (if (< (length out) 2) (car out) (nreverse out))))
3653
3654 (defun gnus-group-kill-level (level)
3655   "Kill all groups that is on a certain LEVEL."
3656   (interactive "nKill all groups on level: ")
3657   (cond
3658    ((= level gnus-level-zombie)
3659     (setq gnus-killed-list
3660           (nconc gnus-zombie-list gnus-killed-list))
3661     (setq gnus-zombie-list nil))
3662    ((and (< level gnus-level-zombie)
3663          (> level 0)
3664          (or gnus-expert-user
3665              (gnus-yes-or-no-p
3666               (format
3667                "Do you really want to kill all groups on level %d? "
3668                level))))
3669     (let* ((prev gnus-newsrc-alist)
3670            (alist (cdr prev)))
3671       (while alist
3672         (if (= (gnus-info-level (car alist)) level)
3673             (progn
3674               (push (gnus-info-group (car alist)) gnus-killed-list)
3675               (setcdr prev (cdr alist)))
3676           (setq prev alist))
3677         (setq alist (cdr alist)))
3678       (gnus-make-hashtable-from-newsrc-alist)
3679       (gnus-group-list-groups)))
3680    (t
3681     (error "Can't kill; invalid level: %d" level))))
3682
3683 (defun gnus-group-list-all-groups (&optional arg)
3684   "List all newsgroups with level ARG or lower.
3685 Default is `gnus-level-unsubscribed', which lists all subscribed and most
3686 unsubscribed groups."
3687   (interactive "P")
3688   (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
3689
3690 ;; Redefine this to list ALL killed groups if prefix arg used.
3691 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
3692 (defun gnus-group-list-killed (&optional arg)
3693   "List all killed newsgroups in the group buffer.
3694 If ARG is non-nil, list ALL killed groups known to Gnus.  This may
3695 entail asking the server for the groups."
3696   (interactive "P")
3697   ;; Find all possible killed newsgroups if arg.
3698   (when arg
3699     (gnus-get-killed-groups))
3700   (if (not gnus-killed-list)
3701       (gnus-message 6 "No killed groups")
3702     (let (gnus-group-list-mode)
3703       (funcall gnus-group-prepare-function
3704                gnus-level-killed t gnus-level-killed))
3705     (goto-char (point-min)))
3706   (gnus-group-position-point))
3707
3708 (defun gnus-group-list-zombies ()
3709   "List all zombie newsgroups in the group buffer."
3710   (interactive)
3711   (if (not gnus-zombie-list)
3712       (gnus-message 6 "No zombie groups")
3713     (let (gnus-group-list-mode)
3714       (funcall gnus-group-prepare-function
3715                gnus-level-zombie t gnus-level-zombie))
3716     (goto-char (point-min)))
3717   (gnus-group-position-point))
3718
3719 (defun gnus-group-list-active ()
3720   "List all groups that are available from the server(s)."
3721   (interactive)
3722   ;; First we make sure that we have really read the active file.
3723   (unless (gnus-read-active-file-p)
3724     (let ((gnus-read-active-file t)
3725           (gnus-agent gnus-plugged)); If we're actually plugged, store the active file in the agent.
3726       (gnus-read-active-file)))
3727   ;; Find all groups and sort them.
3728   (let ((groups
3729          (sort
3730           (let (list)
3731             (mapatoms
3732              (lambda (sym)
3733                (and (boundp sym)
3734                     (symbol-value sym)
3735                     (push (symbol-name sym) list)))
3736              gnus-active-hashtb)
3737             list)
3738           'string<))
3739         (buffer-read-only nil)
3740         group)
3741     (erase-buffer)
3742     (while groups
3743       (setq group (pop groups))
3744       (gnus-add-text-properties
3745        (point) (prog1 (1+ (point))
3746                  (insert "       *: "
3747                          (gnus-group-decoded-name group)
3748                          "\n"))
3749        (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
3750              'gnus-unread t
3751              'gnus-level (inline (gnus-group-level group)))))
3752     (goto-char (point-min))))
3753
3754 (defun gnus-activate-all-groups (level)
3755   "Activate absolutely all groups."
3756   (interactive (list gnus-level-unsubscribed))
3757   (let ((gnus-activate-level level)
3758         (gnus-activate-foreign-newsgroups level))
3759     (gnus-group-get-new-news)))
3760
3761 (defun gnus-group-get-new-news (&optional arg)
3762   "Get newly arrived articles.
3763 If ARG is a number, it specifies which levels you are interested in
3764 re-scanning.  If ARG is non-nil and not a number, this will force
3765 \"hard\" re-reading of the active files from all servers."
3766   (interactive "P")
3767   (require 'nnmail)
3768   (let ((gnus-inhibit-demon t)
3769         ;; Binding this variable will inhibit multiple fetchings
3770         ;; of the same mail source.
3771         (nnmail-fetched-sources (list t)))
3772     (gnus-run-hooks 'gnus-get-top-new-news-hook)
3773     (gnus-run-hooks 'gnus-get-new-news-hook)
3774
3775     ;; Read any slave files.
3776     (unless gnus-slave
3777       (gnus-master-read-slave-newsrc))
3778
3779     ;; We might read in new NoCeM messages here.
3780     (when (and gnus-use-nocem
3781                (null arg))
3782       (gnus-nocem-scan-groups))
3783     ;; If ARG is not a number, then we read the active file.
3784     (when (and arg (not (numberp arg)))
3785       (let ((gnus-read-active-file t))
3786         (gnus-read-active-file))
3787       (setq arg nil)
3788
3789       ;; If the user wants it, we scan for new groups.
3790       (when (eq gnus-check-new-newsgroups 'always)
3791         (gnus-find-new-newsgroups)))
3792
3793     (setq arg (gnus-group-default-level arg t))
3794     (if (and gnus-read-active-file (not arg))
3795         (progn
3796           (gnus-read-active-file)
3797           (gnus-get-unread-articles arg))
3798       (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
3799         (gnus-get-unread-articles arg)))
3800     (gnus-check-reasonable-setup)
3801     (gnus-run-hooks 'gnus-after-getting-new-news-hook)
3802     (gnus-group-list-groups (and (numberp arg)
3803                                  (max (car gnus-group-list-mode) arg)))))
3804
3805 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
3806   "Check for newly arrived news in the current group (and the N-1 next groups).
3807 The difference between N and the number of newsgroup checked is returned.
3808 If N is negative, this group and the N-1 previous groups will be checked.
3809 If DONT-SCAN is non-nil, scan non-activated groups as well."
3810   (interactive "P")
3811   (let* ((groups (gnus-group-process-prefix n))
3812          (ret (if (numberp n) (- n (length groups)) 0))
3813          (beg (unless n
3814                 (point)))
3815          group method
3816          (gnus-inhibit-demon t)
3817          ;; Binding this variable will inhibit multiple fetchings
3818          ;; of the same mail source.
3819          (nnmail-fetched-sources (list t)))
3820     (gnus-run-hooks 'gnus-get-new-news-hook)
3821     (while (setq group (pop groups))
3822       (gnus-group-remove-mark group)
3823       ;; Bypass any previous denials from the server.
3824       (gnus-remove-denial (setq method (gnus-find-method-for-group group)))
3825       (if (gnus-activate-group group (if dont-scan nil 'scan) nil method)
3826           (let ((info (gnus-get-info group))
3827                 (active (gnus-active group)))
3828             (when info
3829               (gnus-request-update-info info method))
3830             (gnus-get-unread-articles-in-group info active)
3831             (unless (gnus-virtual-group-p group)
3832               (gnus-close-group group))
3833             (when gnus-agent
3834               (gnus-agent-save-group-info
3835                method (gnus-group-real-name group) active))
3836             (gnus-group-update-group group))
3837         (if (eq (gnus-server-status (gnus-find-method-for-group group))
3838                 'denied)
3839             (gnus-error 3 "Server denied access")
3840           (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
3841     (when beg
3842       (goto-char beg))
3843     (when gnus-goto-next-group-when-activating
3844       (gnus-group-next-unread-group 1 t))
3845     (gnus-summary-position-point)
3846     ret))
3847
3848 (defun gnus-group-fetch-faq (group &optional faq-dir)
3849   "Fetch the FAQ for the current group.
3850 If given a prefix argument, prompt for the FAQ dir
3851 to use."
3852   (interactive
3853    (list
3854     (gnus-group-group-name)
3855     (when current-prefix-arg
3856       (completing-read
3857        "FAQ dir: " (and (listp gnus-group-faq-directory)
3858                         (mapcar #'list
3859                                 gnus-group-faq-directory))))))
3860   (unless group
3861     (error "No group name given"))
3862   (let ((dirs (or faq-dir gnus-group-faq-directory))
3863         dir found file)
3864     (unless (listp dirs)
3865       (setq dirs (list dirs)))
3866     (while (and (not found)
3867                 (setq dir (pop dirs)))
3868       (let ((name (gnus-group-real-name group)))
3869         (setq file (expand-file-name name dir)))
3870       (if (not (file-exists-p file))
3871           (gnus-message 1 "No such file: %s" file)
3872         (let ((enable-local-variables nil))
3873           (find-file file)
3874           (setq found t))))))
3875
3876 (defun gnus-group-fetch-charter (group)
3877   "Fetch the charter for the current group.
3878 If given a prefix argument, prompt for a group."
3879   (interactive
3880    (list (or (when current-prefix-arg
3881                (completing-read "Group: " gnus-active-hashtb))
3882              (gnus-group-group-name)
3883              gnus-newsgroup-name)))
3884   (unless group
3885     (error "No group name given"))
3886   (require 'mm-url)
3887   (condition-case nil (require 'url-http) (error nil))
3888   (let ((name (mm-url-form-encode-xwfu (gnus-group-real-name group)))
3889         url hierarchy)
3890     (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3891       (setq hierarchy (match-string 1 name))
3892       (if (and (setq url (cdr (assoc hierarchy gnus-group-charter-alist)))
3893                (if (fboundp 'url-http-file-exists-p)
3894                    (url-http-file-exists-p (eval url))
3895                  t))
3896           (browse-url (eval url))
3897         (setq url (concat "http://" hierarchy
3898                           ".news-admin.org/charters/" name))
3899         (if (and (fboundp 'url-http-file-exists-p)
3900                  (url-http-file-exists-p url))
3901             (browse-url url)
3902           (gnus-group-fetch-control group))))))
3903
3904 (defun gnus-group-fetch-control (group)
3905   "Fetch the archived control messages for the current group.
3906 If given a prefix argument, prompt for a group."
3907   (interactive
3908    (list (or (when current-prefix-arg
3909                (completing-read "Group: " gnus-active-hashtb))
3910              (gnus-group-group-name)
3911              gnus-newsgroup-name)))
3912   (unless group
3913     (error "No group name given"))
3914   (let ((name (gnus-group-real-name group))
3915         hierarchy)
3916     (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3917       (setq hierarchy (match-string 1 name))
3918       (if gnus-group-fetch-control-use-browse-url
3919           (browse-url (concat "ftp://ftp.isc.org/usenet/control/"
3920                               hierarchy "/" name ".gz"))
3921         (let ((enable-local-variables nil))
3922           (gnus-group-read-ephemeral-group
3923            group
3924            `(nndoc ,group (nndoc-address
3925                            ,(find-file-noselect
3926                              (concat "/ftp@ftp.isc.org:/usenet/control/"
3927                                      hierarchy "/" name ".gz")))
3928                    (nndoc-article-type mbox)) t nil nil))))))
3929
3930 (defun gnus-group-describe-group (force &optional group)
3931   "Display a description of the current newsgroup."
3932   (interactive (list current-prefix-arg (gnus-group-group-name)))
3933   (let* ((method (gnus-find-method-for-group group))
3934          (mname (gnus-group-prefixed-name "" method))
3935          desc)
3936     (when (and force
3937                gnus-description-hashtb)
3938       (gnus-sethash mname nil gnus-description-hashtb))
3939     (unless group
3940       (error "No group name given"))
3941     (when (or (and gnus-description-hashtb
3942                    ;; We check whether this group's method has been
3943                    ;; queried for a description file.
3944                    (gnus-gethash mname gnus-description-hashtb))
3945               (setq desc (gnus-group-get-description group))
3946               (gnus-read-descriptions-file method))
3947       (gnus-message 1
3948                     (or desc (gnus-gethash group gnus-description-hashtb)
3949                         "No description available")))))
3950
3951 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3952 (defun gnus-group-describe-all-groups (&optional force)
3953   "Pop up a buffer with descriptions of all newsgroups."
3954   (interactive "P")
3955   (when force
3956     (setq gnus-description-hashtb nil))
3957   (when (not (or gnus-description-hashtb
3958                  (gnus-read-all-descriptions-files)))
3959     (error "Couldn't request descriptions file"))
3960   (let ((buffer-read-only nil)
3961         b)
3962     (erase-buffer)
3963     (mapatoms
3964      (lambda (group)
3965        (setq b (point))
3966        (let ((charset (gnus-group-name-charset nil (symbol-name group))))
3967          (insert (format "      *: %-20s %s\n"
3968                          (gnus-group-name-decode
3969                           (symbol-name group) charset)
3970                          (gnus-group-name-decode
3971                           (symbol-value group) charset))))
3972        (gnus-add-text-properties
3973         b (1+ b) (list 'gnus-group group
3974                        'gnus-unread t 'gnus-marked nil
3975                        'gnus-level (1+ gnus-level-subscribed))))
3976      gnus-description-hashtb)
3977     (goto-char (point-min))
3978     (gnus-group-position-point)))
3979
3980 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
3981 (defun gnus-group-apropos (regexp &optional search-description)
3982   "List all newsgroups that have names that match a regexp."
3983   (interactive "sGnus apropos (regexp): ")
3984   (let ((prev "")
3985         (obuf (current-buffer))
3986         groups des)
3987     ;; Go through all newsgroups that are known to Gnus.
3988     (mapatoms
3989      (lambda (group)
3990        (and (symbol-name group)
3991             (string-match regexp (symbol-name group))
3992             (symbol-value group)
3993             (push (symbol-name group) groups)))
3994      gnus-active-hashtb)
3995     ;; Also go through all descriptions that are known to Gnus.
3996     (when search-description
3997       (mapatoms
3998        (lambda (group)
3999          (and (string-match regexp (symbol-value group))
4000               (push (symbol-name group) groups)))
4001        gnus-description-hashtb))
4002     (if (not groups)
4003         (gnus-message 3 "No groups matched \"%s\"." regexp)
4004       ;; Print out all the groups.
4005       (save-excursion
4006         (pop-to-buffer "*Gnus Help*")
4007         (buffer-disable-undo)
4008         (erase-buffer)
4009         (setq groups (sort groups 'string<))
4010         (while groups
4011           ;; Groups may be entered twice into the list of groups.
4012           (when (not (string= (car groups) prev))
4013             (setq prev (car groups))
4014             (let ((charset (gnus-group-name-charset nil prev)))
4015               (insert (gnus-group-name-decode prev charset) "\n")
4016               (when (and gnus-description-hashtb
4017                          (setq des (gnus-gethash (car groups)
4018                                                  gnus-description-hashtb)))
4019                 (insert "  " (gnus-group-name-decode des charset) "\n"))))
4020           (setq groups (cdr groups)))
4021         (goto-char (point-min))))
4022     (pop-to-buffer obuf)))
4023
4024 (defun gnus-group-description-apropos (regexp)
4025   "List all newsgroups that have names or descriptions that match REGEXP."
4026   (interactive "sGnus description apropos (regexp): ")
4027   (when (not (or gnus-description-hashtb
4028                  (gnus-read-all-descriptions-files)))
4029     (error "Couldn't request descriptions file"))
4030   (gnus-group-apropos regexp t))
4031
4032 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4033 (defun gnus-group-list-matching (level regexp &optional all lowest)
4034   "List all groups with unread articles that match REGEXP.
4035 If the prefix LEVEL is non-nil, it should be a number that says which
4036 level to cut off listing groups.
4037 If ALL, also list groups with no unread articles.
4038 If LOWEST, don't list groups with level lower than LOWEST.
4039
4040 This command may read the active file."
4041   (interactive "P\nsList newsgroups matching: ")
4042   ;; First make sure active file has been read.
4043   (when (and level
4044              (> (prefix-numeric-value level) gnus-level-killed))
4045     (gnus-get-killed-groups))
4046   (funcall gnus-group-prepare-function
4047    (or level gnus-level-subscribed) (and all t) (or lowest 1) regexp)
4048   (goto-char (point-min))
4049   (gnus-group-position-point))
4050
4051 (defun gnus-group-list-all-matching (level regexp &optional lowest)
4052   "List all groups that match REGEXP.
4053 If the prefix LEVEL is non-nil, it should be a number that says which
4054 level to cut off listing groups.
4055 If LOWEST, don't list groups with level lower than LOWEST."
4056   (interactive "P\nsList newsgroups matching: ")
4057   (when level
4058     (setq level (prefix-numeric-value level)))
4059   (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
4060
4061 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
4062 (defun gnus-group-save-newsrc (&optional force)
4063   "Save the Gnus startup files.
4064 If FORCE, force saving whether it is necessary or not."
4065   (interactive "P")
4066   (gnus-save-newsrc-file force))
4067
4068 (defun gnus-group-restart (&optional arg)
4069   "Force Gnus to read the .newsrc file."
4070   (interactive "P")
4071   (when (gnus-yes-or-no-p
4072          (format "Are you sure you want to restart Gnus? "))
4073     (gnus-save-newsrc-file)
4074     (gnus-clear-system)
4075     (gnus)))
4076
4077 (defun gnus-group-read-init-file ()
4078   "Read the Gnus elisp init file."
4079   (interactive)
4080   (gnus-read-init-file)
4081   (gnus-message 5 "Read %s" gnus-init-file))
4082
4083 (defun gnus-group-check-bogus-groups (&optional silent)
4084   "Check bogus newsgroups.
4085 If given a prefix, don't ask for confirmation before removing a bogus
4086 group."
4087   (interactive "P")
4088   (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
4089   (gnus-group-list-groups))
4090
4091 (defun gnus-group-find-new-groups (&optional arg)
4092   "Search for new groups and add them.
4093 Each new group will be treated with `gnus-subscribe-newsgroup-method'.
4094 With 1 C-u, use the `ask-server' method to query the server for new
4095 groups.
4096 With 2 C-u's, use most complete method possible to query the server
4097 for new groups, and subscribe the new groups as zombies."
4098   (interactive "p")
4099   (gnus-find-new-newsgroups (or arg 1))
4100   (gnus-group-list-groups))
4101
4102 (defun gnus-group-edit-global-kill (&optional article group)
4103   "Edit the global kill file.
4104 If GROUP, edit that local kill file instead."
4105   (interactive "P")
4106   (setq gnus-current-kill-article article)
4107   (gnus-kill-file-edit-file group)
4108   (gnus-message
4109    6
4110    (substitute-command-keys
4111     (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
4112             (if group "local" "global")))))
4113
4114 (defun gnus-group-edit-local-kill (article group)
4115   "Edit a local kill file."
4116   (interactive (list nil (gnus-group-group-name)))
4117   (gnus-group-edit-global-kill article group))
4118
4119 (defun gnus-group-force-update ()
4120   "Update `.newsrc' file."
4121   (interactive)
4122   (gnus-save-newsrc-file))
4123
4124 (defvar gnus-backlog-articles)
4125
4126 (defun gnus-group-suspend ()
4127   "Suspend the current Gnus session.
4128 In fact, cleanup buffers except for group mode buffer.
4129 The hook `gnus-suspend-gnus-hook' is called before actually suspending."
4130   (interactive)
4131   (gnus-run-hooks 'gnus-suspend-gnus-hook)
4132   (gnus-offer-save-summaries)
4133   ;; Kill Gnus buffers except for group mode buffer.
4134   (let ((group-buf (get-buffer gnus-group-buffer)))
4135     (mapcar (lambda (buf)
4136               (unless (or (member buf (list group-buf gnus-dribble-buffer))
4137                           (with-current-buffer buf
4138                             (eq major-mode 'message-mode)))
4139                 (gnus-kill-buffer buf)))
4140             (gnus-buffers))
4141     (setq gnus-backlog-articles nil)
4142     (gnus-kill-gnus-frames)
4143     (when group-buf
4144       (bury-buffer group-buf)
4145       (delete-windows-on group-buf t))))
4146
4147 (defun gnus-group-clear-dribble ()
4148   "Clear all information from the dribble buffer."
4149   (interactive)
4150   (gnus-dribble-clear)
4151   (gnus-message 7 "Cleared dribble buffer"))
4152
4153 (defun gnus-group-exit ()
4154   "Quit reading news after updating .newsrc.eld and .newsrc.
4155 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4156   (interactive)
4157   (when
4158       (or noninteractive                ;For gnus-batch-kill
4159           (not gnus-interactive-exit)   ;Without confirmation
4160           gnus-expert-user
4161           (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
4162     (gnus-run-hooks 'gnus-exit-gnus-hook)
4163     ;; Offer to save data from non-quitted summary buffers.
4164     (gnus-offer-save-summaries)
4165     ;; Save the newsrc file(s).
4166     (gnus-save-newsrc-file)
4167     ;; Kill-em-all.
4168     (gnus-close-backends)
4169     ;; Reset everything.
4170     (gnus-clear-system)
4171     ;; Allow the user to do things after cleaning up.
4172     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4173
4174 (defun gnus-group-quit ()
4175   "Quit reading news without updating .newsrc.eld or .newsrc.
4176 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4177   (interactive)
4178   (when (or noninteractive              ;For gnus-batch-kill
4179             (zerop (buffer-size))
4180             (not (gnus-server-opened gnus-select-method))
4181             gnus-expert-user
4182             (not gnus-current-startup-file)
4183             (gnus-yes-or-no-p
4184              (format "Quit reading news without saving %s? "
4185                      (file-name-nondirectory gnus-current-startup-file))))
4186     (gnus-run-hooks 'gnus-exit-gnus-hook)
4187     (gnus-configure-windows 'group t)
4188     (when (and (gnus-buffer-live-p gnus-dribble-buffer)
4189                (not (zerop (save-excursion
4190                             (set-buffer gnus-dribble-buffer)
4191                             (buffer-size)))))
4192       (gnus-dribble-enter
4193        ";;; Gnus was exited on purpose without saving the .newsrc files."))
4194     (gnus-dribble-save)
4195     (gnus-close-backends)
4196     (gnus-clear-system)
4197     (gnus-kill-buffer gnus-group-buffer)
4198     ;; Allow the user to do things after cleaning up.
4199     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4200
4201 (defun gnus-group-describe-briefly ()
4202   "Give a one line description of the group mode commands."
4203   (interactive)
4204   (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")))
4205
4206 (defun gnus-group-browse-foreign-server (method)
4207   "Browse a foreign news server.
4208 If called interactively, this function will ask for a select method
4209  (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
4210 If not, METHOD should be a list where the first element is the method
4211 and the second element is the address."
4212   (interactive
4213    (list (let ((how (completing-read
4214                      "Which back end: "
4215                      (append gnus-valid-select-methods gnus-server-alist)
4216                      nil t (cons "nntp" 0) 'gnus-method-history)))
4217            ;; We either got a back end name or a virtual server name.
4218            ;; If the first, we also need an address.
4219            (if (assoc how gnus-valid-select-methods)
4220                (list (intern how)
4221                      ;; Suggested by mapjph@bath.ac.uk.
4222                      (completing-read
4223                       "Address: "
4224                       (mapcar 'list gnus-secondary-servers)))
4225              ;; We got a server name.
4226              how))))
4227   (gnus-browse-foreign-server method))
4228
4229 (defun gnus-group-set-info (info &optional method-only-group part)
4230   (when (or info part)
4231     (let* ((entry (gnus-group-entry
4232                    (or method-only-group (gnus-info-group info))))
4233            (part-info info)
4234            (info (if method-only-group (nth 2 entry) info))
4235            method)
4236       (when method-only-group
4237         (unless entry
4238           (error "Trying to change non-existent group %s" method-only-group))
4239         ;; We have received parts of the actual group info - either the
4240         ;; select method or the group parameters.        We first check
4241         ;; whether we have to extend the info, and if so, do that.
4242         (let ((len (length info))
4243               (total (if (eq part 'method) 5 6)))
4244           (when (< len total)
4245             (setcdr (nthcdr (1- len) info)
4246                     (make-list (- total len) nil)))
4247           ;; Then we enter the new info.
4248           (setcar (nthcdr (1- total) info) part-info)))
4249       (unless entry
4250         ;; This is a new group, so we just create it.
4251         (save-excursion
4252           (set-buffer gnus-group-buffer)
4253           (setq method (gnus-info-method info))
4254           (when (gnus-server-equal method "native")
4255             (setq method nil))
4256           (save-excursion
4257             (set-buffer gnus-group-buffer)
4258             (if method
4259                 ;; It's a foreign group...
4260                 (gnus-group-make-group
4261                  (gnus-group-real-name (gnus-info-group info))
4262                  (if (stringp method) method
4263                    (prin1-to-string (car method)))
4264                  (and (consp method)
4265                       (nth 1 (gnus-info-method info))))
4266               ;; It's a native group.
4267               (gnus-group-make-group (gnus-info-group info))))
4268           (gnus-message 6 "Note: New group created")
4269           (setq entry
4270                 (gnus-group-entry (gnus-group-prefixed-name
4271                                    (gnus-group-real-name (gnus-info-group info))
4272                                    (or (gnus-info-method info) gnus-select-method))))))
4273       ;; Whether it was a new group or not, we now have the entry, so we
4274       ;; can do the update.
4275       (if entry
4276           (progn
4277             (setcar (nthcdr 2 entry) info)
4278             (when (and (not (eq (car entry) t))
4279                        (gnus-active (gnus-info-group info)))
4280               (setcar entry (length
4281                              (gnus-list-of-unread-articles (car info))))))
4282         (error "No such group: %s" (gnus-info-group info))))))
4283
4284 (defun gnus-group-set-method-info (group select-method)
4285   (gnus-group-set-info select-method group 'method))
4286
4287 (defun gnus-group-set-params-info (group params)
4288   (gnus-group-set-info params group 'params))
4289
4290 (defun gnus-add-marked-articles (group type articles &optional info force)
4291   ;; Add ARTICLES of TYPE to the info of GROUP.
4292   ;; If INFO is non-nil, use that info.  If FORCE is non-nil, don't
4293   ;; add, but replace marked articles of TYPE with ARTICLES.
4294   (let ((info (or info (gnus-get-info group)))
4295         marked m)
4296     (or (not info)
4297         (and (not (setq marked (nthcdr 3 info)))
4298              (or (null articles)
4299                  (setcdr (nthcdr 2 info)
4300                          (list (list (cons type (gnus-compress-sequence
4301                                                  articles t)))))))
4302         (and (not (setq m (assq type (car marked))))
4303              (or (null articles)
4304                  (setcar marked
4305                          (cons (cons type (gnus-compress-sequence articles t) )
4306                                (car marked)))))
4307         (if force
4308             (if (null articles)
4309                 (setcar (nthcdr 3 info)
4310                         (gnus-delete-alist type (car marked)))
4311               (setcdr m (gnus-compress-sequence articles t)))
4312           (setcdr m (gnus-compress-sequence
4313                      (sort (nconc (gnus-uncompress-range (cdr m))
4314                                   (copy-sequence articles)) '<) t))))))
4315
4316 (defun gnus-add-mark (group mark article)
4317   "Mark ARTICLE in GROUP with MARK, whether the group is displayed or not."
4318   (let ((buffer (gnus-summary-buffer-name group)))
4319     (if (gnus-buffer-live-p buffer)
4320         (save-excursion
4321           (set-buffer (get-buffer buffer))
4322           (gnus-summary-add-mark article mark))
4323       (gnus-add-marked-articles group (cdr (assq mark gnus-article-mark-lists))
4324                                 (list article)))))
4325
4326 ;;;
4327 ;;; Group timestamps
4328 ;;;
4329
4330 (defun gnus-group-set-timestamp ()
4331   "Change the timestamp of the current group to the current time.
4332 This function can be used in hooks like `gnus-select-group-hook'
4333 or `gnus-group-catchup-group-hook'."
4334   (when gnus-newsgroup-name
4335     (let ((time (current-time)))
4336       (setcdr (cdr time) nil)
4337       (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
4338
4339 (defsubst gnus-group-timestamp (group)
4340   "Return the timestamp for GROUP."
4341   (gnus-group-get-parameter group 'timestamp t))
4342
4343 (defun gnus-group-timestamp-delta (group)
4344   "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
4345   (let* ((time (or (gnus-group-timestamp group)
4346                    (list 0 0)))
4347          (delta (subtract-time (current-time) time)))
4348     (+ (* (nth 0 delta) 65536.0)
4349        (nth 1 delta))))
4350
4351 (defun gnus-group-timestamp-string (group)
4352   "Return a string of the timestamp for GROUP."
4353   (let ((time (gnus-group-timestamp group)))
4354     (if (not time)
4355         ""
4356       (gnus-time-iso8601 time))))
4357
4358 (defun gnus-group-list-cached (level &optional lowest)
4359   "List all groups with cached articles.
4360 If the prefix LEVEL is non-nil, it should be a number that says which
4361 level to cut off listing groups.
4362 If LOWEST, don't list groups with level lower than LOWEST.
4363
4364 This command may read the active file."
4365   (interactive "P")
4366   (when level
4367     (setq level (prefix-numeric-value level)))
4368   (when (or (not level) (>= level gnus-level-zombie))
4369     (gnus-cache-open))
4370   (funcall gnus-group-prepare-function
4371            (or level gnus-level-subscribed)
4372            #'(lambda (info)
4373                (let ((marks (gnus-info-marks info)))
4374                  (assq 'cache marks)))
4375            lowest
4376            #'(lambda (group)
4377                (or (gnus-gethash group
4378                                  gnus-cache-active-hashtb)
4379                    ;; Cache active file might use "."
4380                    ;; instead of ":".
4381                    (gnus-gethash
4382                     (mapconcat 'identity
4383                                (split-string group ":")
4384                                ".")
4385                     gnus-cache-active-hashtb))))
4386   (goto-char (point-min))
4387   (gnus-group-position-point))
4388
4389 (defun gnus-group-list-dormant (level &optional lowest)
4390   "List all groups with dormant articles.
4391 If the prefix LEVEL is non-nil, it should be a number that says which
4392 level to cut off listing groups.
4393 If LOWEST, don't list groups with level lower than LOWEST.
4394
4395 This command may read the active file."
4396   (interactive "P")
4397   (when level
4398     (setq level (prefix-numeric-value level)))
4399   (when (or (not level) (>= level gnus-level-zombie))
4400     (gnus-cache-open))
4401   (funcall gnus-group-prepare-function
4402            (or level gnus-level-subscribed)
4403            #'(lambda (info)
4404                (let ((marks (gnus-info-marks info)))
4405                  (assq 'dormant marks)))
4406            lowest
4407            'ignore)
4408   (goto-char (point-min))
4409   (gnus-group-position-point))
4410
4411 (defun gnus-group-listed-groups ()
4412   "Return a list of listed groups."
4413   (let (point groups)
4414     (goto-char (point-min))
4415     (while (setq point (text-property-not-all (point) (point-max)
4416                                               'gnus-group nil))
4417       (goto-char point)
4418       (push (symbol-name (get-text-property point 'gnus-group)) groups)
4419       (forward-char 1))
4420     groups))
4421
4422 (defun gnus-group-list-plus (&optional args)
4423   "List groups plus the current selection."
4424   (interactive "P")
4425   (let ((gnus-group-listed-groups (gnus-group-listed-groups))
4426         (gnus-group-list-mode gnus-group-list-mode) ;; Save it.
4427         func)
4428     (push last-command-event unread-command-events)
4429     (if (featurep 'xemacs)
4430         (push (make-event 'key-press '(key ?A)) unread-command-events)
4431       (push ?A unread-command-events))
4432     (let (gnus-pick-mode keys)
4433       (setq keys (if (featurep 'xemacs)
4434                      (events-to-keys (read-key-sequence nil))
4435                    (read-key-sequence nil)))
4436       (setq func (lookup-key (current-local-map) keys)))
4437     (if (or (not func)
4438             (numberp func))
4439         (ding)
4440       (call-interactively func))))
4441
4442 (defun gnus-group-list-flush (&optional args)
4443   "Flush groups from the current selection."
4444   (interactive "P")
4445   (let ((gnus-group-list-option 'flush))
4446     (gnus-group-list-plus args)))
4447
4448 (defun gnus-group-list-limit (&optional args)
4449   "List groups limited within the current selection."
4450   (interactive "P")
4451   (let ((gnus-group-list-option 'limit))
4452     (gnus-group-list-plus args)))
4453
4454 (defun gnus-group-mark-article-read (group article)
4455   "Mark ARTICLE read."
4456   (let ((buffer (gnus-summary-buffer-name group))
4457         (mark gnus-read-mark)
4458         active n)
4459     (if (get-buffer buffer)
4460         (with-current-buffer buffer
4461           (setq active gnus-newsgroup-active)
4462           (gnus-activate-group group)
4463           (when gnus-newsgroup-prepared
4464             (when (and gnus-newsgroup-auto-expire
4465                        (memq mark gnus-auto-expirable-marks))
4466               (setq mark gnus-expirable-mark))
4467             (setq mark (gnus-request-update-mark
4468                         group article mark))
4469             (gnus-mark-article-as-read article mark)
4470             (setq gnus-newsgroup-active (gnus-active group))
4471             (when active
4472               (setq n (1+ (cdr active)))
4473               (while (<= n (cdr gnus-newsgroup-active))
4474                 (unless (eq n article)
4475                   (push n gnus-newsgroup-unselected))
4476                 (setq n (1+ n)))
4477               (setq gnus-newsgroup-unselected
4478                     (nreverse gnus-newsgroup-unselected)))))
4479       (gnus-activate-group group)
4480       (gnus-group-make-articles-read group (list article))
4481       (when (gnus-group-auto-expirable-p group)
4482         (gnus-add-marked-articles
4483          group 'expire (list article))))))
4484
4485
4486 ;;;
4487 ;;; Group compaction. -- dvl
4488 ;;;
4489
4490 (defun gnus-group-compact-group (group)
4491   "Compact the current group.
4492 Compaction means removing gaps between article numbers.  Hence, this
4493 operation is only meaningful for back ends using one file per article
4494 \(e.g. nnml).
4495
4496 Note: currently only implemented in nnml."
4497   (interactive (list (gnus-group-group-name)))
4498   (unless group
4499     (error "No group to compact"))
4500   (unless (gnus-check-backend-function 'request-compact-group group)
4501     (error "This back end does not support group compaction"))
4502   (let ((group-decoded (gnus-group-decoded-name group)))
4503     (gnus-message 6 "\
4504 Compacting group %s... (this may take a long time)"
4505                   group-decoded)
4506     (prog1
4507         (if (not (gnus-request-compact-group group))
4508             (gnus-error 3 "Couldn't compact group %s" group-decoded)
4509           (gnus-message 6 "Compacting group %s...done" group-decoded)
4510           t)
4511       ;; Invalidate the "original article" buffer which might be out of date.
4512       ;; #### NOTE: Yes, this might be a bit rude, but since compaction
4513       ;; #### will not happen very often, I think this is acceptable.
4514       (let ((original (get-buffer gnus-original-article-buffer)))
4515         (and original (gnus-kill-buffer original)))
4516       ;; Update the group line to reflect new information (art number etc).
4517       (gnus-group-update-group-line))))
4518
4519 (provide 'gnus-group)
4520
4521 ;;; arch-tag: 2eb5440f-0bca-4091-814c-e37817536af6
4522 ;;; gnus-group.el ends here