5ae29053b6f61419a0c26a5f576e0fd6566a7809
[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 "unplugged" t
1012                                :help "Gnus is currently unplugged.  Click to work online."
1013                                :visible (and gnus-agent (not gnus-plugged)))
1014     (gnus-agent-toggle-plugged "plugged" 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   (unless (gnus-alive-p)
2286     (gnus-no-server))
2287   (when (stringp method)
2288     (setq method (gnus-server-to-method method)))
2289   (setq method
2290         `(,(car method) ,(concat (cadr method) "-ephemeral")
2291           (,(intern (format "%s-address" (car method))) ,(cadr method))
2292           ,@(cddr method)))
2293   (let ((group (if (gnus-group-foreign-p group) group
2294                  (gnus-group-prefixed-name (gnus-group-real-name group)
2295                                            method))))
2296     (gnus-sethash
2297      group
2298      `(-1 nil (,group
2299                ,gnus-level-default-subscribed nil nil ,method
2300                ,(cons
2301                  (cond
2302                   (quit-config
2303                    (cons 'quit-config quit-config))
2304                   ((assq gnus-current-window-configuration
2305                          gnus-buffer-configuration)
2306                    (cons 'quit-config
2307                          (cons gnus-summary-buffer
2308                                gnus-current-window-configuration))))
2309                  parameters)))
2310      gnus-newsrc-hashtb)
2311     (push method gnus-ephemeral-servers)
2312     (set-buffer gnus-group-buffer)
2313     (unless (gnus-check-server method)
2314       (error "Unable to contact server: %s" (gnus-status-message method)))
2315     (when activate
2316       (gnus-activate-group group 'scan)
2317       (unless (gnus-request-group group)
2318         (error "Couldn't request group: %s"
2319                (nnheader-get-report (car method)))))
2320     (if request-only
2321         group
2322       (condition-case ()
2323           (when (let ((gnus-large-newsgroup gnus-large-ephemeral-newsgroup)
2324                       (gnus-fetch-old-headers
2325                        gnus-fetch-old-ephemeral-headers))
2326                   (gnus-group-read-group (or number t) t group select-articles))
2327             group)
2328         (quit
2329          (if debug-on-quit
2330              (debug "Quit")
2331            (message "Quit reading the ephemeral group"))
2332          nil)))))
2333
2334 (defcustom gnus-gmane-group-download-format
2335   "http://download.gmane.org/%s/%s/%s"
2336   "URL for downloading mbox files.
2337 It must contain three \"%s\".  They correspond to the group, the
2338 minimal and maximal article numbers, respectively."
2339   :group 'gnus-group-foreign
2340   :version "23.1" ;; No Gnus
2341   :type 'string)
2342
2343 (autoload 'url-insert-file-contents "url-handlers")
2344 ;; FIXME:
2345 ;; - Add documentation, menu, key bindings, ...
2346
2347 (defun gnus-read-ephemeral-gmane-group (group start &optional range)
2348   "Read articles from Gmane group GROUP as an ephemeral group.
2349 START is the first article.  RANGE specifies how many articles
2350 are fetched.  The articles are downloaded via HTTP using the URL
2351 specified by `gnus-gmane-group-download-format'."
2352   ;; See <http://gmane.org/export.php> for more information.
2353   (interactive
2354    (list
2355     (gnus-group-completing-read "Gmane group")
2356     (read-number "Start article number: ")
2357     (read-number "How many articles: ")))
2358   (unless range (setq range 500))
2359   (when (< range 1)
2360     (error "Invalid range: %s" range))
2361   (let ((tmpfile (mm-make-temp-file
2362                   (format "%s.start-%s.range-%s." group start range)))
2363         (gnus-thread-sort-functions '(gnus-thread-sort-by-number)))
2364     (with-temp-file tmpfile
2365       (url-insert-file-contents
2366        (format gnus-gmane-group-download-format
2367                group start (+ start range)))
2368       (write-region (point-min) (point-max) tmpfile)
2369       (gnus-group-read-ephemeral-group
2370        (format "%s.start-%s.range-%s" group start range)
2371        `(nndoc ,tmpfile
2372                (nndoc-article-type mbox))))
2373     (delete-file tmpfile)))
2374
2375 (defun gnus-read-ephemeral-gmane-group-url (url)
2376   "Create an ephemeral Gmane group from URL.
2377
2378 Valid input formats include:
2379 \"http://thread.gmane.org/gmane.foo.bar/12300/focus=12399\",
2380 \"http://thread.gmane.org/gmane.foo.bar/12345/\",
2381 \"http://article.gmane.org/gmane.foo.bar/12345/\",
2382 \"http://news.gmane.org/group/gmane.foo.bar/thread=12345\""
2383   ;; - Feel free to add other useful Gmane URLs here!  Maybe the URLs should
2384   ;;   be customizable?
2385   ;; - The URLs should be added to `gnus-button-alist'.  Probably we should
2386   ;;   prompt the user to decide: "View via `browse-url' or in Gnus? "
2387   ;;   (`gnus-read-ephemeral-gmane-group-url')
2388   (interactive
2389    (list (gnus-group-completing-read "Gmane URL")))
2390   (let (group start range)
2391     (cond
2392      ;; URLs providing `group', `start' and `range':
2393      ((string-match
2394        ;; http://thread.gmane.org/gmane.emacs.devel/86326/focus=86525
2395        "^http://thread\.gmane\.org/\\([^/]+\\)/\\([0-9]+\\)/focus=\\([0-9]+\\)$"
2396        url)
2397       (setq group (match-string 1 url)
2398             start (string-to-number (match-string 2 url))
2399             ;; Ensure that `range' is large enough to ensure focus article is
2400             ;; included.
2401             range (- (string-to-number (match-string 3 url))
2402                      start -1)))
2403      ;; URLs providing `group' and `start':
2404      ((or (string-match
2405            ;; http://article.gmane.org/gmane.comp.gnu.make.bugs/3584
2406            "^http://\\(?:thread\\|article\\|permalink\\)\.gmane\.org/\\([^/]+\\)/\\([0-9]+\\)"
2407            url)
2408           (string-match
2409            ;; Don't advertise these in the doc string yet:
2410            "^\\(?:nntp\\|news\\)://news\.gmane\.org/\\([^/]+\\)/\\([0-9]+\\)"
2411            url)
2412           (string-match
2413            ;; http://news.gmane.org/group/gmane.emacs.gnus.general/thread=65099/force_load=t
2414            "^http://news\.gmane\.org/group/\\([^/]+\\)/thread=\\([0-9]+\\)"
2415            url))
2416       (setq group (match-string 1 url)
2417             start (string-to-number (match-string 2 url))))
2418      (t
2419       (error "Can't parse URL %s" url)))
2420     (gnus-read-ephemeral-gmane-group group start range)))
2421
2422 (defcustom gnus-bug-group-download-format-alist
2423   '((emacs . "http://debbugs.gnu.org/%s;mboxstat=yes")
2424     (debian
2425      . "http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=%s&mbox=yes;mboxmaint=yes"))
2426   "Alist of symbols for bug trackers and the corresponding URL format string.
2427 The URL format string must contain a single \"%s\", specifying
2428 the bug number, and browsing the URL must return mbox output."
2429   :group 'gnus-group-foreign
2430   ;; Added mboxmaint=yes.  This gets the version with the messages as
2431   ;; they went out, not as they came in.
2432   ;; Eg bug-gnu-emacs is replaced by ###@debbugs.
2433   :version "24.1"
2434   :type '(repeat (cons (symbol) (string :tag "URL format string"))))
2435
2436 (defun gnus-read-ephemeral-bug-group (ids mbox-url &optional window-conf)
2437   "Browse bug NUMBER as ephemeral group."
2438   (interactive (list (read-string "Enter bug number: "
2439                                   (thing-at-point 'word) nil)
2440                      ;; FIXME: Add completing-read from
2441                      ;; `gnus-emacs-bug-group-download-format' ...
2442                      (cdr (assoc 'emacs gnus-bug-group-download-format-alist))))
2443   (when (stringp ids)
2444     (setq ids (string-to-number ids)))
2445   (unless (listp ids)
2446     (setq ids (list ids)))
2447   (let ((tmpfile (mm-make-temp-file "gnus-temp-group-"))
2448         (coding-system-for-write 'binary)
2449         (coding-system-for-read 'binary))
2450     (with-temp-file tmpfile
2451       (dolist (id ids)
2452         (url-insert-file-contents (format mbox-url id)))
2453       (goto-char (point-min))
2454       ;; Add the debbugs address so that we can respond to reports easily.
2455       (while (re-search-forward "^To: " nil t)
2456         (end-of-line)
2457         (insert (format ", %s@%s" (car ids)
2458                         (gnus-replace-in-string
2459                          (gnus-replace-in-string mbox-url "^http://" "")
2460                          "/.*$" ""))))
2461       (write-region (point-min) (point-max) tmpfile)
2462       (gnus-group-read-ephemeral-group
2463        "gnus-read-ephemeral-bug"
2464        `(nndoc ,tmpfile
2465                (nndoc-article-type mbox))
2466        nil window-conf))
2467     (delete-file tmpfile)))
2468
2469 (defun gnus-read-ephemeral-debian-bug-group (number)
2470   "Browse Debian bug NUMBER as ephemeral group."
2471   (interactive (list (read-string "Enter bug number: "
2472                                   (thing-at-point 'word) nil)))
2473   (gnus-read-ephemeral-bug-group
2474    number
2475    (cdr (assoc 'debian gnus-bug-group-download-format-alist))))
2476
2477 (defvar debbugs-gnu-bug-number)         ; debbugs-gnu
2478
2479 (defun gnus-read-ephemeral-emacs-bug-group (ids &optional window-conf)
2480   "Browse Emacs bugs IDS as an ephemeral group."
2481   (interactive (list (string-to-number
2482                       (read-string "Enter bug number: "
2483                                    (thing-at-point 'word) nil))))
2484   (unless (listp ids)
2485     (setq ids (list ids)))
2486   (gnus-read-ephemeral-bug-group
2487    ids
2488    (cdr (assoc 'emacs gnus-bug-group-download-format-alist))
2489    window-conf)
2490   (when (fboundp 'debbugs-gnu-summary-mode)
2491     (with-current-buffer (window-buffer (selected-window))
2492       (debbugs-gnu-summary-mode 1)
2493       (set (make-local-variable 'debbugs-gnu-bug-number) (car ids)))))
2494
2495 (defun gnus-group-jump-to-group (group &optional prompt)
2496   "Jump to newsgroup GROUP.
2497
2498 If PROMPT (the prefix) is a number, use the prompt specified in
2499 `gnus-group-jump-to-group-prompt'."
2500   (interactive
2501    (list (gnus-group-completing-read
2502           nil nil nil
2503           (if current-prefix-arg
2504               (cdr (assq current-prefix-arg gnus-group-jump-to-group-prompt))
2505             (or (and (stringp gnus-group-jump-to-group-prompt)
2506                      gnus-group-jump-to-group-prompt)
2507                 (let ((p (cdr (assq 0 gnus-group-jump-to-group-prompt))))
2508                   (and (stringp p) p)))))))
2509
2510   (when (equal group "")
2511     (error "Empty group name"))
2512
2513   (unless (gnus-ephemeral-group-p group)
2514     ;; Either go to the line in the group buffer...
2515     (unless (gnus-group-goto-group group)
2516       ;; ... or insert the line.
2517       (gnus-group-update-group group)
2518       (gnus-group-goto-group group)))
2519   ;; Adjust cursor point.
2520   (gnus-group-position-point))
2521
2522 (defun gnus-group-goto-group (group &optional far test-marked)
2523   "Goto to newsgroup GROUP.
2524 If FAR, it is likely that the group is not on the current line.
2525 If TEST-MARKED, the line must be marked."
2526   (when group
2527     (beginning-of-line)
2528     (cond
2529      ;; It's quite likely that we are on the right line, so
2530      ;; we check the current line first.
2531      ((and (not far)
2532            (eq (get-text-property (point) 'gnus-group)
2533                (gnus-intern-safe group gnus-active-hashtb))
2534            (or (not test-marked) (gnus-group-mark-line-p)))
2535       (point))
2536      ;; Previous and next line are also likely, so we check them as well.
2537      ((and (not far)
2538            (save-excursion
2539              (forward-line -1)
2540              (and (eq (get-text-property (point) 'gnus-group)
2541                       (gnus-intern-safe group gnus-active-hashtb))
2542                   (or (not test-marked) (gnus-group-mark-line-p)))))
2543       (forward-line -1)
2544       (point))
2545      ((and (not far)
2546            (save-excursion
2547              (forward-line 1)
2548              (and (eq (get-text-property (point) 'gnus-group)
2549                       (gnus-intern-safe group gnus-active-hashtb))
2550                   (or (not test-marked) (gnus-group-mark-line-p)))))
2551       (forward-line 1)
2552       (point))
2553      (test-marked
2554       (goto-char (point-min))
2555       (let (found)
2556         (while (and (not found)
2557                     (gnus-goto-char
2558                      (text-property-any
2559                       (point) (point-max)
2560                       'gnus-group
2561                       (gnus-intern-safe group gnus-active-hashtb))))
2562           (if (gnus-group-mark-line-p)
2563               (setq found t)
2564             (forward-line 1)))
2565         found))
2566      (t
2567       ;; Search through the entire buffer.
2568       (gnus-goto-char
2569        (text-property-any
2570         (point-min) (point-max)
2571         'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
2572
2573 (defun gnus-group-next-group (n &optional silent)
2574   "Go to next N'th newsgroup.
2575 If N is negative, search backward instead.
2576 Returns the difference between N and the number of skips actually
2577 done."
2578   (interactive "p")
2579   (gnus-group-next-unread-group n t nil silent))
2580
2581 (defun gnus-group-next-unread-group (n &optional all level silent)
2582   "Go to next N'th unread newsgroup.
2583 If N is negative, search backward instead.
2584 If ALL is non-nil, choose any newsgroup, unread or not.
2585 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
2586 such group can be found, the next group with a level higher than
2587 LEVEL.
2588 Returns the difference between N and the number of skips actually
2589 made."
2590   (interactive "p")
2591   (let ((backward (< n 0))
2592         (n (abs n)))
2593     (while (and (> n 0)
2594                 (gnus-group-search-forward
2595                  backward (or (not gnus-group-goto-unread) all) level))
2596       (setq n (1- n)))
2597     (when (and (/= 0 n)
2598                (not silent))
2599       (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
2600                     (if level " on this level or higher" "")))
2601     n))
2602
2603 (defun gnus-group-prev-group (n)
2604   "Go to previous N'th newsgroup.
2605 Returns the difference between N and the number of skips actually
2606 done."
2607   (interactive "p")
2608   (gnus-group-next-unread-group (- n) t))
2609
2610 (defun gnus-group-prev-unread-group (n)
2611   "Go to previous N'th unread newsgroup.
2612 Returns the difference between N and the number of skips actually
2613 done."
2614   (interactive "p")
2615   (gnus-group-next-unread-group (- n)))
2616
2617 (defun gnus-group-next-unread-group-same-level (n)
2618   "Go to next N'th unread newsgroup on the same level.
2619 If N is negative, search backward instead.
2620 Returns the difference between N and the number of skips actually
2621 done."
2622   (interactive "p")
2623   (gnus-group-next-unread-group n t (gnus-group-group-level))
2624   (gnus-group-position-point))
2625
2626 (defun gnus-group-prev-unread-group-same-level (n)
2627   "Go to next N'th unread newsgroup on the same level.
2628 Returns the difference between N and the number of skips actually
2629 done."
2630   (interactive "p")
2631   (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
2632   (gnus-group-position-point))
2633
2634 (defun gnus-group-best-unread-group (&optional exclude-group)
2635   "Go to the group with the highest level.
2636 If EXCLUDE-GROUP, do not go to that group."
2637   (interactive)
2638   (goto-char (point-min))
2639   (let ((best 100000)
2640         unread best-point)
2641     (while (not (eobp))
2642       (setq unread (get-text-property (point) 'gnus-unread))
2643       (when (and (numberp unread) (> unread 0))
2644         (when (and (get-text-property (point) 'gnus-level)
2645                    (< (get-text-property (point) 'gnus-level) best)
2646                    (or (not exclude-group)
2647                        (not (equal exclude-group (gnus-group-group-name)))))
2648           (setq best (get-text-property (point) 'gnus-level))
2649           (setq best-point (point))))
2650       (forward-line 1))
2651     (when best-point
2652       (goto-char best-point))
2653     (gnus-group-position-point)
2654     (and best-point (gnus-group-group-name))))
2655
2656 ;; Is there something like an after-point-motion-hook?
2657 ;; (inhibit-point-motion-hooks?).  Is there a tool-bar-update function?
2658
2659 ;; (defun gnus-group-menu-bar-update ()
2660 ;;   (let* ((buf (list (with-current-buffer gnus-group-buffer
2661 ;;                    (current-buffer))))
2662 ;;       (name (buffer-name (car buf))))
2663 ;;     (setcdr buf
2664 ;;          (if (> (length name) 27)
2665 ;;              (concat (substring name 0 12)
2666 ;;                      "..."
2667 ;;                      (substring name -12))
2668 ;;            name))
2669 ;;     (menu-bar-update-buffers-1 buf)))
2670
2671 ;; (defun gnus-group-position-point ()
2672 ;;   (gnus-goto-colon)
2673 ;;   (gnus-group-menu-bar-update))
2674
2675 (defun gnus-group-first-unread-group ()
2676   "Go to the first group with unread articles."
2677   (interactive)
2678   (prog1
2679       (let ((opoint (point))
2680             unread)
2681         (goto-char (point-min))
2682         (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
2683                 (and (numberp unread)   ; Not a topic.
2684                      (not (zerop unread))) ; Has unread articles.
2685                 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
2686             (point)                     ; Success.
2687           (goto-char opoint)
2688           nil))                         ; Not success.
2689     (gnus-group-position-point)))
2690
2691 (defun gnus-group-enter-server-mode ()
2692   "Jump to the server buffer."
2693   (interactive)
2694   (gnus-enter-server-buffer))
2695
2696 (defun gnus-group-make-group-simple (&optional group)
2697   "Add a new newsgroup.
2698 The user will be prompted for GROUP."
2699   (interactive (list (gnus-group-completing-read)))
2700   (gnus-group-make-group (gnus-group-real-name group)
2701                          (gnus-group-server group)
2702                          nil nil t))
2703
2704 (defun gnus-group-make-group (name &optional method address args encoded)
2705   "Add a new newsgroup.
2706 The user will be prompted for a NAME, for a select METHOD, and an
2707 ADDRESS.  NAME should be a human-readable string (i.e., not be encoded
2708 even if it contains non-ASCII characters) unless ENCODED is non-nil.
2709
2710 If the backend supports it, the group will also be created on the
2711 server."
2712   (interactive
2713    (list
2714     (gnus-read-group "Group name: ")
2715     (gnus-read-method "From method")))
2716
2717   (when (stringp method)
2718     (setq method (or (gnus-server-to-method method) method)))
2719   (unless encoded
2720     (setq name (mm-encode-coding-string
2721                 name
2722                 (gnus-group-name-charset method name))))
2723   (let* ((meth (gnus-method-simplify
2724                 (when (and method
2725                            (not (gnus-server-equal method gnus-select-method)))
2726                   (if address (list (intern method) address)
2727                     method))))
2728          (nname (if method (gnus-group-prefixed-name name meth) name))
2729          backend info)
2730     (when (gnus-group-entry nname)
2731       (error "Group %s already exists" (gnus-group-decoded-name nname)))
2732     ;; Subscribe to the new group.
2733     (gnus-group-change-level
2734      (setq info (list t nname gnus-level-default-subscribed nil nil meth))
2735      gnus-level-default-subscribed gnus-level-killed
2736      (and (gnus-group-group-name)
2737           (gnus-group-entry (gnus-group-group-name)))
2738      t)
2739     ;; Make it active.
2740     (gnus-set-active nname (cons 1 0))
2741     (unless (gnus-ephemeral-group-p name)
2742       (gnus-dribble-enter
2743        (concat "(gnus-group-set-info '"
2744                (gnus-prin1-to-string (cdr info)) ")")
2745        (concat "^(gnus-group-set-info '(\"" (regexp-quote name) "\"")))
2746     ;; Insert the line.
2747     (gnus-group-insert-group-line-info nname)
2748     (forward-line -1)
2749     (gnus-group-position-point)
2750
2751     ;; Load the back end and try to make the back end create
2752     ;; the group as well.
2753     (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
2754                                                   nil meth))))
2755                  gnus-valid-select-methods)
2756       (require backend))
2757     (gnus-check-server meth)
2758     (when (gnus-check-backend-function 'request-create-group nname)
2759       (unless (gnus-request-create-group nname nil args)
2760         (error "Could not create group on server: %s"
2761                (nnheader-get-report backend))))
2762     t))
2763
2764 (defun gnus-group-delete-groups (&optional arg)
2765   "Delete the current group.  Only meaningful with editable groups."
2766   (interactive "P")
2767   (let ((n (length (gnus-group-process-prefix arg))))
2768     (when (gnus-yes-or-no-p
2769            (if (= n 1)
2770                "Delete this 1 group? "
2771              (format "Delete these %d groups? " n)))
2772       (gnus-group-iterate arg
2773         (lambda (group)
2774           (gnus-group-delete-group group nil t))))))
2775
2776 (defun gnus-group-delete-articles (group)
2777   "Delete all articles in the current group."
2778   (interactive (list (gnus-group-group-name)))
2779   (let ((articles (gnus-uncompress-range (gnus-active group))))
2780     (when (gnus-yes-or-no-p
2781            (format "Do you really want to delete these %d articles forever? "
2782                    (length articles)))
2783       (gnus-request-expire-articles articles group 'force))))
2784
2785 (defun gnus-group-delete-group (group &optional force no-prompt)
2786   "Delete the current group.  Only meaningful with editable groups.
2787 If FORCE (the prefix) is non-nil, all the articles in the group will
2788 be deleted.  This is \"deleted\" as in \"removed forever from the face
2789 of the Earth\".  There is no undo.  The user will be prompted before
2790 doing the deletion.
2791 Note that you also have to specify FORCE if you want the group to
2792 be removed from the server, even when it's empty."
2793   (interactive
2794    (list (gnus-group-group-name)
2795          current-prefix-arg))
2796   (unless group
2797     (error "No group to delete"))
2798   (unless (gnus-check-backend-function 'request-delete-group group)
2799     (error "This back end does not support group deletion"))
2800   (prog1
2801       (let ((group-decoded (gnus-group-decoded-name group)))
2802         (if (and (not no-prompt)
2803                  (not (gnus-yes-or-no-p
2804                        (format
2805                         "Do you really want to delete %s%s? "
2806                         group-decoded (if force " and all its contents" "")))))
2807             ()                          ; Whew!
2808           (gnus-message 6 "Deleting group %s..." group-decoded)
2809           (if (not (gnus-request-delete-group group force))
2810               (gnus-error 3 "Couldn't delete group %s" group-decoded)
2811             (gnus-message 6 "Deleting group %s...done" group-decoded)
2812             (gnus-group-goto-group group)
2813             (gnus-group-kill-group 1 t)
2814             (gnus-set-active group nil)
2815             t)))
2816     (gnus-group-position-point)))
2817
2818 (defun gnus-group-rename-group (group new-name)
2819   "Rename group from GROUP to NEW-NAME.
2820 When used interactively, GROUP is the group under point
2821 and NEW-NAME will be prompted for."
2822   (interactive
2823    (let ((group (gnus-group-group-name))
2824          method new-name)
2825      (unless (gnus-check-backend-function 'request-rename-group group)
2826        (error "This back end does not support renaming groups"))
2827      (setq new-name (gnus-read-group
2828                      "Rename group to: "
2829                      (gnus-group-real-name (gnus-group-decoded-name group)))
2830            method (gnus-info-method (gnus-get-info group)))
2831      (list group (mm-encode-coding-string
2832                   new-name
2833                   (gnus-group-name-charset
2834                    method
2835                    (gnus-group-prefixed-name new-name method))))))
2836
2837   (unless (gnus-check-backend-function 'request-rename-group group)
2838     (error "This back end does not support renaming groups"))
2839   (unless group
2840     (error "No group to rename"))
2841   (when (equal (gnus-group-real-name group) new-name)
2842     (error "Can't rename to the same name"))
2843
2844   ;; We find the proper prefixed name.
2845   (setq new-name
2846         (if (gnus-group-native-p group)
2847             ;; Native group.
2848             new-name
2849           ;; Foreign group.
2850           (gnus-group-prefixed-name
2851            (gnus-group-real-name new-name)
2852            (gnus-info-method (gnus-get-info group)))))
2853
2854   (let ((decoded-group (gnus-group-decoded-name group))
2855         (decoded-new-name (gnus-group-decoded-name new-name)))
2856     (when (gnus-active new-name)
2857       (error "The group %s already exists" decoded-new-name))
2858
2859     (gnus-message 6 "Renaming group %s to %s..."
2860                   decoded-group decoded-new-name)
2861     (prog1
2862         (if (progn
2863               (gnus-group-goto-group group)
2864               (not (when (< (gnus-group-group-level) gnus-level-zombie)
2865                      (gnus-request-rename-group group new-name))))
2866             (gnus-error 3 "Couldn't rename group %s to %s"
2867                         decoded-group decoded-new-name)
2868           ;; We rename the group internally by killing it...
2869           (gnus-group-kill-group)
2870           ;; ... changing its name ...
2871           (setcar (cdar gnus-list-of-killed-groups) new-name)
2872           ;; ... and then yanking it.  Magic!
2873           (gnus-group-yank-group)
2874           (gnus-set-active new-name (gnus-active group))
2875           (gnus-message 6 "Renaming group %s to %s...done"
2876                         decoded-group decoded-new-name)
2877           new-name)
2878       (setq gnus-killed-list (delete group gnus-killed-list))
2879       (gnus-set-active group nil)
2880       (gnus-dribble-touch)
2881       (gnus-group-position-point))))
2882
2883 (defun gnus-group-edit-group (group &optional part)
2884   "Edit the group on the current line."
2885   (interactive (list (gnus-group-group-name)))
2886   (let ((part (or part 'info))
2887         info)
2888     (unless group
2889       (error "No group on current line"))
2890     (unless (setq info (gnus-get-info group))
2891       (error "Killed group; can't be edited"))
2892     (ignore-errors
2893       (gnus-close-group group))
2894     (gnus-edit-form
2895      ;; Find the proper form to edit.
2896      (cond ((eq part 'method)
2897             (or (gnus-info-method info) "native"))
2898            ((eq part 'params)
2899             (gnus-info-params info))
2900            (t info))
2901      ;; The proper documentation.
2902      (format
2903       "Editing the %s for `%s'."
2904       (cond
2905        ((eq part 'method) "select method")
2906        ((eq part 'params) "group parameters")
2907        (t "group info"))
2908       (gnus-group-decoded-name group))
2909      `(lambda (form)
2910         (gnus-group-edit-group-done ',part ,group form)))
2911     (local-set-key
2912      "\C-c\C-i"
2913      (gnus-create-info-command
2914       (cond
2915        ((eq part 'method)
2916         "(gnus)Select Methods")
2917        ((eq part 'params)
2918         "(gnus)Group Parameters")
2919        (t
2920         "(gnus)Group Info"))))))
2921
2922 (defun gnus-group-edit-group-method (group)
2923   "Edit the select method of GROUP."
2924   (interactive (list (gnus-group-group-name)))
2925   (gnus-group-edit-group group 'method))
2926
2927 (defun gnus-group-edit-group-parameters (group)
2928   "Edit the group parameters of GROUP."
2929   (interactive (list (gnus-group-group-name)))
2930   (gnus-group-edit-group group 'params))
2931
2932 (defun gnus-group-edit-group-done (part group form)
2933   "Update variables."
2934   (let* ((method (cond ((eq part 'info) (nth 4 form))
2935                        ((eq part 'method) form)
2936                        (t nil)))
2937          (info (cond ((eq part 'info) form)
2938                      ((eq part 'method) (gnus-get-info group))
2939                      (t nil)))
2940          (new-group (if info
2941                         (if (or (not method)
2942                                 (gnus-server-equal
2943                                  gnus-select-method method))
2944                             (gnus-group-real-name (car info))
2945                           (gnus-group-prefixed-name
2946                            (gnus-group-real-name (car info)) method))
2947                       nil)))
2948     (when (and new-group
2949                (not (equal new-group group)))
2950       (when (gnus-group-goto-group group)
2951         (gnus-group-kill-group 1))
2952       (gnus-activate-group new-group))
2953     ;; Set the info.
2954     (if (not (and info new-group))
2955         (gnus-group-set-info form (or new-group group) part)
2956       (setq info (gnus-copy-sequence info))
2957       (setcar info new-group)
2958       (unless (gnus-server-equal method "native")
2959         (unless (nthcdr 3 info)
2960           (nconc info (list nil nil)))
2961         (unless (nthcdr 4 info)
2962           (nconc info (list nil)))
2963         (gnus-info-set-method info method))
2964       (gnus-group-set-info info))
2965     (gnus-group-update-group (or new-group group))
2966     (gnus-group-position-point)))
2967
2968 (defun gnus-group-make-useful-group (group method)
2969   "Create one of the groups described in `gnus-useful-groups'."
2970   (interactive
2971    (let ((entry (assoc (gnus-completing-read "Create group"
2972                                              (mapcar 'car gnus-useful-groups)
2973                                              t)
2974                        gnus-useful-groups)))
2975      (list (cadr entry)
2976            ;; Don't use `caddr' here since macros within the `interactive'
2977            ;; form won't be expanded.
2978            (car (cddr entry)))))
2979   (setq method (gnus-copy-sequence method))
2980   (let (entry)
2981     (while (setq entry (memq (assq 'eval method) method))
2982       (setcar entry (eval (cadar entry)))))
2983   (gnus-group-make-group group method))
2984
2985 (defun gnus-group-make-help-group (&optional noerror)
2986   "Create the Gnus documentation group.
2987 Optional argument NOERROR modifies the behavior of this function when the
2988 group already exists:
2989 - if not given, and error is signaled,
2990 - if t, stay silent,
2991 - if anything else, just print a message."
2992   (interactive)
2993   (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2994         (file (nnheader-find-etc-directory "gnus-tut.txt" t)))
2995     (if (gnus-group-entry name)
2996         (cond ((eq noerror nil)
2997                (error "Documentation group already exists"))
2998               ((eq noerror t)
2999                ;; stay silent
3000                )
3001               (t
3002                (gnus-message 1 "Documentation group already exists")))
3003       ;; else:
3004       (if (not file)
3005           (gnus-message 1 "Couldn't find doc group")
3006         (gnus-group-make-group
3007          (gnus-group-real-name name)
3008          (list 'nndoc "gnus-help"
3009                (list 'nndoc-address file)
3010                (list 'nndoc-article-type 'mbox))))
3011       ))
3012   (gnus-group-position-point))
3013
3014 (defun gnus-group-make-doc-group (file type)
3015   "Create a group that uses a single file as the source.
3016
3017 If called with a prefix argument, ask for the file type."
3018   (interactive
3019    (list (read-file-name "File name: ")
3020          (and current-prefix-arg 'ask)))
3021   (when (eq type 'ask)
3022     (let ((err "")
3023           char found)
3024       (while (not found)
3025         (message
3026          "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [m, b, d, f, a, g]: "
3027          err)
3028         (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
3029                           ((= char ?b) 'babyl)
3030                           ((= char ?d) 'digest)
3031                           ((= char ?f) 'forward)
3032                           ((= char ?a) 'mmfd)
3033                           ((= char ?g) 'guess)
3034                           (t (setq err (format "%c unknown. " char))
3035                              nil))))
3036       (setq type found)))
3037   (setq file (expand-file-name file))
3038   (let* ((name (gnus-generate-new-group-name
3039                 (gnus-group-prefixed-name
3040                  (file-name-nondirectory file) '(nndoc ""))))
3041          (method (list 'nndoc file
3042                        (list 'nndoc-address file)
3043                        (list 'nndoc-article-type (or type 'guess))))
3044          (coding (gnus-group-name-charset method name)))
3045     (setcar (cdr method) (mm-encode-coding-string file coding))
3046     (gnus-group-make-group
3047      (mm-encode-coding-string (gnus-group-real-name name) coding)
3048      method nil nil t)))
3049
3050 (defvar nnweb-type-definition)
3051 (defvar gnus-group-web-type-history nil)
3052 (defvar gnus-group-web-search-history nil)
3053 (defun gnus-group-make-web-group (&optional solid)
3054   "Create an ephemeral nnweb group.
3055 If SOLID (the prefix), create a solid group."
3056   (interactive "P")
3057   (require 'nnweb)
3058   (let* ((group
3059           (if solid (gnus-read-group "Group name: ")
3060             (message-unique-id)))
3061          (default-type (or (car gnus-group-web-type-history)
3062                            (symbol-name (caar nnweb-type-definition))))
3063          (type
3064           (gnus-string-or
3065            (gnus-completing-read
3066             "Search engine type"
3067             (mapcar (lambda (elem) (symbol-name (car elem)))
3068                     nnweb-type-definition)
3069             t nil 'gnus-group-web-type-history)
3070            default-type))
3071          (search
3072           (read-string
3073            "Search string: "
3074            (cons (or (car gnus-group-web-search-history) "") 0)
3075            'gnus-group-web-search-history))
3076          (method
3077           `(nnweb ,group (nnweb-search ,search)
3078                   (nnweb-type ,(intern type))
3079                   (nnweb-ephemeral-p t))))
3080     (if solid
3081         (progn
3082           (gnus-alist-pull 'nnweb-ephemeral-p method)
3083           (gnus-group-make-group group method))
3084       (gnus-group-read-ephemeral-group
3085        group method t
3086        (cons (current-buffer)
3087              (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
3088
3089 (defvar nnrss-group-alist)
3090 (eval-when-compile
3091   (defun nnrss-discover-feed (arg))
3092   (defun nnrss-save-server-data (arg)))
3093 (defun gnus-group-make-rss-group (&optional url)
3094   "Given a URL, discover if there is an RSS feed.
3095 If there is, use Gnus to create an nnrss group"
3096   (interactive)
3097   (require 'nnrss)
3098   (if (not url)
3099       (setq url (read-from-minibuffer "URL to Search for RSS: ")))
3100   (let ((feedinfo (nnrss-discover-feed url)))
3101     (if feedinfo
3102         (let* ((title (gnus-newsgroup-savable-name
3103                        (read-from-minibuffer "Title: "
3104                                              (gnus-newsgroup-savable-name
3105                                               (mapconcat
3106                                                'identity
3107                                                (split-string
3108                                                 (or (cdr (assoc 'title
3109                                                                 feedinfo))
3110                                                     ""))
3111                                                " ")))))
3112                (desc  (read-from-minibuffer "Description: "
3113                                             (mapconcat
3114                                              'identity
3115                                              (split-string
3116                                               (or (cdr (assoc 'description
3117                                                               feedinfo))
3118                                                   ""))
3119                                              " ")))
3120                (href (cdr (assoc 'href feedinfo)))
3121                (coding (gnus-group-name-charset '(nnrss "") title)))
3122           (when coding
3123             ;; Unify non-ASCII text.
3124             (setq title (mm-decode-coding-string
3125                          (mm-encode-coding-string title coding)
3126                          coding)))
3127           (gnus-group-make-group title '(nnrss ""))
3128           (push (list title href desc) nnrss-group-alist)
3129           (nnrss-save-server-data nil))
3130       (error "No feeds found for %s" url))))
3131
3132 (defun gnus-group-make-directory-group (dir)
3133   "Create an nndir group.
3134 The user will be prompted for a directory.  The contents of this
3135 directory will be used as a newsgroup.  The directory should contain
3136 mail messages or news articles in files that have numeric names."
3137   (interactive
3138    (list (read-directory-name "Create group from directory: ")))
3139   (unless (file-exists-p dir)
3140     (error "No such directory"))
3141   (unless (file-directory-p dir)
3142     (error "Not a directory"))
3143   (let ((ext "")
3144         (i 0)
3145         group)
3146     (while (or (not group) (gnus-group-entry group))
3147       (setq group
3148             (gnus-group-prefixed-name
3149              (expand-file-name ext dir)
3150              '(nndir "")))
3151       (setq ext (format "<%d>" (setq i (1+ i)))))
3152     (gnus-group-make-group
3153      (gnus-group-real-name group)
3154      (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
3155
3156 (defun gnus-group-add-to-virtual (n vgroup)
3157   "Add the current group to a virtual group."
3158   (interactive
3159    (list current-prefix-arg
3160          (gnus-group-completing-read "Add to virtual group"
3161                                      nil t "nnvirtual:")))
3162   (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
3163     (error "%s is not an nnvirtual group" vgroup))
3164   (gnus-close-group vgroup)
3165   (let* ((groups (gnus-group-process-prefix n))
3166          (method (gnus-info-method (gnus-get-info vgroup))))
3167     (setcar (cdr method)
3168             (concat
3169              (nth 1 method) "\\|"
3170              (mapconcat
3171               (lambda (s)
3172                 (gnus-group-remove-mark s)
3173                 (concat "\\(^" (regexp-quote s) "$\\)"))
3174               groups "\\|"))))
3175   (gnus-group-position-point))
3176
3177 (defun gnus-group-make-empty-virtual (group)
3178   "Create a new, fresh, empty virtual group."
3179   (interactive "sCreate new, empty virtual group: ")
3180   (let* ((method (list 'nnvirtual "^$"))
3181          (pgroup (gnus-group-prefixed-name group method)))
3182     ;; Check whether it exists already.
3183     (when (gnus-group-entry pgroup)
3184       (error "Group %s already exists" pgroup))
3185     ;; Subscribe the new group after the group on the current line.
3186     (gnus-subscribe-group pgroup (gnus-group-group-name) method)
3187     (gnus-group-update-group pgroup)
3188     (forward-line -1)
3189     (gnus-group-position-point)))
3190
3191 (defun gnus-group-enter-directory (dir)
3192   "Enter an ephemeral nneething group."
3193   (interactive "DDirectory to read: ")
3194   (let* ((method (list 'nneething dir '(nneething-read-only t)))
3195          (leaf (gnus-group-prefixed-name
3196                 (file-name-nondirectory (directory-file-name dir))
3197                 method))
3198          (name (gnus-generate-new-group-name leaf)))
3199     (unless (gnus-group-read-ephemeral-group
3200              name method t
3201              (cons (current-buffer)
3202                    (if (eq major-mode 'gnus-summary-mode)
3203                        'summary 'group)))
3204       (error "Couldn't enter %s" dir))))
3205
3206 (defun gnus-group-expunge-group (group)
3207   "Expunge deleted articles in current nnimap GROUP."
3208   (interactive (list (gnus-group-group-name)))
3209   (let ((method (gnus-find-method-for-group group)))
3210     (if (not (gnus-check-backend-function
3211               'request-expunge-group (car method)))
3212         (error "%s does not support expunging" (car method))
3213       (gnus-request-expunge-group group method))))
3214
3215 (autoload 'nnimap-acl-get "nnimap")
3216 (autoload 'nnimap-acl-edit "nnimap")
3217
3218 (defun gnus-group-nnimap-edit-acl (group)
3219   "Edit the Access Control List of current nnimap GROUP."
3220   (interactive (list (gnus-group-group-name)))
3221   (let ((mailbox (gnus-group-real-name group)) method acl)
3222     (unless group
3223       (error "No group on current line"))
3224     (unless (gnus-get-info group)
3225       (error "Killed group; can't be edited"))
3226     (unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
3227       (error "%s is not an nnimap group" group))
3228     (unless (setq acl (nnimap-acl-get mailbox (cadr method)))
3229       (error "Server does not support ACL's"))
3230     (gnus-edit-form acl (format "Editing the access control list for `%s'.
3231
3232    An access control list is a list of (identifier . rights) elements.
3233
3234    The identifier string specifies the corresponding user.  The
3235    identifier \"anyone\" is reserved to refer to the universal identity.
3236
3237    Rights is a string listing a (possibly empty) set of alphanumeric
3238    characters, each character listing a set of operations which is being
3239    controlled.  Letters are reserved for ``standard'' rights, listed
3240    below.  Digits are reserved for implementation or site defined rights.
3241
3242    l - lookup (mailbox is visible to LIST/LSUB commands)
3243    r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
3244        SEARCH, COPY from mailbox)
3245    s - keep seen/unseen information across sessions (STORE \\SEEN flag)
3246    w - write (STORE flags other than \\SEEN and \\DELETED)
3247    i - insert (perform APPEND, COPY into mailbox)
3248    p - post (send mail to submission address for mailbox,
3249        not enforced by IMAP4 itself)
3250    c - create and delete mailbox (CREATE new sub-mailboxes in any
3251        implementation-defined hierarchy, RENAME or DELETE mailbox)
3252    d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
3253    a - administer (perform SETACL)" group)
3254                     `(lambda (form)
3255                        (nnimap-acl-edit
3256                         ,mailbox ',method ',acl form)))))
3257
3258 ;; Group sorting commands
3259 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
3260
3261 (defun gnus-group-sort-groups (func &optional reverse)
3262   "Sort the group buffer according to FUNC.
3263 When used interactively, the sorting function used will be
3264 determined by the `gnus-group-sort-function' variable.
3265 If REVERSE (the prefix), reverse the sorting order."
3266   (interactive (list gnus-group-sort-function current-prefix-arg))
3267   (funcall gnus-group-sort-alist-function
3268            (gnus-make-sort-function func) reverse)
3269   (gnus-group-unmark-all-groups)
3270   (gnus-group-list-groups)
3271   (gnus-dribble-touch))
3272
3273 (defun gnus-group-sort-flat (func reverse)
3274   ;; We peel off the dummy group from the alist.
3275   (when func
3276     (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
3277       (pop gnus-newsrc-alist))
3278     ;; Do the sorting.
3279     (setq gnus-newsrc-alist
3280           (sort gnus-newsrc-alist func))
3281     (when reverse
3282       (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
3283     ;; Regenerate the hash table.
3284     (gnus-make-hashtable-from-newsrc-alist)))
3285
3286 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
3287   "Sort the group buffer alphabetically by group name.
3288 If REVERSE, sort in reverse order."
3289   (interactive "P")
3290   (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
3291
3292 (defun gnus-group-sort-groups-by-real-name (&optional reverse)
3293   "Sort the group buffer alphabetically by real (unprefixed) group name.
3294 If REVERSE, sort in reverse order."
3295   (interactive "P")
3296   (gnus-group-sort-groups 'gnus-group-sort-by-real-name reverse))
3297
3298 (defun gnus-group-sort-groups-by-unread (&optional reverse)
3299   "Sort the group buffer by number of unread articles.
3300 If REVERSE, sort in reverse order."
3301   (interactive "P")
3302   (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
3303
3304 (defun gnus-group-sort-groups-by-level (&optional reverse)
3305   "Sort the group buffer by group level.
3306 If REVERSE, sort in reverse order."
3307   (interactive "P")
3308   (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
3309
3310 (defun gnus-group-sort-groups-by-score (&optional reverse)
3311   "Sort the group buffer by group score.
3312 If REVERSE, sort in reverse order."
3313   (interactive "P")
3314   (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
3315
3316 (defun gnus-group-sort-groups-by-rank (&optional reverse)
3317   "Sort the group buffer by group rank.
3318 If REVERSE, sort in reverse order."
3319   (interactive "P")
3320   (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
3321
3322 (defun gnus-group-sort-groups-by-method (&optional reverse)
3323   "Sort the group buffer alphabetically by back end name.
3324 If REVERSE, sort in reverse order."
3325   (interactive "P")
3326   (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
3327
3328 (defun gnus-group-sort-groups-by-server (&optional reverse)
3329   "Sort the group buffer alphabetically by server name.
3330 If REVERSE, sort in reverse order."
3331   (interactive "P")
3332   (gnus-group-sort-groups 'gnus-group-sort-by-server reverse))
3333
3334 ;;; Selected group sorting.
3335
3336 (defun gnus-group-sort-selected-groups (n func &optional reverse)
3337   "Sort the process/prefixed groups."
3338   (interactive (list current-prefix-arg gnus-group-sort-function))
3339   (let ((groups (gnus-group-process-prefix n)))
3340     (funcall gnus-group-sort-selected-function
3341              groups (gnus-make-sort-function func) reverse)
3342     (gnus-group-unmark-all-groups)
3343     (gnus-group-list-groups)
3344     (gnus-dribble-touch)))
3345
3346 (defun gnus-group-sort-selected-flat (groups func reverse)
3347   (let (entries infos)
3348     ;; First find all the group entries for these groups.
3349     (while groups
3350       (push (nthcdr 2 (gnus-group-entry (pop groups)))
3351             entries))
3352     ;; Then sort the infos.
3353     (setq infos
3354           (sort
3355            (mapcar
3356             (lambda (entry) (car entry))
3357             (setq entries (nreverse entries)))
3358            func))
3359     (when reverse
3360       (setq infos (nreverse infos)))
3361     ;; Go through all the infos and replace the old entries
3362     ;; with the new infos.
3363     (while infos
3364       (setcar (car entries) (pop infos))
3365       (pop entries))
3366     ;; Update the hashtable.
3367     (gnus-make-hashtable-from-newsrc-alist)))
3368
3369 (defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
3370   "Sort the group buffer alphabetically by group name.
3371 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3372 sort in reverse order."
3373   (interactive (gnus-interactive "P\ny"))
3374   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
3375
3376 (defun gnus-group-sort-selected-groups-by-real-name (&optional n reverse)
3377   "Sort the group buffer alphabetically by real group name.
3378 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3379 sort in reverse order."
3380   (interactive (gnus-interactive "P\ny"))
3381   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-real-name reverse))
3382
3383 (defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
3384   "Sort the group buffer by number of unread articles.
3385 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3386 sort in reverse order."
3387   (interactive (gnus-interactive "P\ny"))
3388   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
3389
3390 (defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
3391   "Sort the group buffer by group level.
3392 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3393 sort in reverse order."
3394   (interactive (gnus-interactive "P\ny"))
3395   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
3396
3397 (defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
3398   "Sort the group buffer by group score.
3399 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3400 sort in reverse order."
3401   (interactive (gnus-interactive "P\ny"))
3402   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
3403
3404 (defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
3405   "Sort the group buffer by group rank.
3406 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3407 sort in reverse order."
3408   (interactive (gnus-interactive "P\ny"))
3409   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
3410
3411 (defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
3412   "Sort the group buffer alphabetically by back end name.
3413 Obeys the process/prefix convention.  If REVERSE (the symbolic prefix),
3414 sort in reverse order."
3415   (interactive (gnus-interactive "P\ny"))
3416   (gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
3417
3418 ;;; Sorting predicates.
3419
3420 (defun gnus-group-sort-by-alphabet (info1 info2)
3421   "Sort alphabetically."
3422   (string< (gnus-info-group info1) (gnus-info-group info2)))
3423
3424 (defun gnus-group-sort-by-real-name (info1 info2)
3425   "Sort alphabetically on real (unprefixed) names."
3426   (string< (gnus-group-real-name (gnus-info-group info1))
3427            (gnus-group-real-name (gnus-info-group info2))))
3428
3429 (defun gnus-group-sort-by-unread (info1 info2)
3430   "Sort by number of unread articles."
3431   (let ((n1 (gnus-group-unread (gnus-info-group info1)))
3432         (n2 (gnus-group-unread (gnus-info-group info2))))
3433     (< (or (and (numberp n1) n1) 0)
3434        (or (and (numberp n2) n2) 0))))
3435
3436 (defun gnus-group-sort-by-level (info1 info2)
3437   "Sort by level."
3438   (< (gnus-info-level info1) (gnus-info-level info2)))
3439
3440 (defun gnus-group-sort-by-method (info1 info2)
3441   "Sort alphabetically by back end name."
3442   (string< (car (gnus-find-method-for-group
3443                  (gnus-info-group info1) info1))
3444            (car (gnus-find-method-for-group
3445                  (gnus-info-group info2) info2))))
3446
3447 (defun gnus-group-sort-by-server (info1 info2)
3448   "Sort alphabetically by server name."
3449   (string< (gnus-method-to-full-server-name
3450             (gnus-find-method-for-group
3451              (gnus-info-group info1) info1))
3452            (gnus-method-to-full-server-name
3453             (gnus-find-method-for-group
3454              (gnus-info-group info2) info2))))
3455
3456 (defun gnus-group-sort-by-score (info1 info2)
3457   "Sort by group score."
3458   (> (gnus-info-score info1) (gnus-info-score info2)))
3459
3460 (defun gnus-group-sort-by-rank (info1 info2)
3461   "Sort by level and score."
3462   (let ((level1 (gnus-info-level info1))
3463         (level2 (gnus-info-level info2)))
3464     (or (< level1 level2)
3465         (and (= level1 level2)
3466              (> (gnus-info-score info1) (gnus-info-score info2))))))
3467
3468 ;;; Clearing data
3469
3470 (defun gnus-group-clear-data (&optional arg)
3471   "Clear all marks and read ranges from the current group.
3472 Obeys the process/prefix convention."
3473   (interactive "P")
3474   (when (gnus-y-or-n-p "Really clear data? ")
3475     (gnus-group-iterate arg
3476       (lambda (group)
3477         (let (info)
3478           (gnus-info-clear-data (setq info (gnus-get-info group)))
3479           (gnus-get-unread-articles-in-group info (gnus-active group) t)
3480           (when (gnus-group-goto-group group)
3481             (gnus-group-update-group-line)))))))
3482
3483 (defun gnus-group-clear-data-on-native-groups ()
3484   "Clear all marks and read ranges from all native groups."
3485   (interactive)
3486   (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
3487     (let ((alist (cdr gnus-newsrc-alist))
3488           info)
3489       (while (setq info (pop alist))
3490         (when (gnus-group-native-p (gnus-info-group info))
3491           (gnus-info-clear-data info)))
3492       (gnus-get-unread-articles)
3493       (gnus-dribble-touch)
3494       (when (gnus-y-or-n-p
3495              "Move the cache away to avoid problems in the future? ")
3496         (call-interactively 'gnus-cache-move-cache)))))
3497
3498 (defun gnus-info-clear-data (info)
3499   "Clear all marks and read ranges from INFO."
3500   (let ((group (gnus-info-group info))
3501         action)
3502     (dolist (el (gnus-info-marks info))
3503       (push `(,(cdr el) add (,(car el))) action))
3504     (push `(,(gnus-info-read info) add (read)) action)
3505     (gnus-undo-register
3506       `(progn
3507          (gnus-request-set-mark ,group ',action)
3508          (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
3509          (gnus-info-set-read ',info ',(gnus-info-read info))
3510          (when (gnus-group-goto-group ,group)
3511            (gnus-get-unread-articles-in-group ',info ',(gnus-active group) t)
3512            (gnus-group-update-group-line))))
3513     (setq action (mapcar (lambda (el) (list (nth 0 el) 'del (nth 2 el)))
3514                          action))
3515     (gnus-request-set-mark group action)
3516     (gnus-info-set-read info nil)
3517     (when (gnus-info-marks info)
3518       (gnus-info-set-marks info nil))))
3519
3520 ;; Group catching up.
3521
3522 (defun gnus-group-catchup-current (&optional n all)
3523   "Mark all unread articles in the current newsgroup as read.
3524 If prefix argument N is numeric, the next N newsgroups will be
3525 caught up.  If ALL is non-nil, marked articles will also be marked as
3526 read.  Cross references (Xref: header) of articles are ignored.
3527 The number of newsgroups that this function was unable to catch
3528 up is returned."
3529   (interactive "P")
3530   (let ((groups (gnus-group-process-prefix n))
3531         (ret 0)
3532         group)
3533     (unless groups (error "No groups selected"))
3534     (if (not
3535          (or (not gnus-interactive-catchup) ;Without confirmation?
3536              gnus-expert-user
3537              (gnus-y-or-n-p
3538               (format
3539                (if all
3540                    "Do you really want to mark all articles in %s as read? "
3541                  "Mark all unread articles in %s as read? ")
3542                (if (= (length groups) 1)
3543                    (gnus-group-decoded-name (car groups))
3544                  (format "these %d groups" (length groups)))))))
3545         n
3546       (while (setq group (pop groups))
3547         (gnus-group-remove-mark group)
3548         ;; Virtual groups have to be given special treatment.
3549         (let ((method (gnus-find-method-for-group group)))
3550           (when (eq 'nnvirtual (car method))
3551             (nnvirtual-catchup-group
3552              (gnus-group-real-name group) (nth 1 method) all)))
3553         (cond
3554          ((>= (gnus-group-level group) gnus-level-zombie)
3555           (gnus-message 2 "Dead groups can't be caught up"))
3556          ((prog1
3557               (gnus-group-goto-group group)
3558             (gnus-group-catchup group all))
3559           (gnus-group-update-group-line))
3560          (t
3561           (setq ret (1+ ret)))))
3562       (gnus-group-next-unread-group 1)
3563       ret)))
3564
3565 (defun gnus-group-catchup-current-all (&optional n)
3566   "Mark all articles in current newsgroup as read.
3567 Cross references (Xref: header) of articles are ignored."
3568   (interactive "P")
3569   (gnus-group-catchup-current n 'all))
3570
3571 (defun gnus-group-catchup (group &optional all)
3572   "Mark all articles in GROUP as read.
3573 If ALL is non-nil, all articles are marked as read.
3574 The return value is the number of articles that were marked as read,
3575 or nil if no action could be taken."
3576   (let* ((entry (gnus-group-entry group))
3577          (num (car entry))
3578          (marks (gnus-info-marks (nth 2 entry)))
3579          (unread (gnus-sequence-of-unread-articles group)))
3580     ;; Remove entries for this group.
3581     (nnmail-purge-split-history (gnus-group-real-name group))
3582     ;; Do the updating only if the newsgroup isn't killed.
3583     (if (not (numberp (car entry)))
3584         (gnus-message 1 "Can't catch up %s; non-active group" group)
3585       (gnus-update-read-articles group nil)
3586       (when all
3587         ;; Nix out the lists of marks and dormants.
3588         (gnus-request-set-mark group (list (list (cdr (assq 'tick marks))
3589                                                  'del '(tick))
3590                                            (list (cdr (assq 'dormant marks))
3591                                                  'del '(dormant))))
3592         (setq unread (gnus-range-add (gnus-range-add
3593                                       unread (cdr (assq 'dormant marks)))
3594                                      (cdr (assq 'tick marks))))
3595         (gnus-add-marked-articles group 'tick nil nil 'force)
3596         (gnus-add-marked-articles group 'dormant nil nil 'force))
3597       ;; Do auto-expirable marks if that's required.
3598       (when (and (gnus-group-auto-expirable-p group)
3599                  (not (gnus-group-read-only-p group)))
3600         (gnus-range-map
3601          (lambda (article)
3602            (gnus-add-marked-articles group 'expire (list article))
3603            (gnus-request-set-mark group (list (list (list article)
3604                                                     'add '(expire)))))
3605          unread))
3606       (let ((gnus-newsgroup-name group))
3607         (gnus-run-hooks 'gnus-group-catchup-group-hook))
3608       num)))
3609
3610 (defun gnus-group-expire-articles (&optional n)
3611   "Expire all expirable articles in the current newsgroup.
3612 Uses the process/prefix convention."
3613   (interactive "P")
3614   (let ((groups (gnus-group-process-prefix n))
3615         group)
3616     (unless groups
3617       (error "No groups to expire"))
3618     (while (setq group (pop groups))
3619       (gnus-group-remove-mark group)
3620       (gnus-group-expire-articles-1 group)
3621       (gnus-dribble-touch)
3622       (gnus-group-position-point))))
3623
3624 (defun gnus-group-expire-articles-1 (group)
3625   (when (gnus-check-backend-function 'request-expire-articles group)
3626     (gnus-message 6 "Expiring articles in %s..."
3627                   (gnus-group-decoded-name group))
3628     (let* ((info (gnus-get-info group))
3629            (expirable (if (gnus-group-total-expirable-p group)
3630                           (cons nil (gnus-list-of-read-articles group))
3631                         (assq 'expire (gnus-info-marks info))))
3632            (expiry-wait (gnus-group-find-parameter group 'expiry-wait))
3633            (nnmail-expiry-target
3634             (or (gnus-group-find-parameter group 'expiry-target)
3635                 nnmail-expiry-target)))
3636       (when expirable
3637         (gnus-check-group group)
3638         (setcdr
3639          expirable
3640          (gnus-compress-sequence
3641           (if expiry-wait
3642               ;; We set the expiry variables to the group
3643               ;; parameter.
3644               (let ((nnmail-expiry-wait-function nil)
3645                     (nnmail-expiry-wait expiry-wait))
3646                 (gnus-request-expire-articles
3647                  (gnus-uncompress-sequence (cdr expirable)) group))
3648             ;; Just expire using the normal expiry values.
3649             (gnus-request-expire-articles
3650              (gnus-uncompress-sequence (cdr expirable)) group))))
3651         (gnus-close-group group))
3652       (gnus-message 6 "Expiring articles in %s...done"
3653                     (gnus-group-decoded-name group))
3654       ;; Return the list of un-expired articles.
3655       (cdr expirable))))
3656
3657 (defun gnus-group-expire-all-groups ()
3658   "Expire all expirable articles in all newsgroups."
3659   (interactive)
3660   (save-excursion
3661     (gnus-message 5 "Expiring...")
3662     (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
3663                                      (cdr gnus-newsrc-alist))))
3664       (gnus-group-expire-articles nil)))
3665   (gnus-group-position-point)
3666   (gnus-message 5 "Expiring...done"))
3667
3668 (defun gnus-group-set-current-level (n level)
3669   "Set the level of the next N groups to LEVEL."
3670   (interactive
3671    (list
3672     current-prefix-arg
3673     (progn
3674       (unless (gnus-group-process-prefix current-prefix-arg)
3675         (error "No group on the current line"))
3676       (string-to-number
3677        (let ((s (read-string
3678                  (format "Level (default %s): "
3679                          (or (gnus-group-group-level)
3680                              gnus-level-default-subscribed)))))
3681          (if (string-match "^\\s-*$" s)
3682              (int-to-string (or (gnus-group-group-level)
3683                                 gnus-level-default-subscribed))
3684            s))))))
3685   (unless (and (>= level 1) (<= level gnus-level-killed))
3686     (error "Invalid level: %d" level))
3687   (dolist (group (gnus-group-process-prefix n))
3688     (gnus-group-remove-mark group)
3689     (gnus-message 6 "Changed level of %s from %d to %d"
3690                   (gnus-group-decoded-name group)
3691                   (or (gnus-group-group-level) gnus-level-killed)
3692                   level)
3693     (gnus-group-change-level
3694      group level (or (gnus-group-group-level) gnus-level-killed))
3695     (gnus-group-update-group-line))
3696   (gnus-group-position-point))
3697
3698 (defun gnus-group-unsubscribe (&optional n)
3699   "Unsubscribe the current group."
3700   (interactive "P")
3701   (gnus-group-unsubscribe-current-group n 'unsubscribe))
3702
3703 (defun gnus-group-subscribe (&optional n)
3704   "Subscribe the current group."
3705   (interactive "P")
3706   (gnus-group-unsubscribe-current-group n 'subscribe))
3707
3708 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
3709   "Toggle subscription of the current group.
3710 If given numerical prefix, toggle the N next groups."
3711   (interactive "P")
3712   (dolist (group (gnus-group-process-prefix n))
3713     (gnus-group-remove-mark group)
3714     (gnus-group-unsubscribe-group
3715      group
3716      (cond
3717       ((eq do-sub 'unsubscribe)
3718        gnus-level-default-unsubscribed)
3719       ((eq do-sub 'subscribe)
3720        gnus-level-default-subscribed)
3721       ((<= (gnus-group-group-level) gnus-level-subscribed)
3722        gnus-level-default-unsubscribed)
3723       (t
3724        gnus-level-default-subscribed))
3725      t)
3726     (gnus-group-update-group-line))
3727   (gnus-group-next-group 1))
3728
3729 (defun gnus-group-unsubscribe-group (group &optional level silent)
3730   "Toggle subscription to GROUP.
3731 Killed newsgroups are subscribed.  If SILENT, don't try to update the
3732 group line."
3733   (interactive (list (gnus-group-completing-read
3734                       nil nil (gnus-read-active-file-p))))
3735   (let ((newsrc (gnus-group-entry group)))
3736     (cond
3737      ((string-match "^[ \t]*$" group)
3738       (error "Empty group name"))
3739      (newsrc
3740       ;; Toggle subscription flag.
3741       (gnus-group-change-level
3742        newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
3743                                       gnus-level-subscribed)
3744                                   (1+ gnus-level-subscribed)
3745                                 gnus-level-default-subscribed)))
3746       (unless silent
3747         (gnus-group-update-group group)))
3748      ((and (stringp group)
3749            (or (not (gnus-read-active-file-p))
3750                (gnus-active group)))
3751       ;; Add new newsgroup.
3752       (gnus-group-change-level
3753        group
3754        (if level level gnus-level-default-subscribed)
3755        (or (and (member group gnus-zombie-list)
3756                 gnus-level-zombie)
3757            gnus-level-killed)
3758        (when (gnus-group-group-name)
3759          (gnus-group-entry (gnus-group-group-name))))
3760       (unless silent
3761         (gnus-group-update-group group)))
3762      (t (error "No such newsgroup: %s" group)))
3763     (gnus-group-position-point)))
3764
3765 (defun gnus-group-transpose-groups (n)
3766   "Move the current newsgroup up N places.
3767 If given a negative prefix, move down instead.  The difference between
3768 N and the number of steps taken is returned."
3769   (interactive "p")
3770   (unless (gnus-group-group-name)
3771     (error "No group on current line"))
3772   (gnus-group-kill-group 1)
3773   (prog1
3774       (forward-line (- n))
3775     (gnus-group-yank-group)
3776     (gnus-group-position-point)))
3777
3778 (defun gnus-group-kill-all-zombies (&optional dummy)
3779   "Kill all zombie newsgroups.
3780 The optional DUMMY should always be nil."
3781   (interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
3782   (unless dummy
3783     (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
3784     (setq gnus-zombie-list nil)
3785     (gnus-dribble-touch)
3786     (gnus-group-list-groups)))
3787
3788 (defun gnus-group-kill-region (begin end)
3789   "Kill newsgroups in current region (excluding current point).
3790 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
3791   (interactive "r")
3792   (let ((lines
3793          ;; Count lines.
3794          (save-excursion
3795            (count-lines
3796             (progn
3797               (goto-char begin)
3798               (point-at-bol))
3799             (progn
3800               (goto-char end)
3801               (point-at-bol))))))
3802     (goto-char begin)
3803     (beginning-of-line)                 ;Important when LINES < 1
3804     (gnus-group-kill-group lines)))
3805
3806 (defun gnus-group-kill-group (&optional n discard)
3807   "Kill the next N groups.
3808 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
3809 However, only groups that were alive can be yanked; already killed
3810 groups or zombie groups can't be yanked.
3811 The return value is the name of the group that was killed, or a list
3812 of groups killed."
3813   (interactive "P")
3814   (let ((buffer-read-only nil)
3815         (groups (gnus-group-process-prefix n))
3816         group entry level out)
3817     (if (< (length groups) 10)
3818         ;; This is faster when there are few groups.
3819         (while groups
3820           (push (setq group (pop groups)) out)
3821           (gnus-group-remove-mark group)
3822           (setq level (gnus-group-group-level))
3823           (gnus-delete-line)
3824           (when (and (not discard)
3825                      (setq entry (gnus-group-entry group)))
3826             (gnus-undo-register
3827               `(progn
3828                  (gnus-group-goto-group ,(gnus-group-group-name))
3829                  (gnus-group-yank-group)))
3830             (push (cons (car entry) (nth 2 entry))
3831                   gnus-list-of-killed-groups))
3832           (gnus-group-change-level
3833            (if entry entry group) gnus-level-killed (if entry nil level))
3834           (when (numberp (gnus-group-unread group))
3835             (gnus-request-update-group-status group 'unsubscribe))
3836           (message "Killed group %s" (gnus-group-decoded-name group)))
3837       ;; If there are lots and lots of groups to be killed, we use
3838       ;; this thing instead.
3839       (dolist (group (nreverse groups))
3840         (gnus-group-remove-mark group)
3841         (gnus-delete-line)
3842         (push group gnus-killed-list)
3843         (setq gnus-newsrc-alist
3844               (delq (assoc group gnus-newsrc-alist)
3845                     gnus-newsrc-alist))
3846         (when gnus-group-change-level-function
3847           (funcall gnus-group-change-level-function
3848                    group gnus-level-killed 3))
3849         (cond
3850          ((setq entry (gnus-group-entry group))
3851           (push (cons (car entry) (nth 2 entry))
3852                 gnus-list-of-killed-groups)
3853           (setcdr (cdr entry) (cdddr entry)))
3854          ((member group gnus-zombie-list)
3855           (setq gnus-zombie-list (delete group gnus-zombie-list))))
3856         ;; There may be more than one instance displayed.
3857         (while (gnus-group-goto-group group)
3858           (gnus-delete-line))
3859         (when (numberp (gnus-group-unread group))
3860           (gnus-request-update-group-status group 'unsubscribe)))
3861       (gnus-make-hashtable-from-newsrc-alist))
3862
3863     (gnus-group-position-point)
3864     (if (< (length out) 2) (car out) (nreverse out))))
3865
3866 (defun gnus-group-yank-group (&optional arg)
3867   "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
3868 The numeric ARG specifies how many newsgroups are to be yanked.  The
3869 name of the newsgroup yanked is returned, or (if several groups are
3870 yanked) a list of yanked groups is returned."
3871   (interactive "p")
3872   (setq arg (or arg 1))
3873   (let (info group prev out)
3874     (while (>= (decf arg) 0)
3875       (when (not (setq info (pop gnus-list-of-killed-groups)))
3876         (error "No more newsgroups to yank"))
3877       (push (setq group (nth 1 info)) out)
3878       ;; Find which newsgroup to insert this one before - search
3879       ;; backward until something suitable is found.  If there are no
3880       ;; other newsgroups in this buffer, just make this newsgroup the
3881       ;; first newsgroup.
3882       (setq prev (gnus-group-group-name))
3883       (gnus-group-change-level
3884        info (gnus-info-level (cdr info)) gnus-level-killed
3885        (and prev (gnus-group-entry prev))
3886        t)
3887       (gnus-group-insert-group-line-info group)
3888       (gnus-request-update-group-status group 'subscribe)
3889       (gnus-undo-register
3890         `(when (gnus-group-goto-group ,group)
3891            (gnus-group-kill-group 1))))
3892     (forward-line -1)
3893     (gnus-group-position-point)
3894     (if (< (length out) 2) (car out) (nreverse out))))
3895
3896 (defun gnus-group-kill-level (level)
3897   "Kill all groups that is on a certain LEVEL."
3898   (interactive "nKill all groups on level: ")
3899   (cond
3900    ((= level gnus-level-zombie)
3901     (setq gnus-killed-list
3902           (nconc gnus-zombie-list gnus-killed-list))
3903     (setq gnus-zombie-list nil))
3904    ((and (< level gnus-level-zombie)
3905          (> level 0)
3906          (or gnus-expert-user
3907              (gnus-yes-or-no-p
3908               (format
3909                "Do you really want to kill all groups on level %d? "
3910                level))))
3911     (let* ((prev gnus-newsrc-alist)
3912            (alist (cdr prev)))
3913       (while alist
3914         (if (= (gnus-info-level (car alist)) level)
3915             (progn
3916               (push (gnus-info-group (car alist)) gnus-killed-list)
3917               (setcdr prev (cdr alist)))
3918           (setq prev alist))
3919         (setq alist (cdr alist)))
3920       (gnus-make-hashtable-from-newsrc-alist)
3921       (gnus-group-list-groups)))
3922    (t
3923     (error "Can't kill; invalid level: %d" level))))
3924
3925 (defun gnus-group-list-all-groups (&optional arg)
3926   "List all newsgroups with level ARG or lower.
3927 Default is `gnus-level-unsubscribed', which lists all subscribed and most
3928 unsubscribed groups."
3929   (interactive "P")
3930   (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
3931
3932 ;; Redefine this to list ALL killed groups if prefix arg used.
3933 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
3934 (defun gnus-group-list-killed (&optional arg)
3935   "List all killed newsgroups in the group buffer.
3936 If ARG is non-nil, list ALL killed groups known to Gnus.  This may
3937 entail asking the server for the groups."
3938   (interactive "P")
3939   ;; Find all possible killed newsgroups if arg.
3940   (when arg
3941     (gnus-get-killed-groups))
3942   (if (not gnus-killed-list)
3943       (gnus-message 6 "No killed groups")
3944     (let (gnus-group-list-mode)
3945       (funcall gnus-group-prepare-function
3946                gnus-level-killed t gnus-level-killed))
3947     (goto-char (point-min)))
3948   (gnus-group-position-point))
3949
3950 (defun gnus-group-list-zombies ()
3951   "List all zombie newsgroups in the group buffer."
3952   (interactive)
3953   (if (not gnus-zombie-list)
3954       (gnus-message 6 "No zombie groups")
3955     (let (gnus-group-list-mode)
3956       (funcall gnus-group-prepare-function
3957                gnus-level-zombie t gnus-level-zombie))
3958     (goto-char (point-min)))
3959   (gnus-group-position-point))
3960
3961 (defun gnus-group-list-active ()
3962   "List all groups that are available from the server(s)."
3963   (interactive)
3964   ;; First we make sure that we have really read the active file.
3965   (unless (gnus-read-active-file-p)
3966     (let ((gnus-read-active-file t)
3967           (gnus-agent gnus-plugged)); If we're actually plugged, store the active file in the agent.
3968       (gnus-read-active-file)))
3969   ;; Find all groups and sort them.
3970   (let ((groups
3971          (sort
3972           (let (list)
3973             (mapatoms
3974              (lambda (sym)
3975                (and (boundp sym)
3976                     (symbol-value sym)
3977                     (push (symbol-name sym) list)))
3978              gnus-active-hashtb)
3979             list)
3980           'string<))
3981         (buffer-read-only nil)
3982         group)
3983     (erase-buffer)
3984     (while groups
3985       (setq group (pop groups))
3986       (gnus-add-text-properties
3987        (point) (prog1 (1+ (point))
3988                  (insert "       *: "
3989                          (gnus-group-decoded-name group)
3990                          "\n"))
3991        (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
3992              'gnus-unread t
3993              'gnus-level (inline (gnus-group-level group)))))
3994     (goto-char (point-min))))
3995
3996 (defun gnus-activate-all-groups (level)
3997   "Activate absolutely all groups."
3998   (interactive (list gnus-level-unsubscribed))
3999   (let ((gnus-activate-level level)
4000         (gnus-activate-foreign-newsgroups level))
4001     (gnus-group-get-new-news)))
4002
4003 (defun gnus-group-get-new-news (&optional arg)
4004   "Get newly arrived articles.
4005 If ARG is a number, it specifies which levels you are interested in
4006 re-scanning.  If ARG is non-nil and not a number, this will force
4007 \"hard\" re-reading of the active files from all servers."
4008   (interactive "P")
4009   (require 'nnmail)
4010   (let ((gnus-inhibit-demon t)
4011         ;; Binding this variable will inhibit multiple fetchings
4012         ;; of the same mail source.
4013         (nnmail-fetched-sources (list t)))
4014     (gnus-run-hooks 'gnus-get-top-new-news-hook)
4015     (gnus-run-hooks 'gnus-get-new-news-hook)
4016
4017     ;; Read any slave files.
4018     (unless gnus-slave
4019       (gnus-master-read-slave-newsrc))
4020
4021     (gnus-get-unread-articles arg)
4022
4023     ;; If the user wants it, we scan for new groups.
4024     (when (eq gnus-check-new-newsgroups 'always)
4025       (gnus-find-new-newsgroups))
4026
4027     (gnus-check-reasonable-setup)
4028     (gnus-run-hooks 'gnus-after-getting-new-news-hook)
4029     (gnus-group-list-groups (and (numberp arg)
4030                                  (max (car gnus-group-list-mode) arg)))))
4031
4032 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
4033   "Check for newly arrived news in the current group (and the N-1 next groups).
4034 The difference between N and the number of newsgroup checked is returned.
4035 If N is negative, this group and the N-1 previous groups will be checked.
4036 If DONT-SCAN is non-nil, scan non-activated groups as well."
4037   (interactive "P")
4038   (let* ((groups (gnus-group-process-prefix n))
4039          (ret (if (numberp n) (- n (length groups)) 0))
4040          (beg (unless n
4041                 (point-marker)))
4042          group method
4043          (gnus-inhibit-demon t)
4044          ;; Binding this variable will inhibit multiple fetchings
4045          ;; of the same mail source.
4046          (nnmail-fetched-sources (list t)))
4047     (gnus-run-hooks 'gnus-get-new-news-hook)
4048     (while (setq group (pop groups))
4049       (gnus-group-remove-mark group)
4050       ;; Bypass any previous denials from the server.
4051       (gnus-remove-denial (setq method (gnus-find-method-for-group group)))
4052       (if (gnus-activate-group group (if dont-scan nil 'scan) nil method)
4053           (let ((info (gnus-get-info group))
4054                 (active (gnus-active group)))
4055             (when info
4056               (gnus-request-update-info info method))
4057             (gnus-get-unread-articles-in-group info active)
4058             (unless (gnus-virtual-group-p group)
4059               (gnus-close-group group))
4060             (when gnus-agent
4061               (gnus-agent-save-group-info
4062                method (gnus-group-real-name group) active))
4063             (gnus-group-update-group group nil t))
4064         (if (eq (gnus-server-status (gnus-find-method-for-group group))
4065                 'denied)
4066             (gnus-error 3 "Server denied access")
4067           (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
4068     (when beg
4069       (goto-char beg))
4070     (when gnus-goto-next-group-when-activating
4071       (gnus-group-next-unread-group 1 t))
4072     (gnus-group-position-point)
4073     ret))
4074
4075 (defun gnus-group-describe-group (force &optional group)
4076   "Display a description of the current newsgroup."
4077   (interactive (list current-prefix-arg (gnus-group-group-name)))
4078   (let* ((method (gnus-find-method-for-group group))
4079          (mname (gnus-group-prefixed-name "" method))
4080          desc)
4081     (when (and force
4082                gnus-description-hashtb)
4083       (gnus-sethash mname nil gnus-description-hashtb))
4084     (unless group
4085       (error "No group name given"))
4086     (when (or (and gnus-description-hashtb
4087                    ;; We check whether this group's method has been
4088                    ;; queried for a description file.
4089                    (gnus-gethash mname gnus-description-hashtb))
4090               (setq desc (gnus-group-get-description group))
4091               (gnus-read-descriptions-file method))
4092       (gnus-message 1 "%s"
4093                     (or desc (gnus-gethash group gnus-description-hashtb)
4094                         "No description available")))))
4095
4096 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4097 (defun gnus-group-describe-all-groups (&optional force)
4098   "Pop up a buffer with descriptions of all newsgroups."
4099   (interactive "P")
4100   (when force
4101     (setq gnus-description-hashtb nil))
4102   (when (not (or gnus-description-hashtb
4103                  (gnus-read-all-descriptions-files)))
4104     (error "Couldn't request descriptions file"))
4105   (let ((buffer-read-only nil)
4106         b)
4107     (erase-buffer)
4108     (mapatoms
4109      (lambda (group)
4110        (setq b (point))
4111        (let ((charset (gnus-group-name-charset nil (symbol-name group))))
4112          (insert (format "      *: %-20s %s\n"
4113                          (gnus-group-name-decode
4114                           (symbol-name group) charset)
4115                          (gnus-group-name-decode
4116                           (symbol-value group) charset))))
4117        (gnus-add-text-properties
4118         b (1+ b) (list 'gnus-group group
4119                        'gnus-unread t 'gnus-marked nil
4120                        'gnus-level (1+ gnus-level-subscribed))))
4121      gnus-description-hashtb)
4122     (goto-char (point-min))
4123     (gnus-group-position-point)))
4124
4125 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
4126 (defun gnus-group-apropos (regexp &optional search-description)
4127   "List all newsgroups that have names that match a regexp."
4128   (interactive "sGnus apropos (regexp): ")
4129   (let ((prev "")
4130         (obuf (current-buffer))
4131         groups des)
4132     ;; Go through all newsgroups that are known to Gnus.
4133     (mapatoms
4134      (lambda (group)
4135        (and (symbol-name group)
4136             (string-match regexp (symbol-name group))
4137             (symbol-value group)
4138             (push (symbol-name group) groups)))
4139      gnus-active-hashtb)
4140     ;; Also go through all descriptions that are known to Gnus.
4141     (when search-description
4142       (mapatoms
4143        (lambda (group)
4144          (and (string-match regexp (symbol-value group))
4145               (push (symbol-name group) groups)))
4146        gnus-description-hashtb))
4147     (if (not groups)
4148         (gnus-message 3 "No groups matched \"%s\"." regexp)
4149       ;; Print out all the groups.
4150       (save-excursion
4151         (pop-to-buffer "*Gnus Help*")
4152         (buffer-disable-undo)
4153         (erase-buffer)
4154         (setq groups (sort groups 'string<))
4155         (while groups
4156           ;; Groups may be entered twice into the list of groups.
4157           (when (not (string= (car groups) prev))
4158             (setq prev (car groups))
4159             (let ((charset (gnus-group-name-charset nil prev)))
4160               (insert (gnus-group-name-decode prev charset) "\n")
4161               (when (and gnus-description-hashtb
4162                          (setq des (gnus-gethash (car groups)
4163                                                  gnus-description-hashtb)))
4164                 (insert "  " (gnus-group-name-decode des charset) "\n"))))
4165           (setq groups (cdr groups)))
4166         (goto-char (point-min))))
4167     (pop-to-buffer obuf)))
4168
4169 (defun gnus-group-description-apropos (regexp)
4170   "List all newsgroups that have names or descriptions that match REGEXP."
4171   (interactive "sGnus description apropos (regexp): ")
4172   (when (not (or gnus-description-hashtb
4173                  (gnus-read-all-descriptions-files)))
4174     (error "Couldn't request descriptions file"))
4175   (gnus-group-apropos regexp t))
4176
4177 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4178 (defun gnus-group-list-matching (level regexp &optional all lowest)
4179   "List all groups with unread articles that match REGEXP.
4180 If the prefix LEVEL is non-nil, it should be a number that says which
4181 level to cut off listing groups.
4182 If ALL, also list groups with no unread articles.
4183 If LOWEST, don't list groups with level lower than LOWEST.
4184
4185 This command may read the active file."
4186   (interactive "P\nsList newsgroups matching: ")
4187   ;; First make sure active file has been read.
4188   (when (and level
4189              (> (prefix-numeric-value level) gnus-level-killed))
4190     (gnus-get-killed-groups))
4191   (funcall gnus-group-prepare-function
4192    (or level gnus-level-subscribed) (and all t) (or lowest 1) regexp)
4193   (goto-char (point-min))
4194   (gnus-group-position-point))
4195
4196 (defun gnus-group-list-all-matching (level regexp &optional lowest)
4197   "List all groups that match REGEXP.
4198 If the prefix LEVEL is non-nil, it should be a number that says which
4199 level to cut off listing groups.
4200 If LOWEST, don't list groups with level lower than LOWEST."
4201   (interactive "P\nsList newsgroups matching: ")
4202   (when level
4203     (setq level (prefix-numeric-value level)))
4204   (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
4205
4206 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
4207 (defun gnus-group-save-newsrc (&optional force)
4208   "Save the Gnus startup files.
4209 If FORCE, force saving whether it is necessary or not."
4210   (interactive "P")
4211   (gnus-save-newsrc-file force))
4212
4213 (defun gnus-group-restart (&optional arg)
4214   "Force Gnus to read the .newsrc file."
4215   (interactive "P")
4216   (when (gnus-yes-or-no-p
4217          (format "Are you sure you want to restart Gnus? "))
4218     (gnus-save-newsrc-file)
4219     (gnus-clear-system)
4220     (gnus)))
4221
4222 (defun gnus-group-read-init-file ()
4223   "Read the Gnus elisp init file."
4224   (interactive)
4225   (gnus-read-init-file)
4226   (gnus-message 5 "Read %s" gnus-init-file))
4227
4228 (defun gnus-group-check-bogus-groups (&optional silent)
4229   "Check bogus newsgroups.
4230 If given a prefix, don't ask for confirmation before removing a bogus
4231 group."
4232   (interactive "P")
4233   (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
4234   (gnus-group-list-groups))
4235
4236 (defun gnus-group-find-new-groups (&optional arg)
4237   "Search for new groups and add them.
4238 Each new group will be treated with `gnus-subscribe-newsgroup-method'.
4239 With 1 C-u, use the `ask-server' method to query the server for new
4240 groups.
4241 With 2 C-u's, use most complete method possible to query the server
4242 for new groups, and subscribe the new groups as zombies."
4243   (interactive "p")
4244   (let ((new-groups (gnus-find-new-newsgroups (or arg 1)))
4245         current-group)
4246     (gnus-group-list-groups)
4247     (setq current-group (gnus-group-group-name))
4248     (dolist (group new-groups)
4249       (gnus-group-jump-to-group group))
4250     (when current-group
4251       (gnus-group-jump-to-group current-group))))
4252
4253 (defun gnus-group-edit-global-kill (&optional article group)
4254   "Edit the global kill file.
4255 If GROUP, edit that local kill file instead."
4256   (interactive "P")
4257   (setq gnus-current-kill-article article)
4258   (gnus-kill-file-edit-file group)
4259   (gnus-message 6 "Editing a %s kill file (Type %s to exit)"
4260                 (if group "local" "global")
4261                 (substitute-command-keys "\\[gnus-kill-file-exit]")))
4262
4263 (defun gnus-group-edit-local-kill (article group)
4264   "Edit a local kill file."
4265   (interactive (list nil (gnus-group-group-name)))
4266   (gnus-group-edit-global-kill article group))
4267
4268 (defun gnus-group-force-update ()
4269   "Update `.newsrc' file."
4270   (interactive)
4271   (gnus-save-newsrc-file))
4272
4273 (defvar gnus-backlog-articles)
4274
4275 (defun gnus-group-suspend ()
4276   "Suspend the current Gnus session.
4277 In fact, cleanup buffers except for group mode buffer.
4278 The hook `gnus-suspend-gnus-hook' is called before actually suspending."
4279   (interactive)
4280   (gnus-run-hooks 'gnus-suspend-gnus-hook)
4281   (gnus-offer-save-summaries)
4282   ;; Kill Gnus buffers except for group mode buffer.
4283   (let ((group-buf (get-buffer gnus-group-buffer)))
4284     (dolist (buf (gnus-buffers))
4285       (unless (or (eq buf group-buf)
4286                   (eq buf gnus-dribble-buffer)
4287                   (with-current-buffer buf
4288                     (eq major-mode 'message-mode)))
4289         (gnus-kill-buffer buf)))
4290     (setq gnus-backlog-articles nil)
4291     (gnus-kill-gnus-frames)
4292     (when group-buf
4293       (bury-buffer group-buf)
4294       (delete-windows-on group-buf t))))
4295
4296 (defun gnus-group-clear-dribble ()
4297   "Clear all information from the dribble buffer."
4298   (interactive)
4299   (gnus-dribble-clear)
4300   (gnus-message 7 "Cleared dribble buffer"))
4301
4302 (defun gnus-group-exit ()
4303   "Quit reading news after updating .newsrc.eld and .newsrc.
4304 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4305   (interactive)
4306   (when
4307       (or noninteractive                ;For gnus-batch-kill
4308           (not gnus-interactive-exit)   ;Without confirmation
4309           gnus-expert-user
4310           (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
4311     (gnus-run-hooks 'gnus-exit-gnus-hook)
4312     ;; Offer to save data from non-quitted summary buffers.
4313     (gnus-offer-save-summaries)
4314     ;; Save the newsrc file(s).
4315     (gnus-save-newsrc-file)
4316     ;; Kill-em-all.
4317     (gnus-close-backends)
4318     ;; Reset everything.
4319     (gnus-clear-system)
4320     ;; Allow the user to do things after cleaning up.
4321     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4322
4323 (defun gnus-group-quit ()
4324   "Quit reading news without updating .newsrc.eld or .newsrc.
4325 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4326   (interactive)
4327   (when (or noninteractive              ;For gnus-batch-kill
4328             (zerop (buffer-size))
4329             (not (gnus-server-opened gnus-select-method))
4330             gnus-expert-user
4331             (not gnus-current-startup-file)
4332             (gnus-yes-or-no-p
4333              (format "Quit reading news without saving %s? "
4334                      (file-name-nondirectory gnus-current-startup-file))))
4335     (gnus-run-hooks 'gnus-exit-gnus-hook)
4336     (gnus-configure-windows 'group t)
4337     (when (and (gnus-buffer-live-p gnus-dribble-buffer)
4338                (not (zerop (with-current-buffer gnus-dribble-buffer
4339                             (buffer-size)))))
4340       (gnus-dribble-enter
4341        ";;; Gnus was exited on purpose without saving the .newsrc files."))
4342     (gnus-dribble-save)
4343     (gnus-close-backends)
4344     (gnus-clear-system)
4345     (gnus-kill-buffer gnus-group-buffer)
4346     ;; Allow the user to do things after cleaning up.
4347     (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4348
4349 (defun gnus-group-describe-briefly ()
4350   "Give a one line description of the group mode commands."
4351   (interactive)
4352   (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")))
4353
4354 (defun gnus-group-browse-foreign-server (method)
4355   "Browse a foreign news server.
4356 If called interactively, this function will ask for a select method
4357  (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
4358 If not, METHOD should be a list where the first element is the method
4359 and the second element is the address."
4360   (interactive
4361    (list (let ((how (gnus-completing-read
4362                      "Which back end"
4363                      (mapcar 'car (append gnus-valid-select-methods
4364                                           gnus-server-alist))
4365                      t (cons "nntp" 0) 'gnus-method-history)))
4366            ;; We either got a back end name or a virtual server name.
4367            ;; If the first, we also need an address.
4368            (if (assoc how gnus-valid-select-methods)
4369                (list (intern how)
4370                      ;; Suggested by mapjph@bath.ac.uk.
4371                      (gnus-completing-read
4372                       "Address"
4373                       gnus-secondary-servers))
4374              ;; We got a server name.
4375              how))))
4376   (gnus-browse-foreign-server method))
4377
4378 (defun gnus-group-set-info (info &optional method-only-group part)
4379   (when (or info part)
4380     (let* ((entry (gnus-group-entry
4381                    (or method-only-group (gnus-info-group info))))
4382            (part-info info)
4383            (info (if method-only-group (nth 2 entry) info))
4384            method)
4385       (when method-only-group
4386         (unless entry
4387           (error "Trying to change non-existent group %s" method-only-group))
4388         ;; We have received parts of the actual group info - either the
4389         ;; select method or the group parameters.  We first check
4390         ;; whether we have to extend the info, and if so, do that.
4391         (let ((len (length info))
4392               (total (if (eq part 'method) 5 6)))
4393           (when (< len total)
4394             (setcdr (nthcdr (1- len) info)
4395                     (make-list (- total len) nil)))
4396           ;; Then we enter the new info.
4397           (setcar (nthcdr (1- total) info) part-info)))
4398       (unless entry
4399         ;; This is a new group, so we just create it.
4400         (with-current-buffer gnus-group-buffer
4401           (setq method (gnus-info-method info))
4402           (when (gnus-server-equal method "native")
4403             (setq method nil))
4404           (with-current-buffer gnus-group-buffer
4405             (if method
4406                 ;; It's a foreign group...
4407                 (gnus-group-make-group
4408                  (gnus-group-real-name (gnus-info-group info))
4409                  (if (stringp method) method
4410                    (prin1-to-string (car method)))
4411                  (and (consp method)
4412                       (nth 1 (gnus-info-method info)))
4413                  nil t)
4414               ;; It's a native group.
4415               (gnus-group-make-group (gnus-info-group info) nil nil nil t)))
4416           (gnus-message 6 "Note: New group created")
4417           (setq entry
4418                 (gnus-group-entry (gnus-group-prefixed-name
4419                                    (gnus-group-real-name (gnus-info-group info))
4420                                    (or (gnus-info-method info) gnus-select-method))))))
4421       ;; Whether it was a new group or not, we now have the entry, so we
4422       ;; can do the update.
4423       (if entry
4424           (progn
4425             (setcar (nthcdr 2 entry) info)
4426             (when (and (not (eq (car entry) t))
4427                        (gnus-active (gnus-info-group info)))
4428               (setcar entry (length
4429                              (gnus-list-of-unread-articles (car info))))))
4430         (error "No such group: %s" (gnus-info-group info))))))
4431
4432 (defun gnus-group-set-method-info (group select-method)
4433   (gnus-group-set-info select-method group 'method))
4434
4435 (defun gnus-group-set-params-info (group params)
4436   (gnus-group-set-info params group 'params))
4437
4438 ;; Ad-hoc function for inserting data from a different newsrc.eld
4439 ;; file.  Use with caution, if at all.
4440 (defun gnus-import-other-newsrc-file (file)
4441   (with-temp-buffer
4442     (insert-file-contents file)
4443     (let (form)
4444       (while (ignore-errors
4445                (setq form (read (current-buffer))))
4446         (when (and (consp form)
4447                    (eq (cadr form) 'gnus-newsrc-alist))
4448           (let ((infos (cadr (nth 2 form))))
4449             (dolist (info infos)
4450               (when (gnus-get-info (car info))
4451                 (gnus-set-info (car info) info)))))))))
4452
4453 (defun gnus-add-marked-articles (group type articles &optional info force)
4454   ;; Add ARTICLES of TYPE to the info of GROUP.
4455   ;; If INFO is non-nil, use that info.  If FORCE is non-nil, don't
4456   ;; add, but replace marked articles of TYPE with ARTICLES.
4457   (let ((info (or info (gnus-get-info group)))
4458         marked m)
4459     (or (not info)
4460         (and (not (setq marked (nthcdr 3 info)))
4461              (or (null articles)
4462                  (setcdr (nthcdr 2 info)
4463                          (list (list (cons type (gnus-compress-sequence
4464                                                  articles t)))))))
4465         (and (not (setq m (assq type (car marked))))
4466              (or (null articles)
4467                  (setcar marked
4468                          (cons (cons type (gnus-compress-sequence articles t) )
4469                                (car marked)))))
4470         (if force
4471             (if (null articles)
4472                 (setcar (nthcdr 3 info)
4473                         (gnus-delete-alist type (car marked)))
4474               (setcdr m (gnus-compress-sequence articles t)))
4475           (setcdr m (gnus-compress-sequence
4476                      (sort (nconc (gnus-uncompress-range (cdr m))
4477                                   (copy-sequence articles)) '<) t))))))
4478
4479 (defun gnus-add-mark (group mark article)
4480   "Mark ARTICLE in GROUP with MARK, whether the group is displayed or not."
4481   (let ((buffer (gnus-summary-buffer-name group)))
4482     (if (gnus-buffer-live-p buffer)
4483         (with-current-buffer (get-buffer buffer)
4484           (gnus-summary-add-mark article mark))
4485       (gnus-add-marked-articles group (cdr (assq mark gnus-article-mark-lists))
4486                                 (list article)))))
4487
4488 ;;;
4489 ;;; Group timestamps
4490 ;;;
4491
4492 (defun gnus-group-set-timestamp ()
4493   "Change the timestamp of the current group to the current time.
4494 This function can be used in hooks like `gnus-select-group-hook'
4495 or `gnus-group-catchup-group-hook'."
4496   (when gnus-newsgroup-name
4497     (let ((time (current-time)))
4498       (setcdr (cdr time) nil)
4499       (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
4500
4501 (defsubst gnus-group-timestamp (group)
4502   "Return the timestamp for GROUP."
4503   (gnus-group-get-parameter group 'timestamp t))
4504
4505 (defun gnus-group-timestamp-delta (group)
4506   "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
4507   (let* ((time (or (gnus-group-timestamp group)
4508                    (list 0 0)))
4509          (delta (subtract-time (current-time) time)))
4510     (+ (* (nth 0 delta) 65536.0)
4511        (nth 1 delta))))
4512
4513 (defun gnus-group-timestamp-string (group)
4514   "Return a string of the timestamp for GROUP."
4515   (let ((time (gnus-group-timestamp group)))
4516     (if (not time)
4517         ""
4518       (gnus-time-iso8601 time))))
4519
4520 (defun gnus-group-list-cached (level &optional lowest)
4521   "List all groups with cached articles.
4522 If the prefix LEVEL is non-nil, it should be a number that says which
4523 level to cut off listing groups.
4524 If LOWEST, don't list groups with level lower than LOWEST.
4525
4526 This command may read the active file."
4527   (interactive "P")
4528   (when level
4529     (setq level (prefix-numeric-value level)))
4530   (when (or (not level) (>= level gnus-level-zombie))
4531     (gnus-cache-open))
4532   (funcall gnus-group-prepare-function
4533            (or level gnus-level-subscribed)
4534            #'(lambda (info)
4535                (let ((marks (gnus-info-marks info)))
4536                  (assq 'cache marks)))
4537            lowest
4538            #'(lambda (group)
4539                (or (gnus-gethash group
4540                                  gnus-cache-active-hashtb)
4541                    ;; Cache active file might use "."
4542                    ;; instead of ":".
4543                    (gnus-gethash
4544                     (mapconcat 'identity
4545                                (split-string group ":")
4546                                ".")
4547                     gnus-cache-active-hashtb))))
4548   (goto-char (point-min))
4549   (gnus-group-position-point))
4550
4551 (defun gnus-group-list-dormant (level &optional lowest)
4552   "List all groups with dormant articles.
4553 If the prefix LEVEL is non-nil, it should be a number that says which
4554 level to cut off listing groups.
4555 If LOWEST, don't list groups with level lower than LOWEST.
4556
4557 This command may read the active file."
4558   (interactive "P")
4559   (when level
4560     (setq level (prefix-numeric-value level)))
4561   (when (or (not level) (>= level gnus-level-zombie))
4562     (gnus-cache-open))
4563   (funcall gnus-group-prepare-function
4564            (or level gnus-level-subscribed)
4565            #'(lambda (info)
4566                (let ((marks (gnus-info-marks info)))
4567                  (assq 'dormant marks)))
4568            lowest
4569            'ignore)
4570   (goto-char (point-min))
4571   (gnus-group-position-point))
4572
4573 (defun gnus-group-list-ticked (level &optional lowest)
4574   "List all groups with ticked articles.
4575 If the prefix LEVEL is non-nil, it should be a number that says which
4576 level to cut off listing groups.
4577 If LOWEST, don't list groups with level lower than LOWEST.
4578
4579 This command may read the active file."
4580   (interactive "P")
4581   (when level
4582     (setq level (prefix-numeric-value level)))
4583   (when (or (not level) (>= level gnus-level-zombie))
4584     (gnus-cache-open))
4585   (funcall gnus-group-prepare-function
4586            (or level gnus-level-subscribed)
4587            #'(lambda (info)
4588                (let ((marks (gnus-info-marks info)))
4589                  (assq 'tick marks)))
4590            lowest
4591            'ignore)
4592   (goto-char (point-min))
4593   (gnus-group-position-point))
4594
4595 (defun gnus-group-listed-groups ()
4596   "Return a list of listed groups."
4597   (let (point groups)
4598     (goto-char (point-min))
4599     (while (setq point (text-property-not-all (point) (point-max)
4600                                               'gnus-group nil))
4601       (goto-char point)
4602       (push (symbol-name (get-text-property point 'gnus-group)) groups)
4603       (forward-char 1))
4604     groups))
4605
4606 (defun gnus-group-list-plus (&optional args)
4607   "List groups plus the current selection."
4608   (interactive "P")
4609   (let ((gnus-group-listed-groups (gnus-group-listed-groups))
4610         (gnus-group-list-mode gnus-group-list-mode) ;; Save it.
4611         func)
4612     (push last-command-event unread-command-events)
4613     (if (featurep 'xemacs)
4614         (push (make-event 'key-press '(key ?A)) unread-command-events)
4615       (push ?A unread-command-events))
4616     (let (gnus-pick-mode keys)
4617       (setq keys (if (featurep 'xemacs)
4618                      (events-to-keys (read-key-sequence nil))
4619                    (read-key-sequence nil)))
4620       (setq func (lookup-key (current-local-map) keys)))
4621     (if (or (not func)
4622             (numberp func))
4623         (ding)
4624       (call-interactively func))))
4625
4626 (defun gnus-group-list-flush (&optional args)
4627   "Flush groups from the current selection."
4628   (interactive "P")
4629   (let ((gnus-group-list-option 'flush))
4630     (gnus-group-list-plus args)))
4631
4632 (defun gnus-group-list-limit (&optional args)
4633   "List groups limited within the current selection."
4634   (interactive "P")
4635   (let ((gnus-group-list-option 'limit))
4636     (gnus-group-list-plus args)))
4637
4638 (defun gnus-group-mark-article-read (group article)
4639   "Mark ARTICLE read."
4640   (let ((buffer (gnus-summary-buffer-name group))
4641         (mark gnus-read-mark)
4642         active n)
4643     (if (get-buffer buffer)
4644         (with-current-buffer buffer
4645           (setq active gnus-newsgroup-active)
4646           (gnus-activate-group group)
4647           (when gnus-newsgroup-prepared
4648             (when (and gnus-newsgroup-auto-expire
4649                        (memq mark gnus-auto-expirable-marks))
4650               (setq mark gnus-expirable-mark))
4651             (setq mark (gnus-request-update-mark
4652                         group article mark))
4653             (gnus-mark-article-as-read article mark)
4654             (setq gnus-newsgroup-active (gnus-active group))
4655             (when active
4656               (setq n (1+ (cdr active)))
4657               (while (<= n (cdr gnus-newsgroup-active))
4658                 (unless (eq n article)
4659                   (push n gnus-newsgroup-unselected))
4660                 (setq n (1+ n)))
4661               (setq gnus-newsgroup-unselected
4662                     (sort gnus-newsgroup-unselected '<)))))
4663       (gnus-activate-group group)
4664       (gnus-group-make-articles-read group (list article))
4665       (when (and (gnus-group-auto-expirable-p group)
4666                  (not (gnus-group-read-only-p group)))
4667         (gnus-add-marked-articles
4668          group 'expire (list article))))))
4669
4670
4671 ;;;
4672 ;;; Group compaction. -- dvl
4673 ;;;
4674
4675 (defun gnus-group-compact-group (group)
4676   "Compact the current group.
4677 Compaction means removing gaps between article numbers.  Hence, this
4678 operation is only meaningful for back ends using one file per article
4679 \(e.g. nnml).
4680
4681 Note: currently only implemented in nnml."
4682   (interactive (list (gnus-group-group-name)))
4683   (unless group
4684     (error "No group to compact"))
4685   (unless (gnus-check-backend-function 'request-compact-group group)
4686     (error "This back end does not support group compaction"))
4687   (let ((group-decoded (gnus-group-decoded-name group)))
4688     (gnus-message 6 "\
4689 Compacting group %s... (this may take a long time)"
4690                   group-decoded)
4691     (prog1
4692         (if (not (gnus-request-compact-group group))
4693             (gnus-error 3 "Couldn't compact group %s" group-decoded)
4694           (gnus-message 6 "Compacting group %s...done" group-decoded)
4695           t)
4696       ;; Invalidate the "original article" buffer which might be out of date.
4697       ;; #### NOTE: Yes, this might be a bit rude, but since compaction
4698       ;; #### will not happen very often, I think this is acceptable.
4699       (let ((original (get-buffer gnus-original-article-buffer)))
4700         (and original (gnus-kill-buffer original)))
4701       ;; Update the group line to reflect new information (art number etc).
4702       (gnus-group-update-group-line))))
4703
4704 (provide 'gnus-group)
4705
4706 ;;; gnus-group.el ends here