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