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