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