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