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