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