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