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