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