Import No Gnus v0.4.
[elisp/gnus.git-] / 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 (defun gnus-group-tool-bar-update (&optional symbol value)
1003   "Update group buffer toolbar.
1004 Setter function for custom variables."
1005   (when symbol
1006     (set-default symbol value))
1007   ;; (setq-default gnus-group-tool-bar-map nil)
1008   ;; (use-local-map gnus-group-mode-map)
1009   (when (gnus-alive-p)
1010     (with-current-buffer gnus-group-buffer
1011       (gnus-group-make-tool-bar t))))
1012
1013 (defcustom gnus-group-tool-bar (if (eq gmm-tool-bar-style 'gnome)
1014                                    'gnus-group-tool-bar-gnome
1015                                  'gnus-group-tool-bar-retro)
1016   "Specifies the Gnus group tool bar.
1017
1018 It can be either a list or a symbol refering to a list.  See
1019 `gmm-tool-bar-from-list' for the format of the list.  The
1020 default key map is `gnus-group-mode-map'.
1021
1022 Pre-defined symbols include `gnus-group-tool-bar-gnome' and
1023 `gnus-group-tool-bar-retro'."
1024   :type '(choice (const :tag "GNOME style" gnus-group-tool-bar-gnome)
1025                  (const :tag "Retro look" gnus-group-tool-bar-retro)
1026                  (repeat :tag "User defined list" gmm-tool-bar-item)
1027                  (symbol))
1028   :version "23.0" ;; No Gnus
1029   :initialize 'custom-initialize-default
1030   :set 'gnus-group-tool-bar-update
1031   :group 'gnus-group)
1032
1033 (defcustom gnus-group-tool-bar-gnome
1034   '((gnus-group-post-news "mail/compose")
1035     ;; Some useful agent icons?  I don't use the agent so agent users should
1036     ;; suggest useful commands:
1037     (gnus-agent-toggle-plugged "connect" t
1038                                :visible (and gnus-agent (not gnus-plugged)))
1039     (gnus-agent-toggle-plugged "disconnect" t
1040                                :visible (and gnus-agent gnus-plugged))
1041     ;; FIXME: gnus-agent-toggle-plugged (in gnus-agent-group-make-menu-bar)
1042     ;; should have a better help text.
1043     (gnus-group-send-queue "mail/outbox" t
1044                            :visible (and gnus-agent gnus-plugged)
1045                            :help "Send articles from the queue group")
1046     (gnus-group-get-new-news "mail/inbox" nil
1047                              :visible (or (not gnus-agent)
1048                                           gnus-plugged))
1049     ;; FIXME: gnus-*-read-group should have a better help text.
1050     (gnus-topic-read-group "open" nil
1051                            :visible (and (boundp 'gnus-topic-mode)
1052                                          gnus-topic-mode))
1053     (gnus-group-read-group "open" nil
1054                            :visible (not (and (boundp 'gnus-topic-mode)
1055                                               gnus-topic-mode)))
1056     ;; (gnus-group-find-new-groups "???" nil)
1057     (gnus-group-save-newsrc "save")
1058     (gnus-group-describe-group "describe")
1059     (gnus-group-unsubscribe-current-group "gnus/toggle-subscription")
1060     (gnus-group-prev-unread-group "left-arrow")
1061     (gnus-group-next-unread-group "right-arrow")
1062     (gnus-group-exit "exit")
1063     (gmm-customize-mode "preferences" t :help "Edit mode preferences")
1064     (gnus-info-find-node "help"))
1065   "List of functions for the group tool bar (GNOME style).
1066
1067 See `gmm-tool-bar-from-list' for the format of the list."
1068   :type '(repeat gmm-tool-bar-item)
1069   :version "23.0" ;; No Gnus
1070   :initialize 'custom-initialize-default
1071   :set 'gnus-group-tool-bar-update
1072   :group 'gnus-group)
1073
1074 (defcustom gnus-group-tool-bar-retro
1075   '((gnus-group-get-new-news "gnus/get-news")
1076     (gnus-group-get-new-news-this-group "gnus/gnntg")
1077     (gnus-group-catchup-current "gnus/catchup")
1078     (gnus-group-describe-group "gnus/describe-group")
1079     (gnus-group-subscribe "gnus/subscribe" t
1080                           :help "Subscribe to the current group")
1081     (gnus-group-unsubscribe "gnus/unsubscribe" t
1082                             :help "Unsubscribe from the current group")
1083     (gnus-group-exit "gnus/exit-gnus" gnus-group-mode-map))
1084   "List of functions for the group tool bar (retro look).
1085
1086 See `gmm-tool-bar-from-list' for the format of the list."
1087   :type '(repeat gmm-tool-bar-item)
1088   :version "23.0" ;; No Gnus
1089   :initialize 'custom-initialize-default
1090   :set 'gnus-group-tool-bar-update
1091   :group 'gnus-group)
1092
1093 ;; FIXME: Moving through the Group buffer (in topic mode) e.g. with C-n
1094 ;; doesn't update the state (enabled/disabled) of the icon
1095 ;; `gnus-group-describe-group'.  After `C-l' the state is correct.
1096 ;; See the following report on emacs-devel
1097 ;; <http://thread.gmane.org/v9acdmrcse.fsf@marauder.physik.uni-ulm.de>:
1098 ;; From: Reiner Steib
1099 ;; Subject: tool bar icons not updated according to :active condition
1100 ;; Newsgroups: gmane.emacs.devel
1101 ;; Date: Mon, 23 Jan 2006 19:59:13 +0100
1102 ;; Message-ID: <v9acdmrcse.fsf@marauder.physik.uni-ulm.de>
1103
1104 (defcustom gnus-group-tool-bar-zap-list t
1105   "List of icon items from the global tool bar.
1106 These items are not displayed in the Gnus group mode tool bar.
1107
1108 See `gmm-tool-bar-from-list' for the format of the list."
1109   :type 'gmm-tool-bar-zap-list
1110   :version "23.0" ;; No Gnus
1111   :initialize 'custom-initialize-default
1112   :set 'gnus-group-tool-bar-update
1113   :group 'gnus-group)
1114
1115 (defvar image-load-path)
1116
1117 (defun gnus-group-make-tool-bar (&optional force)
1118   "Make a group mode tool bar from `gnus-group-tool-bar'.
1119 When FORCE, rebuild the tool bar."
1120   (when (and (not (featurep 'xemacs))
1121              (boundp 'tool-bar-mode)
1122              tool-bar-mode
1123              ;; The Gnus 5.10.6 code checked (default-value 'tool-bar-mode).
1124              ;; Why?  --rsteib
1125              (or (not gnus-group-tool-bar-map) force))
1126     (let* ((load-path
1127             (gmm-image-load-path-for-library "gnus"
1128                                              "gnus/toggle-subscription.xpm"
1129                                              nil t))
1130            (image-load-path (cons (car load-path)
1131                                   (when (boundp 'image-load-path)
1132                                     image-load-path)))
1133            (map (gmm-tool-bar-from-list gnus-group-tool-bar
1134                                         gnus-group-tool-bar-zap-list
1135                                         'gnus-group-mode-map)))
1136       (if map
1137           (set (make-local-variable 'tool-bar-map) map))))
1138   gnus-group-tool-bar-map)
1139
1140 (defun gnus-group-mode ()
1141   "Major mode for reading news.
1142
1143 All normal editing commands are switched off.
1144 \\<gnus-group-mode-map>
1145 The group buffer lists (some of) the groups available.  For instance,
1146 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
1147 lists all zombie groups.
1148
1149 Groups that are displayed can be entered with `\\[gnus-group-read-group]'.  To subscribe
1150 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
1151
1152 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
1153
1154 The following commands are available:
1155
1156 \\{gnus-group-mode-map}"
1157   (interactive)
1158   (kill-all-local-variables)
1159   (when (gnus-visual-p 'group-menu 'menu)
1160     (gnus-group-make-menu-bar)
1161     (gnus-group-make-tool-bar))
1162   (gnus-simplify-mode-line)
1163   (setq major-mode 'gnus-group-mode)
1164   (setq mode-name "Group")
1165   (gnus-group-set-mode-line)
1166   (setq mode-line-process nil)
1167   (use-local-map gnus-group-mode-map)
1168   (buffer-disable-undo)
1169   (setq truncate-lines t)
1170   (setq buffer-read-only t
1171         show-trailing-whitespace nil)
1172   (gnus-set-default-directory)
1173   (gnus-update-format-specifications nil 'group 'group-mode)
1174   (gnus-update-group-mark-positions)
1175   (when gnus-use-undo
1176     (gnus-undo-mode 1))
1177   (when gnus-slave
1178     (gnus-slave-mode))
1179   (gnus-run-mode-hooks 'gnus-group-mode-hook))
1180
1181 (defun gnus-update-group-mark-positions ()
1182   (save-excursion
1183     (let ((gnus-process-mark ?\200)
1184           (gnus-group-update-hook nil)
1185           (gnus-group-marked '("dummy.group"))
1186           (gnus-active-hashtb (make-vector 10 0))
1187           (topic ""))
1188       (gnus-set-active "dummy.group" '(0 . 0))
1189       (gnus-set-work-buffer)
1190       (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
1191       (goto-char (point-min))
1192       (setq gnus-group-mark-positions
1193             (list (cons 'process (and (search-forward
1194                                        (mm-string-as-multibyte "\200") nil t)
1195                                       (- (point) 2))))))))
1196
1197 (defun gnus-mouse-pick-group (e)
1198   "Enter the group under the mouse pointer."
1199   (interactive "e")
1200   (mouse-set-point e)
1201   (gnus-group-read-group nil))
1202
1203 ;; Look at LEVEL and find out what the level is really supposed to be.
1204 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
1205 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
1206 (defun gnus-group-default-level (&optional level number-or-nil)
1207   (cond
1208    (gnus-group-use-permanent-levels
1209     (or (setq gnus-group-use-permanent-levels
1210               (or level (if (numberp gnus-group-use-permanent-levels)
1211                             gnus-group-use-permanent-levels
1212                           (or gnus-group-default-list-level
1213                               gnus-level-subscribed))))
1214         gnus-group-default-list-level gnus-level-subscribed))
1215    (number-or-nil
1216     level)
1217    (t
1218     (or level gnus-group-default-list-level gnus-level-subscribed))))
1219
1220 (defun gnus-group-setup-buffer ()
1221   (set-buffer (gnus-get-buffer-create gnus-group-buffer))
1222   (unless (eq major-mode 'gnus-group-mode)
1223     (gnus-group-mode)
1224     (when gnus-carpal
1225       (gnus-carpal-setup-buffer 'group))))
1226
1227 (defun gnus-group-name-charset (method group)
1228   (if (null method)
1229       (setq method (gnus-find-method-for-group group)))
1230   (let ((item (assoc method gnus-group-name-charset-method-alist))
1231         (alist gnus-group-name-charset-group-alist)
1232         result)
1233     (if item
1234         (cdr item)
1235       (while (setq item (pop alist))
1236         (if (string-match (car item) group)
1237             (setq alist nil
1238                   result (cdr item))))
1239       result)))
1240
1241 (defun gnus-group-name-decode (string charset)
1242   ;; Fixme: Don't decode in unibyte mode.
1243   (if (and string charset (featurep 'mule))
1244       (mm-decode-coding-string string charset)
1245     string))
1246
1247 (defun gnus-group-decoded-name (string)
1248   (let ((charset (gnus-group-name-charset nil string)))
1249     (gnus-group-name-decode string charset)))
1250
1251 (defun gnus-group-list-groups (&optional level unread lowest)
1252   "List newsgroups with level LEVEL or lower that have unread articles.
1253 Default is all subscribed groups.
1254 If argument UNREAD is non-nil, groups with no unread articles are also
1255 listed.
1256
1257 Also see the `gnus-group-use-permanent-levels' variable."
1258   (interactive
1259    (list (if current-prefix-arg
1260              (prefix-numeric-value current-prefix-arg)
1261            (or
1262             (gnus-group-default-level nil t)
1263             gnus-group-default-list-level
1264             gnus-level-subscribed))))
1265   (unless level
1266     (setq level (car gnus-group-list-mode)
1267           unread (cdr gnus-group-list-mode)))
1268   (setq level (gnus-group-default-level level))
1269   (gnus-group-setup-buffer)
1270   (gnus-update-format-specifications nil 'group 'group-mode)
1271   (let ((case-fold-search nil)
1272         (props (text-properties-at (point-at-bol)))
1273         (empty (= (point-min) (point-max)))
1274         (group (gnus-group-group-name))
1275         number)
1276     (set-buffer gnus-group-buffer)
1277     (setq number (funcall gnus-group-prepare-function level unread lowest))
1278     (when (or (and (numberp number)
1279                    (zerop number))
1280               (zerop (buffer-size)))
1281       ;; No groups in the buffer.
1282       (gnus-message 5 gnus-no-groups-message))
1283     ;; We have some groups displayed.
1284     (goto-char (point-max))
1285     (when (or (not gnus-group-goto-next-group-function)
1286               (not (funcall gnus-group-goto-next-group-function
1287                             group props)))
1288       (cond
1289        (empty
1290         (goto-char (point-min)))
1291        ((not group)
1292         ;; Go to the first group with unread articles.
1293         (gnus-group-search-forward t))
1294        (t
1295         ;; Find the right group to put point on.  If the current group
1296         ;; has disappeared in the new listing, try to find the next
1297         ;; one.  If no next one can be found, just leave point at the
1298         ;; first newsgroup in the buffer.
1299         (when (not (gnus-goto-char
1300                     (text-property-any
1301                      (point-min) (point-max)
1302                      'gnus-group (gnus-intern-safe
1303                                   group gnus-active-hashtb))))
1304           (let ((newsrc (cdddr (gnus-group-entry group))))
1305             (while (and newsrc
1306                         (not (gnus-goto-char
1307                               (text-property-any
1308                                (point-min) (point-max) 'gnus-group
1309                                (gnus-intern-safe
1310                                 (caar newsrc) gnus-active-hashtb)))))
1311               (setq newsrc (cdr newsrc)))
1312             (unless newsrc
1313               (goto-char (point-max))
1314               (forward-line -1)))))))
1315     ;; Adjust cursor point.
1316     (gnus-group-position-point)))
1317
1318 (defun gnus-group-list-level (level &optional all)
1319   "List groups on LEVEL.
1320 If ALL (the prefix), also list groups that have no unread articles."
1321   (interactive "nList groups on level: \nP")
1322   (gnus-group-list-groups level all level))
1323
1324 (defun gnus-group-prepare-logic (group test)
1325   (or (and gnus-group-listed-groups
1326            (null gnus-group-list-option)
1327            (member group gnus-group-listed-groups))
1328       (cond
1329        ((null gnus-group-listed-groups) test)
1330        ((null gnus-group-list-option) test)
1331        (t (and (member group gnus-group-listed-groups)
1332                (if (eq gnus-group-list-option 'flush)
1333                    (not test)
1334                  test))))))
1335
1336 (defun gnus-group-prepare-flat (level &optional predicate lowest regexp)
1337   "List all newsgroups with unread articles of level LEVEL or lower.
1338 If PREDICATE is a function, list groups that the function returns non-nil;
1339 if it is t, list groups that have no unread articles.
1340 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
1341 If REGEXP is a function, list dead groups that the function returns non-nil;
1342 if it is a string, only list groups matching REGEXP."
1343   (set-buffer gnus-group-buffer)
1344   (let ((buffer-read-only nil)
1345         (newsrc (cdr gnus-newsrc-alist))
1346         (lowest (or lowest 1))
1347         (not-in-list (and gnus-group-listed-groups
1348                           (copy-sequence gnus-group-listed-groups)))
1349         info clevel unread group params)
1350     (erase-buffer)
1351     (when (or (< lowest gnus-level-zombie)
1352               gnus-group-listed-groups)
1353       ;; List living groups.
1354       (while newsrc
1355         (setq info (car newsrc)
1356               group (gnus-info-group info)
1357               params (gnus-info-params info)
1358               newsrc (cdr newsrc)
1359               unread (gnus-group-unread group))
1360         (when not-in-list
1361           (setq not-in-list (delete group not-in-list)))
1362         (when (gnus-group-prepare-logic
1363                group
1364                (and unread              ; This group might be unchecked
1365                     (or (not (stringp regexp))
1366                         (string-match regexp group))
1367                     (<= (setq clevel (gnus-info-level info)) level)
1368                     (>= clevel lowest)
1369                     (cond
1370                      ((functionp predicate)
1371                       (funcall predicate info))
1372                      (predicate t)      ; We list all groups?
1373                      (t
1374                       (or
1375                        (if (eq unread t) ; Unactivated?
1376                            gnus-group-list-inactive-groups
1377                                         ; We list unactivated
1378                          (> unread 0))
1379                                         ; We list groups with unread articles
1380                        (and gnus-list-groups-with-ticked-articles
1381                             (cdr (assq 'tick (gnus-info-marks info))))
1382                                         ; And groups with tickeds
1383                        ;; Check for permanent visibility.
1384                        (and gnus-permanently-visible-groups
1385                             (string-match gnus-permanently-visible-groups
1386                                           group))
1387                        (memq 'visible params)
1388                        (cdr (assq 'visible params)))))))
1389           (gnus-group-insert-group-line
1390            group (gnus-info-level info)
1391            (gnus-info-marks info) unread (gnus-info-method info)))))
1392
1393     ;; List dead groups.
1394     (when (or gnus-group-listed-groups
1395               (and (>= level gnus-level-zombie)
1396                    (<= lowest gnus-level-zombie)))
1397       (gnus-group-prepare-flat-list-dead
1398        (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
1399        gnus-level-zombie ?Z
1400        regexp))
1401     (when not-in-list
1402       (dolist (group gnus-zombie-list)
1403         (setq not-in-list (delete group not-in-list))))
1404     (when (or gnus-group-listed-groups
1405               (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)))
1406       (gnus-group-prepare-flat-list-dead
1407        (gnus-union
1408         not-in-list
1409         (setq gnus-killed-list (sort gnus-killed-list 'string<)))
1410        gnus-level-killed ?K regexp))
1411
1412     (gnus-group-set-mode-line)
1413     (setq gnus-group-list-mode (cons level predicate))
1414     (gnus-run-hooks 'gnus-group-prepare-hook)
1415     t))
1416
1417 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
1418   ;; List zombies and killed lists somewhat faster, which was
1419   ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.  It does
1420   ;; this by ignoring the group format specification altogether.
1421   (let (group)
1422     (if (> (length groups) gnus-group-listing-limit)
1423         (while groups
1424           (setq group (pop groups))
1425           (when (gnus-group-prepare-logic
1426                  group
1427                  (or (not regexp)
1428                      (and (stringp regexp) (string-match regexp group))
1429                      (and (functionp regexp) (funcall regexp group))))
1430             (gnus-add-text-properties
1431              (point) (prog1 (1+ (point))
1432                        (insert " " mark "     *: "
1433                                (gnus-group-decoded-name group)
1434                                "\n"))
1435              (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1436                    'gnus-unread t
1437                    'gnus-level level))))
1438       (while groups
1439         (setq group (pop groups))
1440         (when (gnus-group-prepare-logic
1441                group
1442                (or (not regexp)
1443                    (and (stringp regexp) (string-match regexp group))
1444                    (and (functionp regexp) (funcall regexp group))))
1445           (gnus-group-insert-group-line
1446            group level nil
1447            (let ((active (gnus-active group)))
1448              (if active
1449                  (if (zerop (cdr active))
1450                      0
1451                    (- (1+ (cdr active)) (car active)))
1452                nil))
1453            (gnus-method-simplify (gnus-find-method-for-group group))))))))
1454
1455 (defun gnus-group-update-group-line ()
1456   "Update the current line in the group buffer."
1457   (let* ((buffer-read-only nil)
1458          (group (gnus-group-group-name))
1459          (entry (and group (gnus-group-entry group)))
1460          gnus-group-indentation)
1461     (when group
1462       (and entry
1463            (not (gnus-ephemeral-group-p group))
1464            (gnus-dribble-enter
1465             (concat "(gnus-group-set-info '"
1466                     (gnus-prin1-to-string (nth 2 entry))
1467                     ")")))
1468       (setq gnus-group-indentation (gnus-group-group-indentation))
1469       (gnus-delete-line)
1470       (gnus-group-insert-group-line-info group)
1471       (forward-line -1)
1472       (gnus-group-position-point))))
1473
1474 (defun gnus-group-insert-group-line-info (group)
1475   "Insert GROUP on the current line."
1476   (let ((entry (gnus-group-entry group))
1477         (gnus-group-indentation (gnus-group-group-indentation))
1478         active info)
1479     (if entry
1480         (progn
1481           ;; (Un)subscribed group.
1482           (setq info (nth 2 entry))
1483           (gnus-group-insert-group-line
1484            group (gnus-info-level info) (gnus-info-marks info)
1485            (or (car entry) t) (gnus-info-method info)))
1486       ;; This group is dead.
1487       (gnus-group-insert-group-line
1488        group
1489        (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1490        nil
1491        (if (setq active (gnus-active group))
1492            (if (zerop (cdr active))
1493                0
1494              (- (1+ (cdr active)) (car active)))
1495          nil)
1496        (gnus-method-simplify (gnus-find-method-for-group group))))))
1497
1498 (defun gnus-number-of-unseen-articles-in-group (group)
1499   (let* ((info (nth 2 (gnus-group-entry group)))
1500          (marked (gnus-info-marks info))
1501          (seen (cdr (assq 'seen marked)))
1502          (active (gnus-active group)))
1503     (if (not active)
1504         0
1505       (length (gnus-uncompress-range
1506                (gnus-range-difference
1507                 (gnus-range-difference (list active) (gnus-info-read info))
1508                 seen))))))
1509
1510 (defcustom gnus-group-update-tool-bar
1511   (and (not (featurep 'xemacs))
1512        (boundp 'tool-bar-mode)
1513        tool-bar-mode
1514        ;; Using `redraw-frame' (see `gnus-tool-bar-update') in Emacs 21 might
1515        ;; be confusing, so maybe we shouldn't call it by default.
1516        (fboundp 'force-window-update))
1517   "Force updating the group buffer tool bar."
1518   :group 'gnus-group
1519   :version "22.1"
1520   :initialize 'custom-initialize-default
1521   :set (lambda (symbol value)
1522          (set-default symbol value)
1523          (when (gnus-alive-p)
1524            (with-current-buffer gnus-group-buffer
1525              ;; FIXME: Is there a better way to redraw the group buffer?
1526              (gnus-group-get-new-news 0))))
1527   :type 'boolean)
1528
1529 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1530                                                     gnus-tmp-marked number
1531                                                     gnus-tmp-method)
1532   "Insert a group line in the group buffer."
1533   (let* ((gnus-tmp-method
1534           (gnus-server-get-method gnus-tmp-group gnus-tmp-method))
1535          (group-name-charset (gnus-group-name-charset gnus-tmp-method
1536                                                       gnus-tmp-group))
1537          (gnus-tmp-active (gnus-active gnus-tmp-group))
1538          (gnus-tmp-number-total
1539           (if gnus-tmp-active
1540               (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1541             0))
1542          (gnus-tmp-number-of-unread
1543           (if (numberp number) (int-to-string (max 0 number))
1544             "*"))
1545          (gnus-tmp-number-of-read
1546           (if (numberp number)
1547               (int-to-string (max 0 (- gnus-tmp-number-total number)))
1548             "*"))
1549          (gnus-tmp-subscribed
1550           (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1551                 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1552                 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1553                 (t ?K)))
1554          (gnus-tmp-qualified-group
1555           (gnus-group-name-decode (gnus-group-real-name gnus-tmp-group)
1556                                   group-name-charset))
1557          (gnus-tmp-comment
1558           (or (gnus-group-get-parameter gnus-tmp-group 'comment t)
1559               gnus-tmp-group))
1560          (gnus-tmp-newsgroup-description
1561           (if gnus-description-hashtb
1562               (or (gnus-group-name-decode
1563                    (gnus-gethash gnus-tmp-group gnus-description-hashtb)
1564                    group-name-charset) "")
1565             ""))
1566          (gnus-tmp-moderated
1567           (if (and gnus-moderated-hashtb
1568                    (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1569               ?m ? ))
1570          (gnus-tmp-moderated-string
1571           (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1572          (gnus-tmp-group-icon "==&&==")
1573          (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1574          (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1575          (gnus-tmp-news-method-string
1576           (if gnus-tmp-method
1577               (format "(%s:%s)" (car gnus-tmp-method)
1578                       (cadr gnus-tmp-method)) ""))
1579          (gnus-tmp-marked-mark
1580           (if (and (numberp number)
1581                    (zerop number)
1582                    (cdr (assq 'tick gnus-tmp-marked)))
1583               ?* ? ))
1584          (gnus-tmp-summary-live
1585           (if (and (not gnus-group-is-exiting-p)
1586                    (gnus-buffer-live-p (gnus-summary-buffer-name
1587                                         gnus-tmp-group)))
1588               ?* ? ))
1589          (gnus-tmp-process-marked
1590           (if (member gnus-tmp-group gnus-group-marked)
1591               gnus-process-mark ? ))
1592          (buffer-read-only nil)
1593          beg end
1594          header gnus-tmp-header)        ; passed as parameter to user-funcs.
1595     (beginning-of-line)
1596     (setq beg (point))
1597     (gnus-add-text-properties
1598      (point)
1599      (prog1 (1+ (point))
1600        ;; Insert the text.
1601        (let ((gnus-tmp-decoded-group (gnus-group-name-decode
1602                                       gnus-tmp-group group-name-charset)))
1603          (eval gnus-group-line-format-spec)))
1604      `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1605                   gnus-unread ,(if (numberp number)
1606                                    (string-to-number gnus-tmp-number-of-unread)
1607                                  t)
1608                   gnus-marked ,gnus-tmp-marked-mark
1609                   gnus-indentation ,gnus-group-indentation
1610                   gnus-level ,gnus-tmp-level))
1611     (setq end (point))
1612     (when gnus-group-update-tool-bar
1613       (gnus-put-text-property beg end 'point-entered
1614                               'gnus-tool-bar-update)
1615       (gnus-put-text-property beg end 'point-left
1616                               'gnus-tool-bar-update))
1617     (forward-line -1)
1618     (when (inline (gnus-visual-p 'group-highlight 'highlight))
1619       (gnus-run-hooks 'gnus-group-update-hook))
1620     (forward-line)
1621     ;; Allow XEmacs to remove front-sticky text properties.
1622     (gnus-group-remove-excess-properties)))
1623
1624 (defun gnus-group-highlight-line ()
1625   "Highlight the current line according to `gnus-group-highlight'."
1626   (let* ((list gnus-group-highlight)
1627          (p (point))
1628          (end (point-at-eol))
1629          ;; now find out where the line starts and leave point there.
1630          (beg (progn (beginning-of-line) (point)))
1631          (group (gnus-group-group-name))
1632          (entry (gnus-group-entry group))
1633          (unread (if (numberp (car entry)) (car entry) 0))
1634          (active (gnus-active group))
1635          (total (if active (1+ (- (cdr active) (car active))) 0))
1636          (info (nth 2 entry))
1637          (method (inline (gnus-server-get-method group (gnus-info-method info))))
1638          (marked (gnus-info-marks info))
1639          (mailp (apply 'append
1640                        (mapcar
1641                         (lambda (x)
1642                           (memq x (assoc (symbol-name
1643                                           (car (or method gnus-select-method)))
1644                                          gnus-valid-select-methods)))
1645                         '(mail post-mail))))
1646          (level (or (gnus-info-level info) gnus-level-killed))
1647          (score (or (gnus-info-score info) 0))
1648          (ticked (gnus-range-length (cdr (assq 'tick marked))))
1649          (group-age (gnus-group-timestamp-delta group))
1650          (inhibit-read-only t))
1651     ;; Eval the cars of the lists until we find a match.
1652     (while (and list
1653                 (not (eval (caar list))))
1654       (setq list (cdr list)))
1655     (let ((face (cdar list)))
1656       (unless (eq face (get-text-property beg 'face))
1657         (gnus-put-text-property-excluding-characters-with-faces
1658          beg end 'face
1659          (setq face (if (boundp face) (symbol-value face) face)))
1660         (gnus-extent-start-open beg)))
1661     (goto-char p)))
1662
1663 (defun gnus-group-update-group (group &optional visible-only)
1664   "Update all lines where GROUP appear.
1665 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1666 already."
1667   ;; Can't use `save-excursion' here, so we do it manually.
1668   (let ((buf (current-buffer))
1669         mark)
1670     (set-buffer gnus-group-buffer)
1671     (setq mark (point-marker))
1672     ;; The buffer may be narrowed.
1673     (save-restriction
1674       (widen)
1675       (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1676             (loc (point-min))
1677             found buffer-read-only)
1678         ;; Enter the current status into the dribble buffer.
1679         (let ((entry (gnus-group-entry group)))
1680           (when (and entry
1681                      (not (gnus-ephemeral-group-p group)))
1682             (gnus-dribble-enter
1683              (concat "(gnus-group-set-info '"
1684                      (gnus-prin1-to-string (nth 2 entry))
1685                      ")"))))
1686         ;; Find all group instances.  If topics are in use, each group
1687         ;; may be listed in more than once.
1688         (while (setq loc (text-property-any
1689                           loc (point-max) 'gnus-group ident))
1690           (setq found t)
1691           (goto-char loc)
1692           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1693             (gnus-delete-line)
1694             (gnus-group-insert-group-line-info group)
1695             (save-excursion
1696               (forward-line -1)
1697               (gnus-run-hooks 'gnus-group-update-group-hook)))
1698           (setq loc (1+ loc)))
1699         (unless (or found visible-only)
1700           ;; No such line in the buffer, find out where it's supposed to
1701           ;; go, and insert it there (or at the end of the buffer).
1702           (if gnus-goto-missing-group-function
1703               (funcall gnus-goto-missing-group-function group)
1704             (let ((entry (cddr (gnus-group-entry group))))
1705               (while (and entry (car entry)
1706                           (not
1707                            (gnus-goto-char
1708                             (text-property-any
1709                              (point-min) (point-max)
1710                              'gnus-group (gnus-intern-safe
1711                                           (caar entry) gnus-active-hashtb)))))
1712                 (setq entry (cdr entry)))
1713               (or entry (goto-char (point-max)))))
1714           ;; Finally insert the line.
1715           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1716             (gnus-group-insert-group-line-info group)
1717             (save-excursion
1718               (forward-line -1)
1719               (gnus-run-hooks 'gnus-group-update-group-hook))))
1720         (when gnus-group-update-group-function
1721           (funcall gnus-group-update-group-function group))
1722         (gnus-group-set-mode-line)))
1723     (goto-char mark)
1724     (set-marker mark nil)
1725     (set-buffer buf)))
1726
1727 (defun gnus-group-set-mode-line ()
1728   "Update the mode line in the group buffer."
1729   (when (memq 'group gnus-updated-mode-lines)
1730     ;; Yes, we want to keep this mode line updated.
1731     (save-excursion
1732       (set-buffer gnus-group-buffer)
1733       (let* ((gformat (or gnus-group-mode-line-format-spec
1734                           (gnus-set-format 'group-mode)))
1735              (gnus-tmp-news-server (cadr gnus-select-method))
1736              (gnus-tmp-news-method (car gnus-select-method))
1737              (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1738              (max-len 60)
1739              gnus-tmp-header            ;Dummy binding for user-defined formats
1740              ;; Get the resulting string.
1741              (modified
1742               (and gnus-dribble-buffer
1743                    (buffer-name gnus-dribble-buffer)
1744                    (buffer-modified-p gnus-dribble-buffer)
1745                    (save-excursion
1746                      (set-buffer gnus-dribble-buffer)
1747                      (not (zerop (buffer-size))))))
1748              (mode-string (eval gformat)))
1749         ;; Say whether the dribble buffer has been modified.
1750         (setq mode-line-modified
1751               (if modified (car gnus-mode-line-modified)
1752                 (cdr gnus-mode-line-modified)))
1753         ;; If the line is too long, we chop it off.
1754         (when (> (length mode-string) max-len)
1755           (setq mode-string (substring mode-string 0 (- max-len 4))))
1756         (prog1
1757             (setq mode-line-buffer-identification
1758                   (gnus-mode-line-buffer-identification
1759                    (list mode-string)))
1760           (set-buffer-modified-p modified))))))
1761
1762 (defun gnus-group-group-name ()
1763   "Get the name of the newsgroup on the current line."
1764   (let ((group (get-text-property (point-at-bol) 'gnus-group)))
1765     (when group
1766       (symbol-name group))))
1767
1768 (defun gnus-group-group-level ()
1769   "Get the level of the newsgroup on the current line."
1770   (get-text-property (point-at-bol) 'gnus-level))
1771
1772 (defun gnus-group-group-indentation ()
1773   "Get the indentation of the newsgroup on the current line."
1774   (or (get-text-property (point-at-bol) 'gnus-indentation)
1775       (and gnus-group-indentation-function
1776            (funcall gnus-group-indentation-function))
1777       ""))
1778
1779 (defun gnus-group-group-unread ()
1780   "Get the number of unread articles of the newsgroup on the current line."
1781   (get-text-property (point-at-bol) 'gnus-unread))
1782
1783 (defun gnus-group-new-mail (group)
1784   (if (nnmail-new-mail-p (gnus-group-real-name group))
1785       gnus-new-mail-mark
1786     ? ))
1787
1788 (defun gnus-group-level (group)
1789   "Return the estimated level of GROUP."
1790   (or (gnus-info-level (gnus-get-info group))
1791       (and (member group gnus-zombie-list) gnus-level-zombie)
1792       gnus-level-killed))
1793
1794 (defun gnus-group-search-forward (&optional backward all level first-too)
1795   "Find the next newsgroup with unread articles.
1796 If BACKWARD is non-nil, find the previous newsgroup instead.
1797 If ALL is non-nil, just find any newsgroup.
1798 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1799 group exists.
1800 If FIRST-TOO, the current line is also eligible as a target."
1801   (let ((way (if backward -1 1))
1802         (low gnus-level-killed)
1803         (beg (point))
1804         pos found lev)
1805     (if (and backward (progn (beginning-of-line)) (bobp))
1806         nil
1807       (unless first-too
1808         (forward-line way))
1809       (while (and
1810               (not (eobp))
1811               (not (setq
1812                     found
1813                     (and
1814                      (get-text-property (point) 'gnus-group)
1815                      (or all
1816                          (and
1817                           (let ((unread
1818                                  (get-text-property (point) 'gnus-unread)))
1819                             (and (numberp unread) (> unread 0)))
1820                           (setq lev (get-text-property (point)
1821                                                        'gnus-level))
1822                           (<= lev gnus-level-subscribed)))
1823                      (or (not level)
1824                          (and (setq lev (get-text-property (point)
1825                                                            'gnus-level))
1826                               (or (= lev level)
1827                                   (and (< lev low)
1828                                        (< level lev)
1829                                        (progn
1830                                          (setq low lev)
1831                                          (setq pos (point))
1832                                          nil))))))))
1833               (zerop (forward-line way)))))
1834     (if found
1835         (progn (gnus-group-position-point) t)
1836       (goto-char (or pos beg))
1837       (and pos t))))
1838
1839 (defun gnus-total-fetched-for (group)
1840   (let* ((size-in-cache (or (gnus-cache-total-fetched-for group) 0))
1841          (size-in-agent (or (gnus-agent-total-fetched-for group) 0))
1842          (size (+ size-in-cache size-in-agent))
1843          (suffix '("B" "K" "M" "G"))
1844          (scale 1024.0)
1845          (cutoff scale))
1846     (while (> size cutoff)
1847       (setq size (/ size scale)
1848             suffix (cdr suffix)))
1849     (format "%5.1f%s" size (car suffix))))
1850
1851 ;;; Gnus group mode commands
1852
1853 ;; Group marking.
1854
1855 (defun gnus-group-mark-line-p ()
1856   (save-excursion
1857     (beginning-of-line)
1858     (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1859     (eq (char-after) gnus-process-mark)))
1860
1861 (defun gnus-group-mark-group (n &optional unmark no-advance)
1862   "Mark the current group."
1863   (interactive "p")
1864   (let ((buffer-read-only nil)
1865         group)
1866     (while (and (> n 0)
1867                 (not (eobp)))
1868       (when (setq group (gnus-group-group-name))
1869         ;; Go to the mark position.
1870         (beginning-of-line)
1871         (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1872         (delete-char 1)
1873         (if unmark
1874             (progn
1875               (setq gnus-group-marked (delete group gnus-group-marked))
1876               (insert-char ? 1 t))
1877            (setq gnus-group-marked
1878                  (cons group (delete group gnus-group-marked)))
1879            (insert-char gnus-process-mark 1 t)))
1880       (unless no-advance
1881         (gnus-group-next-group 1))
1882       (decf n))
1883     (gnus-summary-position-point)
1884     n))
1885
1886 (defun gnus-group-unmark-group (n)
1887   "Remove the mark from the current group."
1888   (interactive "p")
1889   (gnus-group-mark-group n 'unmark)
1890   (gnus-group-position-point))
1891
1892 (defun gnus-group-unmark-all-groups ()
1893   "Unmark all groups."
1894   (interactive)
1895   (save-excursion
1896     (mapc 'gnus-group-remove-mark gnus-group-marked))
1897   (gnus-group-position-point))
1898
1899 (defun gnus-group-mark-region (unmark beg end)
1900   "Mark all groups between point and mark.
1901 If UNMARK, remove the mark instead."
1902   (interactive "P\nr")
1903   (let ((num (count-lines beg end)))
1904     (save-excursion
1905       (goto-char beg)
1906       (- num (gnus-group-mark-group num unmark)))))
1907
1908 (defun gnus-group-mark-buffer (&optional unmark)
1909   "Mark all groups in the buffer.
1910 If UNMARK, remove the mark instead."
1911   (interactive "P")
1912   (gnus-group-mark-region unmark (point-min) (point-max)))
1913
1914 (defun gnus-group-mark-regexp (regexp)
1915   "Mark all groups that match some regexp."
1916   (interactive "sMark (regexp): ")
1917   (let ((alist (cdr gnus-newsrc-alist))
1918         group)
1919     (save-excursion
1920       (while alist
1921         (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1922           (gnus-group-jump-to-group group)
1923           (gnus-group-set-mark group)))))
1924   (gnus-group-position-point))
1925
1926 (defun gnus-group-remove-mark (group &optional test-marked)
1927   "Remove the process mark from GROUP and move point there.
1928 Return nil if the group isn't displayed."
1929   (if (gnus-group-goto-group group nil test-marked)
1930       (save-excursion
1931         (gnus-group-mark-group 1 'unmark t)
1932         t)
1933     (setq gnus-group-marked
1934           (delete group gnus-group-marked))
1935     nil))
1936
1937 (defun gnus-group-set-mark (group)
1938   "Set the process mark on GROUP."
1939   (if (gnus-group-goto-group group)
1940       (save-excursion
1941         (gnus-group-mark-group 1 nil t))
1942     (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1943
1944 (defun gnus-group-universal-argument (arg &optional groups func)
1945   "Perform any command on all groups according to the process/prefix convention."
1946   (interactive "P")
1947   (if (eq (setq func (or func
1948                          (key-binding
1949                           (read-key-sequence
1950                            (substitute-command-keys
1951                             "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1952           'undefined)
1953       (gnus-error 1 "Undefined key")
1954     (gnus-group-iterate arg
1955       (lambda (group)
1956         (command-execute func))))
1957   (gnus-group-position-point))
1958
1959 (defun gnus-group-process-prefix (n)
1960   "Return a list of groups to work on.
1961 Take into consideration N (the prefix) and the list of marked groups."
1962   (cond
1963    (n
1964     (setq n (prefix-numeric-value n))
1965     ;; There is a prefix, so we return a list of the N next
1966     ;; groups.
1967     (let ((way (if (< n 0) -1 1))
1968           (n (abs n))
1969           group groups)
1970       (save-excursion
1971         (while (> n 0)
1972           (if (setq group (gnus-group-group-name))
1973               (push group groups))
1974           (setq n (1- n))
1975           (gnus-group-next-group way)))
1976       (nreverse groups)))
1977    ((and (gnus-region-active-p) (mark))
1978     ;; Work on the region between point and mark.
1979     (let ((max (max (point) (mark)))
1980           groups)
1981       (save-excursion
1982         (goto-char (min (point) (mark)))
1983         (while
1984             (and
1985              (push (gnus-group-group-name) groups)
1986              (zerop (gnus-group-next-group 1))
1987              (< (point) max)))
1988         (nreverse groups))))
1989    (gnus-group-marked
1990     ;; No prefix, but a list of marked articles.
1991     (reverse gnus-group-marked))
1992    (t
1993     ;; Neither marked articles or a prefix, so we return the
1994     ;; current group.
1995     (let ((group (gnus-group-group-name)))
1996       (and group (list group))))))
1997
1998 ;;; !!!Surely gnus-group-iterate should be a macro instead?  I can't
1999 ;;; imagine why I went through these contortions...
2000 (eval-and-compile
2001   (let ((function (make-symbol "gnus-group-iterate-function"))
2002         (window (make-symbol "gnus-group-iterate-window"))
2003         (groups (make-symbol "gnus-group-iterate-groups"))
2004         (group (make-symbol "gnus-group-iterate-group")))
2005     (eval
2006      `(defun gnus-group-iterate (arg ,function)
2007         "Iterate FUNCTION over all process/prefixed groups.
2008 FUNCTION will be called with the group name as the parameter
2009 and with point over the group in question."
2010         (let ((,groups (gnus-group-process-prefix arg))
2011               (,window (selected-window))
2012               ,group)
2013           (while ,groups
2014             (setq ,group (car ,groups)
2015                   ,groups (cdr ,groups))
2016             (select-window ,window)
2017             (gnus-group-remove-mark ,group)
2018             (save-selected-window
2019               (save-excursion
2020                 (funcall ,function ,group)))))))))
2021
2022 (put 'gnus-group-iterate 'lisp-indent-function 1)
2023
2024 ;; Selecting groups.
2025
2026 (defun gnus-group-read-group (&optional all no-article group select-articles)
2027   "Read news in this newsgroup.
2028 If the prefix argument ALL is non-nil, already read articles become
2029 readable.  IF ALL is a number, fetch this number of articles.  If the
2030 optional argument NO-ARTICLE is non-nil, no article will be
2031 auto-selected upon group entry.  If GROUP is non-nil, fetch that
2032 group."
2033   (interactive "P")
2034   (let ((no-display (eq all 0))
2035         (group (or group (gnus-group-group-name)))
2036         number active marked entry)
2037     (when (eq all 0)
2038       (setq all nil))
2039     (unless group
2040       (error "No group on current line"))
2041     (setq marked (gnus-info-marks
2042                   (nth 2 (setq entry (gnus-group-entry group)))))
2043     ;; This group might be a dead group.  In that case we have to get
2044     ;; the number of unread articles from `gnus-active-hashtb'.
2045     (setq number
2046           (cond ((numberp all) all)
2047                 (entry (car entry))
2048                 ((setq active (gnus-active group))
2049                  (- (1+ (cdr active)) (car active)))))
2050     (gnus-summary-read-group
2051      group (or all (and (numberp number)
2052                         (zerop (+ number (gnus-range-length
2053                                           (cdr (assq 'tick marked)))
2054                                   (gnus-range-length
2055                                    (cdr (assq 'dormant marked)))))))
2056      no-article nil no-display nil select-articles)))
2057
2058 (defun gnus-group-select-group (&optional all)
2059   "Select this newsgroup.
2060 No article is selected automatically.
2061 If the group is opened, just switch the summary buffer.
2062 If ALL is non-nil, already read articles become readable.
2063 If ALL is a positive number, fetch this number of the latest
2064 articles in the group.
2065 If ALL is a negative number, fetch this number of the earliest
2066 articles in the group."
2067   (interactive "P")
2068   (when (and (eobp) (not (gnus-group-group-name)))
2069     (forward-line -1))
2070   (gnus-group-read-group all t))
2071
2072 (defun gnus-group-quick-select-group (&optional all)
2073   "Select the current group \"quickly\".
2074 This means that no highlighting or scoring will be performed.
2075 If ALL (the prefix argument) is 0, don't even generate the summary
2076 buffer.
2077
2078 This might be useful if you want to toggle threading
2079 before entering the group."
2080   (interactive "P")
2081   (require 'gnus-score)
2082   (let (gnus-visual
2083         gnus-score-find-score-files-function
2084         gnus-home-score-file
2085         gnus-apply-kill-hook
2086         gnus-summary-expunge-below)
2087     (gnus-group-read-group all t)))
2088
2089 (defun gnus-group-visible-select-group (&optional all)
2090   "Select the current group without hiding any articles."
2091   (interactive "P")
2092   (let ((gnus-inhibit-limiting t))
2093     (gnus-group-read-group all t)))
2094
2095 (defun gnus-group-select-group-ephemerally ()
2096   "Select the current group without doing any processing whatsoever.
2097 You will actually be entered into a group that's a copy of
2098 the current group; no changes you make while in this group will
2099 be permanent."
2100   (interactive)
2101   (require 'gnus-score)
2102   (let* (gnus-visual
2103          gnus-score-find-score-files-function gnus-apply-kill-hook
2104          gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
2105          gnus-summary-mode-hook gnus-select-group-hook
2106          (group (gnus-group-group-name))
2107          (method (gnus-find-method-for-group group)))
2108     (gnus-group-read-ephemeral-group
2109      (gnus-group-prefixed-name group method) method)))
2110
2111 ;;;###autoload
2112 (defun gnus-fetch-group (group &optional articles)
2113   "Start Gnus if necessary and enter GROUP.
2114 Returns whether the fetching was successful or not."
2115   (interactive (list (completing-read "Group name: " gnus-active-hashtb)))
2116   (unless (get-buffer gnus-group-buffer)
2117     (gnus-no-server))
2118   (gnus-group-read-group articles nil group))
2119
2120 ;;;###autoload
2121 (defun gnus-fetch-group-other-frame (group)
2122   "Pop up a frame and enter GROUP."
2123   (interactive "P")
2124   (let ((window (get-buffer-window gnus-group-buffer)))
2125     (cond (window
2126            (select-frame (window-frame window)))
2127           ((= (length (frame-list)) 1)
2128            (select-frame (make-frame)))
2129           (t
2130            (other-frame 1))))
2131   (gnus-fetch-group group))
2132
2133 (defvar gnus-ephemeral-group-server 0)
2134
2135 (defcustom gnus-large-ephemeral-newsgroup 200
2136   "The number of articles which indicates a large ephemeral newsgroup.
2137 Same as `gnus-large-newsgroup', but only used for ephemeral newsgroups.
2138
2139 If the number of articles in a newsgroup is greater than this value,
2140 confirmation is required for selecting the newsgroup.  If it is nil, no
2141 confirmation is required."
2142   :version "22.1"
2143   :group 'gnus-group-select
2144   :type '(choice (const :tag "No limit" nil)
2145                  integer))
2146
2147 (defcustom gnus-fetch-old-ephemeral-headers nil
2148   "Same as `gnus-fetch-old-headers', but only used for ephemeral newsgroups."
2149   :version "22.1"
2150   :group 'gnus-thread
2151   :type '(choice (const :tag "off" nil)
2152                  (const some)
2153                  number
2154                  (sexp :menu-tag "other" t)))
2155
2156 ;; Enter a group that is not in the group buffer.  Non-nil is returned
2157 ;; if selection was successful.
2158 (defun gnus-group-read-ephemeral-group (group method &optional activate
2159                                               quit-config request-only
2160                                               select-articles
2161                                               parameters
2162                                               number)
2163   "Read GROUP from METHOD as an ephemeral group.
2164 If ACTIVATE, request the group first.
2165 If QUIT-CONFIG, use that window configuration when exiting from the
2166 ephemeral group.
2167 If REQUEST-ONLY, don't actually read the group; just request it.
2168 If SELECT-ARTICLES, only select those articles.
2169 If PARAMETERS, use those as the group parameters.
2170 If NUMBER, fetch this number of articles.
2171
2172 Return the name of the group if selection was successful."
2173   (interactive
2174    (list
2175     ;; (gnus-read-group "Group name: ")
2176     (completing-read
2177      "Group: " gnus-active-hashtb
2178      nil nil nil
2179      'gnus-group-history)
2180     (gnus-read-method "From method: ")))
2181   ;; Transform the select method into a unique server.
2182   (when (stringp method)
2183     (setq method (gnus-server-to-method method)))
2184   (setq method
2185         `(,(car method) ,(concat (cadr method) "-ephemeral")
2186           (,(intern (format "%s-address" (car method))) ,(cadr method))
2187           ,@(cddr method)))
2188   (let ((group (if (gnus-group-foreign-p group) group
2189                  (gnus-group-prefixed-name (gnus-group-real-name group)
2190                                            method))))
2191     (gnus-sethash
2192      group
2193      `(-1 nil (,group
2194                ,gnus-level-default-subscribed nil nil ,method
2195                ,(cons
2196                  (if quit-config
2197                      (cons 'quit-config quit-config)
2198                    (cons 'quit-config
2199                          (cons gnus-summary-buffer
2200                                gnus-current-window-configuration)))
2201                  parameters)))
2202      gnus-newsrc-hashtb)
2203     (push method gnus-ephemeral-servers)
2204     (set-buffer gnus-group-buffer)
2205     (unless (gnus-check-server method)
2206       (error "Unable to contact server: %s" (gnus-status-message method)))
2207     (when activate
2208       (gnus-activate-group group 'scan)
2209       (unless (gnus-request-group group)
2210         (error "Couldn't request group: %s"
2211                (nnheader-get-report (car method)))))
2212     (if request-only
2213         group
2214       (condition-case ()
2215           (when (let ((gnus-large-newsgroup gnus-large-ephemeral-newsgroup)
2216                       (gnus-fetch-old-headers
2217                        gnus-fetch-old-ephemeral-headers))
2218                   (gnus-group-read-group (or number t) t group select-articles))
2219             group)
2220         ;;(error nil)
2221         (quit
2222          (message "Quit reading the ephemeral group")
2223          nil)))))
2224
2225 (defun gnus-group-jump-to-group (group &optional prompt)
2226   "Jump to newsgroup GROUP.
2227
2228 If PROMPT (the prefix) is a number, use the prompt specified in
2229 `gnus-group-jump-to-group-prompt'."
2230   (interactive
2231    (list (mm-string-make-unibyte
2232           (completing-read
2233            "Group: " gnus-active-hashtb nil
2234            (gnus-read-active-file-p)
2235            (if current-prefix-arg
2236                (cdr (assq current-prefix-arg gnus-group-jump-to-group-prompt))
2237              (or (and (stringp gnus-group-jump-to-group-prompt)
2238                       gnus-group-jump-to-group-prompt)
2239                  (let ((p (cdr (assq 0 gnus-group-jump-to-group-prompt))))
2240                    (and (stringp p) p))))
2241            'gnus-group-history))))
2242
2243   (when (equal group "")
2244     (error "Empty group name"))
2245
2246   (unless (gnus-ephemeral-group-p group)
2247     ;; Either go to the line in the group buffer...
2248     (unless (gnus-group-goto-group group)
2249       ;; ... or insert the line.
2250       (gnus-group-update-group group)
2251       (gnus-group-goto-group group)))
2252   ;; Adjust cursor point.
2253   (gnus-group-position-point))
2254
2255 (defun gnus-group-goto-group (group &optional far test-marked)
2256   "Goto to newsgroup GROUP.
2257 If FAR, it is likely that the group is not on the current line.
2258 If TEST-MARKED, the line must be marked."
2259   (when group
2260     (beginning-of-line)
2261     (cond
2262      ;; It's quite likely that we are on the right line, so
2263      ;; we check the current line first.
2264      ((and (not far)
2265            (eq (get-text-property (point) 'gnus-group)
2266                (gnus-intern-safe group gnus-active-hashtb))
2267            (or (not test-marked) (gnus-group-mark-line-p)))
2268       (point))
2269      ;; Previous and next line are also likely, so we check them as well.
2270      ((and (not far)
2271            (save-excursion
2272              (forward-line -1)
2273              (and (eq (get-text-property (point) 'gnus-group)
2274                       (gnus-intern-safe group gnus-active-hashtb))
2275                   (or (not test-marked) (gnus-group-mark-line-p)))))
2276       (forward-line -1)
2277       (point))
2278      ((and (not far)
2279            (save-excursion
2280              (forward-line 1)
2281              (and (eq (get-text-property (point) 'gnus-group)
2282                       (gnus-intern-safe group gnus-active-hashtb))
2283                   (or (not test-marked) (gnus-group-mark-line-p)))))
2284       (forward-line 1)
2285       (point))
2286      (test-marked
2287       (goto-char (point-min))
2288       (let (found)
2289         (while (and (not found)
2290                     (gnus-goto-char
2291                      (text-property-any
2292                       (point) (point-max)
2293                       'gnus-group
2294                       (gnus-intern-safe group gnus-active-hashtb))))
2295           (if (gnus-group-mark-line-p)
2296               (setq found t)
2297             (forward-line 1)))
2298         found))
2299      (t
2300       ;; Search through the entire buffer.
2301       (gnus-goto-char
2302        (text-property-any
2303         (point-min) (point-max)
2304         'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
2305
2306 (defun gnus-group-next-group (n &optional silent)
2307   "Go to next N'th newsgroup.
2308 If N is negative, search backward instead.
2309 Returns the difference between N and the number of skips actually
2310 done."
2311   (interactive "p")
2312   (gnus-group-next-unread-group n t nil silent))
2313
2314 (defun gnus-group-next-unread-group (n &optional all level silent)
2315   "Go to next N'th unread newsgroup.
2316 If N is negative, search backward instead.
2317 If ALL is non-nil, choose any newsgroup, unread or not.
2318 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
2319 such group can be found, the next group with a level higher than
2320 LEVEL.
2321 Returns the difference between N and the number of skips actually
2322 made."
2323   (interactive "p")
2324   (let ((backward (< n 0))
2325         (n (abs n)))
2326     (while (and (> n 0)
2327                 (gnus-group-search-forward
2328                  backward (or (not gnus-group-goto-unread) all) level))
2329       (setq n (1- n)))
2330     (when (and (/= 0 n)
2331                (not silent))
2332       (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
2333                     (if level " on this level or higher" "")))
2334     n))
2335
2336 (defun gnus-group-prev-group (n)
2337   "Go to previous N'th newsgroup.
2338 Returns the difference between N and the number of skips actually
2339 done."
2340   (interactive "p")
2341   (gnus-group-next-unread-group (- n) t))
2342
2343 (defun gnus-group-prev-unread-group (n)
2344   "Go to previous N'th unread newsgroup.
2345 Returns the difference between N and the number of skips actually
2346 done."
2347   (interactive "p")
2348   (gnus-group-next-unread-group (- n)))
2349
2350 (defun gnus-group-next-unread-group-same-level (n)
2351   "Go to next N'th unread newsgroup on the same level.
2352 If N is negative, search backward instead.
2353 Returns the difference between N and the number of skips actually
2354 done."
2355   (interactive "p")
2356   (gnus-group-next-unread-group n t (gnus-group-group-level))
2357   (gnus-group-position-point))
2358
2359 (defun gnus-group-prev-unread-group-same-level (n)
2360   "Go to next N'th unread newsgroup on the same level.
2361 Returns the difference between N and the number of skips actually
2362 done."
2363   (interactive "p")
2364   (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
2365   (gnus-group-position-point))
2366
2367 (defun gnus-group-best-unread-group (&optional exclude-group)
2368   "Go to the group with the highest level.
2369 If EXCLUDE-GROUP, do not go to that group."
2370   (interactive)
2371   (goto-char (point-min))
2372   (let ((best 100000)
2373         unread best-point)
2374     (while (not (eobp))
2375       (setq unread (get-text-property (point) 'gnus-unread))
2376       (when (and (numberp unread) (> unread 0))
2377         (when (and (get-text-property (point) 'gnus-level)
2378                    (< (get-text-property (point) 'gnus-level) best)
2379                    (or (not exclude-group)
2380                        (not (equal exclude-group (gnus-group-group-name)))))
2381           (setq best (get-text-property (point) 'gnus-level))
2382           (setq best-point (point))))
2383       (forward-line 1))
2384     (when best-point
2385       (goto-char best-point))
2386     (gnus-group-position-point)
2387     (and best-point (gnus-group-group-name))))
2388
2389 ;; Is there something like an after-point-motion-hook?
2390 ;; (inhibit-point-motion-hooks?).  Is there a tool-bar-update function?
2391
2392 ;; (defun gnus-group-menu-bar-update ()
2393 ;;   (let* ((buf (list (with-current-buffer gnus-group-buffer
2394 ;;                    (current-buffer))))
2395 ;;       (name (buffer-name (car buf))))
2396 ;;     (setcdr buf
2397 ;;          (if (> (length name) 27)
2398 ;;              (concat (substring name 0 12)
2399 ;;                      "..."
2400 ;;                      (substring name -12))
2401 ;;            name))
2402 ;;     (menu-bar-update-buffers-1 buf)))
2403
2404 ;; (defun gnus-group-position-point ()
2405 ;;   (gnus-goto-colon)
2406 ;;   (gnus-group-menu-bar-update))
2407
2408 (defun gnus-group-first-unread-group ()
2409   "Go to the first group with unread articles."
2410   (interactive)
2411   (prog1
2412       (let ((opoint (point))
2413             unread)
2414         (goto-char (point-min))
2415         (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
2416                 (and (numberp unread)   ; Not a topic.
2417                      (not (zerop unread))) ; Has unread articles.
2418                 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
2419             (point)                     ; Success.
2420           (goto-char opoint)
2421           nil))                         ; Not success.
2422     (gnus-group-position-point)))
2423
2424 (defun gnus-group-enter-server-mode ()
2425   "Jump to the server buffer."
2426   (interactive)
2427   (gnus-enter-server-buffer))
2428
2429 (defun gnus-group-make-group-simple (&optional group)
2430   "Add a new newsgroup.
2431 The user will be prompted for GROUP."
2432   (interactive
2433    (list (completing-read "Group: " gnus-active-hashtb
2434                           nil nil nil 'gnus-group-history)))
2435   (gnus-group-make-group
2436    (gnus-group-real-name group)
2437    (gnus-group-server group)))
2438
2439 (defun gnus-group-make-group (name &optional method address args)
2440   "Add a new newsgroup.
2441 The user will be prompted for a NAME, for a select METHOD, and an
2442 ADDRESS."
2443   (interactive
2444    (list
2445     (gnus-read-group "Group name: ")
2446     (gnus-read-method "From method: ")))
2447
2448   (when (stringp method)
2449     (setq method (or (gnus-server-to-method method) method)))
2450   (let* ((meth (gnus-method-simplify
2451                 (when (and method
2452                            (not (gnus-server-equal method gnus-select-method)))
2453                   (if address (list (intern method) address)
2454                     method))))
2455          (nname (if method (gnus-group-prefixed-name name meth) name))
2456          backend info)
2457     (when (gnus-group-entry nname)
2458       (error "Group %s already exists" (gnus-group-decoded-name nname)))
2459     ;; Subscribe to the new group.
2460     (gnus-group-change-level
2461      (setq info (list t nname gnus-level-default-subscribed nil nil meth))
2462      gnus-level-default-subscribed gnus-level-killed
2463      (and (gnus-group-group-name)
2464           (gnus-group-entry (gnus-group-group-name)))
2465      t)
2466     ;; Make it active.
2467     (gnus-set-active nname (cons 1 0))
2468     (unless (gnus-ephemeral-group-p name)
2469       (gnus-dribble-enter
2470        (concat "(gnus-group-set-info '"
2471                (gnus-prin1-to-string (cdr info)) ")")))
2472     ;; Insert the line.
2473     (gnus-group-insert-group-line-info nname)
2474     (forward-line -1)
2475     (gnus-group-position-point)
2476
2477     ;; Load the back end and try to make the back end create
2478     ;; the group as well.
2479     (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
2480                                                   nil meth))))
2481                  gnus-valid-select-methods)
2482       (require backend))
2483     (gnus-check-server meth)
2484     (when (gnus-check-backend-function 'request-create-group nname)
2485       (unless (gnus-request-create-group nname nil args)
2486         (error "Could not create group on server: %s"
2487                (nnheader-get-report backend))))
2488     t))
2489
2490 (defun gnus-group-delete-groups (&optional arg)
2491   "Delete the current group.  Only meaningful with editable groups."
2492   (interactive "P")
2493   (let ((n (length (gnus-group-process-prefix arg))))
2494     (when (gnus-yes-or-no-p
2495            (if (= n 1)
2496                "Delete this 1 group? "
2497              (format "Delete these %d groups? " n)))
2498       (gnus-group-iterate arg
2499         (lambda (group)
2500           (gnus-group-delete-group group nil t))))))
2501
2502 (defun gnus-group-delete-group (group &optional force no-prompt)
2503   "Delete the current group.  Only meaningful with editable groups.
2504 If FORCE (the prefix) is non-nil, all the articles in the group will
2505 be deleted.  This is \"deleted\" as in \"removed forever from the face
2506 of the Earth\".  There is no undo.  The user will be prompted before
2507 doing the deletion.
2508 Note that you also have to specify FORCE if you want the group to
2509 be removed from the server, even when it's empty."
2510   (interactive
2511    (list (gnus-group-group-name)
2512          current-prefix-arg))
2513   (unless group
2514     (error "No group to delete"))
2515   (unless (gnus-check-backend-function 'request-delete-group group)
2516     (error "This back end does not support group deletion"))
2517   (prog1
2518       (let ((group-decoded (gnus-group-decoded-name group)))
2519         (if (and (not no-prompt)
2520                  (not (gnus-yes-or-no-p
2521                        (format
2522                         "Do you really want to delete %s%s? "
2523                         group-decoded (if force " and all its contents" "")))))
2524             ()                          ; Whew!
2525           (gnus-message 6 "Deleting group %s..." group-decoded)
2526           (if (not (gnus-request-delete-group group force))
2527               (gnus-error 3 "Couldn't delete group %s" group-decoded)
2528             (gnus-message 6 "Deleting group %s...done" group-decoded)
2529             (gnus-group-goto-group group)
2530             (gnus-group-kill-group 1 t)
2531             (gnus-set-active group nil)
2532             t)))
2533     (gnus-group-position-point)))
2534
2535 (defun gnus-group-rename-group (group new-name)
2536   "Rename group from GROUP to NEW-NAME.
2537 When used interactively, GROUP is the group under point
2538 and NEW-NAME will be prompted for."
2539   (interactive
2540    (list
2541     (gnus-group-group-name)
2542     (progn
2543       (unless (gnus-check-backend-function
2544                'request-rename-group (gnus-group-group-name))
2545         (error "This back end does not support renaming groups"))
2546       (gnus-read-group "Rename group to: "
2547                        (gnus-group-real-name (gnus-group-group-name))))))
2548
2549   (unless (gnus-check-backend-function 'request-rename-group group)
2550     (error "This back end does not support renaming groups"))
2551   (unless group
2552     (error "No group to rename"))
2553   (when (equal (gnus-group-real-name group) new-name)
2554     (error "Can't rename to the same name"))
2555
2556   ;; We find the proper prefixed name.
2557   (setq new-name
2558         (if (gnus-group-native-p group)
2559             ;; Native group.
2560             new-name
2561           ;; Foreign group.
2562           (gnus-group-prefixed-name
2563            (gnus-group-real-name new-name)
2564            (gnus-info-method (gnus-get-info group)))))
2565
2566   (when (gnus-active new-name)
2567     (error "The group %s already exists" new-name))
2568
2569   (gnus-message 6 "Renaming group %s to %s..." group new-name)
2570   (prog1
2571       (if (progn
2572             (gnus-group-goto-group group)
2573             (not (when (< (gnus-group-group-level) gnus-level-zombie)
2574                    (gnus-request-rename-group group new-name))))
2575           (gnus-error 3 "Couldn't rename group %s to %s" group new-name)
2576         ;; We rename the group internally by killing it...
2577         (gnus-group-kill-group)
2578         ;; ... changing its name ...
2579         (setcar (cdar gnus-list-of-killed-groups) new-name)
2580         ;; ... and then yanking it.  Magic!
2581         (gnus-group-yank-group)
2582         (gnus-set-active new-name (gnus-active group))
2583         (gnus-message 6 "Renaming group %s to %s...done" group new-name)
2584         new-name)
2585     (setq gnus-killed-list (delete group gnus-killed-list))
2586     (gnus-set-active group nil)
2587     (gnus-dribble-touch)
2588     (gnus-group-position-point)))
2589
2590 (defun gnus-group-edit-group (group &optional part)
2591   "Edit the group on the current line."
2592   (interactive (list (gnus-group-group-name)))
2593   (let ((part (or part 'info))
2594         info)
2595     (unless group
2596       (error "No group on current line"))
2597     (unless (setq info (gnus-get-info group))
2598       (error "Killed group; can't be edited"))
2599     (ignore-errors
2600       (gnus-close-group group))
2601     (gnus-edit-form
2602      ;; Find the proper form to edit.
2603      (cond ((eq part 'method)
2604             (or (gnus-info-method info) "native"))
2605            ((eq part 'params)
2606             (gnus-info-params info))
2607            (t info))
2608      ;; The proper documentation.
2609      (format
2610       "Editing the %s for `%s'."
2611       (cond
2612        ((eq part 'method) "select method")
2613        ((eq part 'params) "group parameters")
2614        (t "group info"))
2615       (gnus-group-decoded-name group))
2616      `(lambda (form)
2617         (gnus-group-edit-group-done ',part ,group form)))
2618     (local-set-key
2619      "\C-c\C-i"
2620      (gnus-create-info-command
2621       (cond
2622        ((eq part 'method)
2623         "(gnus)Select Methods")
2624        ((eq part 'params)
2625         "(gnus)Group Parameters")
2626        (t
2627         "(gnus)Group Info"))))))
2628
2629 (defun gnus-group-edit-group-method (group)
2630   "Edit the select method of GROUP."
2631   (interactive (list (gnus-group-group-name)))
2632   (gnus-group-edit-group group 'method))
2633
2634 (defun gnus-group-edit-group-parameters (group)
2635   "Edit the group parameters of GROUP."
2636   (interactive (list (gnus-group-group-name)))
2637   (gnus-group-edit-group group 'params))
2638
2639 (defun gnus-group-edit-group-done (part group form)
2640   "Update variables."
2641   (let* ((method (cond ((eq part 'info) (nth 4 form))
2642                        ((eq part 'method) form)
2643                        (t nil)))
2644          (info (cond ((eq part 'info) form)
2645                      ((eq part 'method) (gnus-get-info group))
2646                      (t nil)))
2647          (new-group (if info
2648                         (if (or (not method)
2649                                 (gnus-server-equal
2650                                  gnus-select-method method))
2651                             (gnus-group-real-name (car info))
2652                           (gnus-group-prefixed-name
2653                            (gnus-group-real-name (car info)) method))
2654                       nil)))
2655     (when (and new-group
2656                (not (equal new-group group)))
2657       (when (gnus-group-goto-group group)
2658         (gnus-group-kill-group 1))
2659       (gnus-activate-group new-group))
2660     ;; Set the info.
2661     (if (not (and info new-group))
2662         (gnus-group-set-info form (or new-group group) part)
2663       (setq info (gnus-copy-sequence info))
2664       (setcar info new-group)
2665       (unless (gnus-server-equal method "native")
2666         (unless (nthcdr 3 info)
2667           (nconc info (list nil nil)))
2668         (unless (nthcdr 4 info)
2669           (nconc info (list nil)))
2670         (gnus-info-set-method info method))
2671       (gnus-group-set-info info))
2672     (gnus-group-update-group (or new-group group))
2673     (gnus-group-position-point)))
2674
2675 (defun gnus-group-make-useful-group (group method)
2676   "Create one of the groups described in `gnus-useful-groups'."
2677   (interactive
2678    (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
2679                                         nil t)
2680                        gnus-useful-groups)))
2681      (list (cadr entry) (caddr entry))))
2682   (setq method (gnus-copy-sequence method))
2683   (let (entry)
2684     (while (setq entry (memq (assq 'eval method) method))
2685       (setcar entry (eval (cadar entry)))))
2686   (gnus-group-make-group group method))
2687
2688 (defun gnus-group-make-help-group (&optional noerror)
2689   "Create the Gnus documentation group.
2690 Optional argument NOERROR modifies the behavior of this function when the
2691 group already exists:
2692 - if not given, and error is signaled,
2693 - if t, stay silent,
2694 - if anything else, just print a message."
2695   (interactive)
2696   (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2697         (file (nnheader-find-etc-directory "gnus-tut.txt" t)))
2698     (if (gnus-group-entry name)
2699         (cond ((eq noerror nil)
2700                (error "Documentation group already exists"))
2701               ((eq noerror t)
2702                ;; stay silent
2703                )
2704               (t
2705                (gnus-message 1 "Documentation group already exists")))
2706       ;; else:
2707       (if (not file)
2708           (gnus-message 1 "Couldn't find doc group")
2709         (gnus-group-make-group
2710          (gnus-group-real-name name)
2711          (list 'nndoc "gnus-help"
2712                (list 'nndoc-address file)
2713                (list 'nndoc-article-type 'mbox))))
2714       ))
2715   (gnus-group-position-point))
2716
2717 (defun gnus-group-make-doc-group (file type)
2718   "Create a group that uses a single file as the source.
2719
2720 If called with a prefix argument, ask for the file type."
2721   (interactive
2722    (list (read-file-name "File name: ")
2723          (and current-prefix-arg 'ask)))
2724   (when (eq type 'ask)
2725     (let ((err "")
2726           char found)
2727       (while (not found)
2728         (message
2729          "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [m, b, d, f, a, g]: "
2730          err)
2731         (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2732                           ((= char ?b) 'babyl)
2733                           ((= char ?d) 'digest)
2734                           ((= char ?f) 'forward)
2735                           ((= char ?a) 'mmfd)
2736                           ((= char ?g) 'guess)
2737                           (t (setq err (format "%c unknown. " char))
2738                              nil))))
2739       (setq type found)))
2740   (let* ((file (expand-file-name file))
2741          (name (gnus-generate-new-group-name
2742                 (gnus-group-prefixed-name
2743                  (file-name-nondirectory file) '(nndoc "")))))
2744     (gnus-group-make-group
2745      (gnus-group-real-name name)
2746      (list 'nndoc file
2747            (list 'nndoc-address file)
2748            (list 'nndoc-article-type (or type 'guess))))))
2749
2750 (defvar nnweb-type-definition)
2751 (defvar gnus-group-web-type-history nil)
2752 (defvar gnus-group-web-search-history nil)
2753 (defun gnus-group-make-web-group (&optional solid)
2754   "Create an ephemeral nnweb group.
2755 If SOLID (the prefix), create a solid group."
2756   (interactive "P")
2757   (require 'nnweb)
2758   (let* ((group
2759           (if solid (gnus-read-group "Group name: ")
2760             (message-unique-id)))
2761          (default-type (or (car gnus-group-web-type-history)
2762                            (symbol-name (caar nnweb-type-definition))))
2763          (type
2764           (gnus-string-or
2765            (completing-read
2766             (format "Search engine type (default %s): " default-type)
2767             (mapcar (lambda (elem) (list (symbol-name (car elem))))
2768                     nnweb-type-definition)
2769             nil t nil 'gnus-group-web-type-history)
2770            default-type))
2771          (search
2772           (read-string
2773            "Search string: "
2774            (cons (or (car gnus-group-web-search-history) "") 0)
2775            'gnus-group-web-search-history))
2776          (method
2777           `(nnweb ,group (nnweb-search ,search)
2778                   (nnweb-type ,(intern type))
2779                   (nnweb-ephemeral-p t))))
2780     (if solid
2781         (progn
2782           (gnus-pull 'nnweb-ephemeral-p method)
2783           (gnus-group-make-group group method))
2784       (gnus-group-read-ephemeral-group
2785        group method t
2786        (cons (current-buffer)
2787              (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
2788
2789 (eval-when-compile
2790   (defvar nnrss-group-alist)
2791   (defun nnrss-discover-feed (arg))
2792   (defun nnrss-save-server-data (arg)))
2793 (defun gnus-group-make-rss-group (&optional url)
2794   "Given a URL, discover if there is an RSS feed.
2795 If there is, use Gnus to create an nnrss group"
2796   (interactive)
2797   (require 'nnrss)
2798   (if (not url)
2799       (setq url (read-from-minibuffer "URL to Search for RSS: ")))
2800   (let ((feedinfo (nnrss-discover-feed url)))
2801     (if feedinfo
2802         (let ((title (gnus-newsgroup-savable-name
2803                       (read-from-minibuffer "Title: "
2804                                             (gnus-newsgroup-savable-name
2805                                              (or (cdr (assoc 'title
2806                                                              feedinfo))
2807                                                  "")))))
2808               (desc  (read-from-minibuffer "Description: "
2809                                            (cdr (assoc 'description
2810                                                        feedinfo))))
2811               (href (cdr (assoc 'href feedinfo)))
2812               (encodable (mm-coding-system-p 'utf-8)))
2813           (when encodable
2814             ;; Unify non-ASCII text.
2815             (setq title (mm-decode-coding-string
2816                          (mm-encode-coding-string title 'utf-8) 'utf-8)))
2817           (gnus-group-make-group (if encodable
2818                                      (mm-encode-coding-string title 'utf-8)
2819                                    title)
2820                                  '(nnrss ""))
2821           (push (list title href desc) nnrss-group-alist)
2822           (nnrss-save-server-data nil))
2823       (error "No feeds found for %s" url))))
2824
2825 (defvar nnwarchive-type-definition)
2826 (defvar gnus-group-warchive-type-history nil)
2827 (defvar gnus-group-warchive-login-history nil)
2828 (defvar gnus-group-warchive-address-history nil)
2829
2830 (defun gnus-group-make-warchive-group ()
2831   "Create a nnwarchive group."
2832   (interactive)
2833   (require 'nnwarchive)
2834   (let* ((group (gnus-read-group "Group name: "))
2835          (default-type (or (car gnus-group-warchive-type-history)
2836                            (symbol-name (caar nnwarchive-type-definition))))
2837          (type
2838           (gnus-string-or
2839            (completing-read
2840             (format "Warchive type (default %s): " default-type)
2841             (mapcar (lambda (elem) (list (symbol-name (car elem))))
2842                     nnwarchive-type-definition)
2843             nil t nil 'gnus-group-warchive-type-history)
2844            default-type))
2845          (address (read-string "Warchive address: "
2846                                nil 'gnus-group-warchive-address-history))
2847          (default-login (or (car gnus-group-warchive-login-history)
2848                             user-mail-address))
2849          (login
2850           (gnus-string-or
2851            (read-string
2852             (format "Warchive login (default %s): " user-mail-address)
2853             default-login 'gnus-group-warchive-login-history)
2854            user-mail-address))
2855          (method
2856           `(nnwarchive ,address
2857                        (nnwarchive-type ,(intern type))
2858                        (nnwarchive-login ,login))))
2859     (gnus-group-make-group group method)))
2860
2861 (defun gnus-group-make-archive-group (&optional all)
2862   "Create the (ding) Gnus archive group of the most recent articles.
2863 Given a prefix, create a full group."
2864   (interactive "P")
2865   (let ((group (gnus-group-prefixed-name
2866                 (if all "ding.archives" "ding.recent") '(nndir ""))))
2867     (when (gnus-group-entry group)
2868       (error "Archive group already exists"))
2869     (gnus-group-make-group
2870      (gnus-group-real-name group)
2871      (list 'nndir (if all "hpc" "edu")
2872            (list 'nndir-directory
2873                  (if all gnus-group-archive-directory
2874                    gnus-group-recent-archive-directory))))
2875     (gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
2876
2877 (defun gnus-group-make-directory-group (dir)
2878   "Create an nndir group.
2879 The user will be prompted for a directory.  The contents of this
2880 directory will be used as a newsgroup.  The directory should contain
2881 mail messages or news articles in files that have numeric names."
2882   (interactive
2883    (list (read-file-name "Create group from directory: ")))
2884   (unless (file-exists-p dir)
2885     (error "No such directory"))
2886   (unless (file-directory-p dir)
2887     (error "Not a directory"))
2888   (let ((ext "")
2889         (i 0)
2890         group)
2891     (while (or (not group) (gnus-group-entry group))
2892       (setq group
2893             (gnus-group-prefixed-name
2894              (expand-file-name ext dir)
2895              '(nndir "")))
2896       (setq ext (format "<%d>" (setq i (1+ i)))))
2897     (gnus-group-make-group
2898      (gnus-group-real-name group)
2899      (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
2900
2901 (defvar nnkiboze-score-file)
2902 (defun gnus-group-make-kiboze-group (group address scores)
2903   "Create an nnkiboze group.
2904 The user will be prompted for a name, a regexp to match groups, and
2905 score file entries for articles to include in the group."
2906   (interactive
2907    (list
2908     (read-string "nnkiboze group name: ")
2909     (read-string "Source groups (regexp): ")
2910     (let ((headers (mapcar 'list
2911                            '("subject" "from" "number" "date" "message-id"
2912                              "references" "chars" "lines" "xref"
2913                              "followup" "all" "body" "head")))
2914           scores header regexp regexps)
2915       (while (not (equal "" (setq header (completing-read
2916                                           "Match on header: " headers nil t))))
2917         (setq regexps nil)
2918         (while (not (equal "" (setq regexp (read-string
2919                                             (format "Match on %s (regexp): "
2920                                                     header)))))
2921           (push (list regexp nil nil 'r) regexps))
2922         (push (cons header regexps) scores))
2923       scores)))
2924   (gnus-group-make-group group "nnkiboze" address)
2925   (let* ((nnkiboze-current-group group)
2926          (score-file (car (nnkiboze-score-file "")))
2927          (score-dir (file-name-directory score-file)))
2928     (unless (file-exists-p score-dir)
2929       (make-directory score-dir))
2930     (with-temp-file score-file
2931       (let (emacs-lisp-mode-hook)
2932         (gnus-pp scores)))))
2933
2934 (defun gnus-group-add-to-virtual (n vgroup)
2935   "Add the current group to a virtual group."
2936   (interactive
2937    (list current-prefix-arg
2938          (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
2939                           "nnvirtual:")))
2940   (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
2941     (error "%s is not an nnvirtual group" vgroup))
2942   (gnus-close-group vgroup)
2943   (let* ((groups (gnus-group-process-prefix n))
2944          (method (gnus-info-method (gnus-get-info vgroup))))
2945     (setcar (cdr method)
2946             (concat
2947              (nth 1 method) "\\|"
2948              (mapconcat
2949               (lambda (s)
2950                 (gnus-group-remove-mark s)
2951                 (concat "\\(^" (regexp-quote s) "$\\)"))
2952               groups "\\|"))))
2953   (gnus-group-position-point))
2954
2955 (defun gnus-group-make-empty-virtual (group)
2956   "Create a new, fresh, empty virtual group."
2957   (interactive "sCreate new, empty virtual group: ")
2958   (let* ((method (list 'nnvirtual "^$"))
2959          (pgroup (gnus-group-prefixed-name group method)))
2960     ;; Check whether it exists already.
2961     (when (gnus-group-entry pgroup)
2962       (error "Group %s already exists" pgroup))
2963     ;; Subscribe the new group after the group on the current line.
2964     (gnus-subscribe-group pgroup (gnus-group-group-name) method)
2965     (gnus-group-update-group pgroup)
2966     (forward-line -1)
2967     (gnus-group-position-point)))
2968
2969 (defun gnus-group-enter-directory (dir)
2970   "Enter an ephemeral nneething group."
2971   (interactive "DDirectory to read: ")
2972   (let* ((method (list 'nneething dir '(nneething-read-only t)))
2973          (leaf (gnus-group-prefixed-name
2974                 (file-name-nondirectory (directory-file-name dir))
2975                 method))
2976          (name (gnus-generate-new-group-name leaf)))
2977     (unless (gnus-group-read-ephemeral-group
2978              name method t
2979              (cons (current-buffer)
2980                    (if (eq major-mode 'gnus-summary-mode)
2981                        'summary 'group)))
2982       (error "Couldn't enter %s" dir))))
2983
2984 (eval-and-compile
2985   (autoload 'nnimap-expunge "nnimap")
2986   (autoload 'nnimap-acl-get "nnimap")
2987   (autoload 'nnimap-acl-edit "nnimap"))
2988
2989 (defun gnus-group-nnimap-expunge (group)
2990   "Expunge deleted articles in current nnimap GROUP."
2991   (interactive (list (gnus-group-group-name)))
2992   (let ((mailbox (gnus-group-real-name group)) method)
2993     (unless group
2994       (error "No group on current line"))
2995     (unless (gnus-get-info group)
2996       (error "Killed group; can't be edited"))
2997     (unless (eq 'nnimap (car (setq method (gnus-find-method-for-group group))))
2998       (error "%s is not an nnimap group" group))
2999     (nnimap-expunge mailbox (cadr method))))
3000
3001 (defun gnus-group-nnimap-edit-acl (group)
3002   "Edit the Access Control List of current nnimap GROUP."
3003   (interactive (list (gnus-group-group-name)))
3004   (let ((mailbox (gnus-group-real-name group)) method acl)
3005     (unless group
3006       (error "No group on current line"))
3007     (unless (gnus-get-info group)
3008       (error "Killed group; can't be edited"))
3009     (unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
3010       (error "%s is not an nnimap group" group))
3011     (unless (setq acl (nnimap-acl-get mailbox (cadr method)))
3012       (error "Server does not support ACL's"))
3013     (gnus-edit-form acl (format "Editing the access control list for `%s'.
3014
3015    An access control list is a list of (identifier . rights) elements.
3016
3017    The identifier string specifies the corresponding user.  The
3018    identifier \"anyone\" is reserved to refer to the universal identity.
3019
3020    Rights is a string listing a (possibly empty) set of alphanumeric
3021    characters, each character listing a set of operations which is being
3022    controlled.  Letters are reserved for ``standard'' rights, listed
3023    below.  Digits are reserved for implementation or site defined rights.
3024
3025    l - lookup (mailbox is visible to LIST/LSUB commands)
3026    r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
3027        SEARCH, COPY from mailbox)
3028    s - keep seen/unseen information across sessions (STORE \\SEEN flag)
3029    w - write (STORE flags other than \\SEEN and \\DELETED)
3030    i - insert (perform APPEND, COPY into mailbox)
3031    p - post (send mail to submission address for mailbox,
3032        not enforced by IMAP4 itself)
3033    c - create and delete mailbox (CREATE new sub-mailboxes in any
3034        implementation-defined hierarchy, RENAME or DELETE mailbox)
3035    d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
3036    a - administer (perform SETACL)" group)
3037                     `(lambda (form)
3038                        (nnimap-acl-edit
3039                         ,mailbox ',method ',acl form)))))
3040
3041 ;; Group sorting commands
3042 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
3043
3044 (defun gnus-group-sort-groups (func &optional reverse)
3045   "Sort the group buffer according to FUNC.
3046 When used interactively, the sorting function used will be
3047 determined by the `gnus-group-sort-function' variable.
3048 If REVERSE (the prefix), reverse the sorting order."
3049   (interactive (list gnus-group-sort-function current-prefix-arg))
3050   (funcall gnus-group-sort-alist-function
3051            (gnus-make-sort-function func) reverse)
3052   (gnus-group-unmark-all-groups)
3053   (gnus-group-list-groups)
3054   (gnus-dribble-touch))
3055
3056 (defun gnus-group-sort-flat (func reverse)
3057   ;; We peel off the dummy group from the alist.
3058   (when func
3059     (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
3060       (pop gnus-newsrc-alist))
3061     ;; Do the sorting.
3062     (setq gnus-newsrc-alist
3063           (sort gnus-newsrc-alist func))
3064     (when reverse
3065       (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
3066     ;; Regenerate the hash table.
3067     (gnus-make-hashtable-from-newsrc-alist)))
3068
3069 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
3070   "Sort the group buffer alphabetically by group name.
3071 If REVERSE, sort in reverse order."
3072   (interactive "P")
3073   (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
3074
3075 (defun gnus-group-sort-groups-by-real-name (&optional reverse)
3076   "Sort the group buffer alphabetically by real (unprefixed) group name.
3077 If REVERSE, sort in reverse order."
3078   (interactive "P")
3079   (gnus-group-sort-groups 'gnus-group-sort-by-real-name reverse))
3080
3081 (defun gnus-group-sort-groups-by-unread (&optional reverse)
3082   "Sort the group buffer by number of unread articles.
3083 If REVERSE, sort in reverse order."
3084   (interactive "P")
3085   (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
3086
3087 (defun gnus-group-sort-groups-by-level (&optional reverse)
3088   "Sort the group buffer by group level.
3089 If REVERSE, sort in reverse order."
3090   (interactive "P")
3091   (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
3092
3093 (defun gnus-group-sort-groups-by-score (&optional reverse)
3094   "Sort the group buffer by group score.
3095 If REVERSE, sort in reverse order."
3096   (interactive "P")
3097   (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
3098
3099 (defun gnus-group-sort-groups-by-rank (&optional reverse)
3100   "Sort the group buffer by group rank.
3101 If REVERSE, sort in reverse order."
3102   (interactive "P")
3103   (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
3104
3105 (defun gnus-group-sort-groups-by-method (&optional reverse)
3106   "Sort the group buffer alphabetically by back end name.
3107 If REVERSE, sort in reverse order."
3108   (interactive "P")
3109   (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
3110
3111 (defun gnus-group-sort-groups-by-server (&optional reverse)
3112   "Sort the group buffer alphabetically by server name.
3113 If REVERSE, sort in reverse order."
3114   (interactive "P")
3115   (gnus-group-sort-groups 'gnus-group-sort-by-server reverse))
3116
3117 ;;; Selected group sorting.
3118
3119 (defun gnus-group-sort-selected-groups (n func &optional reverse)
3120   "Sort the process/prefixed groups."
3121   (interactive (list current-prefix-arg gnus-group-sort-function))
3122   (let ((groups (gnus-group-process-prefix n)))
3123     (funcall gnus-group-sort-selected-function
3124              groups (gnus-make-sort-function func) reverse)
3125     (gnus-group-unmark-all-groups)
3126     (gnus-group-list-groups)
3127     (gnus-dribble-touch)))
3128
3129 (defun gnus-group-sort-selected-flat (groups func reverse)
3130   (let (entries infos)
3131     ;; First find all the group entries for these groups.
3132     (while groups
3133       (push (nthcdr 2 (gnus-group-entry (pop groups)))
3134             entries))
3135     ;; Then sort the infos.
3136     (setq infos
3137           (sort
3138            (mapcar
3139             (lambda (entry) (car entry))
3140             (setq entries (nreverse entries)))
3141            func))
3142     (when reverse
3143       (setq infos (nreverse infos)))
3144     ;; Go through all the infos and replace the old entries
3145     ;; with the new infos.
3146     (while infos
3147       (setcar (car entries) (pop infos))
3148       (pop entries))
3149     ;; Update the hashtable.
3150     (gnus-make-hashtable-from-newsrc-alist)))
3151
3152 (defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
3153   "Sort the group buffer alphabetically by group name.
3154 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3155 sort in reverse order."
3156   (interactive (gnus-interactive "P\ny"))
3157   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
3158
3159 (defun gnus-group-sort-selected-groups-by-real-name (&optional n reverse)
3160   "Sort the group buffer alphabetically by real group name.
3161 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3162 sort in reverse order."
3163   (interactive (gnus-interactive "P\ny"))
3164   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-real-name reverse))
3165
3166 (defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
3167   "Sort the group buffer by number of unread articles.
3168 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3169 sort in reverse order."
3170   (interactive (gnus-interactive "P\ny"))
3171   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
3172
3173 (defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
3174   "Sort the group buffer by group level.
3175 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3176 sort in reverse order."
3177   (interactive (gnus-interactive "P\ny"))
3178   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
3179
3180 (defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
3181   "Sort the group buffer by group score.
3182 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3183 sort in reverse order."
3184   (interactive (gnus-interactive "P\ny"))
3185   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
3186
3187 (defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
3188   "Sort the group buffer by group rank.
3189 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3190 sort in reverse order."
3191   (interactive (gnus-interactive "P\ny"))
3192   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
3193
3194 (defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
3195   "Sort the group buffer alphabetically by back end name.
3196 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3197 sort in reverse order."
3198   (interactive (gnus-interactive "P\ny"))
3199   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
3200
3201 ;;; Sorting predicates.
3202
3203 (defun gnus-group-sort-by-alphabet (info1 info2)
3204   "Sort alphabetically."
3205   (string< (gnus-info-group info1) (gnus-info-group info2)))
3206
3207 (defun gnus-group-sort-by-real-name (info1 info2)
3208   "Sort alphabetically on real (unprefixed) names."
3209   (string< (gnus-group-real-name (gnus-info-group info1))
3210            (gnus-group-real-name (gnus-info-group info2))))
3211
3212 (defun gnus-group-sort-by-unread (info1 info2)
3213   "Sort by number of unread articles."
3214   (let ((n1 (gnus-group-unread (gnus-info-group info1)))
3215         (n2 (gnus-group-unread (gnus-info-group info1))))
3216     (< (or (and (numberp n1) n1) 0)
3217        (or (and (numberp n2) n2) 0))))
3218
3219 (defun gnus-group-sort-by-level (info1 info2)
3220   "Sort by level."
3221   (< (gnus-info-level info1) (gnus-info-level info2)))
3222
3223 (defun gnus-group-sort-by-method (info1 info2)
3224   "Sort alphabetically by back end name."
3225   (string< (car (gnus-find-method-for-group
3226                  (gnus-info-group info1) info1))
3227            (car (gnus-find-method-for-group
3228                  (gnus-info-group info2) info2))))
3229
3230 (defun gnus-group-sort-by-server (info1 info2)
3231   "Sort alphabetically by server name."
3232   (string< (gnus-method-to-full-server-name
3233             (gnus-find-method-for-group
3234              (gnus-info-group info1) info1))
3235            (gnus-method-to-full-server-name
3236             (gnus-find-method-for-group
3237              (gnus-info-group info2) info2))))
3238
3239 (defun gnus-group-sort-by-score (info1 info2)
3240   "Sort by group score."
3241   (> (gnus-info-score info1) (gnus-info-score info2)))
3242
3243 (defun gnus-group-sort-by-rank (info1 info2)
3244   "Sort by level and score."
3245   (let ((level1 (gnus-info-level info1))
3246         (level2 (gnus-info-level info2)))
3247     (or (< level1 level2)
3248         (and (= level1 level2)
3249              (> (gnus-info-score info1) (gnus-info-score info2))))))
3250
3251 ;;; Clearing data
3252
3253 (defun gnus-group-clear-data (&optional arg)
3254   "Clear all marks and read ranges from the current group.
3255 Obeys the process/prefix convention."
3256   (interactive "P")
3257   (gnus-group-iterate arg
3258     (lambda (group)
3259       (let (info)
3260         (gnus-info-clear-data (setq info (gnus-get-info group)))
3261         (gnus-get-unread-articles-in-group info (gnus-active group) t)
3262         (when (gnus-group-goto-group group)
3263           (gnus-group-update-group-line))))))
3264
3265 (defun gnus-group-clear-data-on-native-groups ()
3266   "Clear all marks and read ranges from all native groups."
3267   (interactive)
3268   (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
3269     (let ((alist (cdr gnus-newsrc-alist))
3270           info)
3271       (while (setq info (pop alist))
3272         (when (gnus-group-native-p (gnus-info-group info))
3273           (gnus-info-clear-data info)))
3274       (gnus-get-unread-articles)
3275       (gnus-dribble-touch)
3276       (when (gnus-y-or-n-p
3277              "Move the cache away to avoid problems in the future? ")
3278         (call-interactively 'gnus-cache-move-cache)))))
3279
3280 (defun gnus-info-clear-data (info)
3281   "Clear all marks and read ranges from INFO."
3282   (let ((group (gnus-info-group info))
3283         action)
3284     (dolist (el (gnus-info-marks info))
3285       (push `(,(cdr el) add (,(car el))) action))
3286     (push `(,(gnus-info-read info) add (read)) action)
3287     (gnus-undo-register
3288       `(progn
3289          (gnus-request-set-mark ,group ',action)
3290          (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
3291          (gnus-info-set-read ',info ',(gnus-info-read info))
3292          (when (gnus-group-goto-group ,group)
3293            (gnus-get-unread-articles-in-group ',info ',(gnus-active group) t)
3294            (gnus-group-update-group-line))))
3295     (setq action (mapcar (lambda (el) (list (nth 0 el) 'del (nth 2 el)))
3296                          action))
3297     (gnus-request-set-mark group action)
3298     (gnus-info-set-read info nil)
3299     (when (gnus-info-marks info)
3300       (gnus-info-set-marks info nil))))
3301
3302 ;; Group catching up.
3303
3304 (defun gnus-group-catchup-current (&optional n all)
3305   "Mark all unread articles in the current newsgroup as read.
3306 If prefix argument N is numeric, the next N newsgroups will be
3307 caught up.  If ALL is non-nil, marked articles will also be marked as
3308 read.  Cross references (Xref: header) of articles are ignored.
3309 The number of newsgroups that this function was unable to catch
3310 up is returned."
3311   (interactive "P")
3312   (let ((groups (gnus-group-process-prefix n))
3313         (ret 0)
3314         group)
3315     (unless groups (error "No groups selected"))
3316     (if (not
3317          (or (not gnus-interactive-catchup) ;Without confirmation?
3318              gnus-expert-user
3319              (gnus-y-or-n-p
3320               (format
3321                (if all
3322                    "Do you really want to mark all articles in %s as read? "
3323                  "Mark all unread articles in %s as read? ")
3324                (if (= (length groups) 1)
3325                    (gnus-group-decoded-name (car groups))
3326                  (format "these %d groups" (length groups)))))))
3327         n
3328       (while (setq group (pop groups))
3329         (gnus-group-remove-mark group)
3330         ;; Virtual groups have to be given special treatment.
3331         (let ((method (gnus-find-method-for-group group)))
3332           (when (eq 'nnvirtual (car method))
3333             (nnvirtual-catchup-group
3334              (gnus-group-real-name group) (nth 1 method) all)))
3335         (if (>= (gnus-group-level group) gnus-level-zombie)
3336             (gnus-message 2 "Dead groups can't be caught up")
3337           (if (prog1
3338                   (gnus-group-goto-group group)
3339                 (gnus-group-catchup group all))
3340               (gnus-group-update-group-line)
3341             (setq ret (1+ ret)))))
3342       (gnus-group-next-unread-group 1)
3343       ret)))
3344
3345 (defun gnus-group-catchup-current-all (&optional n)
3346   "Mark all articles in current newsgroup as read.
3347 Cross references (Xref: header) of articles are ignored."
3348   (interactive "P")
3349   (gnus-group-catchup-current n 'all))
3350
3351 (defun gnus-group-catchup (group &optional all)
3352   "Mark all articles in GROUP as read.
3353 If ALL is non-nil, all articles are marked as read.
3354 The return value is the number of articles that were marked as read,
3355 or nil if no action could be taken."
3356   (let* ((entry (gnus-group-entry group))
3357          (num (car entry))
3358          (marks (gnus-info-marks (nth 2 entry)))
3359          (unread (gnus-sequence-of-unread-articles group)))
3360     ;; Remove entries for this group.
3361     (nnmail-purge-split-history (gnus-group-real-name group))
3362     ;; Do the updating only if the newsgroup isn't killed.
3363     (if (not (numberp (car entry)))
3364         (gnus-message 1 "Can't catch up %s; non-active group" group)
3365       (gnus-update-read-articles group nil)
3366       (when all
3367         ;; Nix out the lists of marks and dormants.
3368         (gnus-request-set-mark group (list (list (cdr (assq 'tick marks))
3369                                                  'del '(tick))
3370                                            (list (cdr (assq 'dormant marks))
3371                                                  'del '(dormant))))
3372         (setq unread (gnus-range-add (gnus-range-add
3373                                       unread (cdr (assq 'dormant marks)))
3374                                      (cdr (assq 'tick marks))))
3375         (gnus-add-marked-articles group 'tick nil nil 'force)
3376         (gnus-add-marked-articles group 'dormant nil nil 'force))
3377       ;; Do auto-expirable marks if that's required.
3378       (when (gnus-group-auto-expirable-p group)
3379         (gnus-range-map (lambda (article)
3380                           (gnus-add-marked-articles group 'expire (list article))
3381                           (gnus-request-set-mark group (list (list (list article) 'add '(expire)))))
3382                         unread))
3383       (let ((gnus-newsgroup-name group))
3384         (gnus-run-hooks 'gnus-group-catchup-group-hook))
3385       num)))
3386
3387 (defun gnus-group-expire-articles (&optional n)
3388   "Expire all expirable articles in the current newsgroup.
3389 Uses the process/prefix convention."
3390   (interactive "P")
3391   (let ((groups (gnus-group-process-prefix n))
3392         group)
3393     (unless groups
3394       (error "No groups to expire"))
3395     (while (setq group (pop groups))
3396       (gnus-group-remove-mark group)
3397       (gnus-group-expire-articles-1 group)
3398       (gnus-dribble-touch)
3399       (gnus-group-position-point))))
3400
3401 (defun gnus-group-expire-articles-1 (group)
3402   (when (gnus-check-backend-function 'request-expire-articles group)
3403     (gnus-message 6 "Expiring articles in %s..."
3404                   (gnus-group-decoded-name group))
3405     (let* ((info (gnus-get-info group))
3406            (expirable (if (gnus-group-total-expirable-p group)
3407                           (cons nil (gnus-list-of-read-articles group))
3408                         (assq 'expire (gnus-info-marks info))))
3409            (expiry-wait (gnus-group-find-parameter group 'expiry-wait))
3410            (nnmail-expiry-target
3411             (or (gnus-group-find-parameter group 'expiry-target)
3412                 nnmail-expiry-target)))
3413       (when expirable
3414         (gnus-check-group group)
3415         (setcdr
3416          expirable
3417          (gnus-compress-sequence
3418           (if expiry-wait
3419               ;; We set the expiry variables to the group
3420               ;; parameter.
3421               (let ((nnmail-expiry-wait-function nil)
3422                     (nnmail-expiry-wait expiry-wait))
3423                 (gnus-request-expire-articles
3424                  (gnus-uncompress-sequence (cdr expirable)) group))
3425             ;; Just expire using the normal expiry values.
3426             (gnus-request-expire-articles
3427              (gnus-uncompress-sequence (cdr expirable)) group))))
3428         (gnus-close-group group))
3429       (gnus-message 6 "Expiring articles in %s...done"
3430                     (gnus-group-decoded-name group))
3431       ;; Return the list of un-expired articles.
3432       (cdr expirable))))
3433
3434 (defun gnus-group-expire-all-groups ()
3435   "Expire all expirable articles in all newsgroups."
3436   (interactive)
3437   (save-excursion
3438     (gnus-message 5 "Expiring...")
3439     (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
3440                                      (cdr gnus-newsrc-alist))))
3441       (gnus-group-expire-articles nil)))
3442   (gnus-group-position-point)
3443   (gnus-message 5 "Expiring...done"))
3444
3445 (defun gnus-group-set-current-level (n level)
3446   "Set the level of the next N groups to LEVEL."
3447   (interactive
3448    (list
3449     current-prefix-arg
3450     (progn
3451       (unless (gnus-group-process-prefix current-prefix-arg)
3452         (error "No group on the current line"))
3453       (string-to-number
3454        (let ((s (read-string
3455                  (format "Level (default %s): "
3456                          (or (gnus-group-group-level)
3457                              gnus-level-default-subscribed)))))
3458          (if (string-match "^\\s-*$" s)
3459              (int-to-string (or (gnus-group-group-level)
3460                                 gnus-level-default-subscribed))
3461            s))))))
3462   (unless (and (>= level 1) (<= level gnus-level-killed))
3463     (error "Invalid level: %d" level))
3464   (dolist (group (gnus-group-process-prefix n))
3465     (gnus-group-remove-mark group)
3466     (gnus-message 6 "Changed level of %s from %d to %d"
3467                   (gnus-group-decoded-name group)
3468                   (or (gnus-group-group-level) gnus-level-killed)
3469                   level)
3470     (gnus-group-change-level
3471      group level (or (gnus-group-group-level) gnus-level-killed))
3472     (gnus-group-update-group-line))
3473   (gnus-group-position-point))
3474
3475 (defun gnus-group-unsubscribe (&optional n)
3476   "Unsubscribe the current group."
3477   (interactive "P")
3478   (gnus-group-unsubscribe-current-group n 'unsubscribe))
3479
3480 (defun gnus-group-subscribe (&optional n)
3481   "Subscribe the current group."
3482   (interactive "P")
3483   (gnus-group-unsubscribe-current-group n 'subscribe))
3484
3485 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
3486   "Toggle subscription of the current group.
3487 If given numerical prefix, toggle the N next groups."
3488   (interactive "P")
3489   (dolist (group (gnus-group-process-prefix n))
3490     (gnus-group-remove-mark group)
3491     (gnus-group-unsubscribe-group
3492      group
3493      (cond
3494       ((eq do-sub 'unsubscribe)
3495        gnus-level-default-unsubscribed)
3496       ((eq do-sub 'subscribe)
3497        gnus-level-default-subscribed)
3498       ((<= (gnus-group-group-level) gnus-level-subscribed)
3499        gnus-level-default-unsubscribed)
3500       (t
3501        gnus-level-default-subscribed))
3502      t)
3503     (gnus-group-update-group-line))
3504   (gnus-group-next-group 1))
3505
3506 (defun gnus-group-unsubscribe-group (group &optional level silent)
3507   "Toggle subscription to GROUP.
3508 Killed newsgroups are subscribed.  If SILENT, don't try to update the
3509 group line."
3510   (interactive
3511    (list (completing-read
3512           "Group: " gnus-active-hashtb nil
3513           (gnus-read-active-file-p)
3514           nil
3515           'gnus-group-history)))
3516   (let ((newsrc (gnus-group-entry group)))
3517     (cond
3518      ((string-match "^[ \t]*$" group)
3519       (error "Empty group name"))
3520      (newsrc
3521       ;; Toggle subscription flag.
3522       (gnus-group-change-level
3523        newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
3524                                       gnus-level-subscribed)
3525                                   (1+ gnus-level-subscribed)
3526                                 gnus-level-default-subscribed)))
3527       (unless silent
3528         (gnus-group-update-group group)))
3529      ((and (stringp group)
3530            (or (not (gnus-read-active-file-p))
3531                (gnus-active group)))
3532       ;; Add new newsgroup.
3533       (gnus-group-change-level
3534        group
3535        (if level level gnus-level-default-subscribed)
3536        (or (and (member group gnus-zombie-list)
3537                 gnus-level-zombie)
3538            gnus-level-killed)
3539        (when (gnus-group-group-name)
3540          (gnus-group-entry (gnus-group-group-name))))
3541       (unless silent
3542         (gnus-group-update-group group)))
3543      (t (error "No such newsgroup: %s" group)))
3544     (gnus-group-position-point)))
3545
3546 (defun gnus-group-transpose-groups (n)
3547   "Move the current newsgroup up N places.
3548 If given a negative prefix, move down instead.  The difference between
3549 N and the number of steps taken is returned."
3550   (interactive "p")
3551   (unless (gnus-group-group-name)
3552     (error "No group on current line"))
3553   (gnus-group-kill-group 1)
3554   (prog1
3555       (forward-line (- n))
3556     (gnus-group-yank-group)
3557     (gnus-group-position-point)))
3558
3559 (defun gnus-group-kill-all-zombies (&optional dummy)
3560   "Kill all zombie newsgroups.
3561 The optional DUMMY should always be nil."
3562   (interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
3563   (unless dummy
3564     (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
3565     (setq gnus-zombie-list nil)
3566     (gnus-dribble-touch)
3567     (gnus-group-list-groups)))
3568
3569 (defun gnus-group-kill-region (begin end)
3570   "Kill newsgroups in current region (excluding current point).
3571 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
3572   (interactive "r")
3573   (let ((lines
3574          ;; Count lines.
3575          (save-excursion
3576            (count-lines
3577             (progn
3578               (goto-char begin)
3579               (point-at-bol))
3580             (progn
3581               (goto-char end)
3582               (point-at-bol))))))
3583     (goto-char begin)
3584     (beginning-of-line)                 ;Important when LINES < 1
3585     (gnus-group-kill-group lines)))
3586
3587 (defun gnus-group-kill-group (&optional n discard)
3588   "Kill the next N groups.
3589 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
3590 However, only groups that were alive can be yanked; already killed
3591 groups or zombie groups can't be yanked.
3592 The return value is the name of the group that was killed, or a list
3593 of groups killed."
3594   (interactive "P")
3595   (let ((buffer-read-only nil)
3596         (groups (gnus-group-process-prefix n))
3597         group entry level out)
3598     (if (< (length groups) 10)
3599         ;; This is faster when there are few groups.
3600         (while groups
3601           (push (setq group (pop groups)) out)
3602           (gnus-group-remove-mark group)
3603           (setq level (gnus-group-group-level))
3604           (gnus-delete-line)
3605           (when (and (not discard)
3606                      (setq entry (gnus-group-entry group)))
3607             (gnus-undo-register
3608               `(progn
3609                  (gnus-group-goto-group ,(gnus-group-group-name))
3610                  (gnus-group-yank-group)))
3611             (push (cons (car entry) (nth 2 entry))
3612                   gnus-list-of-killed-groups))
3613           (gnus-group-change-level
3614            (if entry entry group) gnus-level-killed (if entry nil level))
3615           (message "Killed group %s" (gnus-group-decoded-name group)))
3616       ;; If there are lots and lots of groups to be killed, we use
3617       ;; this thing instead.
3618       (dolist (group (nreverse groups))
3619         (gnus-group-remove-mark group)
3620         (gnus-delete-line)
3621         (push group gnus-killed-list)
3622         (setq gnus-newsrc-alist
3623               (delq (assoc group gnus-newsrc-alist)
3624                     gnus-newsrc-alist))
3625         (when gnus-group-change-level-function
3626           (funcall gnus-group-change-level-function
3627                    group gnus-level-killed 3))
3628         (cond
3629          ((setq entry (gnus-group-entry group))
3630           (push (cons (car entry) (nth 2 entry))
3631                 gnus-list-of-killed-groups)
3632           (setcdr (cdr entry) (cdddr entry)))
3633          ((member group gnus-zombie-list)
3634           (setq gnus-zombie-list (delete group gnus-zombie-list))))
3635         ;; There may be more than one instance displayed.
3636         (while (gnus-group-goto-group group)
3637           (gnus-delete-line)))
3638       (gnus-make-hashtable-from-newsrc-alist))
3639
3640     (gnus-group-position-point)
3641     (if (< (length out) 2) (car out) (nreverse out))))
3642
3643 (defun gnus-group-yank-group (&optional arg)
3644   "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
3645 The numeric ARG specifies how many newsgroups are to be yanked.  The
3646 name of the newsgroup yanked is returned, or (if several groups are
3647 yanked) a list of yanked groups is returned."
3648   (interactive "p")
3649   (setq arg (or arg 1))
3650   (let (info group prev out)
3651     (while (>= (decf arg) 0)
3652       (when (not (setq info (pop gnus-list-of-killed-groups)))
3653         (error "No more newsgroups to yank"))
3654       (push (setq group (nth 1 info)) out)
3655       ;; Find which newsgroup to insert this one before - search
3656       ;; backward until something suitable is found.  If there are no
3657       ;; other newsgroups in this buffer, just make this newsgroup the
3658       ;; first newsgroup.
3659       (setq prev (gnus-group-group-name))
3660       (gnus-group-change-level
3661        info (gnus-info-level (cdr info)) gnus-level-killed
3662        (and prev (gnus-group-entry prev))
3663        t)
3664       (gnus-group-insert-group-line-info group)
3665       (gnus-undo-register
3666         `(when (gnus-group-goto-group ,group)
3667            (gnus-group-kill-group 1))))
3668     (forward-line -1)
3669     (gnus-group-position-point)
3670     (if (< (length out) 2) (car out) (nreverse out))))
3671
3672 (defun gnus-group-kill-level (level)
3673   "Kill all groups that is on a certain LEVEL."
3674   (interactive "nKill all groups on level: ")
3675   (cond
3676    ((= level gnus-level-zombie)
3677     (setq gnus-killed-list
3678           (nconc gnus-zombie-list gnus-killed-list))
3679     (setq gnus-zombie-list nil))
3680    ((and (< level gnus-level-zombie)
3681          (> level 0)
3682          (or gnus-expert-user
3683              (gnus-yes-or-no-p
3684               (format
3685                "Do you really want to kill all groups on level %d? "
3686                level))))
3687     (let* ((prev gnus-newsrc-alist)
3688            (alist (cdr prev)))
3689       (while alist
3690         (if (= (gnus-info-level (car alist)) level)
3691             (progn
3692               (push (gnus-info-group (car alist)) gnus-killed-list)
3693               (setcdr prev (cdr alist)))
3694           (setq prev alist))
3695         (setq alist (cdr alist)))
3696       (gnus-make-hashtable-from-newsrc-alist)
3697       (gnus-group-list-groups)))
3698    (t
3699     (error "Can't kill; invalid level: %d" level))))
3700
3701 (defun gnus-group-list-all-groups (&optional arg)
3702   "List all newsgroups with level ARG or lower.
3703 Default is `gnus-level-unsubscribed', which lists all subscribed and most
3704 unsubscribed groups."
3705   (interactive "P")
3706   (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
3707
3708 ;; Redefine this to list ALL killed groups if prefix arg used.
3709 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
3710 (defun gnus-group-list-killed (&optional arg)
3711   "List all killed newsgroups in the group buffer.
3712 If ARG is non-nil, list ALL killed groups known to Gnus.  This may
3713 entail asking the server for the groups."
3714   (interactive "P")
3715   ;; Find all possible killed newsgroups if arg.
3716   (when arg
3717     (gnus-get-killed-groups))
3718   (if (not gnus-killed-list)
3719       (gnus-message 6 "No killed groups")
3720     (let (gnus-group-list-mode)
3721       (funcall gnus-group-prepare-function
3722                gnus-level-killed t gnus-level-killed))
3723     (goto-char (point-min)))
3724   (gnus-group-position-point))
3725
3726 (defun gnus-group-list-zombies ()
3727   "List all zombie newsgroups in the group buffer."
3728   (interactive)
3729   (if (not gnus-zombie-list)
3730       (gnus-message 6 "No zombie groups")
3731     (let (gnus-group-list-mode)
3732       (funcall gnus-group-prepare-function
3733                gnus-level-zombie t gnus-level-zombie))
3734     (goto-char (point-min)))
3735   (gnus-group-position-point))
3736
3737 (defun gnus-group-list-active ()
3738   "List all groups that are available from the server(s)."
3739   (interactive)
3740   ;; First we make sure that we have really read the active file.
3741   (unless (gnus-read-active-file-p)
3742     (let ((gnus-read-active-file t)
3743           (gnus-agent gnus-plugged)); If we're actually plugged, store the active file in the agent.
3744       (gnus-read-active-file)))
3745   ;; Find all groups and sort them.
3746   (let ((groups
3747          (sort
3748           (let (list)
3749             (mapatoms
3750              (lambda (sym)
3751                (and (boundp sym)
3752                     (symbol-value sym)
3753                     (push (symbol-name sym) list)))
3754              gnus-active-hashtb)
3755             list)
3756           'string<))
3757         (buffer-read-only nil)
3758         group)
3759     (erase-buffer)
3760     (while groups
3761       (setq group (pop groups))
3762       (gnus-add-text-properties
3763        (point) (prog1 (1+ (point))
3764                  (insert "       *: "
3765                          (gnus-group-decoded-name group)
3766                          "\n"))
3767        (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
3768              'gnus-unread t
3769              'gnus-level (inline (gnus-group-level group)))))
3770     (goto-char (point-min))))
3771
3772 (defun gnus-activate-all-groups (level)
3773   "Activate absolutely all groups."
3774   (interactive (list gnus-level-unsubscribed))
3775   (let ((gnus-activate-level level)
3776         (gnus-activate-foreign-newsgroups level))
3777     (gnus-group-get-new-news)))
3778
3779 (defun gnus-group-get-new-news (&optional arg)
3780   "Get newly arrived articles.
3781 If ARG is a number, it specifies which levels you are interested in
3782 re-scanning.  If ARG is non-nil and not a number, this will force
3783 \"hard\" re-reading of the active files from all servers."
3784   (interactive "P")
3785   (require 'nnmail)
3786   (let ((gnus-inhibit-demon t)
3787         ;; Binding this variable will inhibit multiple fetchings
3788         ;; of the same mail source.
3789         (nnmail-fetched-sources (list t)))
3790     (gnus-run-hooks 'gnus-get-top-new-news-hook)
3791     (gnus-run-hooks 'gnus-get-new-news-hook)
3792
3793     ;; Read any slave files.
3794     (unless gnus-slave
3795       (gnus-master-read-slave-newsrc))
3796
3797     ;; We might read in new NoCeM messages here.
3798     (when (and gnus-use-nocem
3799                (or (and (numberp gnus-use-nocem)
3800                         (numberp arg)
3801                         (>= arg gnus-use-nocem))
3802                    (not arg)))
3803       (gnus-nocem-scan-groups))
3804     ;; If ARG is not a number, then we read the active file.
3805     (when (and arg (not (numberp arg)))
3806       (let ((gnus-read-active-file t))
3807         (gnus-read-active-file))
3808       (setq arg nil)
3809
3810       ;; If the user wants it, we scan for new groups.
3811       (when (eq gnus-check-new-newsgroups 'always)
3812         (gnus-find-new-newsgroups)))
3813
3814     (setq arg (gnus-group-default-level arg t))
3815     (if (and gnus-read-active-file (not arg))
3816         (progn
3817           (gnus-read-active-file)
3818           (gnus-get-unread-articles arg))
3819       (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
3820         (gnus-get-unread-articles arg)))
3821     (gnus-check-reasonable-setup)
3822     (gnus-run-hooks 'gnus-after-getting-new-news-hook)
3823     (gnus-group-list-groups (and (numberp arg)
3824                                  (max (car gnus-group-list-mode) arg)))))
3825
3826 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
3827   "Check for newly arrived news in the current group (and the N-1 next groups).
3828 The difference between N and the number of newsgroup checked is returned.
3829 If N is negative, this group and the N-1 previous groups will be checked.
3830 If DONT-SCAN is non-nil, scan non-activated groups as well."
3831   (interactive "P")
3832   (let* ((groups (gnus-group-process-prefix n))
3833          (ret (if (numberp n) (- n (length groups)) 0))
3834          (beg (unless n
3835                 (point)))
3836          group method
3837          (gnus-inhibit-demon t)
3838          ;; Binding this variable will inhibit multiple fetchings
3839          ;; of the same mail source.
3840          (nnmail-fetched-sources (list t)))
3841     (gnus-run-hooks 'gnus-get-new-news-hook)
3842     (while (setq group (pop groups))
3843       (gnus-group-remove-mark group)
3844       ;; Bypass any previous denials from the server.
3845       (gnus-remove-denial (setq method (gnus-find-method-for-group group)))
3846       (if (gnus-activate-group group (if dont-scan nil 'scan) nil method)
3847           (let ((info (gnus-get-info group))
3848                 (active (gnus-active group)))
3849             (when info
3850               (gnus-request-update-info info method))
3851             (gnus-get-unread-articles-in-group info active)
3852             (unless (gnus-virtual-group-p group)
3853               (gnus-close-group group))
3854             (when gnus-agent
3855               (gnus-agent-save-group-info
3856                method (gnus-group-real-name group) active))
3857             (gnus-group-update-group group))
3858         (if (eq (gnus-server-status (gnus-find-method-for-group group))
3859                 'denied)
3860             (gnus-error 3 "Server denied access")
3861           (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
3862     (when beg
3863       (goto-char beg))
3864     (when gnus-goto-next-group-when-activating
3865       (gnus-group-next-unread-group 1 t))
3866     (gnus-summary-position-point)
3867     ret))
3868
3869 (defun gnus-group-fetch-faq (group &optional faq-dir)
3870   "Fetch the FAQ for the current group.
3871 If given a prefix argument, prompt for the FAQ dir
3872 to use."
3873   (interactive
3874    (list
3875     (gnus-group-group-name)
3876     (when current-prefix-arg
3877       (completing-read
3878        "FAQ dir: " (and (listp gnus-group-faq-directory)
3879                         (mapcar #'list
3880                                 gnus-group-faq-directory))))))
3881   (unless group
3882     (error "No group name given"))
3883   (let ((dirs (or faq-dir gnus-group-faq-directory))
3884         dir found file)
3885     (unless (listp dirs)
3886       (setq dirs (list dirs)))
3887     (while (and (not found)
3888                 (setq dir (pop dirs)))
3889       (let ((name (gnus-group-real-name group)))
3890         (setq file (expand-file-name name dir)))
3891       (if (not (file-exists-p file))
3892           (gnus-message 1 "No such file: %s" file)
3893         (let ((enable-local-variables nil))
3894           (find-file file)
3895           (setq found t))))))
3896
3897 (defun gnus-group-fetch-charter (group)
3898   "Fetch the charter for the current group.
3899 If given a prefix argument, prompt for a group."
3900   (interactive
3901    (list (or (when current-prefix-arg
3902                (completing-read "Group: " gnus-active-hashtb))
3903              (gnus-group-group-name)
3904              gnus-newsgroup-name)))
3905   (unless group
3906     (error "No group name given"))
3907   (require 'mm-url)
3908   (condition-case nil (require 'url-http) (error nil))
3909   (let ((name (mm-url-form-encode-xwfu (gnus-group-real-name group)))
3910         url hierarchy)
3911     (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3912       (setq hierarchy (match-string 1 name))
3913       (if (and (setq url (cdr (assoc hierarchy gnus-group-charter-alist)))
3914                (if (fboundp 'url-http-file-exists-p)
3915                    (url-http-file-exists-p (eval url))
3916                  t))
3917           (browse-url (eval url))
3918         (setq url (concat "http://" hierarchy
3919                           ".news-admin.org/charters/" name))
3920         (if (and (fboundp 'url-http-file-exists-p)
3921                  (url-http-file-exists-p url))
3922             (browse-url url)
3923           (gnus-group-fetch-control group))))))
3924
3925 (defun gnus-group-fetch-control (group)
3926   "Fetch the archived control messages for the current group.
3927 If given a prefix argument, prompt for a group."
3928   (interactive
3929    (list (or (when current-prefix-arg
3930                (completing-read "Group: " gnus-active-hashtb))
3931              (gnus-group-group-name)
3932              gnus-newsgroup-name)))
3933   (unless group
3934     (error "No group name given"))
3935   (let ((name (gnus-group-real-name group))
3936         hierarchy)
3937     (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3938       (setq hierarchy (match-string 1 name))
3939       (if gnus-group-fetch-control-use-browse-url
3940           (browse-url (concat "ftp://ftp.isc.org/usenet/control/"
3941                               hierarchy "/" name ".gz"))
3942         (let ((enable-local-variables nil))
3943           (gnus-group-read-ephemeral-group
3944            group
3945            `(nndoc ,group (nndoc-address
3946                            ,(find-file-noselect
3947                              (concat "/ftp@ftp.isc.org:/usenet/control/"
3948                                      hierarchy "/" name ".gz")))
3949                    (nndoc-article-type mbox)) t nil nil))))))
3950
3951 (defun gnus-group-describe-group (force &optional group)
3952   "Display a description of the current newsgroup."
3953   (interactive (list current-prefix-arg (gnus-group-group-name)))
3954   (let* ((method (gnus-find-method-for-group group))
3955          (mname (gnus-group-prefixed-name "" method))
3956          desc)
3957     (when (and force
3958                gnus-description-hashtb)
3959       (gnus-sethash mname nil gnus-description-hashtb))
3960     (unless group
3961       (error "No group name given"))
3962     (when (or (and gnus-description-hashtb
3963                    ;; We check whether this group's method has been
3964                    ;; queried for a description file.
3965                    (gnus-gethash mname gnus-description-hashtb))
3966               (setq desc (gnus-group-get-description group))
3967               (gnus-read-descriptions-file method))
3968       (gnus-message 1
3969                     (or desc (gnus-gethash group gnus-description-hashtb)
3970                         "No description available")))))
3971
3972 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3973 (defun gnus-group-describe-all-groups (&optional force)
3974   "Pop up a buffer with descriptions of all newsgroups."
3975   (interactive "P")
3976   (when force
3977     (setq gnus-description-hashtb nil))
3978   (when (not (or gnus-description-hashtb
3979                  (gnus-read-all-descriptions-files)))
3980     (error "Couldn't request descriptions file"))
3981   (let ((buffer-read-only nil)
3982         b)
3983     (erase-buffer)
3984     (mapatoms
3985      (lambda (group)
3986        (setq b (point))
3987        (let ((charset (gnus-group-name-charset nil (symbol-name group))))
3988          (insert (format "      *: %-20s %s\n"
3989                          (gnus-group-name-decode
3990                           (symbol-name group) charset)
3991                          (gnus-group-name-decode
3992                           (symbol-value group) charset))))
3993        (gnus-add-text-properties
3994         b (1+ b) (list 'gnus-group group
3995                        'gnus-unread t 'gnus-marked nil
3996                        'gnus-level (1+ gnus-level-subscribed))))
3997      gnus-description-hashtb)
3998     (goto-char (point-min))
3999     (gnus-group-position-point)))
4000
4001 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
4002 (defun gnus-group-apropos (regexp &optional search-description)
4003   "List all newsgroups that have names that match a regexp."
4004   (interactive "sGnus apropos (regexp): ")
4005   (let ((prev "")
4006         (obuf (current-buffer))
4007         groups des)
4008     ;; Go through all newsgroups that are known to Gnus.
4009     (mapatoms
4010      (lambda (group)
4011        (and (symbol-name group)
4012             (string-match regexp (symbol-name group))
4013             (symbol-value group)
4014             (push (symbol-name group) groups)))
4015      gnus-active-hashtb)
4016     ;; Also go through all descriptions that are known to Gnus.
4017     (when search-description
4018       (mapatoms
4019        (lambda (group)
4020          (and (string-match regexp (symbol-value group))
4021               (push (symbol-name group) groups)))
4022        gnus-description-hashtb))
4023     (if (not groups)
4024         (gnus-message 3 "No groups matched \"%s\"." regexp)
4025       ;; Print out all the groups.
4026       (save-excursion
4027         (pop-to-buffer "*Gnus Help*")
4028         (buffer-disable-undo)
4029         (erase-buffer)
4030         (setq groups (sort groups 'string<))
4031         (while groups
4032           ;; Groups may be entered twice into the list of groups.
4033           (when (not (string= (car groups) prev))
4034             (setq prev (car groups))
4035             (let ((charset (gnus-group-name-charset nil prev)))
4036               (insert (gnus-group-name-decode prev charset) "\n")
4037               (when (and gnus-description-hashtb
4038                          (setq des (gnus-gethash (car groups)
4039                                                  gnus-description-hashtb)))
4040                 (insert "  " (gnus-group-name-decode des charset) "\n"))))
4041           (setq groups (cdr groups)))
4042         (goto-char (point-min))))
4043     (pop-to-buffer obuf)))
4044
4045 (defun gnus-group-description-apropos (regexp)
4046   "List all newsgroups that have names or descriptions that match REGEXP."
4047   (interactive "sGnus description apropos (regexp): ")
4048   (when (not (or gnus-description-hashtb
4049                  (gnus-read-all-descriptions-files)))
4050     (error "Couldn't request descriptions file"))
4051   (gnus-group-apropos regexp t))
4052
4053 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4054 (defun gnus-group-list-matching (level regexp &optional all lowest)
4055   "List all groups with unread articles that match REGEXP.
4056 If the prefix LEVEL is non-nil, it should be a number that says which
4057 level to cut off listing groups.
4058 If ALL, also list groups with no unread articles.
4059 If LOWEST, don't list groups with level lower than LOWEST.
4060
4061 This command may read the active file."
4062   (interactive "P\nsList newsgroups matching: ")
4063   ;; First make sure active file has been read.
4064   (when (and level
4065              (> (prefix-numeric-value level) gnus-level-killed))
4066     (gnus-get-killed-groups))
4067   (funcall gnus-group-prepare-function
4068    (or level gnus-level-subscribed) (and all t) (or lowest 1) regexp)
4069   (goto-char (point-min))
4070   (gnus-group-position-point))
4071
4072 (defun gnus-group-list-all-matching (level regexp &optional lowest)
4073   "List all groups that match REGEXP.
4074 If the prefix LEVEL is non-nil, it should be a number that says which
4075 level to cut off listing groups.
4076 If LOWEST, don't list groups with level lower than LOWEST."
4077   (interactive "P\nsList newsgroups matching: ")
4078   (when level
4079     (setq level (prefix-numeric-value level)))
4080   (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
4081
4082 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
4083 (defun gnus-group-save-newsrc (&optional force)
4084   "Save the Gnus startup files.
4085 If FORCE, force saving whether it is necessary or not."
4086   (interactive "P")
4087   (gnus-save-newsrc-file force))
4088
4089 (defun gnus-group-restart (&optional arg)
4090   "Force Gnus to read the .newsrc file."
4091   (interactive "P")
4092   (when (gnus-yes-or-no-p
4093          (format "Are you sure you want to restart Gnus? "))
4094     (gnus-save-newsrc-file)
4095     (gnus-clear-system)
4096     (gnus)))
4097
4098 (defun gnus-group-read-init-file ()
4099   "Read the Gnus elisp init file."
4100   (interactive)
4101   (gnus-read-init-file)
4102   (gnus-message 5 "Read %s" gnus-init-file))
4103
4104 (defun gnus-group-check-bogus-groups (&optional silent)
4105   "Check bogus newsgroups.
4106 If given a prefix, don't ask for confirmation before removing a bogus
4107 group."
4108   (interactive "P")
4109   (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
4110   (gnus-group-list-groups))
4111
4112 (defun gnus-group-find-new-groups (&optional arg)
4113   "Search for new groups and add them.
4114 Each new group will be treated with `gnus-subscribe-newsgroup-method'.
4115 With 1 C-u, use the `ask-server' method to query the server for new
4116 groups.
4117 With 2 C-u's, use most complete method possible to query the server
4118 for new groups, and subscribe the new groups as zombies."
4119   (interactive "p")
4120   (gnus-find-new-newsgroups (or arg 1))
4121   (gnus-group-list-groups))
4122
4123 (defun gnus-group-edit-global-kill (&optional article group)
4124   "Edit the global kill file.
4125 If GROUP, edit that local kill file instead."
4126   (interactive "P")
4127   (setq gnus-current-kill-article article)
4128   (gnus-kill-file-edit-file group)
4129   (gnus-message
4130    6
4131    (substitute-command-keys
4132     (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
4133             (if group "local" "global")))))
4134
4135 (defun gnus-group-edit-local-kill (article group)
4136   "Edit a local kill file."
4137   (interactive (list nil (gnus-group-group-name)))
4138   (gnus-group-edit-global-kill article group))
4139
4140 (defun gnus-group-force-update ()
4141   "Update `.newsrc' file."
4142   (interactive)
4143   (gnus-save-newsrc-file))
4144
4145 (defvar gnus-backlog-articles)
4146
4147 (defun gnus-group-suspend ()
4148   "Suspend the current Gnus session.
4149 In fact, cleanup buffers except for group mode buffer.
4150 The hook `gnus-suspend-gnus-hook' is called before actually suspending."
4151   (interactive)
4152   (gnus-run-hooks 'gnus-suspend-gnus-hook)
4153   (gnus-offer-save-summaries)
4154   ;; Kill Gnus buffers except for group mode buffer.
4155   (let ((group-buf (get-buffer gnus-group-buffer)))
4156     (mapcar (lambda (buf)
4157               (unless (or (member buf (list group-buf gnus-dribble-buffer))
4158                           (with-current-buffer buf
4159                             (eq major-mode 'message-mode)))
4160                 (gnus-kill-buffer buf)))
4161             (gnus-buffers))
4162     (setq gnus-backlog-articles nil)
4163     (gnus-kill-gnus-frames)
4164     (when group-buf
4165       (bury-buffer group-buf)
4166       (delete-windows-on group-buf t))))
4167
4168 (defun gnus-group-clear-dribble ()
4169   "Clear all information from the dribble buffer."
4170   (interactive)
4171   (gnus-dribble-clear)
4172   (gnus-message 7 "Cleared dribble buffer"))
4173
4174 (defun gnus-group-exit ()
4175   "Quit reading news after updating .newsrc.eld and .newsrc.
4176 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4177   (interactive)
4178   (when
4179       (or noninteractive                ;For gnus-batch-kill
4180           (not gnus-interactive-exit)   ;Without confirmation
4181           gnus-expert-user
4182           (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
4183     (gnus-run-hooks 'gnus-exit-gnus-hook)
4184     ;; Offer to save data from non-quitted summary buffers.
4185     (gnus-offer-save-summaries)
4186     ;; Save the newsrc file(s).
4187     (gnus-save-newsrc-file)
4188     ;; Kill-em-all.
4189     (gnus-close-backends)
4190     ;; Reset everything.
4191     (gnus-clear-system)
4192     ;; Allow the user to do things after cleaning up.
4193     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4194
4195 (defun gnus-group-quit ()
4196   "Quit reading news without updating .newsrc.eld or .newsrc.
4197 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4198   (interactive)
4199   (when (or noninteractive              ;For gnus-batch-kill
4200             (zerop (buffer-size))
4201             (not (gnus-server-opened gnus-select-method))
4202             gnus-expert-user
4203             (not gnus-current-startup-file)
4204             (gnus-yes-or-no-p
4205              (format "Quit reading news without saving %s? "
4206                      (file-name-nondirectory gnus-current-startup-file))))
4207     (gnus-run-hooks 'gnus-exit-gnus-hook)
4208     (gnus-configure-windows 'group t)
4209     (when (and (gnus-buffer-live-p gnus-dribble-buffer)
4210                (not (zerop (save-excursion
4211                             (set-buffer gnus-dribble-buffer)
4212                             (buffer-size)))))
4213       (gnus-dribble-enter
4214        ";;; Gnus was exited on purpose without saving the .newsrc files."))
4215     (gnus-dribble-save)
4216     (gnus-close-backends)
4217     (gnus-clear-system)
4218     (gnus-kill-buffer gnus-group-buffer)
4219     ;; Allow the user to do things after cleaning up.
4220     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4221
4222 (defun gnus-group-describe-briefly ()
4223   "Give a one line description of the group mode commands."
4224   (interactive)
4225   (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")))
4226
4227 (defun gnus-group-browse-foreign-server (method)
4228   "Browse a foreign news server.
4229 If called interactively, this function will ask for a select method
4230  (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
4231 If not, METHOD should be a list where the first element is the method
4232 and the second element is the address."
4233   (interactive
4234    (list (let ((how (completing-read
4235                      "Which back end: "
4236                      (append gnus-valid-select-methods gnus-server-alist)
4237                      nil t (cons "nntp" 0) 'gnus-method-history)))
4238            ;; We either got a back end name or a virtual server name.
4239            ;; If the first, we also need an address.
4240            (if (assoc how gnus-valid-select-methods)
4241                (list (intern how)
4242                      ;; Suggested by mapjph@bath.ac.uk.
4243                      (completing-read
4244                       "Address: "
4245                       (mapcar 'list gnus-secondary-servers)))
4246              ;; We got a server name.
4247              how))))
4248   (gnus-browse-foreign-server method))
4249
4250 (defun gnus-group-set-info (info &optional method-only-group part)
4251   (when (or info part)
4252     (let* ((entry (gnus-group-entry
4253                    (or method-only-group (gnus-info-group info))))
4254            (part-info info)
4255            (info (if method-only-group (nth 2 entry) info))
4256            method)
4257       (when method-only-group
4258         (unless entry
4259           (error "Trying to change non-existent group %s" method-only-group))
4260         ;; We have received parts of the actual group info - either the
4261         ;; select method or the group parameters.        We first check
4262         ;; whether we have to extend the info, and if so, do that.
4263         (let ((len (length info))
4264               (total (if (eq part 'method) 5 6)))
4265           (when (< len total)
4266             (setcdr (nthcdr (1- len) info)
4267                     (make-list (- total len) nil)))
4268           ;; Then we enter the new info.
4269           (setcar (nthcdr (1- total) info) part-info)))
4270       (unless entry
4271         ;; This is a new group, so we just create it.
4272         (save-excursion
4273           (set-buffer gnus-group-buffer)
4274           (setq method (gnus-info-method info))
4275           (when (gnus-server-equal method "native")
4276             (setq method nil))
4277           (save-excursion
4278             (set-buffer gnus-group-buffer)
4279             (if method
4280                 ;; It's a foreign group...
4281                 (gnus-group-make-group
4282                  (gnus-group-real-name (gnus-info-group info))
4283                  (if (stringp method) method
4284                    (prin1-to-string (car method)))
4285                  (and (consp method)
4286                       (nth 1 (gnus-info-method info))))
4287               ;; It's a native group.
4288               (gnus-group-make-group (gnus-info-group info))))
4289           (gnus-message 6 "Note: New group created")
4290           (setq entry
4291                 (gnus-group-entry (gnus-group-prefixed-name
4292                                    (gnus-group-real-name (gnus-info-group info))
4293                                    (or (gnus-info-method info) gnus-select-method))))))
4294       ;; Whether it was a new group or not, we now have the entry, so we
4295       ;; can do the update.
4296       (if entry
4297           (progn
4298             (setcar (nthcdr 2 entry) info)
4299             (when (and (not (eq (car entry) t))
4300                        (gnus-active (gnus-info-group info)))
4301               (setcar entry (length
4302                              (gnus-list-of-unread-articles (car info))))))
4303         (error "No such group: %s" (gnus-info-group info))))))
4304
4305 (defun gnus-group-set-method-info (group select-method)
4306   (gnus-group-set-info select-method group 'method))
4307
4308 (defun gnus-group-set-params-info (group params)
4309   (gnus-group-set-info params group 'params))
4310
4311 (defun gnus-add-marked-articles (group type articles &optional info force)
4312   ;; Add ARTICLES of TYPE to the info of GROUP.
4313   ;; If INFO is non-nil, use that info.  If FORCE is non-nil, don't
4314   ;; add, but replace marked articles of TYPE with ARTICLES.
4315   (let ((info (or info (gnus-get-info group)))
4316         marked m)
4317     (or (not info)
4318         (and (not (setq marked (nthcdr 3 info)))
4319              (or (null articles)
4320                  (setcdr (nthcdr 2 info)
4321                          (list (list (cons type (gnus-compress-sequence
4322                                                  articles t)))))))
4323         (and (not (setq m (assq type (car marked))))
4324              (or (null articles)
4325                  (setcar marked
4326                          (cons (cons type (gnus-compress-sequence articles t) )
4327                                (car marked)))))
4328         (if force
4329             (if (null articles)
4330                 (setcar (nthcdr 3 info)
4331                         (gnus-delete-alist type (car marked)))
4332               (setcdr m (gnus-compress-sequence articles t)))
4333           (setcdr m (gnus-compress-sequence
4334                      (sort (nconc (gnus-uncompress-range (cdr m))
4335                                   (copy-sequence articles)) '<) t))))))
4336
4337 (defun gnus-add-mark (group mark article)
4338   "Mark ARTICLE in GROUP with MARK, whether the group is displayed or not."
4339   (let ((buffer (gnus-summary-buffer-name group)))
4340     (if (gnus-buffer-live-p buffer)
4341         (save-excursion
4342           (set-buffer (get-buffer buffer))
4343           (gnus-summary-add-mark article mark))
4344       (gnus-add-marked-articles group (cdr (assq mark gnus-article-mark-lists))
4345                                 (list article)))))
4346
4347 ;;;
4348 ;;; Group timestamps
4349 ;;;
4350
4351 (defun gnus-group-set-timestamp ()
4352   "Change the timestamp of the current group to the current time.
4353 This function can be used in hooks like `gnus-select-group-hook'
4354 or `gnus-group-catchup-group-hook'."
4355   (when gnus-newsgroup-name
4356     (let ((time (current-time)))
4357       (setcdr (cdr time) nil)
4358       (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
4359
4360 (defsubst gnus-group-timestamp (group)
4361   "Return the timestamp for GROUP."
4362   (gnus-group-get-parameter group 'timestamp t))
4363
4364 (defun gnus-group-timestamp-delta (group)
4365   "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
4366   (let* ((time (or (gnus-group-timestamp group)
4367                    (list 0 0)))
4368          (delta (subtract-time (current-time) time)))
4369     (+ (* (nth 0 delta) 65536.0)
4370        (nth 1 delta))))
4371
4372 (defun gnus-group-timestamp-string (group)
4373   "Return a string of the timestamp for GROUP."
4374   (let ((time (gnus-group-timestamp group)))
4375     (if (not time)
4376         ""
4377       (gnus-time-iso8601 time))))
4378
4379 (defun gnus-group-list-cached (level &optional lowest)
4380   "List all groups with cached articles.
4381 If the prefix LEVEL is non-nil, it should be a number that says which
4382 level to cut off listing groups.
4383 If LOWEST, don't list groups with level lower than LOWEST.
4384
4385 This command may read the active file."
4386   (interactive "P")
4387   (when level
4388     (setq level (prefix-numeric-value level)))
4389   (when (or (not level) (>= level gnus-level-zombie))
4390     (gnus-cache-open))
4391   (funcall gnus-group-prepare-function
4392            (or level gnus-level-subscribed)
4393            #'(lambda (info)
4394                (let ((marks (gnus-info-marks info)))
4395                  (assq 'cache marks)))
4396            lowest
4397            #'(lambda (group)
4398                (or (gnus-gethash group
4399                                  gnus-cache-active-hashtb)
4400                    ;; Cache active file might use "."
4401                    ;; instead of ":".
4402                    (gnus-gethash
4403                     (mapconcat 'identity
4404                                (split-string group ":")
4405                                ".")
4406                     gnus-cache-active-hashtb))))
4407   (goto-char (point-min))
4408   (gnus-group-position-point))
4409
4410 (defun gnus-group-list-dormant (level &optional lowest)
4411   "List all groups with dormant articles.
4412 If the prefix LEVEL is non-nil, it should be a number that says which
4413 level to cut off listing groups.
4414 If LOWEST, don't list groups with level lower than LOWEST.
4415
4416 This command may read the active file."
4417   (interactive "P")
4418   (when level
4419     (setq level (prefix-numeric-value level)))
4420   (when (or (not level) (>= level gnus-level-zombie))
4421     (gnus-cache-open))
4422   (funcall gnus-group-prepare-function
4423            (or level gnus-level-subscribed)
4424            #'(lambda (info)
4425                (let ((marks (gnus-info-marks info)))
4426                  (assq 'dormant marks)))
4427            lowest
4428            'ignore)
4429   (goto-char (point-min))
4430   (gnus-group-position-point))
4431
4432 (defun gnus-group-listed-groups ()
4433   "Return a list of listed groups."
4434   (let (point groups)
4435     (goto-char (point-min))
4436     (while (setq point (text-property-not-all (point) (point-max)
4437                                               'gnus-group nil))
4438       (goto-char point)
4439       (push (symbol-name (get-text-property point 'gnus-group)) groups)
4440       (forward-char 1))
4441     groups))
4442
4443 (defun gnus-group-list-plus (&optional args)
4444   "List groups plus the current selection."
4445   (interactive "P")
4446   (let ((gnus-group-listed-groups (gnus-group-listed-groups))
4447         (gnus-group-list-mode gnus-group-list-mode) ;; Save it.
4448         func)
4449     (push last-command-event unread-command-events)
4450     (if (featurep 'xemacs)
4451         (push (make-event 'key-press '(key ?A)) unread-command-events)
4452       (push ?A unread-command-events))
4453     (let (gnus-pick-mode keys)
4454       (setq keys (if (featurep 'xemacs)
4455                      (events-to-keys (read-key-sequence nil))
4456                    (read-key-sequence nil)))
4457       (setq func (lookup-key (current-local-map) keys)))
4458     (if (or (not func)
4459             (numberp func))
4460         (ding)
4461       (call-interactively func))))
4462
4463 (defun gnus-group-list-flush (&optional args)
4464   "Flush groups from the current selection."
4465   (interactive "P")
4466   (let ((gnus-group-list-option 'flush))
4467     (gnus-group-list-plus args)))
4468
4469 (defun gnus-group-list-limit (&optional args)
4470   "List groups limited within the current selection."
4471   (interactive "P")
4472   (let ((gnus-group-list-option 'limit))
4473     (gnus-group-list-plus args)))
4474
4475 (defun gnus-group-mark-article-read (group article)
4476   "Mark ARTICLE read."
4477   (let ((buffer (gnus-summary-buffer-name group))
4478         (mark gnus-read-mark)
4479         active n)
4480     (if (get-buffer buffer)
4481         (with-current-buffer buffer
4482           (setq active gnus-newsgroup-active)
4483           (gnus-activate-group group)
4484           (when gnus-newsgroup-prepared
4485             (when (and gnus-newsgroup-auto-expire
4486                        (memq mark gnus-auto-expirable-marks))
4487               (setq mark gnus-expirable-mark))
4488             (setq mark (gnus-request-update-mark
4489                         group article mark))
4490             (gnus-mark-article-as-read article mark)
4491             (setq gnus-newsgroup-active (gnus-active group))
4492             (when active
4493               (setq n (1+ (cdr active)))
4494               (while (<= n (cdr gnus-newsgroup-active))
4495                 (unless (eq n article)
4496                   (push n gnus-newsgroup-unselected))
4497                 (setq n (1+ n)))
4498               (setq gnus-newsgroup-unselected
4499                     (nreverse gnus-newsgroup-unselected)))))
4500       (gnus-activate-group group)
4501       (gnus-group-make-articles-read group (list article))
4502       (when (gnus-group-auto-expirable-p group)
4503         (gnus-add-marked-articles
4504          group 'expire (list article))))))
4505
4506
4507 ;;;
4508 ;;; Group compaction. -- dvl
4509 ;;;
4510
4511 (defun gnus-group-compact-group (group)
4512   "Compact the current group.
4513 Compaction means removing gaps between article numbers.  Hence, this
4514 operation is only meaningful for back ends using one file per article
4515 \(e.g. nnml).
4516
4517 Note: currently only implemented in nnml."
4518   (interactive (list (gnus-group-group-name)))
4519   (unless group
4520     (error "No group to compact"))
4521   (unless (gnus-check-backend-function 'request-compact-group group)
4522     (error "This back end does not support group compaction"))
4523   (let ((group-decoded (gnus-group-decoded-name group)))
4524     (gnus-message 6 "\
4525 Compacting group %s... (this may take a long time)"
4526                   group-decoded)
4527     (prog1
4528         (if (not (gnus-request-compact-group group))
4529             (gnus-error 3 "Couldn't compact group %s" group-decoded)
4530           (gnus-message 6 "Compacting group %s...done" group-decoded)
4531           t)
4532       ;; Invalidate the "original article" buffer which might be out of date.
4533       ;; #### NOTE: Yes, this might be a bit rude, but since compaction
4534       ;; #### will not happen very often, I think this is acceptable.
4535       (let ((original (get-buffer gnus-original-article-buffer)))
4536         (and original (gnus-kill-buffer original)))
4537       ;; Update the group line to reflect new information (art number etc).
4538       (gnus-group-update-group-line))))
4539
4540 (provide 'gnus-group)
4541
4542 ;;; arch-tag: 2eb5440f-0bca-4091-814c-e37817536af6
4543 ;;; gnus-group.el ends here