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