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