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