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