* message.el: Require gmm-utils, remove autoloads.
[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-mode))
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 ;; Work around for Emacs not updating the tool bar, see
1003 ; http://www.google.com/groups?as_umsgid=v9u0an3hti.fsf@marauder.physik.uni-ulm.de
1004 (defvar gnus-group-redraw-when-idle 2
1005   "When non-nil, redraw the Group buffer frame when idle.
1006 Internal variable.")
1007 ;; Don't make this customizable yet.
1008
1009 (defun gnus-group-redraw-check ()
1010   "Check if we need to redraw the frame."
1011   (when (and gnus-group-redraw-when-idle
1012              (not (featurep 'xemacs))
1013              (boundp 'tool-bar-mode)
1014              tool-bar-mode)
1015     ;;(run-with-idle-timer gnus-group-redraw-when-idle
1016     ;;                   nil 'redraw-frame (selected-frame))
1017     (run-with-idle-timer gnus-group-redraw-when-idle
1018                          nil 'force-window-update)
1019     t))
1020
1021 (defun gnus-group-tool-bar-update (&optional symbol value)
1022   "Update group buffer toolbar.
1023 Setter function for custom variables."
1024   (when symbol
1025     (set-default symbol value))
1026   ;; (setq-default gnus-group-tool-bar-map nil)
1027   ;; (use-local-map gnus-group-mode-map)
1028   (when (gnus-alive-p)
1029     (with-current-buffer gnus-group-buffer
1030       (gnus-group-make-tool-bar t))))
1031
1032 (defcustom gnus-group-tool-bar (if (eq gmm-tool-bar-style 'gnome)
1033                                    'gnus-group-tool-bar-gnome
1034                                  'gnus-group-tool-bar-retro)
1035   "Specifies the Gnus group tool bar.
1036
1037 It can be either a list or a symbol refering to a list.  See
1038 `gmm-tool-bar-from-list' for the format of the list.  The
1039 default key map is `gnus-group-mode-map'.
1040
1041 Pre-defined symbols include `gnus-group-tool-bar-gnome' and
1042 `gnus-group-tool-bar-retro'."
1043   :type '(choice (const :tag "GNOME style" gnus-group-tool-bar-gnome)
1044                  (const :tag "Retro look" gnus-group-tool-bar-retro)
1045                  (repeat :tag "User defined list" gmm-tool-bar-item)
1046                  (symbol))
1047   :version "23.0" ;; No Gnus
1048   :initialize 'custom-initialize-default
1049   :set 'gnus-group-tool-bar-update
1050   :group 'gnus-group)
1051
1052 (defcustom gnus-group-tool-bar-gnome
1053   '((gnus-group-post-news "mail/compose")
1054     ;; Some useful agent icons?  I don't use the agent so agent users should
1055     ;; suggest useful commands:
1056     (gnus-agent-toggle-plugged "connect" t
1057                                :visible (and gnus-agent (not gnus-plugged)))
1058     (gnus-agent-toggle-plugged "disconnect" t
1059                                :visible (and gnus-agent gnus-plugged))
1060     ;; FIXME: gnus-agent-toggle-plugged (in gnus-agent-group-make-menu-bar)
1061     ;; should have a better help text.
1062     (gnus-group-send-queue "mail/outbox" t
1063                            :visible (and gnus-agent gnus-plugged)
1064                            :help "Send articles from the queue group")
1065     (gnus-group-get-new-news "mail/inbox" nil
1066                              :visible (or (not gnus-agent)
1067                                           gnus-plugged))
1068     ;; FIXME: gnus-*-read-group should have a better help text.
1069     (gnus-topic-read-group "open" nil :visible gnus-topic-mode)
1070     (gnus-group-read-group "open" nil :visible (not gnus-topic-mode))
1071     ;; (gnus-group-find-new-groups "???" nil)
1072     (gnus-group-save-newsrc "save")
1073     (gnus-group-describe-group "describe")
1074     (gnus-group-unsubscribe-current-group "gnus/toggle-subscription")
1075     (gnus-group-prev-unread-group "left-arrow")
1076     (gnus-group-next-unread-group "right-arrow")
1077     (gnus-group-exit "exit")
1078     (gmm-customize-mode "preferences" t :help "Edit mode preferences")
1079     (gnus-info-find-node "help"))
1080   "List of functions for the group tool bar (GNOME style).
1081
1082 See `gmm-tool-bar-from-list' for the format of the list."
1083   :type '(repeat gmm-tool-bar-item)
1084   :version "23.0" ;; No Gnus
1085   :initialize 'custom-initialize-default
1086   :set 'gnus-group-tool-bar-update
1087   :group 'gnus-group)
1088
1089 (defcustom gnus-group-tool-bar-retro
1090   '((gnus-group-get-new-news "gnus/get-news")
1091     (gnus-group-get-new-news-this-group "gnus/gnntg")
1092     (gnus-group-catchup-current "gnus/catchup")
1093     (gnus-group-describe-group "gnus/describe-group")
1094     (gnus-group-subscribe "gnus/subscribe" t
1095                           :help "Subscribe to the current group")
1096     (gnus-group-unsubscribe "gnus/unsubscribe" t
1097                             :help "Unsubscribe from the current group")
1098     (gnus-group-exit "gnus/exit-gnus" gnus-group-mode-map))
1099   "List of functions for the group tool bar (retro look).
1100
1101 See `gmm-tool-bar-from-list' for the format of the list."
1102   :type '(repeat gmm-tool-bar-item)
1103   :version "23.0" ;; No Gnus
1104   :initialize 'custom-initialize-default
1105   :set 'gnus-group-tool-bar-update
1106   :group 'gnus-group)
1107
1108 ;; FIXME: Moving through the Group buffer (in topic mode) e.g. with C-n
1109 ;; doesn't update the state (enabled/disabled) of the icon
1110 ;; `gnus-group-describe-group'.  After `C-l' the state is correct.
1111 ;; See the following report on emacs-devel
1112 ;; <http://thread.gmane.org/v9acdmrcse.fsf@marauder.physik.uni-ulm.de>:
1113 ;; From: Reiner Steib
1114 ;; Subject: tool bar icons not updated according to :active condition
1115 ;; Newsgroups: gmane.emacs.devel
1116 ;; Date: Mon, 23 Jan 2006 19:59:13 +0100
1117 ;; Message-ID: <v9acdmrcse.fsf@marauder.physik.uni-ulm.de>
1118
1119 (defcustom gnus-group-tool-bar-zap-list t
1120   "List of icon items from the global tool bar.
1121 These items are not displayed in the Gnus group mode tool bar.
1122
1123 See `gmm-tool-bar-from-list' for the format of the list."
1124   :type 'gmm-tool-bar-zap-list
1125   :version "23.0" ;; No Gnus
1126   :initialize 'custom-initialize-default
1127   :set 'gnus-group-tool-bar-update
1128   :group 'gnus-group)
1129
1130 (defun gnus-group-make-tool-bar (&optional force)
1131   "Make a group mode tool bar from `gnus-group-tool-bar'.
1132 When FORCE, rebuild the tool bar."
1133   (when (and (not (featurep 'xemacs))
1134              (boundp 'tool-bar-mode)
1135              tool-bar-mode
1136              ;; The Gnus 5.10.6 code checked (default-value 'tool-bar-mode).
1137              ;; Why?  --rsteib
1138              (or (not gnus-group-tool-bar-map) force))
1139     (when gnus-group-redraw-when-idle
1140       (add-to-list (make-local-variable 'post-command-hook)
1141                    'gnus-group-redraw-check))
1142     (let* ((load-path
1143             (gmm-image-load-path "gnus" "gnus/toggle-subscription.xpm"
1144                                  'load-path))
1145            (image-load-path
1146             (gmm-image-load-path "gnus" "gnus/toggle-subscription.xpm"
1147                                  'image-load-path))
1148            (map (gmm-tool-bar-from-list gnus-group-tool-bar
1149                                         gnus-group-tool-bar-zap-list
1150                                         'gnus-group-mode-map)))
1151       (if map
1152           (set (make-local-variable 'tool-bar-map) map))))
1153   gnus-group-tool-bar-map)
1154
1155 (defun gnus-group-mode ()
1156   "Major mode for reading news.
1157
1158 All normal editing commands are switched off.
1159 \\<gnus-group-mode-map>
1160 The group buffer lists (some of) the groups available.  For instance,
1161 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
1162 lists all zombie groups.
1163
1164 Groups that are displayed can be entered with `\\[gnus-group-read-group]'.  To subscribe
1165 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
1166
1167 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
1168
1169 The following commands are available:
1170
1171 \\{gnus-group-mode-map}"
1172   (interactive)
1173   (kill-all-local-variables)
1174   (when (gnus-visual-p 'group-menu 'menu)
1175     (gnus-group-make-menu-bar)
1176     (gnus-group-make-tool-bar))
1177   (gnus-simplify-mode-line)
1178   (setq major-mode 'gnus-group-mode)
1179   (setq mode-name "Group")
1180   (gnus-group-set-mode-line)
1181   (setq mode-line-process nil)
1182   (use-local-map gnus-group-mode-map)
1183   (buffer-disable-undo)
1184   (setq truncate-lines t)
1185   (setq buffer-read-only t
1186         show-trailing-whitespace nil)
1187   (gnus-set-default-directory)
1188   (gnus-update-format-specifications nil 'group 'group-mode)
1189   (gnus-update-group-mark-positions)
1190   (when gnus-use-undo
1191     (gnus-undo-mode 1))
1192   (when gnus-slave
1193     (gnus-slave-mode))
1194   (gnus-run-mode-hooks 'gnus-group-mode-hook))
1195
1196 (defun gnus-update-group-mark-positions ()
1197   (save-excursion
1198     (let ((gnus-process-mark ?\200)
1199           (gnus-group-update-hook nil)
1200           (gnus-group-marked '("dummy.group"))
1201           (gnus-active-hashtb (make-vector 10 0))
1202           (topic ""))
1203       (gnus-set-active "dummy.group" '(0 . 0))
1204       (gnus-set-work-buffer)
1205       (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
1206       (goto-char (point-min))
1207       (setq gnus-group-mark-positions
1208             (list (cons 'process (and (search-forward
1209                                        (mm-string-as-multibyte "\200") nil t)
1210                                       (- (point) 2))))))))
1211
1212 (defun gnus-mouse-pick-group (e)
1213   "Enter the group under the mouse pointer."
1214   (interactive "e")
1215   (mouse-set-point e)
1216   (gnus-group-read-group nil))
1217
1218 ;; Look at LEVEL and find out what the level is really supposed to be.
1219 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
1220 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
1221 (defun gnus-group-default-level (&optional level number-or-nil)
1222   (cond
1223    (gnus-group-use-permanent-levels
1224     (or (setq gnus-group-use-permanent-levels
1225               (or level (if (numberp gnus-group-use-permanent-levels)
1226                             gnus-group-use-permanent-levels
1227                           (or gnus-group-default-list-level
1228                               gnus-level-subscribed))))
1229         gnus-group-default-list-level gnus-level-subscribed))
1230    (number-or-nil
1231     level)
1232    (t
1233     (or level gnus-group-default-list-level gnus-level-subscribed))))
1234
1235 (defun gnus-group-setup-buffer ()
1236   (set-buffer (gnus-get-buffer-create gnus-group-buffer))
1237   (unless (eq major-mode 'gnus-group-mode)
1238     (gnus-group-mode)
1239     (when gnus-carpal
1240       (gnus-carpal-setup-buffer 'group))))
1241
1242 (defun gnus-group-name-charset (method group)
1243   (if (null method)
1244       (setq method (gnus-find-method-for-group group)))
1245   (let ((item (assoc method gnus-group-name-charset-method-alist))
1246         (alist gnus-group-name-charset-group-alist)
1247         result)
1248     (if item
1249         (cdr item)
1250       (while (setq item (pop alist))
1251         (if (string-match (car item) group)
1252             (setq alist nil
1253                   result (cdr item))))
1254       result)))
1255
1256 (defun gnus-group-name-decode (string charset)
1257   ;; Fixme: Don't decode in unibyte mode.
1258   (if (and string charset (featurep 'mule))
1259       (mm-decode-coding-string string charset)
1260     string))
1261
1262 (defun gnus-group-decoded-name (string)
1263   (let ((charset (gnus-group-name-charset nil string)))
1264     (gnus-group-name-decode string charset)))
1265
1266 (defun gnus-group-list-groups (&optional level unread lowest)
1267   "List newsgroups with level LEVEL or lower that have unread articles.
1268 Default is all subscribed groups.
1269 If argument UNREAD is non-nil, groups with no unread articles are also
1270 listed.
1271
1272 Also see the `gnus-group-use-permanent-levels' variable."
1273   (interactive
1274    (list (if current-prefix-arg
1275              (prefix-numeric-value current-prefix-arg)
1276            (or
1277             (gnus-group-default-level nil t)
1278             gnus-group-default-list-level
1279             gnus-level-subscribed))))
1280   (unless level
1281     (setq level (car gnus-group-list-mode)
1282           unread (cdr gnus-group-list-mode)))
1283   (setq level (gnus-group-default-level level))
1284   (gnus-group-setup-buffer)
1285   (gnus-update-format-specifications nil 'group 'group-mode)
1286   (let ((case-fold-search nil)
1287         (props (text-properties-at (point-at-bol)))
1288         (empty (= (point-min) (point-max)))
1289         (group (gnus-group-group-name))
1290         number)
1291     (set-buffer gnus-group-buffer)
1292     (setq number (funcall gnus-group-prepare-function level unread lowest))
1293     (when (or (and (numberp number)
1294                    (zerop number))
1295               (zerop (buffer-size)))
1296       ;; No groups in the buffer.
1297       (gnus-message 5 gnus-no-groups-message))
1298     ;; We have some groups displayed.
1299     (goto-char (point-max))
1300     (when (or (not gnus-group-goto-next-group-function)
1301               (not (funcall gnus-group-goto-next-group-function
1302                             group props)))
1303       (cond
1304        (empty
1305         (goto-char (point-min)))
1306        ((not group)
1307         ;; Go to the first group with unread articles.
1308         (gnus-group-search-forward t))
1309        (t
1310         ;; Find the right group to put point on.  If the current group
1311         ;; has disappeared in the new listing, try to find the next
1312         ;; one.  If no next one can be found, just leave point at the
1313         ;; first newsgroup in the buffer.
1314         (when (not (gnus-goto-char
1315                     (text-property-any
1316                      (point-min) (point-max)
1317                      'gnus-group (gnus-intern-safe
1318                                   group gnus-active-hashtb))))
1319           (let ((newsrc (cdddr (gnus-group-entry group))))
1320             (while (and newsrc
1321                         (not (gnus-goto-char
1322                               (text-property-any
1323                                (point-min) (point-max) 'gnus-group
1324                                (gnus-intern-safe
1325                                 (caar newsrc) gnus-active-hashtb)))))
1326               (setq newsrc (cdr newsrc)))
1327             (unless newsrc
1328               (goto-char (point-max))
1329               (forward-line -1)))))))
1330     ;; Adjust cursor point.
1331     (gnus-group-position-point)))
1332
1333 (defun gnus-group-list-level (level &optional all)
1334   "List groups on LEVEL.
1335 If ALL (the prefix), also list groups that have no unread articles."
1336   (interactive "nList groups on level: \nP")
1337   (gnus-group-list-groups level all level))
1338
1339 (defun gnus-group-prepare-logic (group test)
1340   (or (and gnus-group-listed-groups
1341            (null gnus-group-list-option)
1342            (member group gnus-group-listed-groups))
1343       (cond
1344        ((null gnus-group-listed-groups) test)
1345        ((null gnus-group-list-option) test)
1346        (t (and (member group gnus-group-listed-groups)
1347                (if (eq gnus-group-list-option 'flush)
1348                    (not test)
1349                  test))))))
1350
1351 (defun gnus-group-prepare-flat (level &optional predicate lowest regexp)
1352   "List all newsgroups with unread articles of level LEVEL or lower.
1353 If PREDICATE is a function, list groups that the function returns non-nil;
1354 if it is t, list groups that have no unread articles.
1355 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
1356 If REGEXP is a function, list dead groups that the function returns non-nil;
1357 if it is a string, only list groups matching REGEXP."
1358   (set-buffer gnus-group-buffer)
1359   (let ((buffer-read-only nil)
1360         (newsrc (cdr gnus-newsrc-alist))
1361         (lowest (or lowest 1))
1362         (not-in-list (and gnus-group-listed-groups
1363                           (copy-sequence gnus-group-listed-groups)))
1364         info clevel unread group params)
1365     (erase-buffer)
1366     (when (or (< lowest gnus-level-zombie)
1367               gnus-group-listed-groups)
1368       ;; List living groups.
1369       (while newsrc
1370         (setq info (car newsrc)
1371               group (gnus-info-group info)
1372               params (gnus-info-params info)
1373               newsrc (cdr newsrc)
1374               unread (gnus-group-unread group))
1375         (when not-in-list
1376           (setq not-in-list (delete group not-in-list)))
1377         (when (gnus-group-prepare-logic
1378                group
1379                (and unread              ; This group might be unchecked
1380                     (or (not (stringp regexp))
1381                         (string-match regexp group))
1382                     (<= (setq clevel (gnus-info-level info)) level)
1383                     (>= clevel lowest)
1384                     (cond
1385                      ((functionp predicate)
1386                       (funcall predicate info))
1387                      (predicate t)      ; We list all groups?
1388                      (t
1389                       (or
1390                        (if (eq unread t) ; Unactivated?
1391                            gnus-group-list-inactive-groups
1392                                         ; We list unactivated
1393                          (> unread 0))
1394                                         ; We list groups with unread articles
1395                        (and gnus-list-groups-with-ticked-articles
1396                             (cdr (assq 'tick (gnus-info-marks info))))
1397                                         ; And groups with tickeds
1398                        ;; Check for permanent visibility.
1399                        (and gnus-permanently-visible-groups
1400                             (string-match gnus-permanently-visible-groups
1401                                           group))
1402                        (memq 'visible params)
1403                        (cdr (assq 'visible params)))))))
1404           (gnus-group-insert-group-line
1405            group (gnus-info-level info)
1406            (gnus-info-marks info) unread (gnus-info-method info)))))
1407
1408     ;; List dead groups.
1409     (when (or gnus-group-listed-groups
1410               (and (>= level gnus-level-zombie)
1411                    (<= lowest gnus-level-zombie)))
1412       (gnus-group-prepare-flat-list-dead
1413        (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
1414        gnus-level-zombie ?Z
1415        regexp))
1416     (when not-in-list
1417       (dolist (group gnus-zombie-list)
1418         (setq not-in-list (delete group not-in-list))))
1419     (when (or gnus-group-listed-groups
1420               (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)))
1421       (gnus-group-prepare-flat-list-dead
1422        (gnus-union
1423         not-in-list
1424         (setq gnus-killed-list (sort gnus-killed-list 'string<)))
1425        gnus-level-killed ?K regexp))
1426
1427     (gnus-group-set-mode-line)
1428     (setq gnus-group-list-mode (cons level predicate))
1429     (gnus-run-hooks 'gnus-group-prepare-hook)
1430     t))
1431
1432 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
1433   ;; List zombies and killed lists somewhat faster, which was
1434   ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.  It does
1435   ;; this by ignoring the group format specification altogether.
1436   (let (group)
1437     (if (> (length groups) gnus-group-listing-limit)
1438         (while groups
1439           (setq group (pop groups))
1440           (when (gnus-group-prepare-logic
1441                  group
1442                  (or (not regexp)
1443                      (and (stringp regexp) (string-match regexp group))
1444                      (and (functionp regexp) (funcall regexp group))))
1445             (gnus-add-text-properties
1446              (point) (prog1 (1+ (point))
1447                        (insert " " mark "     *: "
1448                                (gnus-group-decoded-name group)
1449                                "\n"))
1450              (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1451                    'gnus-unread t
1452                    'gnus-level level))))
1453       (while groups
1454         (setq group (pop groups))
1455         (when (gnus-group-prepare-logic
1456                group
1457                (or (not regexp)
1458                    (and (stringp regexp) (string-match regexp group))
1459                    (and (functionp regexp) (funcall regexp group))))
1460           (gnus-group-insert-group-line
1461            group level nil
1462            (let ((active (gnus-active group)))
1463              (if active
1464                  (if (zerop (cdr active))
1465                      0
1466                    (- (1+ (cdr active)) (car active)))
1467                nil))
1468            (gnus-method-simplify (gnus-find-method-for-group group))))))))
1469
1470 (defun gnus-group-update-group-line ()
1471   "Update the current line in the group buffer."
1472   (let* ((buffer-read-only nil)
1473          (group (gnus-group-group-name))
1474          (entry (and group (gnus-group-entry group)))
1475          gnus-group-indentation)
1476     (when group
1477       (and entry
1478            (not (gnus-ephemeral-group-p group))
1479            (gnus-dribble-enter
1480             (concat "(gnus-group-set-info '"
1481                     (gnus-prin1-to-string (nth 2 entry))
1482                     ")")))
1483       (setq gnus-group-indentation (gnus-group-group-indentation))
1484       (gnus-delete-line)
1485       (gnus-group-insert-group-line-info group)
1486       (forward-line -1)
1487       (gnus-group-position-point))))
1488
1489 (defun gnus-group-insert-group-line-info (group)
1490   "Insert GROUP on the current line."
1491   (let ((entry (gnus-group-entry group))
1492         (gnus-group-indentation (gnus-group-group-indentation))
1493         active info)
1494     (if entry
1495         (progn
1496           ;; (Un)subscribed group.
1497           (setq info (nth 2 entry))
1498           (gnus-group-insert-group-line
1499            group (gnus-info-level info) (gnus-info-marks info)
1500            (or (car entry) t) (gnus-info-method info)))
1501       ;; This group is dead.
1502       (gnus-group-insert-group-line
1503        group
1504        (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1505        nil
1506        (if (setq active (gnus-active group))
1507            (if (zerop (cdr active))
1508                0
1509              (- (1+ (cdr active)) (car active)))
1510          nil)
1511        (gnus-method-simplify (gnus-find-method-for-group group))))))
1512
1513 (defun gnus-number-of-unseen-articles-in-group (group)
1514   (let* ((info (nth 2 (gnus-group-entry group)))
1515          (marked (gnus-info-marks info))
1516          (seen (cdr (assq 'seen marked)))
1517          (active (gnus-active group)))
1518     (if (not active)
1519         0
1520       (length (gnus-uncompress-range
1521                (gnus-range-difference
1522                 (gnus-range-difference (list active) (gnus-info-read info))
1523                 seen))))))
1524
1525 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1526                                                     gnus-tmp-marked number
1527                                                     gnus-tmp-method)
1528   "Insert a group line in the group buffer."
1529   (let* ((gnus-tmp-method
1530           (gnus-server-get-method gnus-tmp-group gnus-tmp-method))
1531          (group-name-charset (gnus-group-name-charset gnus-tmp-method
1532                                                       gnus-tmp-group))
1533          (gnus-tmp-active (gnus-active gnus-tmp-group))
1534          (gnus-tmp-number-total
1535           (if gnus-tmp-active
1536               (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1537             0))
1538          (gnus-tmp-number-of-unread
1539           (if (numberp number) (int-to-string (max 0 number))
1540             "*"))
1541          (gnus-tmp-number-of-read
1542           (if (numberp number)
1543               (int-to-string (max 0 (- gnus-tmp-number-total number)))
1544             "*"))
1545          (gnus-tmp-subscribed
1546           (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1547                 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1548                 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1549                 (t ?K)))
1550          (gnus-tmp-qualified-group
1551           (gnus-group-name-decode (gnus-group-real-name gnus-tmp-group)
1552                                   group-name-charset))
1553          (gnus-tmp-comment
1554           (or (gnus-group-get-parameter gnus-tmp-group 'comment t)
1555               gnus-tmp-group))
1556          (gnus-tmp-newsgroup-description
1557           (if gnus-description-hashtb
1558               (or (gnus-group-name-decode
1559                    (gnus-gethash gnus-tmp-group gnus-description-hashtb)
1560                    group-name-charset) "")
1561             ""))
1562          (gnus-tmp-moderated
1563           (if (and gnus-moderated-hashtb
1564                    (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1565               ?m ? ))
1566          (gnus-tmp-moderated-string
1567           (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1568          (gnus-tmp-group-icon "==&&==")
1569          (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1570          (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1571          (gnus-tmp-news-method-string
1572           (if gnus-tmp-method
1573               (format "(%s:%s)" (car gnus-tmp-method)
1574                       (cadr gnus-tmp-method)) ""))
1575          (gnus-tmp-marked-mark
1576           (if (and (numberp number)
1577                    (zerop number)
1578                    (cdr (assq 'tick gnus-tmp-marked)))
1579               ?* ? ))
1580          (gnus-tmp-summary-live
1581           (if (and (not gnus-group-is-exiting-p)
1582                    (gnus-buffer-live-p (gnus-summary-buffer-name
1583                                         gnus-tmp-group)))
1584               ?* ? ))
1585          (gnus-tmp-process-marked
1586           (if (member gnus-tmp-group gnus-group-marked)
1587               gnus-process-mark ? ))
1588          (buffer-read-only nil)
1589          header gnus-tmp-header)        ; passed as parameter to user-funcs.
1590     (beginning-of-line)
1591     (gnus-add-text-properties
1592      (point)
1593      (prog1 (1+ (point))
1594        ;; Insert the text.
1595        (let ((gnus-tmp-decoded-group (gnus-group-name-decode
1596                                       gnus-tmp-group group-name-charset)))
1597          (eval gnus-group-line-format-spec)))
1598      `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1599                   gnus-unread ,(if (numberp number)
1600                                    (string-to-number gnus-tmp-number-of-unread)
1601                                  t)
1602                   gnus-marked ,gnus-tmp-marked-mark
1603                   gnus-indentation ,gnus-group-indentation
1604                   gnus-level ,gnus-tmp-level))
1605     (forward-line -1)
1606     (when (inline (gnus-visual-p 'group-highlight 'highlight))
1607       (gnus-run-hooks 'gnus-group-update-hook))
1608     (forward-line)
1609     ;; Allow XEmacs to remove front-sticky text properties.
1610     (gnus-group-remove-excess-properties)))
1611
1612 (defun gnus-group-highlight-line ()
1613   "Highlight the current line according to `gnus-group-highlight'."
1614   (let* ((list gnus-group-highlight)
1615          (p (point))
1616          (end (point-at-eol))
1617          ;; now find out where the line starts and leave point there.
1618          (beg (progn (beginning-of-line) (point)))
1619          (group (gnus-group-group-name))
1620          (entry (gnus-group-entry group))
1621          (unread (if (numberp (car entry)) (car entry) 0))
1622          (active (gnus-active group))
1623          (total (if active (1+ (- (cdr active) (car active))) 0))
1624          (info (nth 2 entry))
1625          (method (inline (gnus-server-get-method group (gnus-info-method info))))
1626          (marked (gnus-info-marks info))
1627          (mailp (apply 'append
1628                        (mapcar
1629                         (lambda (x)
1630                           (memq x (assoc (symbol-name
1631                                           (car (or method gnus-select-method)))
1632                                          gnus-valid-select-methods)))
1633                         '(mail post-mail))))
1634          (level (or (gnus-info-level info) gnus-level-killed))
1635          (score (or (gnus-info-score info) 0))
1636          (ticked (gnus-range-length (cdr (assq 'tick marked))))
1637          (group-age (gnus-group-timestamp-delta group))
1638          (inhibit-read-only t))
1639     ;; Eval the cars of the lists until we find a match.
1640     (while (and list
1641                 (not (eval (caar list))))
1642       (setq list (cdr list)))
1643     (let ((face (cdar list)))
1644       (unless (eq face (get-text-property beg 'face))
1645         (gnus-put-text-property-excluding-characters-with-faces
1646          beg end 'face
1647          (setq face (if (boundp face) (symbol-value face) face)))
1648         (gnus-extent-start-open beg)))
1649     (goto-char p)))
1650
1651 (defun gnus-group-update-group (group &optional visible-only)
1652   "Update all lines where GROUP appear.
1653 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1654 already."
1655   ;; Can't use `save-excursion' here, so we do it manually.
1656   (let ((buf (current-buffer))
1657         mark)
1658     (set-buffer gnus-group-buffer)
1659     (setq mark (point-marker))
1660     ;; The buffer may be narrowed.
1661     (save-restriction
1662       (widen)
1663       (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1664             (loc (point-min))
1665             found buffer-read-only)
1666         ;; Enter the current status into the dribble buffer.
1667         (let ((entry (gnus-group-entry group)))
1668           (when (and entry
1669                      (not (gnus-ephemeral-group-p group)))
1670             (gnus-dribble-enter
1671              (concat "(gnus-group-set-info '"
1672                      (gnus-prin1-to-string (nth 2 entry))
1673                      ")"))))
1674         ;; Find all group instances.  If topics are in use, each group
1675         ;; may be listed in more than once.
1676         (while (setq loc (text-property-any
1677                           loc (point-max) 'gnus-group ident))
1678           (setq found t)
1679           (goto-char loc)
1680           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1681             (gnus-delete-line)
1682             (gnus-group-insert-group-line-info group)
1683             (save-excursion
1684               (forward-line -1)
1685               (gnus-run-hooks 'gnus-group-update-group-hook)))
1686           (setq loc (1+ loc)))
1687         (unless (or found visible-only)
1688           ;; No such line in the buffer, find out where it's supposed to
1689           ;; go, and insert it there (or at the end of the buffer).
1690           (if gnus-goto-missing-group-function
1691               (funcall gnus-goto-missing-group-function group)
1692             (let ((entry (cddr (gnus-group-entry group))))
1693               (while (and entry (car entry)
1694                           (not
1695                            (gnus-goto-char
1696                             (text-property-any
1697                              (point-min) (point-max)
1698                              'gnus-group (gnus-intern-safe
1699                                           (caar entry) gnus-active-hashtb)))))
1700                 (setq entry (cdr entry)))
1701               (or entry (goto-char (point-max)))))
1702           ;; Finally insert the line.
1703           (let ((gnus-group-indentation (gnus-group-group-indentation)))
1704             (gnus-group-insert-group-line-info group)
1705             (save-excursion
1706               (forward-line -1)
1707               (gnus-run-hooks 'gnus-group-update-group-hook))))
1708         (when gnus-group-update-group-function
1709           (funcall gnus-group-update-group-function group))
1710         (gnus-group-set-mode-line)))
1711     (goto-char mark)
1712     (set-marker mark nil)
1713     (set-buffer buf)))
1714
1715 (defun gnus-group-set-mode-line ()
1716   "Update the mode line in the group buffer."
1717   (when (memq 'group gnus-updated-mode-lines)
1718     ;; Yes, we want to keep this mode line updated.
1719     (save-excursion
1720       (set-buffer gnus-group-buffer)
1721       (let* ((gformat (or gnus-group-mode-line-format-spec
1722                           (gnus-set-format 'group-mode)))
1723              (gnus-tmp-news-server (cadr gnus-select-method))
1724              (gnus-tmp-news-method (car gnus-select-method))
1725              (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1726              (max-len 60)
1727              gnus-tmp-header            ;Dummy binding for user-defined formats
1728              ;; Get the resulting string.
1729              (modified
1730               (and gnus-dribble-buffer
1731                    (buffer-name gnus-dribble-buffer)
1732                    (buffer-modified-p gnus-dribble-buffer)
1733                    (save-excursion
1734                      (set-buffer gnus-dribble-buffer)
1735                      (not (zerop (buffer-size))))))
1736              (mode-string (eval gformat)))
1737         ;; Say whether the dribble buffer has been modified.
1738         (setq mode-line-modified
1739               (if modified (car gnus-mode-line-modified)
1740                 (cdr gnus-mode-line-modified)))
1741         ;; If the line is too long, we chop it off.
1742         (when (> (length mode-string) max-len)
1743           (setq mode-string (substring mode-string 0 (- max-len 4))))
1744         (prog1
1745             (setq mode-line-buffer-identification
1746                   (gnus-mode-line-buffer-identification
1747                    (list mode-string)))
1748           (set-buffer-modified-p modified))))))
1749
1750 (defun gnus-group-group-name ()
1751   "Get the name of the newsgroup on the current line."
1752   (let ((group (get-text-property (point-at-bol) 'gnus-group)))
1753     (when group
1754       (symbol-name group))))
1755
1756 (defun gnus-group-group-level ()
1757   "Get the level of the newsgroup on the current line."
1758   (get-text-property (point-at-bol) 'gnus-level))
1759
1760 (defun gnus-group-group-indentation ()
1761   "Get the indentation of the newsgroup on the current line."
1762   (or (get-text-property (point-at-bol) 'gnus-indentation)
1763       (and gnus-group-indentation-function
1764            (funcall gnus-group-indentation-function))
1765       ""))
1766
1767 (defun gnus-group-group-unread ()
1768   "Get the number of unread articles of the newsgroup on the current line."
1769   (get-text-property (point-at-bol) 'gnus-unread))
1770
1771 (defun gnus-group-new-mail (group)
1772   (if (nnmail-new-mail-p (gnus-group-real-name group))
1773       gnus-new-mail-mark
1774     ? ))
1775
1776 (defun gnus-group-level (group)
1777   "Return the estimated level of GROUP."
1778   (or (gnus-info-level (gnus-get-info group))
1779       (and (member group gnus-zombie-list) gnus-level-zombie)
1780       gnus-level-killed))
1781
1782 (defun gnus-group-search-forward (&optional backward all level first-too)
1783   "Find the next newsgroup with unread articles.
1784 If BACKWARD is non-nil, find the previous newsgroup instead.
1785 If ALL is non-nil, just find any newsgroup.
1786 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1787 group exists.
1788 If FIRST-TOO, the current line is also eligible as a target."
1789   (let ((way (if backward -1 1))
1790         (low gnus-level-killed)
1791         (beg (point))
1792         pos found lev)
1793     (if (and backward (progn (beginning-of-line)) (bobp))
1794         nil
1795       (unless first-too
1796         (forward-line way))
1797       (while (and
1798               (not (eobp))
1799               (not (setq
1800                     found
1801                     (and
1802                      (get-text-property (point) 'gnus-group)
1803                      (or all
1804                          (and
1805                           (let ((unread
1806                                  (get-text-property (point) 'gnus-unread)))
1807                             (and (numberp unread) (> unread 0)))
1808                           (setq lev (get-text-property (point)
1809                                                        'gnus-level))
1810                           (<= lev gnus-level-subscribed)))
1811                      (or (not level)
1812                          (and (setq lev (get-text-property (point)
1813                                                            'gnus-level))
1814                               (or (= lev level)
1815                                   (and (< lev low)
1816                                        (< level lev)
1817                                        (progn
1818                                          (setq low lev)
1819                                          (setq pos (point))
1820                                          nil))))))))
1821               (zerop (forward-line way)))))
1822     (if found
1823         (progn (gnus-group-position-point) t)
1824       (goto-char (or pos beg))
1825       (and pos t))))
1826
1827 (defun gnus-total-fetched-for (group)
1828   (let* ((size-in-cache (or (gnus-cache-total-fetched-for group) 0))
1829          (size-in-agent (or (gnus-agent-total-fetched-for group) 0))
1830          (size (+ size-in-cache size-in-agent))
1831          (suffix '("B" "K" "M" "G"))
1832          (scale 1024.0)
1833          (cutoff scale))
1834     (while (> size cutoff)
1835       (setq size (/ size scale)
1836             suffix (cdr suffix)))
1837     (format "%5.1f%s" size (car suffix))))
1838
1839 ;;; Gnus group mode commands
1840
1841 ;; Group marking.
1842
1843 (defun gnus-group-mark-line-p ()
1844   (save-excursion
1845     (beginning-of-line)
1846     (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1847     (eq (char-after) gnus-process-mark)))
1848
1849 (defun gnus-group-mark-group (n &optional unmark no-advance)
1850   "Mark the current group."
1851   (interactive "p")
1852   (let ((buffer-read-only nil)
1853         group)
1854     (while (and (> n 0)
1855                 (not (eobp)))
1856       (when (setq group (gnus-group-group-name))
1857         ;; Go to the mark position.
1858         (beginning-of-line)
1859         (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1860         (delete-char 1)
1861         (if unmark
1862             (progn
1863               (setq gnus-group-marked (delete group gnus-group-marked))
1864               (insert-char ? 1 t))
1865            (setq gnus-group-marked
1866                  (cons group (delete group gnus-group-marked)))
1867            (insert-char gnus-process-mark 1 t)))
1868       (unless no-advance
1869         (gnus-group-next-group 1))
1870       (decf n))
1871     (gnus-summary-position-point)
1872     n))
1873
1874 (defun gnus-group-unmark-group (n)
1875   "Remove the mark from the current group."
1876   (interactive "p")
1877   (gnus-group-mark-group n 'unmark)
1878   (gnus-group-position-point))
1879
1880 (defun gnus-group-unmark-all-groups ()
1881   "Unmark all groups."
1882   (interactive)
1883   (save-excursion
1884     (mapc 'gnus-group-remove-mark gnus-group-marked))
1885   (gnus-group-position-point))
1886
1887 (defun gnus-group-mark-region (unmark beg end)
1888   "Mark all groups between point and mark.
1889 If UNMARK, remove the mark instead."
1890   (interactive "P\nr")
1891   (let ((num (count-lines beg end)))
1892     (save-excursion
1893       (goto-char beg)
1894       (- num (gnus-group-mark-group num unmark)))))
1895
1896 (defun gnus-group-mark-buffer (&optional unmark)
1897   "Mark all groups in the buffer.
1898 If UNMARK, remove the mark instead."
1899   (interactive "P")
1900   (gnus-group-mark-region unmark (point-min) (point-max)))
1901
1902 (defun gnus-group-mark-regexp (regexp)
1903   "Mark all groups that match some regexp."
1904   (interactive "sMark (regexp): ")
1905   (let ((alist (cdr gnus-newsrc-alist))
1906         group)
1907     (save-excursion
1908       (while alist
1909         (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1910           (gnus-group-jump-to-group group)
1911           (gnus-group-set-mark group)))))
1912   (gnus-group-position-point))
1913
1914 (defun gnus-group-remove-mark (group &optional test-marked)
1915   "Remove the process mark from GROUP and move point there.
1916 Return nil if the group isn't displayed."
1917   (if (gnus-group-goto-group group nil test-marked)
1918       (save-excursion
1919         (gnus-group-mark-group 1 'unmark t)
1920         t)
1921     (setq gnus-group-marked
1922           (delete group gnus-group-marked))
1923     nil))
1924
1925 (defun gnus-group-set-mark (group)
1926   "Set the process mark on GROUP."
1927   (if (gnus-group-goto-group group)
1928       (save-excursion
1929         (gnus-group-mark-group 1 nil t))
1930     (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1931
1932 (defun gnus-group-universal-argument (arg &optional groups func)
1933   "Perform any command on all groups according to the process/prefix convention."
1934   (interactive "P")
1935   (if (eq (setq func (or func
1936                          (key-binding
1937                           (read-key-sequence
1938                            (substitute-command-keys
1939                             "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1940           'undefined)
1941       (gnus-error 1 "Undefined key")
1942     (gnus-group-iterate arg
1943       (lambda (group)
1944         (command-execute func))))
1945   (gnus-group-position-point))
1946
1947 (defun gnus-group-process-prefix (n)
1948   "Return a list of groups to work on.
1949 Take into consideration N (the prefix) and the list of marked groups."
1950   (cond
1951    (n
1952     (setq n (prefix-numeric-value n))
1953     ;; There is a prefix, so we return a list of the N next
1954     ;; groups.
1955     (let ((way (if (< n 0) -1 1))
1956           (n (abs n))
1957           group groups)
1958       (save-excursion
1959         (while (> n 0)
1960           (if (setq group (gnus-group-group-name))
1961               (push group groups))
1962           (setq n (1- n))
1963           (gnus-group-next-group way)))
1964       (nreverse groups)))
1965    ((and (gnus-region-active-p) (mark))
1966     ;; Work on the region between point and mark.
1967     (let ((max (max (point) (mark)))
1968           groups)
1969       (save-excursion
1970         (goto-char (min (point) (mark)))
1971         (while
1972             (and
1973              (push (gnus-group-group-name) groups)
1974              (zerop (gnus-group-next-group 1))
1975              (< (point) max)))
1976         (nreverse groups))))
1977    (gnus-group-marked
1978     ;; No prefix, but a list of marked articles.
1979     (reverse gnus-group-marked))
1980    (t
1981     ;; Neither marked articles or a prefix, so we return the
1982     ;; current group.
1983     (let ((group (gnus-group-group-name)))
1984       (and group (list group))))))
1985
1986 ;;; !!!Surely gnus-group-iterate should be a macro instead?  I can't
1987 ;;; imagine why I went through these contortions...
1988 (eval-and-compile
1989   (let ((function (make-symbol "gnus-group-iterate-function"))
1990         (window (make-symbol "gnus-group-iterate-window"))
1991         (groups (make-symbol "gnus-group-iterate-groups"))
1992         (group (make-symbol "gnus-group-iterate-group")))
1993     (eval
1994      `(defun gnus-group-iterate (arg ,function)
1995         "Iterate FUNCTION over all process/prefixed groups.
1996 FUNCTION will be called with the group name as the parameter
1997 and with point over the group in question."
1998         (let ((,groups (gnus-group-process-prefix arg))
1999               (,window (selected-window))
2000               ,group)
2001           (while ,groups
2002             (setq ,group (car ,groups)
2003                   ,groups (cdr ,groups))
2004             (select-window ,window)
2005             (gnus-group-remove-mark ,group)
2006             (save-selected-window
2007               (save-excursion
2008                 (funcall ,function ,group)))))))))
2009
2010 (put 'gnus-group-iterate 'lisp-indent-function 1)
2011
2012 ;; Selecting groups.
2013
2014 (defun gnus-group-read-group (&optional all no-article group select-articles)
2015   "Read news in this newsgroup.
2016 If the prefix argument ALL is non-nil, already read articles become
2017 readable.  IF ALL is a number, fetch this number of articles.  If the
2018 optional argument NO-ARTICLE is non-nil, no article will be
2019 auto-selected upon group entry.  If GROUP is non-nil, fetch that
2020 group."
2021   (interactive "P")
2022   (let ((no-display (eq all 0))
2023         (group (or group (gnus-group-group-name)))
2024         number active marked entry)
2025     (when (eq all 0)
2026       (setq all nil))
2027     (unless group
2028       (error "No group on current line"))
2029     (setq marked (gnus-info-marks
2030                   (nth 2 (setq entry (gnus-group-entry group)))))
2031     ;; This group might be a dead group.  In that case we have to get
2032     ;; the number of unread articles from `gnus-active-hashtb'.
2033     (setq number
2034           (cond ((numberp all) all)
2035                 (entry (car entry))
2036                 ((setq active (gnus-active group))
2037                  (- (1+ (cdr active)) (car active)))))
2038     (gnus-summary-read-group
2039      group (or all (and (numberp number)
2040                         (zerop (+ number (gnus-range-length
2041                                           (cdr (assq 'tick marked)))
2042                                   (gnus-range-length
2043                                    (cdr (assq 'dormant marked)))))))
2044      no-article nil no-display nil select-articles)))
2045
2046 (defun gnus-group-select-group (&optional all)
2047   "Select this newsgroup.
2048 No article is selected automatically.
2049 If the group is opened, just switch the summary buffer.
2050 If ALL is non-nil, already read articles become readable.
2051 If ALL is a positive number, fetch this number of the latest
2052 articles in the group.
2053 If ALL is a negative number, fetch this number of the earliest
2054 articles in the group."
2055   (interactive "P")
2056   (when (and (eobp) (not (gnus-group-group-name)))
2057     (forward-line -1))
2058   (gnus-group-read-group all t))
2059
2060 (defun gnus-group-quick-select-group (&optional all)
2061   "Select the current group \"quickly\".
2062 This means that no highlighting or scoring will be performed.
2063 If ALL (the prefix argument) is 0, don't even generate the summary
2064 buffer.
2065
2066 This might be useful if you want to toggle threading
2067 before entering the group."
2068   (interactive "P")
2069   (require 'gnus-score)
2070   (let (gnus-visual
2071         gnus-score-find-score-files-function
2072         gnus-home-score-file
2073         gnus-apply-kill-hook
2074         gnus-summary-expunge-below)
2075     (gnus-group-read-group all t)))
2076
2077 (defun gnus-group-visible-select-group (&optional all)
2078   "Select the current group without hiding any articles."
2079   (interactive "P")
2080   (let ((gnus-inhibit-limiting t))
2081     (gnus-group-read-group all t)))
2082
2083 (defun gnus-group-select-group-ephemerally ()
2084   "Select the current group without doing any processing whatsoever.
2085 You will actually be entered into a group that's a copy of
2086 the current group; no changes you make while in this group will
2087 be permanent."
2088   (interactive)
2089   (require 'gnus-score)
2090   (let* (gnus-visual
2091          gnus-score-find-score-files-function gnus-apply-kill-hook
2092          gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
2093          gnus-summary-mode-hook gnus-select-group-hook
2094          (group (gnus-group-group-name))
2095          (method (gnus-find-method-for-group group)))
2096     (gnus-group-read-ephemeral-group
2097      (gnus-group-prefixed-name group method) method)))
2098
2099 ;;;###autoload
2100 (defun gnus-fetch-group (group &optional articles)
2101   "Start Gnus if necessary and enter GROUP.
2102 Returns whether the fetching was successful or not."
2103   (interactive (list (completing-read "Group name: " gnus-active-hashtb)))
2104   (unless (get-buffer gnus-group-buffer)
2105     (gnus-no-server))
2106   (gnus-group-read-group articles nil group))
2107
2108 ;;;###autoload
2109 (defun gnus-fetch-group-other-frame (group)
2110   "Pop up a frame and enter GROUP."
2111   (interactive "P")
2112   (let ((window (get-buffer-window gnus-group-buffer)))
2113     (cond (window
2114            (select-frame (window-frame window)))
2115           ((= (length (frame-list)) 1)
2116            (select-frame (make-frame)))
2117           (t
2118            (other-frame 1))))
2119   (gnus-fetch-group group))
2120
2121 (defvar gnus-ephemeral-group-server 0)
2122
2123 (defcustom gnus-large-ephemeral-newsgroup 200
2124   "The number of articles which indicates a large ephemeral newsgroup.
2125 Same as `gnus-large-newsgroup', but only used for ephemeral newsgroups.
2126
2127 If the number of articles in a newsgroup is greater than this value,
2128 confirmation is required for selecting the newsgroup.  If it is nil, no
2129 confirmation is required."
2130   :version "22.1"
2131   :group 'gnus-group-select
2132   :type '(choice (const :tag "No limit" nil)
2133                  integer))
2134
2135 (defcustom gnus-fetch-old-ephemeral-headers nil
2136   "Same as `gnus-fetch-old-headers', but only used for ephemeral newsgroups."
2137   :version "22.1"
2138   :group 'gnus-thread
2139   :type '(choice (const :tag "off" nil)
2140                  (const some)
2141                  number
2142                  (sexp :menu-tag "other" t)))
2143
2144 ;; Enter a group that is not in the group buffer.  Non-nil is returned
2145 ;; if selection was successful.
2146 (defun gnus-group-read-ephemeral-group (group method &optional activate
2147                                               quit-config request-only
2148                                               select-articles
2149                                               parameters
2150                                               number)
2151   "Read GROUP from METHOD as an ephemeral group.
2152 If ACTIVATE, request the group first.
2153 If QUIT-CONFIG, use that window configuration when exiting from the
2154 ephemeral group.
2155 If REQUEST-ONLY, don't actually read the group; just request it.
2156 If SELECT-ARTICLES, only select those articles.
2157 If PARAMETERS, use those as the group parameters.
2158 If NUMBER, fetch this number of articles.
2159
2160 Return the name of the group if selection was successful."
2161   (interactive
2162    (list
2163     ;; (gnus-read-group "Group name: ")
2164     (completing-read
2165      "Group: " gnus-active-hashtb
2166      nil nil nil
2167      'gnus-group-history)
2168     (gnus-read-method "From method: ")))
2169   ;; Transform the select method into a unique server.
2170   (when (stringp method)
2171     (setq method (gnus-server-to-method method)))
2172   (setq method
2173         `(,(car method) ,(concat (cadr method) "-ephemeral")
2174           (,(intern (format "%s-address" (car method))) ,(cadr method))
2175           ,@(cddr method)))
2176   (let ((group (if (gnus-group-foreign-p group) group
2177                  (gnus-group-prefixed-name (gnus-group-real-name group)
2178                                            method))))
2179     (gnus-sethash
2180      group
2181      `(-1 nil (,group
2182                ,gnus-level-default-subscribed nil nil ,method
2183                ,(cons
2184                  (if quit-config
2185                      (cons 'quit-config quit-config)
2186                    (cons 'quit-config
2187                          (cons gnus-summary-buffer
2188                                gnus-current-window-configuration)))
2189                  parameters)))
2190      gnus-newsrc-hashtb)
2191     (push method gnus-ephemeral-servers)
2192     (set-buffer gnus-group-buffer)
2193     (unless (gnus-check-server method)
2194       (error "Unable to contact server: %s" (gnus-status-message method)))
2195     (when activate
2196       (gnus-activate-group group 'scan)
2197       (unless (gnus-request-group group)
2198         (error "Couldn't request group: %s"
2199                (nnheader-get-report (car method)))))
2200     (if request-only
2201         group
2202       (condition-case ()
2203           (when (let ((gnus-large-newsgroup gnus-large-ephemeral-newsgroup)
2204                       (gnus-fetch-old-headers
2205                        gnus-fetch-old-ephemeral-headers))
2206                   (gnus-group-read-group (or number t) t group select-articles))
2207             group)
2208         ;;(error nil)
2209         (quit
2210          (message "Quit reading the ephemeral group")
2211          nil)))))
2212
2213 (defun gnus-group-jump-to-group (group &optional prompt)
2214   "Jump to newsgroup GROUP.
2215
2216 If PROMPT (the prefix) is a number, use the prompt specified in
2217 `gnus-group-jump-to-group-prompt'."
2218   (interactive
2219    (list (mm-string-make-unibyte
2220           (completing-read
2221            "Group: " gnus-active-hashtb nil
2222            (gnus-read-active-file-p)
2223            (if current-prefix-arg
2224                (cdr (assq current-prefix-arg gnus-group-jump-to-group-prompt))
2225              (or (and (stringp gnus-group-jump-to-group-prompt)
2226                       gnus-group-jump-to-group-prompt)
2227                  (let ((p (cdr (assq 0 gnus-group-jump-to-group-prompt))))
2228                    (and (stringp p) p))))
2229            'gnus-group-history))))
2230
2231   (when (equal group "")
2232     (error "Empty group name"))
2233
2234   (unless (gnus-ephemeral-group-p group)
2235     ;; Either go to the line in the group buffer...
2236     (unless (gnus-group-goto-group group)
2237       ;; ... or insert the line.
2238       (gnus-group-update-group group)
2239       (gnus-group-goto-group group)))
2240   ;; Adjust cursor point.
2241   (gnus-group-position-point))
2242
2243 (defun gnus-group-goto-group (group &optional far test-marked)
2244   "Goto to newsgroup GROUP.
2245 If FAR, it is likely that the group is not on the current line.
2246 If TEST-MARKED, the line must be marked."
2247   (when group
2248     (beginning-of-line)
2249     (cond
2250      ;; It's quite likely that we are on the right line, so
2251      ;; we check the current line first.
2252      ((and (not far)
2253            (eq (get-text-property (point) 'gnus-group)
2254                (gnus-intern-safe group gnus-active-hashtb))
2255            (or (not test-marked) (gnus-group-mark-line-p)))
2256       (point))
2257      ;; Previous and next line are also likely, so we check them as well.
2258      ((and (not far)
2259            (save-excursion
2260              (forward-line -1)
2261              (and (eq (get-text-property (point) 'gnus-group)
2262                       (gnus-intern-safe group gnus-active-hashtb))
2263                   (or (not test-marked) (gnus-group-mark-line-p)))))
2264       (forward-line -1)
2265       (point))
2266      ((and (not far)
2267            (save-excursion
2268              (forward-line 1)
2269              (and (eq (get-text-property (point) 'gnus-group)
2270                       (gnus-intern-safe group gnus-active-hashtb))
2271                   (or (not test-marked) (gnus-group-mark-line-p)))))
2272       (forward-line 1)
2273       (point))
2274      (test-marked
2275       (goto-char (point-min))
2276       (let (found)
2277         (while (and (not found)
2278                     (gnus-goto-char
2279                      (text-property-any
2280                       (point) (point-max)
2281                       'gnus-group
2282                       (gnus-intern-safe group gnus-active-hashtb))))
2283           (if (gnus-group-mark-line-p)
2284               (setq found t)
2285             (forward-line 1)))
2286         found))
2287      (t
2288       ;; Search through the entire buffer.
2289       (gnus-goto-char
2290        (text-property-any
2291         (point-min) (point-max)
2292         'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
2293
2294 (defun gnus-group-next-group (n &optional silent)
2295   "Go to next N'th newsgroup.
2296 If N is negative, search backward instead.
2297 Returns the difference between N and the number of skips actually
2298 done."
2299   (interactive "p")
2300   (gnus-group-next-unread-group n t nil silent))
2301
2302 (defun gnus-group-next-unread-group (n &optional all level silent)
2303   "Go to next N'th unread newsgroup.
2304 If N is negative, search backward instead.
2305 If ALL is non-nil, choose any newsgroup, unread or not.
2306 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
2307 such group can be found, the next group with a level higher than
2308 LEVEL.
2309 Returns the difference between N and the number of skips actually
2310 made."
2311   (interactive "p")
2312   (let ((backward (< n 0))
2313         (n (abs n)))
2314     (while (and (> n 0)
2315                 (gnus-group-search-forward
2316                  backward (or (not gnus-group-goto-unread) all) level))
2317       (setq n (1- n)))
2318     (when (and (/= 0 n)
2319                (not silent))
2320       (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
2321                     (if level " on this level or higher" "")))
2322     n))
2323
2324 (defun gnus-group-prev-group (n)
2325   "Go to previous N'th newsgroup.
2326 Returns the difference between N and the number of skips actually
2327 done."
2328   (interactive "p")
2329   (gnus-group-next-unread-group (- n) t))
2330
2331 (defun gnus-group-prev-unread-group (n)
2332   "Go to previous N'th unread newsgroup.
2333 Returns the difference between N and the number of skips actually
2334 done."
2335   (interactive "p")
2336   (gnus-group-next-unread-group (- n)))
2337
2338 (defun gnus-group-next-unread-group-same-level (n)
2339   "Go to next N'th unread newsgroup on the same level.
2340 If N is negative, search backward instead.
2341 Returns the difference between N and the number of skips actually
2342 done."
2343   (interactive "p")
2344   (gnus-group-next-unread-group n t (gnus-group-group-level))
2345   (gnus-group-position-point))
2346
2347 (defun gnus-group-prev-unread-group-same-level (n)
2348   "Go to next N'th unread newsgroup on the same level.
2349 Returns the difference between N and the number of skips actually
2350 done."
2351   (interactive "p")
2352   (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
2353   (gnus-group-position-point))
2354
2355 (defun gnus-group-best-unread-group (&optional exclude-group)
2356   "Go to the group with the highest level.
2357 If EXCLUDE-GROUP, do not go to that group."
2358   (interactive)
2359   (goto-char (point-min))
2360   (let ((best 100000)
2361         unread best-point)
2362     (while (not (eobp))
2363       (setq unread (get-text-property (point) 'gnus-unread))
2364       (when (and (numberp unread) (> unread 0))
2365         (when (and (get-text-property (point) 'gnus-level)
2366                    (< (get-text-property (point) 'gnus-level) best)
2367                    (or (not exclude-group)
2368                        (not (equal exclude-group (gnus-group-group-name)))))
2369           (setq best (get-text-property (point) 'gnus-level))
2370           (setq best-point (point))))
2371       (forward-line 1))
2372     (when best-point
2373       (goto-char best-point))
2374     (gnus-group-position-point)
2375     (and best-point (gnus-group-group-name))))
2376
2377 ;; Is there something like an after-point-motion-hook?
2378 ;; (inhibit-point-motion-hooks?).  Is there a tool-bar-update function?
2379
2380 ;; (defun gnus-group-menu-bar-update ()
2381 ;;   (let* ((buf (list (with-current-buffer gnus-group-buffer
2382 ;;                    (current-buffer))))
2383 ;;       (name (buffer-name (car buf))))
2384 ;;     (setcdr buf
2385 ;;          (if (> (length name) 27)
2386 ;;              (concat (substring name 0 12)
2387 ;;                      "..."
2388 ;;                      (substring name -12))
2389 ;;            name))
2390 ;;     (menu-bar-update-buffers-1 buf)))
2391
2392 ;; (defun gnus-group-position-point ()
2393 ;;   (gnus-goto-colon)
2394 ;;   (gnus-group-menu-bar-update))
2395
2396 (defun gnus-group-first-unread-group ()
2397   "Go to the first group with unread articles."
2398   (interactive)
2399   (prog1
2400       (let ((opoint (point))
2401             unread)
2402         (goto-char (point-min))
2403         (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
2404                 (and (numberp unread)   ; Not a topic.
2405                      (not (zerop unread))) ; Has unread articles.
2406                 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
2407             (point)                     ; Success.
2408           (goto-char opoint)
2409           nil))                         ; Not success.
2410     (gnus-group-position-point)))
2411
2412 (defun gnus-group-enter-server-mode ()
2413   "Jump to the server buffer."
2414   (interactive)
2415   (gnus-enter-server-buffer))
2416
2417 (defun gnus-group-make-group-simple (&optional group)
2418   "Add a new newsgroup.
2419 The user will be prompted for GROUP."
2420   (interactive
2421    (list (completing-read "Group: " gnus-active-hashtb
2422                           nil nil nil 'gnus-group-history)))
2423   (gnus-group-make-group
2424    (gnus-group-real-name group)
2425    (gnus-group-server group)))
2426
2427 (defun gnus-group-make-group (name &optional method address args)
2428   "Add a new newsgroup.
2429 The user will be prompted for a NAME, for a select METHOD, and an
2430 ADDRESS."
2431   (interactive
2432    (list
2433     (gnus-read-group "Group name: ")
2434     (gnus-read-method "From method: ")))
2435
2436   (when (stringp method)
2437     (setq method (or (gnus-server-to-method method) method)))
2438   (let* ((meth (gnus-method-simplify
2439                 (when (and method
2440                            (not (gnus-server-equal method gnus-select-method)))
2441                   (if address (list (intern method) address)
2442                     method))))
2443          (nname (if method (gnus-group-prefixed-name name meth) name))
2444          backend info)
2445     (when (gnus-group-entry nname)
2446       (error "Group %s already exists" (gnus-group-decoded-name nname)))
2447     ;; Subscribe to the new group.
2448     (gnus-group-change-level
2449      (setq info (list t nname gnus-level-default-subscribed nil nil meth))
2450      gnus-level-default-subscribed gnus-level-killed
2451      (and (gnus-group-group-name)
2452           (gnus-group-entry (gnus-group-group-name)))
2453      t)
2454     ;; Make it active.
2455     (gnus-set-active nname (cons 1 0))
2456     (unless (gnus-ephemeral-group-p name)
2457       (gnus-dribble-enter
2458        (concat "(gnus-group-set-info '"
2459                (gnus-prin1-to-string (cdr info)) ")")))
2460     ;; Insert the line.
2461     (gnus-group-insert-group-line-info nname)
2462     (forward-line -1)
2463     (gnus-group-position-point)
2464
2465     ;; Load the back end and try to make the back end create
2466     ;; the group as well.
2467     (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
2468                                                   nil meth))))
2469                  gnus-valid-select-methods)
2470       (require backend))
2471     (gnus-check-server meth)
2472     (when (gnus-check-backend-function 'request-create-group nname)
2473       (unless (gnus-request-create-group nname nil args)
2474         (error "Could not create group on server: %s"
2475                (nnheader-get-report backend))))
2476     t))
2477
2478 (defun gnus-group-delete-groups (&optional arg)
2479   "Delete the current group.  Only meaningful with editable groups."
2480   (interactive "P")
2481   (let ((n (length (gnus-group-process-prefix arg))))
2482     (when (gnus-yes-or-no-p
2483            (if (= n 1)
2484                "Delete this 1 group? "
2485              (format "Delete these %d groups? " n)))
2486       (gnus-group-iterate arg
2487         (lambda (group)
2488           (gnus-group-delete-group group nil t))))))
2489
2490 (defun gnus-group-delete-group (group &optional force no-prompt)
2491   "Delete the current group.  Only meaningful with editable groups.
2492 If FORCE (the prefix) is non-nil, all the articles in the group will
2493 be deleted.  This is \"deleted\" as in \"removed forever from the face
2494 of the Earth\".  There is no undo.  The user will be prompted before
2495 doing the deletion.
2496 Note that you also have to specify FORCE if you want the group to
2497 be removed from the server, even when it's empty."
2498   (interactive
2499    (list (gnus-group-group-name)
2500          current-prefix-arg))
2501   (unless group
2502     (error "No group to delete"))
2503   (unless (gnus-check-backend-function 'request-delete-group group)
2504     (error "This back end does not support group deletion"))
2505   (prog1
2506       (let ((group-decoded (gnus-group-decoded-name group)))
2507         (if (and (not no-prompt)
2508                  (not (gnus-yes-or-no-p
2509                        (format
2510                         "Do you really want to delete %s%s? "
2511                         group-decoded (if force " and all its contents" "")))))
2512             ()                          ; Whew!
2513           (gnus-message 6 "Deleting group %s..." group-decoded)
2514           (if (not (gnus-request-delete-group group force))
2515               (gnus-error 3 "Couldn't delete group %s" group-decoded)
2516             (gnus-message 6 "Deleting group %s...done" group-decoded)
2517             (gnus-group-goto-group group)
2518             (gnus-group-kill-group 1 t)
2519             (gnus-set-active group nil)
2520             t)))
2521     (gnus-group-position-point)))
2522
2523 (defun gnus-group-rename-group (group new-name)
2524   "Rename group from GROUP to NEW-NAME.
2525 When used interactively, GROUP is the group under point
2526 and NEW-NAME will be prompted for."
2527   (interactive
2528    (list
2529     (gnus-group-group-name)
2530     (progn
2531       (unless (gnus-check-backend-function
2532                'request-rename-group (gnus-group-group-name))
2533         (error "This back end does not support renaming groups"))
2534       (gnus-read-group "Rename group to: "
2535                        (gnus-group-real-name (gnus-group-group-name))))))
2536
2537   (unless (gnus-check-backend-function 'request-rename-group group)
2538     (error "This back end does not support renaming groups"))
2539   (unless group
2540     (error "No group to rename"))
2541   (when (equal (gnus-group-real-name group) new-name)
2542     (error "Can't rename to the same name"))
2543
2544   ;; We find the proper prefixed name.
2545   (setq new-name
2546         (if (gnus-group-native-p group)
2547             ;; Native group.
2548             new-name
2549           ;; Foreign group.
2550           (gnus-group-prefixed-name
2551            (gnus-group-real-name new-name)
2552            (gnus-info-method (gnus-get-info group)))))
2553
2554   (when (gnus-active new-name)
2555     (error "The group %s already exists" new-name))
2556
2557   (gnus-message 6 "Renaming group %s to %s..." group new-name)
2558   (prog1
2559       (if (progn
2560             (gnus-group-goto-group group)
2561             (not (when (< (gnus-group-group-level) gnus-level-zombie)
2562                    (gnus-request-rename-group group new-name))))
2563           (gnus-error 3 "Couldn't rename group %s to %s" group new-name)
2564         ;; We rename the group internally by killing it...
2565         (gnus-group-kill-group)
2566         ;; ... changing its name ...
2567         (setcar (cdar gnus-list-of-killed-groups) new-name)
2568         ;; ... and then yanking it.  Magic!
2569         (gnus-group-yank-group)
2570         (gnus-set-active new-name (gnus-active group))
2571         (gnus-message 6 "Renaming group %s to %s...done" group new-name)
2572         new-name)
2573     (setq gnus-killed-list (delete group gnus-killed-list))
2574     (gnus-set-active group nil)
2575     (gnus-dribble-touch)
2576     (gnus-group-position-point)))
2577
2578 (defun gnus-group-edit-group (group &optional part)
2579   "Edit the group on the current line."
2580   (interactive (list (gnus-group-group-name)))
2581   (let ((part (or part 'info))
2582         info)
2583     (unless group
2584       (error "No group on current line"))
2585     (unless (setq info (gnus-get-info group))
2586       (error "Killed group; can't be edited"))
2587     (ignore-errors
2588       (gnus-close-group group))
2589     (gnus-edit-form
2590      ;; Find the proper form to edit.
2591      (cond ((eq part 'method)
2592             (or (gnus-info-method info) "native"))
2593            ((eq part 'params)
2594             (gnus-info-params info))
2595            (t info))
2596      ;; The proper documentation.
2597      (format
2598       "Editing the %s for `%s'."
2599       (cond
2600        ((eq part 'method) "select method")
2601        ((eq part 'params) "group parameters")
2602        (t "group info"))
2603       (gnus-group-decoded-name group))
2604      `(lambda (form)
2605         (gnus-group-edit-group-done ',part ,group form)))
2606     (local-set-key
2607      "\C-c\C-i"
2608      (gnus-create-info-command
2609       (cond
2610        ((eq part 'method)
2611         "(gnus)Select Methods")
2612        ((eq part 'params)
2613         "(gnus)Group Parameters")
2614        (t
2615         "(gnus)Group Info"))))))
2616
2617 (defun gnus-group-edit-group-method (group)
2618   "Edit the select method of GROUP."
2619   (interactive (list (gnus-group-group-name)))
2620   (gnus-group-edit-group group 'method))
2621
2622 (defun gnus-group-edit-group-parameters (group)
2623   "Edit the group parameters of GROUP."
2624   (interactive (list (gnus-group-group-name)))
2625   (gnus-group-edit-group group 'params))
2626
2627 (defun gnus-group-edit-group-done (part group form)
2628   "Update variables."
2629   (let* ((method (cond ((eq part 'info) (nth 4 form))
2630                        ((eq part 'method) form)
2631                        (t nil)))
2632          (info (cond ((eq part 'info) form)
2633                      ((eq part 'method) (gnus-get-info group))
2634                      (t nil)))
2635          (new-group (if info
2636                         (if (or (not method)
2637                                 (gnus-server-equal
2638                                  gnus-select-method method))
2639                             (gnus-group-real-name (car info))
2640                           (gnus-group-prefixed-name
2641                            (gnus-group-real-name (car info)) method))
2642                       nil)))
2643     (when (and new-group
2644                (not (equal new-group group)))
2645       (when (gnus-group-goto-group group)
2646         (gnus-group-kill-group 1))
2647       (gnus-activate-group new-group))
2648     ;; Set the info.
2649     (if (not (and info new-group))
2650         (gnus-group-set-info form (or new-group group) part)
2651       (setq info (gnus-copy-sequence info))
2652       (setcar info new-group)
2653       (unless (gnus-server-equal method "native")
2654         (unless (nthcdr 3 info)
2655           (nconc info (list nil nil)))
2656         (unless (nthcdr 4 info)
2657           (nconc info (list nil)))
2658         (gnus-info-set-method info method))
2659       (gnus-group-set-info info))
2660     (gnus-group-update-group (or new-group group))
2661     (gnus-group-position-point)))
2662
2663 (defun gnus-group-make-useful-group (group method)
2664   "Create one of the groups described in `gnus-useful-groups'."
2665   (interactive
2666    (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
2667                                         nil t)
2668                        gnus-useful-groups)))
2669      (list (cadr entry) (caddr entry))))
2670   (setq method (gnus-copy-sequence method))
2671   (let (entry)
2672     (while (setq entry (memq (assq 'eval method) method))
2673       (setcar entry (eval (cadar entry)))))
2674   (gnus-group-make-group group method))
2675
2676 (defun gnus-group-make-help-group (&optional noerror)
2677   "Create the Gnus documentation group.
2678 Optional argument NOERROR modifies the behavior of this function when the
2679 group already exists:
2680 - if not given, and error is signaled,
2681 - if t, stay silent,
2682 - if anything else, just print a message."
2683   (interactive)
2684   (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2685         (file (nnheader-find-etc-directory "gnus-tut.txt" t)))
2686     (if (gnus-group-entry name)
2687         (cond ((eq noerror nil)
2688                (error "Documentation group already exists"))
2689               ((eq noerror t)
2690                ;; stay silent
2691                )
2692               (t
2693                (gnus-message 1 "Documentation group already exists")))
2694       ;; else:
2695       (if (not file)
2696           (gnus-message 1 "Couldn't find doc group")
2697         (gnus-group-make-group
2698          (gnus-group-real-name name)
2699          (list 'nndoc "gnus-help"
2700                (list 'nndoc-address file)
2701                (list 'nndoc-article-type 'mbox))))
2702       ))
2703   (gnus-group-position-point))
2704
2705 (defun gnus-group-make-doc-group (file type)
2706   "Create a group that uses a single file as the source.
2707
2708 If called with a prefix argument, ask for the file type."
2709   (interactive
2710    (list (read-file-name "File name: ")
2711          (and current-prefix-arg 'ask)))
2712   (when (eq type 'ask)
2713     (let ((err "")
2714           char found)
2715       (while (not found)
2716         (message
2717          "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [m, b, d, f, a, g]: "
2718          err)
2719         (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2720                           ((= char ?b) 'babyl)
2721                           ((= char ?d) 'digest)
2722                           ((= char ?f) 'forward)
2723                           ((= char ?a) 'mmfd)
2724                           ((= char ?g) 'guess)
2725                           (t (setq err (format "%c unknown. " char))
2726                              nil))))
2727       (setq type found)))
2728   (let* ((file (expand-file-name file))
2729          (name (gnus-generate-new-group-name
2730                 (gnus-group-prefixed-name
2731                  (file-name-nondirectory file) '(nndoc "")))))
2732     (gnus-group-make-group
2733      (gnus-group-real-name name)
2734      (list 'nndoc file
2735            (list 'nndoc-address file)
2736            (list 'nndoc-article-type (or type 'guess))))))
2737
2738 (defvar nnweb-type-definition)
2739 (defvar gnus-group-web-type-history nil)
2740 (defvar gnus-group-web-search-history nil)
2741 (defun gnus-group-make-web-group (&optional solid)
2742   "Create an ephemeral nnweb group.
2743 If SOLID (the prefix), create a solid group."
2744   (interactive "P")
2745   (require 'nnweb)
2746   (let* ((group
2747           (if solid (gnus-read-group "Group name: ")
2748             (message-unique-id)))
2749          (default-type (or (car gnus-group-web-type-history)
2750                            (symbol-name (caar nnweb-type-definition))))
2751          (type
2752           (gnus-string-or
2753            (completing-read
2754             (format "Search engine type (default %s): " default-type)
2755             (mapcar (lambda (elem) (list (symbol-name (car elem))))
2756                     nnweb-type-definition)
2757             nil t nil 'gnus-group-web-type-history)
2758            default-type))
2759          (search
2760           (read-string
2761            "Search string: "
2762            (cons (or (car gnus-group-web-search-history) "") 0)
2763            'gnus-group-web-search-history))
2764          (method
2765           `(nnweb ,group (nnweb-search ,search)
2766                   (nnweb-type ,(intern type))
2767                   (nnweb-ephemeral-p t))))
2768     (if solid
2769         (progn
2770           (gnus-pull 'nnweb-ephemeral-p method)
2771           (gnus-group-make-group group method))
2772       (gnus-group-read-ephemeral-group
2773        group method t
2774        (cons (current-buffer)
2775              (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
2776
2777 (eval-when-compile
2778   (defvar nnrss-group-alist)
2779   (defun nnrss-discover-feed (arg))
2780   (defun nnrss-save-server-data (arg)))
2781 (defun gnus-group-make-rss-group (&optional url)
2782   "Given a URL, discover if there is an RSS feed.
2783 If there is, use Gnus to create an nnrss group"
2784   (interactive)
2785   (require 'nnrss)
2786   (if (not url)
2787       (setq url (read-from-minibuffer "URL to Search for RSS: ")))
2788   (let ((feedinfo (nnrss-discover-feed url)))
2789     (if feedinfo
2790         (let ((title (gnus-newsgroup-savable-name
2791                       (read-from-minibuffer "Title: "
2792                                             (gnus-newsgroup-savable-name
2793                                              (or (cdr (assoc 'title
2794                                                              feedinfo))
2795                                                  "")))))
2796               (desc  (read-from-minibuffer "Description: "
2797                                            (cdr (assoc 'description
2798                                                        feedinfo))))
2799               (href (cdr (assoc 'href feedinfo)))
2800               (encodable (mm-coding-system-p 'utf-8)))
2801           (when encodable
2802             ;; Unify non-ASCII text.
2803             (setq title (mm-decode-coding-string
2804                          (mm-encode-coding-string title 'utf-8) 'utf-8)))
2805           (gnus-group-make-group (if encodable
2806                                      (mm-encode-coding-string title 'utf-8)
2807                                    title)
2808                                  '(nnrss ""))
2809           (push (list title href desc) nnrss-group-alist)
2810           (nnrss-save-server-data nil))
2811       (error "No feeds found for %s" url))))
2812
2813 (defvar nnwarchive-type-definition)
2814 (defvar gnus-group-warchive-type-history nil)
2815 (defvar gnus-group-warchive-login-history nil)
2816 (defvar gnus-group-warchive-address-history nil)
2817
2818 (defun gnus-group-make-warchive-group ()
2819   "Create a nnwarchive group."
2820   (interactive)
2821   (require 'nnwarchive)
2822   (let* ((group (gnus-read-group "Group name: "))
2823          (default-type (or (car gnus-group-warchive-type-history)
2824                            (symbol-name (caar nnwarchive-type-definition))))
2825          (type
2826           (gnus-string-or
2827            (completing-read
2828             (format "Warchive type (default %s): " default-type)
2829             (mapcar (lambda (elem) (list (symbol-name (car elem))))
2830                     nnwarchive-type-definition)
2831             nil t nil 'gnus-group-warchive-type-history)
2832            default-type))
2833          (address (read-string "Warchive address: "
2834                                nil 'gnus-group-warchive-address-history))
2835          (default-login (or (car gnus-group-warchive-login-history)
2836                             user-mail-address))
2837          (login
2838           (gnus-string-or
2839            (read-string
2840             (format "Warchive login (default %s): " user-mail-address)
2841             default-login 'gnus-group-warchive-login-history)
2842            user-mail-address))
2843          (method
2844           `(nnwarchive ,address
2845                        (nnwarchive-type ,(intern type))
2846                        (nnwarchive-login ,login))))
2847     (gnus-group-make-group group method)))
2848
2849 (defun gnus-group-make-archive-group (&optional all)
2850   "Create the (ding) Gnus archive group of the most recent articles.
2851 Given a prefix, create a full group."
2852   (interactive "P")
2853   (let ((group (gnus-group-prefixed-name
2854                 (if all "ding.archives" "ding.recent") '(nndir ""))))
2855     (when (gnus-group-entry group)
2856       (error "Archive group already exists"))
2857     (gnus-group-make-group
2858      (gnus-group-real-name group)
2859      (list 'nndir (if all "hpc" "edu")
2860            (list 'nndir-directory
2861                  (if all gnus-group-archive-directory
2862                    gnus-group-recent-archive-directory))))
2863     (gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
2864
2865 (defun gnus-group-make-directory-group (dir)
2866   "Create an nndir group.
2867 The user will be prompted for a directory.  The contents of this
2868 directory will be used as a newsgroup.  The directory should contain
2869 mail messages or news articles in files that have numeric names."
2870   (interactive
2871    (list (read-file-name "Create group from directory: ")))
2872   (unless (file-exists-p dir)
2873     (error "No such directory"))
2874   (unless (file-directory-p dir)
2875     (error "Not a directory"))
2876   (let ((ext "")
2877         (i 0)
2878         group)
2879     (while (or (not group) (gnus-group-entry group))
2880       (setq group
2881             (gnus-group-prefixed-name
2882              (expand-file-name ext dir)
2883              '(nndir "")))
2884       (setq ext (format "<%d>" (setq i (1+ i)))))
2885     (gnus-group-make-group
2886      (gnus-group-real-name group)
2887      (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
2888
2889 (defvar nnkiboze-score-file)
2890 (defun gnus-group-make-kiboze-group (group address scores)
2891   "Create an nnkiboze group.
2892 The user will be prompted for a name, a regexp to match groups, and
2893 score file entries for articles to include in the group."
2894   (interactive
2895    (list
2896     (read-string "nnkiboze group name: ")
2897     (read-string "Source groups (regexp): ")
2898     (let ((headers (mapcar 'list
2899                            '("subject" "from" "number" "date" "message-id"
2900                              "references" "chars" "lines" "xref"
2901                              "followup" "all" "body" "head")))
2902           scores header regexp regexps)
2903       (while (not (equal "" (setq header (completing-read
2904                                           "Match on header: " headers nil t))))
2905         (setq regexps nil)
2906         (while (not (equal "" (setq regexp (read-string
2907                                             (format "Match on %s (regexp): "
2908                                                     header)))))
2909           (push (list regexp nil nil 'r) regexps))
2910         (push (cons header regexps) scores))
2911       scores)))
2912   (gnus-group-make-group group "nnkiboze" address)
2913   (let* ((nnkiboze-current-group group)
2914          (score-file (car (nnkiboze-score-file "")))
2915          (score-dir (file-name-directory score-file)))
2916     (unless (file-exists-p score-dir)
2917       (make-directory score-dir))
2918     (with-temp-file score-file
2919       (let (emacs-lisp-mode-hook)
2920         (gnus-pp scores)))))
2921
2922 (defun gnus-group-add-to-virtual (n vgroup)
2923   "Add the current group to a virtual group."
2924   (interactive
2925    (list current-prefix-arg
2926          (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
2927                           "nnvirtual:")))
2928   (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
2929     (error "%s is not an nnvirtual group" vgroup))
2930   (gnus-close-group vgroup)
2931   (let* ((groups (gnus-group-process-prefix n))
2932          (method (gnus-info-method (gnus-get-info vgroup))))
2933     (setcar (cdr method)
2934             (concat
2935              (nth 1 method) "\\|"
2936              (mapconcat
2937               (lambda (s)
2938                 (gnus-group-remove-mark s)
2939                 (concat "\\(^" (regexp-quote s) "$\\)"))
2940               groups "\\|"))))
2941   (gnus-group-position-point))
2942
2943 (defun gnus-group-make-empty-virtual (group)
2944   "Create a new, fresh, empty virtual group."
2945   (interactive "sCreate new, empty virtual group: ")
2946   (let* ((method (list 'nnvirtual "^$"))
2947          (pgroup (gnus-group-prefixed-name group method)))
2948     ;; Check whether it exists already.
2949     (when (gnus-group-entry pgroup)
2950       (error "Group %s already exists" pgroup))
2951     ;; Subscribe the new group after the group on the current line.
2952     (gnus-subscribe-group pgroup (gnus-group-group-name) method)
2953     (gnus-group-update-group pgroup)
2954     (forward-line -1)
2955     (gnus-group-position-point)))
2956
2957 (defun gnus-group-enter-directory (dir)
2958   "Enter an ephemeral nneething group."
2959   (interactive "DDirectory to read: ")
2960   (let* ((method (list 'nneething dir '(nneething-read-only t)))
2961          (leaf (gnus-group-prefixed-name
2962                 (file-name-nondirectory (directory-file-name dir))
2963                 method))
2964          (name (gnus-generate-new-group-name leaf)))
2965     (unless (gnus-group-read-ephemeral-group
2966              name method t
2967              (cons (current-buffer)
2968                    (if (eq major-mode 'gnus-summary-mode)
2969                        'summary 'group)))
2970       (error "Couldn't enter %s" dir))))
2971
2972 (eval-and-compile
2973   (autoload 'nnimap-expunge "nnimap")
2974   (autoload 'nnimap-acl-get "nnimap")
2975   (autoload 'nnimap-acl-edit "nnimap"))
2976
2977 (defun gnus-group-nnimap-expunge (group)
2978   "Expunge deleted articles in current nnimap GROUP."
2979   (interactive (list (gnus-group-group-name)))
2980   (let ((mailbox (gnus-group-real-name group)) method)
2981     (unless group
2982       (error "No group on current line"))
2983     (unless (gnus-get-info group)
2984       (error "Killed group; can't be edited"))
2985     (unless (eq 'nnimap (car (setq method (gnus-find-method-for-group group))))
2986       (error "%s is not an nnimap group" group))
2987     (nnimap-expunge mailbox (cadr method))))
2988
2989 (defun gnus-group-nnimap-edit-acl (group)
2990   "Edit the Access Control List of current nnimap GROUP."
2991   (interactive (list (gnus-group-group-name)))
2992   (let ((mailbox (gnus-group-real-name group)) method acl)
2993     (unless group
2994       (error "No group on current line"))
2995     (unless (gnus-get-info group)
2996       (error "Killed group; can't be edited"))
2997     (unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
2998       (error "%s is not an nnimap group" group))
2999     (unless (setq acl (nnimap-acl-get mailbox (cadr method)))
3000       (error "Server does not support ACL's"))
3001     (gnus-edit-form acl (format "Editing the access control list for `%s'.
3002
3003    An access control list is a list of (identifier . rights) elements.
3004
3005    The identifier string specifies the corresponding user.  The
3006    identifier \"anyone\" is reserved to refer to the universal identity.
3007
3008    Rights is a string listing a (possibly empty) set of alphanumeric
3009    characters, each character listing a set of operations which is being
3010    controlled.  Letters are reserved for ``standard'' rights, listed
3011    below.  Digits are reserved for implementation or site defined rights.
3012
3013    l - lookup (mailbox is visible to LIST/LSUB commands)
3014    r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
3015        SEARCH, COPY from mailbox)
3016    s - keep seen/unseen information across sessions (STORE \\SEEN flag)
3017    w - write (STORE flags other than \\SEEN and \\DELETED)
3018    i - insert (perform APPEND, COPY into mailbox)
3019    p - post (send mail to submission address for mailbox,
3020        not enforced by IMAP4 itself)
3021    c - create and delete mailbox (CREATE new sub-mailboxes in any
3022        implementation-defined hierarchy, RENAME or DELETE mailbox)
3023    d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
3024    a - administer (perform SETACL)" group)
3025                     `(lambda (form)
3026                        (nnimap-acl-edit
3027                         ,mailbox ',method ',acl form)))))
3028
3029 ;; Group sorting commands
3030 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
3031
3032 (defun gnus-group-sort-groups (func &optional reverse)
3033   "Sort the group buffer according to FUNC.
3034 When used interactively, the sorting function used will be
3035 determined by the `gnus-group-sort-function' variable.
3036 If REVERSE (the prefix), reverse the sorting order."
3037   (interactive (list gnus-group-sort-function current-prefix-arg))
3038   (funcall gnus-group-sort-alist-function
3039            (gnus-make-sort-function func) reverse)
3040   (gnus-group-unmark-all-groups)
3041   (gnus-group-list-groups)
3042   (gnus-dribble-touch))
3043
3044 (defun gnus-group-sort-flat (func reverse)
3045   ;; We peel off the dummy group from the alist.
3046   (when func
3047     (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
3048       (pop gnus-newsrc-alist))
3049     ;; Do the sorting.
3050     (setq gnus-newsrc-alist
3051           (sort gnus-newsrc-alist func))
3052     (when reverse
3053       (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
3054     ;; Regenerate the hash table.
3055     (gnus-make-hashtable-from-newsrc-alist)))
3056
3057 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
3058   "Sort the group buffer alphabetically by group name.
3059 If REVERSE, sort in reverse order."
3060   (interactive "P")
3061   (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
3062
3063 (defun gnus-group-sort-groups-by-real-name (&optional reverse)
3064   "Sort the group buffer alphabetically by real (unprefixed) group name.
3065 If REVERSE, sort in reverse order."
3066   (interactive "P")
3067   (gnus-group-sort-groups 'gnus-group-sort-by-real-name reverse))
3068
3069 (defun gnus-group-sort-groups-by-unread (&optional reverse)
3070   "Sort the group buffer by number of unread articles.
3071 If REVERSE, sort in reverse order."
3072   (interactive "P")
3073   (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
3074
3075 (defun gnus-group-sort-groups-by-level (&optional reverse)
3076   "Sort the group buffer by group level.
3077 If REVERSE, sort in reverse order."
3078   (interactive "P")
3079   (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
3080
3081 (defun gnus-group-sort-groups-by-score (&optional reverse)
3082   "Sort the group buffer by group score.
3083 If REVERSE, sort in reverse order."
3084   (interactive "P")
3085   (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
3086
3087 (defun gnus-group-sort-groups-by-rank (&optional reverse)
3088   "Sort the group buffer by group rank.
3089 If REVERSE, sort in reverse order."
3090   (interactive "P")
3091   (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
3092
3093 (defun gnus-group-sort-groups-by-method (&optional reverse)
3094   "Sort the group buffer alphabetically by back end name.
3095 If REVERSE, sort in reverse order."
3096   (interactive "P")
3097   (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
3098
3099 (defun gnus-group-sort-groups-by-server (&optional reverse)
3100   "Sort the group buffer alphabetically by server name.
3101 If REVERSE, sort in reverse order."
3102   (interactive "P")
3103   (gnus-group-sort-groups 'gnus-group-sort-by-server reverse))
3104
3105 ;;; Selected group sorting.
3106
3107 (defun gnus-group-sort-selected-groups (n func &optional reverse)
3108   "Sort the process/prefixed groups."
3109   (interactive (list current-prefix-arg gnus-group-sort-function))
3110   (let ((groups (gnus-group-process-prefix n)))
3111     (funcall gnus-group-sort-selected-function
3112              groups (gnus-make-sort-function func) reverse)
3113     (gnus-group-unmark-all-groups)
3114     (gnus-group-list-groups)
3115     (gnus-dribble-touch)))
3116
3117 (defun gnus-group-sort-selected-flat (groups func reverse)
3118   (let (entries infos)
3119     ;; First find all the group entries for these groups.
3120     (while groups
3121       (push (nthcdr 2 (gnus-group-entry (pop groups)))
3122             entries))
3123     ;; Then sort the infos.
3124     (setq infos
3125           (sort
3126            (mapcar
3127             (lambda (entry) (car entry))
3128             (setq entries (nreverse entries)))
3129            func))
3130     (when reverse
3131       (setq infos (nreverse infos)))
3132     ;; Go through all the infos and replace the old entries
3133     ;; with the new infos.
3134     (while infos
3135       (setcar (car entries) (pop infos))
3136       (pop entries))
3137     ;; Update the hashtable.
3138     (gnus-make-hashtable-from-newsrc-alist)))
3139
3140 (defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
3141   "Sort the group buffer alphabetically by group name.
3142 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3143 sort in reverse order."
3144   (interactive (gnus-interactive "P\ny"))
3145   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
3146
3147 (defun gnus-group-sort-selected-groups-by-real-name (&optional n reverse)
3148   "Sort the group buffer alphabetically by real group name.
3149 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3150 sort in reverse order."
3151   (interactive (gnus-interactive "P\ny"))
3152   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-real-name reverse))
3153
3154 (defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
3155   "Sort the group buffer by number of unread articles.
3156 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3157 sort in reverse order."
3158   (interactive (gnus-interactive "P\ny"))
3159   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
3160
3161 (defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
3162   "Sort the group buffer by group level.
3163 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3164 sort in reverse order."
3165   (interactive (gnus-interactive "P\ny"))
3166   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
3167
3168 (defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
3169   "Sort the group buffer by group score.
3170 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3171 sort in reverse order."
3172   (interactive (gnus-interactive "P\ny"))
3173   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
3174
3175 (defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
3176   "Sort the group buffer by group rank.
3177 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3178 sort in reverse order."
3179   (interactive (gnus-interactive "P\ny"))
3180   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
3181
3182 (defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
3183   "Sort the group buffer alphabetically by back end name.
3184 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3185 sort in reverse order."
3186   (interactive (gnus-interactive "P\ny"))
3187   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
3188
3189 ;;; Sorting predicates.
3190
3191 (defun gnus-group-sort-by-alphabet (info1 info2)
3192   "Sort alphabetically."
3193   (string< (gnus-info-group info1) (gnus-info-group info2)))
3194
3195 (defun gnus-group-sort-by-real-name (info1 info2)
3196   "Sort alphabetically on real (unprefixed) names."
3197   (string< (gnus-group-real-name (gnus-info-group info1))
3198            (gnus-group-real-name (gnus-info-group info2))))
3199
3200 (defun gnus-group-sort-by-unread (info1 info2)
3201   "Sort by number of unread articles."
3202   (let ((n1 (gnus-group-unread (gnus-info-group info1)))
3203         (n2 (gnus-group-unread (gnus-info-group info1))))
3204     (< (or (and (numberp n1) n1) 0)
3205        (or (and (numberp n2) n2) 0))))
3206
3207 (defun gnus-group-sort-by-level (info1 info2)
3208   "Sort by level."
3209   (< (gnus-info-level info1) (gnus-info-level info2)))
3210
3211 (defun gnus-group-sort-by-method (info1 info2)
3212   "Sort alphabetically by back end name."
3213   (string< (car (gnus-find-method-for-group
3214                  (gnus-info-group info1) info1))
3215            (car (gnus-find-method-for-group
3216                  (gnus-info-group info2) info2))))
3217
3218 (defun gnus-group-sort-by-server (info1 info2)
3219   "Sort alphabetically by server name."
3220   (string< (gnus-method-to-full-server-name
3221             (gnus-find-method-for-group
3222              (gnus-info-group info1) info1))
3223            (gnus-method-to-full-server-name
3224             (gnus-find-method-for-group
3225              (gnus-info-group info2) info2))))
3226
3227 (defun gnus-group-sort-by-score (info1 info2)
3228   "Sort by group score."
3229   (> (gnus-info-score info1) (gnus-info-score info2)))
3230
3231 (defun gnus-group-sort-by-rank (info1 info2)
3232   "Sort by level and score."
3233   (let ((level1 (gnus-info-level info1))
3234         (level2 (gnus-info-level info2)))
3235     (or (< level1 level2)
3236         (and (= level1 level2)
3237              (> (gnus-info-score info1) (gnus-info-score info2))))))
3238
3239 ;;; Clearing data
3240
3241 (defun gnus-group-clear-data (&optional arg)
3242   "Clear all marks and read ranges from the current group.
3243 Obeys the process/prefix convention."
3244   (interactive "P")
3245   (gnus-group-iterate arg
3246     (lambda (group)
3247       (let (info)
3248         (gnus-info-clear-data (setq info (gnus-get-info group)))
3249         (gnus-get-unread-articles-in-group info (gnus-active group) t)
3250         (when (gnus-group-goto-group group)
3251           (gnus-group-update-group-line))))))
3252
3253 (defun gnus-group-clear-data-on-native-groups ()
3254   "Clear all marks and read ranges from all native groups."
3255   (interactive)
3256   (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
3257     (let ((alist (cdr gnus-newsrc-alist))
3258           info)
3259       (while (setq info (pop alist))
3260         (when (gnus-group-native-p (gnus-info-group info))
3261           (gnus-info-clear-data info)))
3262       (gnus-get-unread-articles)
3263       (gnus-dribble-touch)
3264       (when (gnus-y-or-n-p
3265              "Move the cache away to avoid problems in the future? ")
3266         (call-interactively 'gnus-cache-move-cache)))))
3267
3268 (defun gnus-info-clear-data (info)
3269   "Clear all marks and read ranges from INFO."
3270   (let ((group (gnus-info-group info))
3271         action)
3272     (dolist (el (gnus-info-marks info))
3273       (push `(,(cdr el) add (,(car el))) action))
3274     (push `(,(gnus-info-read info) add (read)) action)
3275     (gnus-undo-register
3276       `(progn
3277          (gnus-request-set-mark ,group ',action)
3278          (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
3279          (gnus-info-set-read ',info ',(gnus-info-read info))
3280          (when (gnus-group-goto-group ,group)
3281            (gnus-get-unread-articles-in-group ',info ',(gnus-active group) t)
3282            (gnus-group-update-group-line))))
3283     (setq action (mapcar (lambda (el) (list (nth 0 el) 'del (nth 2 el)))
3284                          action))
3285     (gnus-request-set-mark group action)
3286     (gnus-info-set-read info nil)
3287     (when (gnus-info-marks info)
3288       (gnus-info-set-marks info nil))))
3289
3290 ;; Group catching up.
3291
3292 (defun gnus-group-catchup-current (&optional n all)
3293   "Mark all unread articles in the current newsgroup as read.
3294 If prefix argument N is numeric, the next N newsgroups will be
3295 caught up.  If ALL is non-nil, marked articles will also be marked as
3296 read.  Cross references (Xref: header) of articles are ignored.
3297 The number of newsgroups that this function was unable to catch
3298 up is returned."
3299   (interactive "P")
3300   (let ((groups (gnus-group-process-prefix n))
3301         (ret 0)
3302         group)
3303     (unless groups (error "No groups selected"))
3304     (if (not
3305          (or (not gnus-interactive-catchup) ;Without confirmation?
3306              gnus-expert-user
3307              (gnus-y-or-n-p
3308               (format
3309                (if all
3310                    "Do you really want to mark all articles in %s as read? "
3311                  "Mark all unread articles in %s as read? ")
3312                (if (= (length groups) 1)
3313                    (gnus-group-decoded-name (car groups))
3314                  (format "these %d groups" (length groups)))))))
3315         n
3316       (while (setq group (pop groups))
3317         (gnus-group-remove-mark group)
3318         ;; Virtual groups have to be given special treatment.
3319         (let ((method (gnus-find-method-for-group group)))
3320           (when (eq 'nnvirtual (car method))
3321             (nnvirtual-catchup-group
3322              (gnus-group-real-name group) (nth 1 method) all)))
3323         (if (>= (gnus-group-level group) gnus-level-zombie)
3324             (gnus-message 2 "Dead groups can't be caught up")
3325           (if (prog1
3326                   (gnus-group-goto-group group)
3327                 (gnus-group-catchup group all))
3328               (gnus-group-update-group-line)
3329             (setq ret (1+ ret)))))
3330       (gnus-group-next-unread-group 1)
3331       ret)))
3332
3333 (defun gnus-group-catchup-current-all (&optional n)
3334   "Mark all articles in current newsgroup as read.
3335 Cross references (Xref: header) of articles are ignored."
3336   (interactive "P")
3337   (gnus-group-catchup-current n 'all))
3338
3339 (defun gnus-group-catchup (group &optional all)
3340   "Mark all articles in GROUP as read.
3341 If ALL is non-nil, all articles are marked as read.
3342 The return value is the number of articles that were marked as read,
3343 or nil if no action could be taken."
3344   (let* ((entry (gnus-group-entry group))
3345          (num (car entry))
3346          (marks (gnus-info-marks (nth 2 entry)))
3347          (unread (gnus-sequence-of-unread-articles group)))
3348     ;; Remove entries for this group.
3349     (nnmail-purge-split-history (gnus-group-real-name group))
3350     ;; Do the updating only if the newsgroup isn't killed.
3351     (if (not (numberp (car entry)))
3352         (gnus-message 1 "Can't catch up %s; non-active group" group)
3353       (gnus-update-read-articles group nil)
3354       (when all
3355         ;; Nix out the lists of marks and dormants.
3356         (gnus-request-set-mark group (list (list (cdr (assq 'tick marks))
3357                                                  'del '(tick))
3358                                            (list (cdr (assq 'dormant marks))
3359                                                  'del '(dormant))))
3360         (setq unread (gnus-range-add (gnus-range-add
3361                                       unread (cdr (assq 'dormant marks)))
3362                                      (cdr (assq 'tick marks))))
3363         (gnus-add-marked-articles group 'tick nil nil 'force)
3364         (gnus-add-marked-articles group 'dormant nil nil 'force))
3365       ;; Do auto-expirable marks if that's required.
3366       (when (gnus-group-auto-expirable-p group)
3367         (gnus-range-map (lambda (article)
3368                           (gnus-add-marked-articles group 'expire (list article))
3369                           (gnus-request-set-mark group (list (list (list article) 'add '(expire)))))
3370                         unread))
3371       (let ((gnus-newsgroup-name group))
3372         (gnus-run-hooks 'gnus-group-catchup-group-hook))
3373       num)))
3374
3375 (defun gnus-group-expire-articles (&optional n)
3376   "Expire all expirable articles in the current newsgroup.
3377 Uses the process/prefix convention."
3378   (interactive "P")
3379   (let ((groups (gnus-group-process-prefix n))
3380         group)
3381     (unless groups
3382       (error "No groups to expire"))
3383     (while (setq group (pop groups))
3384       (gnus-group-remove-mark group)
3385       (gnus-group-expire-articles-1 group)
3386       (gnus-dribble-touch)
3387       (gnus-group-position-point))))
3388
3389 (defun gnus-group-expire-articles-1 (group)
3390   (when (gnus-check-backend-function 'request-expire-articles group)
3391     (gnus-message 6 "Expiring articles in %s..."
3392                   (gnus-group-decoded-name group))
3393     (let* ((info (gnus-get-info group))
3394            (expirable (if (gnus-group-total-expirable-p group)
3395                           (cons nil (gnus-list-of-read-articles group))
3396                         (assq 'expire (gnus-info-marks info))))
3397            (expiry-wait (gnus-group-find-parameter group 'expiry-wait))
3398            (nnmail-expiry-target
3399             (or (gnus-group-find-parameter group 'expiry-target)
3400                 nnmail-expiry-target)))
3401       (when expirable
3402         (gnus-check-group group)
3403         (setcdr
3404          expirable
3405          (gnus-compress-sequence
3406           (if expiry-wait
3407               ;; We set the expiry variables to the group
3408               ;; parameter.
3409               (let ((nnmail-expiry-wait-function nil)
3410                     (nnmail-expiry-wait expiry-wait))
3411                 (gnus-request-expire-articles
3412                  (gnus-uncompress-sequence (cdr expirable)) group))
3413             ;; Just expire using the normal expiry values.
3414             (gnus-request-expire-articles
3415              (gnus-uncompress-sequence (cdr expirable)) group))))
3416         (gnus-close-group group))
3417       (gnus-message 6 "Expiring articles in %s...done"
3418                     (gnus-group-decoded-name group))
3419       ;; Return the list of un-expired articles.
3420       (cdr expirable))))
3421
3422 (defun gnus-group-expire-all-groups ()
3423   "Expire all expirable articles in all newsgroups."
3424   (interactive)
3425   (save-excursion
3426     (gnus-message 5 "Expiring...")
3427     (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
3428                                      (cdr gnus-newsrc-alist))))
3429       (gnus-group-expire-articles nil)))
3430   (gnus-group-position-point)
3431   (gnus-message 5 "Expiring...done"))
3432
3433 (defun gnus-group-set-current-level (n level)
3434   "Set the level of the next N groups to LEVEL."
3435   (interactive
3436    (list
3437     current-prefix-arg
3438     (progn
3439       (unless (gnus-group-process-prefix current-prefix-arg)
3440         (error "No group on the current line"))
3441       (string-to-number
3442        (let ((s (read-string
3443                  (format "Level (default %s): "
3444                          (or (gnus-group-group-level)
3445                              gnus-level-default-subscribed)))))
3446          (if (string-match "^\\s-*$" s)
3447              (int-to-string (or (gnus-group-group-level)
3448                                 gnus-level-default-subscribed))
3449            s))))))
3450   (unless (and (>= level 1) (<= level gnus-level-killed))
3451     (error "Invalid level: %d" level))
3452   (dolist (group (gnus-group-process-prefix n))
3453     (gnus-group-remove-mark group)
3454     (gnus-message 6 "Changed level of %s from %d to %d"
3455                   (gnus-group-decoded-name group)
3456                   (or (gnus-group-group-level) gnus-level-killed)
3457                   level)
3458     (gnus-group-change-level
3459      group level (or (gnus-group-group-level) gnus-level-killed))
3460     (gnus-group-update-group-line))
3461   (gnus-group-position-point))
3462
3463 (defun gnus-group-unsubscribe (&optional n)
3464   "Unsubscribe the current group."
3465   (interactive "P")
3466   (gnus-group-unsubscribe-current-group n 'unsubscribe))
3467
3468 (defun gnus-group-subscribe (&optional n)
3469   "Subscribe the current group."
3470   (interactive "P")
3471   (gnus-group-unsubscribe-current-group n 'subscribe))
3472
3473 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
3474   "Toggle subscription of the current group.
3475 If given numerical prefix, toggle the N next groups."
3476   (interactive "P")
3477   (dolist (group (gnus-group-process-prefix n))
3478     (gnus-group-remove-mark group)
3479     (gnus-group-unsubscribe-group
3480      group
3481      (cond
3482       ((eq do-sub 'unsubscribe)
3483        gnus-level-default-unsubscribed)
3484       ((eq do-sub 'subscribe)
3485        gnus-level-default-subscribed)
3486       ((<= (gnus-group-group-level) gnus-level-subscribed)
3487        gnus-level-default-unsubscribed)
3488       (t
3489        gnus-level-default-subscribed))
3490      t)
3491     (gnus-group-update-group-line))
3492   (gnus-group-next-group 1))
3493
3494 (defun gnus-group-unsubscribe-group (group &optional level silent)
3495   "Toggle subscription to GROUP.
3496 Killed newsgroups are subscribed.  If SILENT, don't try to update the
3497 group line."
3498   (interactive
3499    (list (completing-read
3500           "Group: " gnus-active-hashtb nil
3501           (gnus-read-active-file-p)
3502           nil
3503           'gnus-group-history)))
3504   (let ((newsrc (gnus-group-entry group)))
3505     (cond
3506      ((string-match "^[ \t]*$" group)
3507       (error "Empty group name"))
3508      (newsrc
3509       ;; Toggle subscription flag.
3510       (gnus-group-change-level
3511        newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
3512                                       gnus-level-subscribed)
3513                                   (1+ gnus-level-subscribed)
3514                                 gnus-level-default-subscribed)))
3515       (unless silent
3516         (gnus-group-update-group group)))
3517      ((and (stringp group)
3518            (or (not (gnus-read-active-file-p))
3519                (gnus-active group)))
3520       ;; Add new newsgroup.
3521       (gnus-group-change-level
3522        group
3523        (if level level gnus-level-default-subscribed)
3524        (or (and (member group gnus-zombie-list)
3525                 gnus-level-zombie)
3526            gnus-level-killed)
3527        (when (gnus-group-group-name)
3528          (gnus-group-entry (gnus-group-group-name))))
3529       (unless silent
3530         (gnus-group-update-group group)))
3531      (t (error "No such newsgroup: %s" group)))
3532     (gnus-group-position-point)))
3533
3534 (defun gnus-group-transpose-groups (n)
3535   "Move the current newsgroup up N places.
3536 If given a negative prefix, move down instead.  The difference between
3537 N and the number of steps taken is returned."
3538   (interactive "p")
3539   (unless (gnus-group-group-name)
3540     (error "No group on current line"))
3541   (gnus-group-kill-group 1)
3542   (prog1
3543       (forward-line (- n))
3544     (gnus-group-yank-group)
3545     (gnus-group-position-point)))
3546
3547 (defun gnus-group-kill-all-zombies (&optional dummy)
3548   "Kill all zombie newsgroups.
3549 The optional DUMMY should always be nil."
3550   (interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
3551   (unless dummy
3552     (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
3553     (setq gnus-zombie-list nil)
3554     (gnus-dribble-touch)
3555     (gnus-group-list-groups)))
3556
3557 (defun gnus-group-kill-region (begin end)
3558   "Kill newsgroups in current region (excluding current point).
3559 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
3560   (interactive "r")
3561   (let ((lines
3562          ;; Count lines.
3563          (save-excursion
3564            (count-lines
3565             (progn
3566               (goto-char begin)
3567               (point-at-bol))
3568             (progn
3569               (goto-char end)
3570               (point-at-bol))))))
3571     (goto-char begin)
3572     (beginning-of-line)                 ;Important when LINES < 1
3573     (gnus-group-kill-group lines)))
3574
3575 (defun gnus-group-kill-group (&optional n discard)
3576   "Kill the next N groups.
3577 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
3578 However, only groups that were alive can be yanked; already killed
3579 groups or zombie groups can't be yanked.
3580 The return value is the name of the group that was killed, or a list
3581 of groups killed."
3582   (interactive "P")
3583   (let ((buffer-read-only nil)
3584         (groups (gnus-group-process-prefix n))
3585         group entry level out)
3586     (if (< (length groups) 10)
3587         ;; This is faster when there are few groups.
3588         (while groups
3589           (push (setq group (pop groups)) out)
3590           (gnus-group-remove-mark group)
3591           (setq level (gnus-group-group-level))
3592           (gnus-delete-line)
3593           (when (and (not discard)
3594                      (setq entry (gnus-group-entry group)))
3595             (gnus-undo-register
3596               `(progn
3597                  (gnus-group-goto-group ,(gnus-group-group-name))
3598                  (gnus-group-yank-group)))
3599             (push (cons (car entry) (nth 2 entry))
3600                   gnus-list-of-killed-groups))
3601           (gnus-group-change-level
3602            (if entry entry group) gnus-level-killed (if entry nil level))
3603           (message "Killed group %s" (gnus-group-decoded-name group)))
3604       ;; If there are lots and lots of groups to be killed, we use
3605       ;; this thing instead.
3606       (dolist (group (nreverse groups))
3607         (gnus-group-remove-mark group)
3608         (gnus-delete-line)
3609         (push group gnus-killed-list)
3610         (setq gnus-newsrc-alist
3611               (delq (assoc group gnus-newsrc-alist)
3612                     gnus-newsrc-alist))
3613         (when gnus-group-change-level-function
3614           (funcall gnus-group-change-level-function
3615                    group gnus-level-killed 3))
3616         (cond
3617          ((setq entry (gnus-group-entry group))
3618           (push (cons (car entry) (nth 2 entry))
3619                 gnus-list-of-killed-groups)
3620           (setcdr (cdr entry) (cdddr entry)))
3621          ((member group gnus-zombie-list)
3622           (setq gnus-zombie-list (delete group gnus-zombie-list))))
3623         ;; There may be more than one instance displayed.
3624         (while (gnus-group-goto-group group)
3625           (gnus-delete-line)))
3626       (gnus-make-hashtable-from-newsrc-alist))
3627
3628     (gnus-group-position-point)
3629     (if (< (length out) 2) (car out) (nreverse out))))
3630
3631 (defun gnus-group-yank-group (&optional arg)
3632   "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
3633 The numeric ARG specifies how many newsgroups are to be yanked.  The
3634 name of the newsgroup yanked is returned, or (if several groups are
3635 yanked) a list of yanked groups is returned."
3636   (interactive "p")
3637   (setq arg (or arg 1))
3638   (let (info group prev out)
3639     (while (>= (decf arg) 0)
3640       (when (not (setq info (pop gnus-list-of-killed-groups)))
3641         (error "No more newsgroups to yank"))
3642       (push (setq group (nth 1 info)) out)
3643       ;; Find which newsgroup to insert this one before - search
3644       ;; backward until something suitable is found.  If there are no
3645       ;; other newsgroups in this buffer, just make this newsgroup the
3646       ;; first newsgroup.
3647       (setq prev (gnus-group-group-name))
3648       (gnus-group-change-level
3649        info (gnus-info-level (cdr info)) gnus-level-killed
3650        (and prev (gnus-group-entry prev))
3651        t)
3652       (gnus-group-insert-group-line-info group)
3653       (gnus-undo-register
3654         `(when (gnus-group-goto-group ,group)
3655            (gnus-group-kill-group 1))))
3656     (forward-line -1)
3657     (gnus-group-position-point)
3658     (if (< (length out) 2) (car out) (nreverse out))))
3659
3660 (defun gnus-group-kill-level (level)
3661   "Kill all groups that is on a certain LEVEL."
3662   (interactive "nKill all groups on level: ")
3663   (cond
3664    ((= level gnus-level-zombie)
3665     (setq gnus-killed-list
3666           (nconc gnus-zombie-list gnus-killed-list))
3667     (setq gnus-zombie-list nil))
3668    ((and (< level gnus-level-zombie)
3669          (> level 0)
3670          (or gnus-expert-user
3671              (gnus-yes-or-no-p
3672               (format
3673                "Do you really want to kill all groups on level %d? "
3674                level))))
3675     (let* ((prev gnus-newsrc-alist)
3676            (alist (cdr prev)))
3677       (while alist
3678         (if (= (gnus-info-level (car alist)) level)
3679             (progn
3680               (push (gnus-info-group (car alist)) gnus-killed-list)
3681               (setcdr prev (cdr alist)))
3682           (setq prev alist))
3683         (setq alist (cdr alist)))
3684       (gnus-make-hashtable-from-newsrc-alist)
3685       (gnus-group-list-groups)))
3686    (t
3687     (error "Can't kill; invalid level: %d" level))))
3688
3689 (defun gnus-group-list-all-groups (&optional arg)
3690   "List all newsgroups with level ARG or lower.
3691 Default is `gnus-level-unsubscribed', which lists all subscribed and most
3692 unsubscribed groups."
3693   (interactive "P")
3694   (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
3695
3696 ;; Redefine this to list ALL killed groups if prefix arg used.
3697 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
3698 (defun gnus-group-list-killed (&optional arg)
3699   "List all killed newsgroups in the group buffer.
3700 If ARG is non-nil, list ALL killed groups known to Gnus.  This may
3701 entail asking the server for the groups."
3702   (interactive "P")
3703   ;; Find all possible killed newsgroups if arg.
3704   (when arg
3705     (gnus-get-killed-groups))
3706   (if (not gnus-killed-list)
3707       (gnus-message 6 "No killed groups")
3708     (let (gnus-group-list-mode)
3709       (funcall gnus-group-prepare-function
3710                gnus-level-killed t gnus-level-killed))
3711     (goto-char (point-min)))
3712   (gnus-group-position-point))
3713
3714 (defun gnus-group-list-zombies ()
3715   "List all zombie newsgroups in the group buffer."
3716   (interactive)
3717   (if (not gnus-zombie-list)
3718       (gnus-message 6 "No zombie groups")
3719     (let (gnus-group-list-mode)
3720       (funcall gnus-group-prepare-function
3721                gnus-level-zombie t gnus-level-zombie))
3722     (goto-char (point-min)))
3723   (gnus-group-position-point))
3724
3725 (defun gnus-group-list-active ()
3726   "List all groups that are available from the server(s)."
3727   (interactive)
3728   ;; First we make sure that we have really read the active file.
3729   (unless (gnus-read-active-file-p)
3730     (let ((gnus-read-active-file t)
3731           (gnus-agent gnus-plugged)); If we're actually plugged, store the active file in the agent.
3732       (gnus-read-active-file)))
3733   ;; Find all groups and sort them.
3734   (let ((groups
3735          (sort
3736           (let (list)
3737             (mapatoms
3738              (lambda (sym)
3739                (and (boundp sym)
3740                     (symbol-value sym)
3741                     (push (symbol-name sym) list)))
3742              gnus-active-hashtb)
3743             list)
3744           'string<))
3745         (buffer-read-only nil)
3746         group)
3747     (erase-buffer)
3748     (while groups
3749       (setq group (pop groups))
3750       (gnus-add-text-properties
3751        (point) (prog1 (1+ (point))
3752                  (insert "       *: "
3753                          (gnus-group-decoded-name group)
3754                          "\n"))
3755        (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
3756              'gnus-unread t
3757              'gnus-level (inline (gnus-group-level group)))))
3758     (goto-char (point-min))))
3759
3760 (defun gnus-activate-all-groups (level)
3761   "Activate absolutely all groups."
3762   (interactive (list gnus-level-unsubscribed))
3763   (let ((gnus-activate-level level)
3764         (gnus-activate-foreign-newsgroups level))
3765     (gnus-group-get-new-news)))
3766
3767 (defun gnus-group-get-new-news (&optional arg)
3768   "Get newly arrived articles.
3769 If ARG is a number, it specifies which levels you are interested in
3770 re-scanning.  If ARG is non-nil and not a number, this will force
3771 \"hard\" re-reading of the active files from all servers."
3772   (interactive "P")
3773   (require 'nnmail)
3774   (let ((gnus-inhibit-demon t)
3775         ;; Binding this variable will inhibit multiple fetchings
3776         ;; of the same mail source.
3777         (nnmail-fetched-sources (list t)))
3778     (gnus-run-hooks 'gnus-get-top-new-news-hook)
3779     (gnus-run-hooks 'gnus-get-new-news-hook)
3780
3781     ;; Read any slave files.
3782     (unless gnus-slave
3783       (gnus-master-read-slave-newsrc))
3784
3785     ;; We might read in new NoCeM messages here.
3786     (when (and gnus-use-nocem
3787                (null arg))
3788       (gnus-nocem-scan-groups))
3789     ;; If ARG is not a number, then we read the active file.
3790     (when (and arg (not (numberp arg)))
3791       (let ((gnus-read-active-file t))
3792         (gnus-read-active-file))
3793       (setq arg nil)
3794
3795       ;; If the user wants it, we scan for new groups.
3796       (when (eq gnus-check-new-newsgroups 'always)
3797         (gnus-find-new-newsgroups)))
3798
3799     (setq arg (gnus-group-default-level arg t))
3800     (if (and gnus-read-active-file (not arg))
3801         (progn
3802           (gnus-read-active-file)
3803           (gnus-get-unread-articles arg))
3804       (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
3805         (gnus-get-unread-articles arg)))
3806     (gnus-check-reasonable-setup)
3807     (gnus-run-hooks 'gnus-after-getting-new-news-hook)
3808     (gnus-group-list-groups (and (numberp arg)
3809                                  (max (car gnus-group-list-mode) arg)))))
3810
3811 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
3812   "Check for newly arrived news in the current group (and the N-1 next groups).
3813 The difference between N and the number of newsgroup checked is returned.
3814 If N is negative, this group and the N-1 previous groups will be checked.
3815 If DONT-SCAN is non-nil, scan non-activated groups as well."
3816   (interactive "P")
3817   (let* ((groups (gnus-group-process-prefix n))
3818          (ret (if (numberp n) (- n (length groups)) 0))
3819          (beg (unless n
3820                 (point)))
3821          group method
3822          (gnus-inhibit-demon t)
3823          ;; Binding this variable will inhibit multiple fetchings
3824          ;; of the same mail source.
3825          (nnmail-fetched-sources (list t)))
3826     (gnus-run-hooks 'gnus-get-new-news-hook)
3827     (while (setq group (pop groups))
3828       (gnus-group-remove-mark group)
3829       ;; Bypass any previous denials from the server.
3830       (gnus-remove-denial (setq method (gnus-find-method-for-group group)))
3831       (if (gnus-activate-group group (if dont-scan nil 'scan) nil method)
3832           (let ((info (gnus-get-info group))
3833                 (active (gnus-active group)))
3834             (when info
3835               (gnus-request-update-info info method))
3836             (gnus-get-unread-articles-in-group info active)
3837             (unless (gnus-virtual-group-p group)
3838               (gnus-close-group group))
3839             (when gnus-agent
3840               (gnus-agent-save-group-info
3841                method (gnus-group-real-name group) active))
3842             (gnus-group-update-group group))
3843         (if (eq (gnus-server-status (gnus-find-method-for-group group))
3844                 'denied)
3845             (gnus-error 3 "Server denied access")
3846           (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
3847     (when beg
3848       (goto-char beg))
3849     (when gnus-goto-next-group-when-activating
3850       (gnus-group-next-unread-group 1 t))
3851     (gnus-summary-position-point)
3852     ret))
3853
3854 (defun gnus-group-fetch-faq (group &optional faq-dir)
3855   "Fetch the FAQ for the current group.
3856 If given a prefix argument, prompt for the FAQ dir
3857 to use."
3858   (interactive
3859    (list
3860     (gnus-group-group-name)
3861     (when current-prefix-arg
3862       (completing-read
3863        "FAQ dir: " (and (listp gnus-group-faq-directory)
3864                         (mapcar #'list
3865                                 gnus-group-faq-directory))))))
3866   (unless group
3867     (error "No group name given"))
3868   (let ((dirs (or faq-dir gnus-group-faq-directory))
3869         dir found file)
3870     (unless (listp dirs)
3871       (setq dirs (list dirs)))
3872     (while (and (not found)
3873                 (setq dir (pop dirs)))
3874       (let ((name (gnus-group-real-name group)))
3875         (setq file (expand-file-name name dir)))
3876       (if (not (file-exists-p file))
3877           (gnus-message 1 "No such file: %s" file)
3878         (let ((enable-local-variables nil))
3879           (find-file file)
3880           (setq found t))))))
3881
3882 (defun gnus-group-fetch-charter (group)
3883   "Fetch the charter for the current group.
3884 If given a prefix argument, prompt for a group."
3885   (interactive
3886    (list (or (when current-prefix-arg
3887                (completing-read "Group: " gnus-active-hashtb))
3888              (gnus-group-group-name)
3889              gnus-newsgroup-name)))
3890   (unless group
3891     (error "No group name given"))
3892   (require 'mm-url)
3893   (condition-case nil (require 'url-http) (error nil))
3894   (let ((name (mm-url-form-encode-xwfu (gnus-group-real-name group)))
3895         url hierarchy)
3896     (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3897       (setq hierarchy (match-string 1 name))
3898       (if (and (setq url (cdr (assoc hierarchy gnus-group-charter-alist)))
3899                (if (fboundp 'url-http-file-exists-p)
3900                    (url-http-file-exists-p (eval url))
3901                  t))
3902           (browse-url (eval url))
3903         (setq url (concat "http://" hierarchy
3904                           ".news-admin.org/charters/" name))
3905         (if (and (fboundp 'url-http-file-exists-p)
3906                  (url-http-file-exists-p url))
3907             (browse-url url)
3908           (gnus-group-fetch-control group))))))
3909
3910 (defun gnus-group-fetch-control (group)
3911   "Fetch the archived control messages for the current group.
3912 If given a prefix argument, prompt for a group."
3913   (interactive
3914    (list (or (when current-prefix-arg
3915                (completing-read "Group: " gnus-active-hashtb))
3916              (gnus-group-group-name)
3917              gnus-newsgroup-name)))
3918   (unless group
3919     (error "No group name given"))
3920   (let ((name (gnus-group-real-name group))
3921         hierarchy)
3922     (when (string-match "\\(^[^\\.]+\\)\\..*" name)
3923       (setq hierarchy (match-string 1 name))
3924       (if gnus-group-fetch-control-use-browse-url
3925           (browse-url (concat "ftp://ftp.isc.org/usenet/control/"
3926                               hierarchy "/" name ".gz"))
3927         (let ((enable-local-variables nil))
3928           (gnus-group-read-ephemeral-group
3929            group
3930            `(nndoc ,group (nndoc-address
3931                            ,(find-file-noselect
3932                              (concat "/ftp@ftp.isc.org:/usenet/control/"
3933                                      hierarchy "/" name ".gz")))
3934                    (nndoc-article-type mbox)) t nil nil))))))
3935
3936 (defun gnus-group-describe-group (force &optional group)
3937   "Display a description of the current newsgroup."
3938   (interactive (list current-prefix-arg (gnus-group-group-name)))
3939   (let* ((method (gnus-find-method-for-group group))
3940          (mname (gnus-group-prefixed-name "" method))
3941          desc)
3942     (when (and force
3943                gnus-description-hashtb)
3944       (gnus-sethash mname nil gnus-description-hashtb))
3945     (unless group
3946       (error "No group name given"))
3947     (when (or (and gnus-description-hashtb
3948                    ;; We check whether this group's method has been
3949                    ;; queried for a description file.
3950                    (gnus-gethash mname gnus-description-hashtb))
3951               (setq desc (gnus-group-get-description group))
3952               (gnus-read-descriptions-file method))
3953       (gnus-message 1
3954                     (or desc (gnus-gethash group gnus-description-hashtb)
3955                         "No description available")))))
3956
3957 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
3958 (defun gnus-group-describe-all-groups (&optional force)
3959   "Pop up a buffer with descriptions of all newsgroups."
3960   (interactive "P")
3961   (when force
3962     (setq gnus-description-hashtb nil))
3963   (when (not (or gnus-description-hashtb
3964                  (gnus-read-all-descriptions-files)))
3965     (error "Couldn't request descriptions file"))
3966   (let ((buffer-read-only nil)
3967         b)
3968     (erase-buffer)
3969     (mapatoms
3970      (lambda (group)
3971        (setq b (point))
3972        (let ((charset (gnus-group-name-charset nil (symbol-name group))))
3973          (insert (format "      *: %-20s %s\n"
3974                          (gnus-group-name-decode
3975                           (symbol-name group) charset)
3976                          (gnus-group-name-decode
3977                           (symbol-value group) charset))))
3978        (gnus-add-text-properties
3979         b (1+ b) (list 'gnus-group group
3980                        'gnus-unread t 'gnus-marked nil
3981                        'gnus-level (1+ gnus-level-subscribed))))
3982      gnus-description-hashtb)
3983     (goto-char (point-min))
3984     (gnus-group-position-point)))
3985
3986 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
3987 (defun gnus-group-apropos (regexp &optional search-description)
3988   "List all newsgroups that have names that match a regexp."
3989   (interactive "sGnus apropos (regexp): ")
3990   (let ((prev "")
3991         (obuf (current-buffer))
3992         groups des)
3993     ;; Go through all newsgroups that are known to Gnus.
3994     (mapatoms
3995      (lambda (group)
3996        (and (symbol-name group)
3997             (string-match regexp (symbol-name group))
3998             (symbol-value group)
3999             (push (symbol-name group) groups)))
4000      gnus-active-hashtb)
4001     ;; Also go through all descriptions that are known to Gnus.
4002     (when search-description
4003       (mapatoms
4004        (lambda (group)
4005          (and (string-match regexp (symbol-value group))
4006               (push (symbol-name group) groups)))
4007        gnus-description-hashtb))
4008     (if (not groups)
4009         (gnus-message 3 "No groups matched \"%s\"." regexp)
4010       ;; Print out all the groups.
4011       (save-excursion
4012         (pop-to-buffer "*Gnus Help*")
4013         (buffer-disable-undo)
4014         (erase-buffer)
4015         (setq groups (sort groups 'string<))
4016         (while groups
4017           ;; Groups may be entered twice into the list of groups.
4018           (when (not (string= (car groups) prev))
4019             (setq prev (car groups))
4020             (let ((charset (gnus-group-name-charset nil prev)))
4021               (insert (gnus-group-name-decode prev charset) "\n")
4022               (when (and gnus-description-hashtb
4023                          (setq des (gnus-gethash (car groups)
4024                                                  gnus-description-hashtb)))
4025                 (insert "  " (gnus-group-name-decode des charset) "\n"))))
4026           (setq groups (cdr groups)))
4027         (goto-char (point-min))))
4028     (pop-to-buffer obuf)))
4029
4030 (defun gnus-group-description-apropos (regexp)
4031   "List all newsgroups that have names or descriptions that match REGEXP."
4032   (interactive "sGnus description apropos (regexp): ")
4033   (when (not (or gnus-description-hashtb
4034                  (gnus-read-all-descriptions-files)))
4035     (error "Couldn't request descriptions file"))
4036   (gnus-group-apropos regexp t))
4037
4038 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4039 (defun gnus-group-list-matching (level regexp &optional all lowest)
4040   "List all groups with unread articles that match REGEXP.
4041 If the prefix LEVEL is non-nil, it should be a number that says which
4042 level to cut off listing groups.
4043 If ALL, also list groups with no unread articles.
4044 If LOWEST, don't list groups with level lower than LOWEST.
4045
4046 This command may read the active file."
4047   (interactive "P\nsList newsgroups matching: ")
4048   ;; First make sure active file has been read.
4049   (when (and level
4050              (> (prefix-numeric-value level) gnus-level-killed))
4051     (gnus-get-killed-groups))
4052   (funcall gnus-group-prepare-function
4053    (or level gnus-level-subscribed) (and all t) (or lowest 1) regexp)
4054   (goto-char (point-min))
4055   (gnus-group-position-point))
4056
4057 (defun gnus-group-list-all-matching (level regexp &optional lowest)
4058   "List all groups that match REGEXP.
4059 If the prefix LEVEL is non-nil, it should be a number that says which
4060 level to cut off listing groups.
4061 If LOWEST, don't list groups with level lower than LOWEST."
4062   (interactive "P\nsList newsgroups matching: ")
4063   (when level
4064     (setq level (prefix-numeric-value level)))
4065   (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
4066
4067 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
4068 (defun gnus-group-save-newsrc (&optional force)
4069   "Save the Gnus startup files.
4070 If FORCE, force saving whether it is necessary or not."
4071   (interactive "P")
4072   (gnus-save-newsrc-file force))
4073
4074 (defun gnus-group-restart (&optional arg)
4075   "Force Gnus to read the .newsrc file."
4076   (interactive "P")
4077   (when (gnus-yes-or-no-p
4078          (format "Are you sure you want to restart Gnus? "))
4079     (gnus-save-newsrc-file)
4080     (gnus-clear-system)
4081     (gnus)))
4082
4083 (defun gnus-group-read-init-file ()
4084   "Read the Gnus elisp init file."
4085   (interactive)
4086   (gnus-read-init-file)
4087   (gnus-message 5 "Read %s" gnus-init-file))
4088
4089 (defun gnus-group-check-bogus-groups (&optional silent)
4090   "Check bogus newsgroups.
4091 If given a prefix, don't ask for confirmation before removing a bogus
4092 group."
4093   (interactive "P")
4094   (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
4095   (gnus-group-list-groups))
4096
4097 (defun gnus-group-find-new-groups (&optional arg)
4098   "Search for new groups and add them.
4099 Each new group will be treated with `gnus-subscribe-newsgroup-method'.
4100 With 1 C-u, use the `ask-server' method to query the server for new
4101 groups.
4102 With 2 C-u's, use most complete method possible to query the server
4103 for new groups, and subscribe the new groups as zombies."
4104   (interactive "p")
4105   (gnus-find-new-newsgroups (or arg 1))
4106   (gnus-group-list-groups))
4107
4108 (defun gnus-group-edit-global-kill (&optional article group)
4109   "Edit the global kill file.
4110 If GROUP, edit that local kill file instead."
4111   (interactive "P")
4112   (setq gnus-current-kill-article article)
4113   (gnus-kill-file-edit-file group)
4114   (gnus-message
4115    6
4116    (substitute-command-keys
4117     (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
4118             (if group "local" "global")))))
4119
4120 (defun gnus-group-edit-local-kill (article group)
4121   "Edit a local kill file."
4122   (interactive (list nil (gnus-group-group-name)))
4123   (gnus-group-edit-global-kill article group))
4124
4125 (defun gnus-group-force-update ()
4126   "Update `.newsrc' file."
4127   (interactive)
4128   (gnus-save-newsrc-file))
4129
4130 (defvar gnus-backlog-articles)
4131
4132 (defun gnus-group-suspend ()
4133   "Suspend the current Gnus session.
4134 In fact, cleanup buffers except for group mode buffer.
4135 The hook `gnus-suspend-gnus-hook' is called before actually suspending."
4136   (interactive)
4137   (gnus-run-hooks 'gnus-suspend-gnus-hook)
4138   (gnus-offer-save-summaries)
4139   ;; Kill Gnus buffers except for group mode buffer.
4140   (let ((group-buf (get-buffer gnus-group-buffer)))
4141     (mapcar (lambda (buf)
4142               (unless (or (member buf (list group-buf gnus-dribble-buffer))
4143                           (with-current-buffer buf
4144                             (eq major-mode 'message-mode)))
4145                 (gnus-kill-buffer buf)))
4146             (gnus-buffers))
4147     (setq gnus-backlog-articles nil)
4148     (gnus-kill-gnus-frames)
4149     (when group-buf
4150       (bury-buffer group-buf)
4151       (delete-windows-on group-buf t))))
4152
4153 (defun gnus-group-clear-dribble ()
4154   "Clear all information from the dribble buffer."
4155   (interactive)
4156   (gnus-dribble-clear)
4157   (gnus-message 7 "Cleared dribble buffer"))
4158
4159 (defun gnus-group-exit ()
4160   "Quit reading news after updating .newsrc.eld and .newsrc.
4161 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4162   (interactive)
4163   (when
4164       (or noninteractive                ;For gnus-batch-kill
4165           (not gnus-interactive-exit)   ;Without confirmation
4166           gnus-expert-user
4167           (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
4168     (gnus-run-hooks 'gnus-exit-gnus-hook)
4169     ;; Offer to save data from non-quitted summary buffers.
4170     (gnus-offer-save-summaries)
4171     ;; Save the newsrc file(s).
4172     (gnus-save-newsrc-file)
4173     ;; Kill-em-all.
4174     (gnus-close-backends)
4175     ;; Reset everything.
4176     (gnus-clear-system)
4177     ;; Allow the user to do things after cleaning up.
4178     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4179
4180 (defun gnus-group-quit ()
4181   "Quit reading news without updating .newsrc.eld or .newsrc.
4182 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4183   (interactive)
4184   (when (or noninteractive              ;For gnus-batch-kill
4185             (zerop (buffer-size))
4186             (not (gnus-server-opened gnus-select-method))
4187             gnus-expert-user
4188             (not gnus-current-startup-file)
4189             (gnus-yes-or-no-p
4190              (format "Quit reading news without saving %s? "
4191                      (file-name-nondirectory gnus-current-startup-file))))
4192     (gnus-run-hooks 'gnus-exit-gnus-hook)
4193     (gnus-configure-windows 'group t)
4194     (when (and (gnus-buffer-live-p gnus-dribble-buffer)
4195                (not (zerop (save-excursion
4196                             (set-buffer gnus-dribble-buffer)
4197                             (buffer-size)))))
4198       (gnus-dribble-enter
4199        ";;; Gnus was exited on purpose without saving the .newsrc files."))
4200     (gnus-dribble-save)
4201     (gnus-close-backends)
4202     (gnus-clear-system)
4203     (gnus-kill-buffer gnus-group-buffer)
4204     ;; Allow the user to do things after cleaning up.
4205     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4206
4207 (defun gnus-group-describe-briefly ()
4208   "Give a one line description of the group mode commands."
4209   (interactive)
4210   (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")))
4211
4212 (defun gnus-group-browse-foreign-server (method)
4213   "Browse a foreign news server.
4214 If called interactively, this function will ask for a select method
4215  (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
4216 If not, METHOD should be a list where the first element is the method
4217 and the second element is the address."
4218   (interactive
4219    (list (let ((how (completing-read
4220                      "Which back end: "
4221                      (append gnus-valid-select-methods gnus-server-alist)
4222                      nil t (cons "nntp" 0) 'gnus-method-history)))
4223            ;; We either got a back end name or a virtual server name.
4224            ;; If the first, we also need an address.
4225            (if (assoc how gnus-valid-select-methods)
4226                (list (intern how)
4227                      ;; Suggested by mapjph@bath.ac.uk.
4228                      (completing-read
4229                       "Address: "
4230                       (mapcar 'list gnus-secondary-servers)))
4231              ;; We got a server name.
4232              how))))
4233   (gnus-browse-foreign-server method))
4234
4235 (defun gnus-group-set-info (info &optional method-only-group part)
4236   (when (or info part)
4237     (let* ((entry (gnus-group-entry
4238                    (or method-only-group (gnus-info-group info))))
4239            (part-info info)
4240            (info (if method-only-group (nth 2 entry) info))
4241            method)
4242       (when method-only-group
4243         (unless entry
4244           (error "Trying to change non-existent group %s" method-only-group))
4245         ;; We have received parts of the actual group info - either the
4246         ;; select method or the group parameters.        We first check
4247         ;; whether we have to extend the info, and if so, do that.
4248         (let ((len (length info))
4249               (total (if (eq part 'method) 5 6)))
4250           (when (< len total)
4251             (setcdr (nthcdr (1- len) info)
4252                     (make-list (- total len) nil)))
4253           ;; Then we enter the new info.
4254           (setcar (nthcdr (1- total) info) part-info)))
4255       (unless entry
4256         ;; This is a new group, so we just create it.
4257         (save-excursion
4258           (set-buffer gnus-group-buffer)
4259           (setq method (gnus-info-method info))
4260           (when (gnus-server-equal method "native")
4261             (setq method nil))
4262           (save-excursion
4263             (set-buffer gnus-group-buffer)
4264             (if method
4265                 ;; It's a foreign group...
4266                 (gnus-group-make-group
4267                  (gnus-group-real-name (gnus-info-group info))
4268                  (if (stringp method) method
4269                    (prin1-to-string (car method)))
4270                  (and (consp method)
4271                       (nth 1 (gnus-info-method info))))
4272               ;; It's a native group.
4273               (gnus-group-make-group (gnus-info-group info))))
4274           (gnus-message 6 "Note: New group created")
4275           (setq entry
4276                 (gnus-group-entry (gnus-group-prefixed-name
4277                                    (gnus-group-real-name (gnus-info-group info))
4278                                    (or (gnus-info-method info) gnus-select-method))))))
4279       ;; Whether it was a new group or not, we now have the entry, so we
4280       ;; can do the update.
4281       (if entry
4282           (progn
4283             (setcar (nthcdr 2 entry) info)
4284             (when (and (not (eq (car entry) t))
4285                        (gnus-active (gnus-info-group info)))
4286               (setcar entry (length
4287                              (gnus-list-of-unread-articles (car info))))))
4288         (error "No such group: %s" (gnus-info-group info))))))
4289
4290 (defun gnus-group-set-method-info (group select-method)
4291   (gnus-group-set-info select-method group 'method))
4292
4293 (defun gnus-group-set-params-info (group params)
4294   (gnus-group-set-info params group 'params))
4295
4296 (defun gnus-add-marked-articles (group type articles &optional info force)
4297   ;; Add ARTICLES of TYPE to the info of GROUP.
4298   ;; If INFO is non-nil, use that info.  If FORCE is non-nil, don't
4299   ;; add, but replace marked articles of TYPE with ARTICLES.
4300   (let ((info (or info (gnus-get-info group)))
4301         marked m)
4302     (or (not info)
4303         (and (not (setq marked (nthcdr 3 info)))
4304              (or (null articles)
4305                  (setcdr (nthcdr 2 info)
4306                          (list (list (cons type (gnus-compress-sequence
4307                                                  articles t)))))))
4308         (and (not (setq m (assq type (car marked))))
4309              (or (null articles)
4310                  (setcar marked
4311                          (cons (cons type (gnus-compress-sequence articles t) )
4312                                (car marked)))))
4313         (if force
4314             (if (null articles)
4315                 (setcar (nthcdr 3 info)
4316                         (gnus-delete-alist type (car marked)))
4317               (setcdr m (gnus-compress-sequence articles t)))
4318           (setcdr m (gnus-compress-sequence
4319                      (sort (nconc (gnus-uncompress-range (cdr m))
4320                                   (copy-sequence articles)) '<) t))))))
4321
4322 (defun gnus-add-mark (group mark article)
4323   "Mark ARTICLE in GROUP with MARK, whether the group is displayed or not."
4324   (let ((buffer (gnus-summary-buffer-name group)))
4325     (if (gnus-buffer-live-p buffer)
4326         (save-excursion
4327           (set-buffer (get-buffer buffer))
4328           (gnus-summary-add-mark article mark))
4329       (gnus-add-marked-articles group (cdr (assq mark gnus-article-mark-lists))
4330                                 (list article)))))
4331
4332 ;;;
4333 ;;; Group timestamps
4334 ;;;
4335
4336 (defun gnus-group-set-timestamp ()
4337   "Change the timestamp of the current group to the current time.
4338 This function can be used in hooks like `gnus-select-group-hook'
4339 or `gnus-group-catchup-group-hook'."
4340   (when gnus-newsgroup-name
4341     (let ((time (current-time)))
4342       (setcdr (cdr time) nil)
4343       (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
4344
4345 (defsubst gnus-group-timestamp (group)
4346   "Return the timestamp for GROUP."
4347   (gnus-group-get-parameter group 'timestamp t))
4348
4349 (defun gnus-group-timestamp-delta (group)
4350   "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
4351   (let* ((time (or (gnus-group-timestamp group)
4352                    (list 0 0)))
4353          (delta (subtract-time (current-time) time)))
4354     (+ (* (nth 0 delta) 65536.0)
4355        (nth 1 delta))))
4356
4357 (defun gnus-group-timestamp-string (group)
4358   "Return a string of the timestamp for GROUP."
4359   (let ((time (gnus-group-timestamp group)))
4360     (if (not time)
4361         ""
4362       (gnus-time-iso8601 time))))
4363
4364 (defun gnus-group-list-cached (level &optional lowest)
4365   "List all groups with cached articles.
4366 If the prefix LEVEL is non-nil, it should be a number that says which
4367 level to cut off listing groups.
4368 If LOWEST, don't list groups with level lower than LOWEST.
4369
4370 This command may read the active file."
4371   (interactive "P")
4372   (when level
4373     (setq level (prefix-numeric-value level)))
4374   (when (or (not level) (>= level gnus-level-zombie))
4375     (gnus-cache-open))
4376   (funcall gnus-group-prepare-function
4377            (or level gnus-level-subscribed)
4378            #'(lambda (info)
4379                (let ((marks (gnus-info-marks info)))
4380                  (assq 'cache marks)))
4381            lowest
4382            #'(lambda (group)
4383                (or (gnus-gethash group
4384                                  gnus-cache-active-hashtb)
4385                    ;; Cache active file might use "."
4386                    ;; instead of ":".
4387                    (gnus-gethash
4388                     (mapconcat 'identity
4389                                (split-string group ":")
4390                                ".")
4391                     gnus-cache-active-hashtb))))
4392   (goto-char (point-min))
4393   (gnus-group-position-point))
4394
4395 (defun gnus-group-list-dormant (level &optional lowest)
4396   "List all groups with dormant articles.
4397 If the prefix LEVEL is non-nil, it should be a number that says which
4398 level to cut off listing groups.
4399 If LOWEST, don't list groups with level lower than LOWEST.
4400
4401 This command may read the active file."
4402   (interactive "P")
4403   (when level
4404     (setq level (prefix-numeric-value level)))
4405   (when (or (not level) (>= level gnus-level-zombie))
4406     (gnus-cache-open))
4407   (funcall gnus-group-prepare-function
4408            (or level gnus-level-subscribed)
4409            #'(lambda (info)
4410                (let ((marks (gnus-info-marks info)))
4411                  (assq 'dormant marks)))
4412            lowest
4413            'ignore)
4414   (goto-char (point-min))
4415   (gnus-group-position-point))
4416
4417 (defun gnus-group-listed-groups ()
4418   "Return a list of listed groups."
4419   (let (point groups)
4420     (goto-char (point-min))
4421     (while (setq point (text-property-not-all (point) (point-max)
4422                                               'gnus-group nil))
4423       (goto-char point)
4424       (push (symbol-name (get-text-property point 'gnus-group)) groups)
4425       (forward-char 1))
4426     groups))
4427
4428 (defun gnus-group-list-plus (&optional args)
4429   "List groups plus the current selection."
4430   (interactive "P")
4431   (let ((gnus-group-listed-groups (gnus-group-listed-groups))
4432         (gnus-group-list-mode gnus-group-list-mode) ;; Save it.
4433         func)
4434     (push last-command-event unread-command-events)
4435     (if (featurep 'xemacs)
4436         (push (make-event 'key-press '(key ?A)) unread-command-events)
4437       (push ?A unread-command-events))
4438     (let (gnus-pick-mode keys)
4439       (setq keys (if (featurep 'xemacs)
4440                      (events-to-keys (read-key-sequence nil))
4441                    (read-key-sequence nil)))
4442       (setq func (lookup-key (current-local-map) keys)))
4443     (if (or (not func)
4444             (numberp func))
4445         (ding)
4446       (call-interactively func))))
4447
4448 (defun gnus-group-list-flush (&optional args)
4449   "Flush groups from the current selection."
4450   (interactive "P")
4451   (let ((gnus-group-list-option 'flush))
4452     (gnus-group-list-plus args)))
4453
4454 (defun gnus-group-list-limit (&optional args)
4455   "List groups limited within the current selection."
4456   (interactive "P")
4457   (let ((gnus-group-list-option 'limit))
4458     (gnus-group-list-plus args)))
4459
4460 (defun gnus-group-mark-article-read (group article)
4461   "Mark ARTICLE read."
4462   (let ((buffer (gnus-summary-buffer-name group))
4463         (mark gnus-read-mark)
4464         active n)
4465     (if (get-buffer buffer)
4466         (with-current-buffer buffer
4467           (setq active gnus-newsgroup-active)
4468           (gnus-activate-group group)
4469           (when gnus-newsgroup-prepared
4470             (when (and gnus-newsgroup-auto-expire
4471                        (memq mark gnus-auto-expirable-marks))
4472               (setq mark gnus-expirable-mark))
4473             (setq mark (gnus-request-update-mark
4474                         group article mark))
4475             (gnus-mark-article-as-read article mark)
4476             (setq gnus-newsgroup-active (gnus-active group))
4477             (when active
4478               (setq n (1+ (cdr active)))
4479               (while (<= n (cdr gnus-newsgroup-active))
4480                 (unless (eq n article)
4481                   (push n gnus-newsgroup-unselected))
4482                 (setq n (1+ n)))
4483               (setq gnus-newsgroup-unselected
4484                     (nreverse gnus-newsgroup-unselected)))))
4485       (gnus-activate-group group)
4486       (gnus-group-make-articles-read group (list article))
4487       (when (gnus-group-auto-expirable-p group)
4488         (gnus-add-marked-articles
4489          group 'expire (list article))))))
4490
4491
4492 ;;;
4493 ;;; Group compaction. -- dvl
4494 ;;;
4495
4496 (defun gnus-group-compact-group (group)
4497   "Compact the current group.
4498 Compaction means removing gaps between article numbers.  Hence, this
4499 operation is only meaningful for back ends using one file per article
4500 \(e.g. nnml).
4501
4502 Note: currently only implemented in nnml."
4503   (interactive (list (gnus-group-group-name)))
4504   (unless group
4505     (error "No group to compact"))
4506   (unless (gnus-check-backend-function 'request-compact-group group)
4507     (error "This back end does not support group compaction"))
4508   (let ((group-decoded (gnus-group-decoded-name group)))
4509     (gnus-message 6 "\
4510 Compacting group %s... (this may take a long time)"
4511                   group-decoded)
4512     (prog1
4513         (if (not (gnus-request-compact-group group))
4514             (gnus-error 3 "Couldn't compact group %s" group-decoded)
4515           (gnus-message 6 "Compacting group %s...done" group-decoded)
4516           t)
4517       ;; Invalidate the "original article" buffer which might be out of date.
4518       ;; #### NOTE: Yes, this might be a bit rude, but since compaction
4519       ;; #### will not happen very often, I think this is acceptable.
4520       (let ((original (get-buffer gnus-original-article-buffer)))
4521         (and original (gnus-kill-buffer original)))
4522       ;; Update the group line to reflect new information (art number etc).
4523       (gnus-group-update-group-line))))
4524
4525 (provide 'gnus-group)
4526
4527 ;;; arch-tag: 2eb5440f-0bca-4091-814c-e37817536af6
4528 ;;; gnus-group.el ends here