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