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