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