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