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