1 ;;; gnus-group.el --- group mode commands for Gnus
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
34 (defvar tool-bar-mode)
50 (let ((features (cons 'gnus-group features)))
52 (unless (boundp 'gnus-cache-active-hashtb)
53 (defvar gnus-cache-active-hashtb nil)))
55 (autoload 'gnus-agent-total-fetched-for "gnus-agent")
56 (autoload 'gnus-cache-total-fetched-for "gnus-cache")
58 (defcustom gnus-group-archive-directory
59 "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list/"
60 "*The address of the (ding) archives."
61 :group 'gnus-group-foreign
64 (defcustom gnus-group-recent-archive-directory
65 "/ftp@ftp.hpc.uh.edu:/pub/emacs/ding-list-recent/"
66 "*The address of the most recent (ding) articles."
67 :group 'gnus-group-foreign
70 (defcustom gnus-no-groups-message "No Gnus is good news"
71 "*Message displayed by Gnus when no groups are available."
75 (defcustom gnus-keep-same-level nil
76 "*Non-nil means that the next newsgroup after the current will be on the same level.
77 When you type, for instance, `n' after reading the last article in the
78 current newsgroup, you will go to the next newsgroup. If this variable
79 is nil, the next newsgroup will be the next from the group
81 If this variable is non-nil, Gnus will either put you in the
82 next newsgroup with the same level, or, if no such newsgroup is
83 available, the next newsgroup with the lowest possible level higher
84 than the current level.
85 If this variable is `best', Gnus will make the next newsgroup the one
87 :group 'gnus-group-levels
88 :type '(choice (const nil)
90 (sexp :tag "other" t)))
92 (defcustom gnus-group-goto-unread t
93 "*If non-nil, movement commands will go to the next unread and subscribed group."
94 :link '(custom-manual "(gnus)Group Maneuvering")
95 :group 'gnus-group-various
98 (defcustom gnus-goto-next-group-when-activating t
99 "*If non-nil, the \\<gnus-group-mode-map>\\[gnus-group-get-new-news-this-group] command will advance point to the next group."
100 :link '(custom-manual "(gnus)Scanning New Messages")
101 :group 'gnus-group-various
104 (defcustom gnus-permanently-visible-groups nil
105 "*Regexp to match groups that should always be listed in the group buffer.
106 This means that they will still be listed even when there are no
107 unread articles in the groups.
109 If nil, no groups are permanently visible."
110 :group 'gnus-group-listing
111 :type '(choice regexp (const nil)))
113 (defcustom gnus-safe-html-newsgroups "\\`nnrss[+:]"
114 "Groups in which links in html articles are considered all safe.
115 The value may be a regexp matching those groups, a list of group names,
116 or nil. This overrides `mm-w3m-safe-url-regexp' (which see). This is
117 effective only when emacs-w3m renders html articles, i.e., in the case
118 `mm-text-html-renderer' is set to `w3m'."
120 :group 'gnus-group-various
121 :type '(choice regexp
122 (repeat :tag "List of group names" (string :tag "Group"))
125 (defcustom gnus-list-groups-with-ticked-articles t
126 "*If non-nil, list groups that have only ticked articles.
127 If nil, only list groups that have unread articles."
128 :group 'gnus-group-listing
131 (defcustom gnus-group-default-list-level gnus-level-subscribed
132 "*Default listing level.
133 Ignored if `gnus-group-use-permanent-levels' is non-nil."
134 :group 'gnus-group-listing
137 (defcustom gnus-group-list-inactive-groups t
138 "*If non-nil, inactive groups will be listed."
139 :group 'gnus-group-listing
140 :group 'gnus-group-levels
143 (defcustom gnus-group-sort-function 'gnus-group-sort-by-alphabet
144 "*Function used for sorting the group buffer.
145 This function will be called with group info entries as the arguments
146 for the groups to be sorted. Pre-made functions include
147 `gnus-group-sort-by-alphabet', `gnus-group-sort-by-real-name',
148 `gnus-group-sort-by-unread', `gnus-group-sort-by-level',
149 `gnus-group-sort-by-score', `gnus-group-sort-by-method',
150 `gnus-group-sort-by-server', and `gnus-group-sort-by-rank'.
152 This variable can also be a list of sorting functions. In that case,
153 the most significant sort function should be the last function in the
155 :group 'gnus-group-listing
156 :link '(custom-manual "(gnus)Sorting Groups")
157 :type '(repeat :value-to-internal (lambda (widget value)
158 (if (listp value) value (list value)))
159 :match (lambda (widget value)
161 (widget-editable-list-match widget value)))
162 (choice (function-item gnus-group-sort-by-alphabet)
163 (function-item gnus-group-sort-by-real-name)
164 (function-item gnus-group-sort-by-unread)
165 (function-item gnus-group-sort-by-level)
166 (function-item gnus-group-sort-by-score)
167 (function-item gnus-group-sort-by-method)
168 (function-item gnus-group-sort-by-server)
169 (function-item gnus-group-sort-by-rank)
170 (function :tag "other" nil))))
172 (defcustom gnus-group-line-format "%M\%S\%p\%P\%5y:%B%(%g%)%O\n"
173 "*Format of group lines.
174 It works along the same lines as a normal formatting string,
175 with some simple extensions.
177 %M Only marked articles (character, \"*\" or \" \")
178 %S Whether the group is subscribed (character, \"U\", \"K\", \"Z\" or \" \")
179 %L Level of subscribedness (integer)
180 %N Number of unread articles (integer)
181 %I Number of dormant articles (integer)
182 %i Number of ticked and dormant (integer)
183 %T Number of ticked articles (integer)
184 %R Number of read articles (integer)
185 %U Number of unseen articles (integer)
186 %t Estimated total number of articles (integer)
187 %y Number of unread, unticked articles (integer)
188 %G Group name (string)
189 %g Qualified group name (string)
190 %c Short (collapsed) group name. See `gnus-group-uncollapsed-levels'.
191 %C Group comment (string)
192 %D Group description (string)
193 %s Select method (string)
194 %o Moderated group (char, \"m\")
195 %p Process mark (char)
196 %B Whether a summary buffer for the group is open (char, \"*\")
197 %O Moderated group (string, \"(m)\" or \"\")
198 %P Topic indentation (string)
199 %m Whether there is new(ish) mail in the group (char, \"%\")
200 %n Select from where (string)
201 %z A string that look like `<%s:%n>' if a foreign select method is used
202 %d The date the group was last entered.
203 %E Icon as defined by `gnus-group-icon-list'.
204 %F The disk space used by the articles fetched by both the cache and agent.
205 %u User defined specifier. The next character in the format string should
206 be a letter. Gnus will call the function gnus-user-format-function-X,
207 where X is the letter following %u. The function will be passed a
208 single dummy parameter as argument. The function should return a
209 string, which will be inserted into the buffer just like information
210 from any other group specifier.
212 Note that this format specification is not always respected. For
213 reasons of efficiency, when listing killed groups, this specification
214 is ignored altogether. If the spec is changed considerably, your
215 output may end up looking strange when listing both alive and killed
218 If you use %o or %O, reading the active file will be slower and quite
219 a bit of extra memory will be used. %D and %F will also worsen
220 performance. Also note that if you change the format specification to
221 include any of these specs, you must probably re-start Gnus to see
224 General format specifiers can also be used.
225 See Info node `(gnus)Formatting Variables'."
226 :link '(custom-manual "(gnus)Formatting Variables")
227 :group 'gnus-group-visual
230 (defcustom gnus-group-mode-line-format "Gnus: %%b {%M\%:%S}"
231 "*The format specification for the group mode line.
232 It works along the same lines as a normal formatting string,
233 with some simple extensions:
235 %S The native news server.
236 %M The native select method.
237 %: \":\" if %S isn't \"\"."
238 :group 'gnus-group-visual
241 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
242 (when (featurep 'xemacs)
243 (add-hook 'gnus-group-mode-hook 'gnus-xmas-group-menu-add)
244 (add-hook 'gnus-group-mode-hook 'gnus-xmas-setup-group-toolbar))
246 (defcustom gnus-group-menu-hook nil
247 "Hook run after the creation of the group mode menu."
248 :group 'gnus-group-various
251 (defcustom gnus-group-catchup-group-hook nil
252 "Hook run when catching up a group from the group buffer."
253 :group 'gnus-group-various
254 :link '(custom-manual "(gnus)Group Data")
257 (defcustom gnus-group-update-group-hook nil
258 "Hook called when updating group lines."
259 :group 'gnus-group-visual
262 (defcustom gnus-group-prepare-function 'gnus-group-prepare-flat
263 "*A function that is called to generate the group buffer.
264 The function is called with three arguments: The first is a number;
265 all group with a level less or equal to that number should be listed,
266 if the second is non-nil, empty groups should also be displayed. If
267 the third is non-nil, it is a number. No groups with a level lower
268 than this number should be displayed.
270 The only current function implemented is `gnus-group-prepare-flat'."
271 :group 'gnus-group-listing
274 (defcustom gnus-group-prepare-hook nil
275 "Hook called after the group buffer has been generated.
276 If you want to modify the group buffer, you can use this hook."
277 :group 'gnus-group-listing
280 (defcustom gnus-suspend-gnus-hook nil
281 "Hook called when suspending (not exiting) Gnus."
285 (defcustom gnus-exit-gnus-hook nil
286 "Hook called when exiting Gnus."
290 (defcustom gnus-after-exiting-gnus-hook nil
291 "Hook called after exiting Gnus."
295 (defcustom gnus-group-update-hook '(gnus-group-highlight-line)
296 "Hook called when a group line is changed.
297 The hook will not be called if `gnus-visual' is nil.
299 The default function `gnus-group-highlight-line' will
300 highlight the line according to the `gnus-group-highlight'
302 :group 'gnus-group-visual
305 (defcustom gnus-useful-groups
306 '(("(ding) mailing list mirrored at gmane.org"
307 "gmane.emacs.gnus.general"
309 (nntp-address "news.gmane.org")))
312 (nntp "news.gnus.org"
313 (nntp-address "news.gnus.org")))
314 ("Local Gnus help group"
317 (nndoc-article-type mbox)
318 (eval `(nndoc-address
319 ,(let ((file (nnheader-find-etc-directory
322 (error "Couldn't find doc group"))
324 "*Alist of useful group-server pairs."
325 :group 'gnus-group-listing
326 :type '(repeat (list (string :tag "Description")
328 (sexp :tag "Method"))))
330 (defcustom gnus-group-highlight
332 ((and mailp (= unread 0) (eq level 1)) .
333 gnus-group-mail-1-empty)
334 ((and mailp (eq level 1)) .
336 ((and mailp (= unread 0) (eq level 2)) .
337 gnus-group-mail-2-empty)
338 ((and mailp (eq level 2)) .
340 ((and mailp (= unread 0) (eq level 3)) .
341 gnus-group-mail-3-empty)
342 ((and mailp (eq level 3)) .
344 ((and mailp (= unread 0)) .
345 gnus-group-mail-low-empty)
349 ((and (= unread 0) (eq level 1)) .
350 gnus-group-news-1-empty)
351 ((and (eq level 1)) .
353 ((and (= unread 0) (eq level 2)) .
354 gnus-group-news-2-empty)
355 ((and (eq level 2)) .
357 ((and (= unread 0) (eq level 3)) .
358 gnus-group-news-3-empty)
359 ((and (eq level 3)) .
361 ((and (= unread 0) (eq level 4)) .
362 gnus-group-news-4-empty)
363 ((and (eq level 4)) .
365 ((and (= unread 0) (eq level 5)) .
366 gnus-group-news-5-empty)
367 ((and (eq level 5)) .
369 ((and (= unread 0) (eq level 6)) .
370 gnus-group-news-6-empty)
371 ((and (eq level 6)) .
373 ((and (= unread 0)) .
374 gnus-group-news-low-empty)
376 gnus-group-news-low))
377 "*Controls the highlighting of group buffer lines.
379 Below is a list of `Form'/`Face' pairs. When deciding how a a
380 particular group line should be displayed, each form is
381 evaluated. The content of the face field after the first true form is
382 used. You can change how those group lines are displayed by
383 editing the face field.
385 It is also possible to change and add form fields, but currently that
386 requires an understanding of Lisp expressions. Hopefully this will
387 change in a future release. For now, you can use the following
388 variables in the Lisp expression:
390 group: The name of the group.
391 unread: The number of unread articles in the group.
392 method: The select method used.
393 mailp: Whether it's a mail group or not.
394 level: The level of the group.
395 score: The score of the group.
396 ticked: The number of ticked articles."
397 :group 'gnus-group-visual
398 :type '(repeat (cons (sexp :tag "Form") face)))
399 (put 'gnus-group-highlight 'risky-local-variable t)
401 (defcustom gnus-new-mail-mark ?%
402 "Mark used for groups with new mail."
403 :group 'gnus-group-visual
406 (defgroup gnus-group-icons nil
407 "Add Icons to your group buffer."
408 :group 'gnus-group-visual)
410 (defcustom gnus-group-icon-list
412 "*Controls the insertion of icons into group buffer lines.
414 Below is a list of `Form'/`File' pairs. When deciding how a
415 particular group line should be displayed, each form is evaluated.
416 The icon from the file field after the first true form is used. You
417 can change how those group lines are displayed by editing the file
418 field. The File will either be found in the
419 `gnus-group-glyph-directory' or by designating absolute name of the
422 It is also possible to change and add form fields, but currently that
423 requires an understanding of Lisp expressions. Hopefully this will
424 change in a future release. For now, you can use the following
425 variables in the Lisp expression:
427 group: The name of the group.
428 unread: The number of unread articles in the group.
429 method: The select method used.
430 mailp: Whether it's a mail group or not.
431 newsp: Whether it's a news group or not
432 level: The level of the group.
433 score: The score of the group.
434 ticked: The number of ticked articles."
435 :group 'gnus-group-icons
436 :type '(repeat (cons (sexp :tag "Form") file)))
437 (put 'gnus-group-icon-list 'risky-local-variable t)
439 (defcustom gnus-group-name-charset-method-alist nil
440 "Alist of method and the charset for group names.
443 (((nntp \"news.com.cn\") . cn-gb-2312))"
446 :type '(repeat (cons (sexp :tag "Method") (symbol :tag "Charset"))))
448 (defcustom gnus-group-name-charset-group-alist
449 (if (or (and (fboundp 'find-coding-system) (find-coding-system 'utf-8))
450 (mm-coding-system-p 'utf-8))
453 "Alist of group regexp and the charset for group names.
456 ((\"\\.com\\.cn:\" . cn-gb-2312))"
458 :type '(repeat (cons (regexp :tag "Group") (symbol :tag "Charset"))))
460 (defcustom gnus-group-jump-to-group-prompt nil
461 "Default prompt for `gnus-group-jump-to-group'.
463 If non-nil, the value should be a string or an alist. If it is a string,
464 e.g. \"nnml:\", in which case `gnus-group-jump-to-group' offers \"Group:
465 nnml:\" in the minibuffer prompt.
467 If it is an alist, it must consist of \(NUMBER . PROMPT\) pairs, for example:
468 \((1 . \"\") (2 . \"nnfolder+archive:\")). The element with number 0 is
469 used when no prefix argument is given to `gnus-group-jump-to-group'."
471 :group 'gnus-group-various
472 :type '(choice (string :tag "Prompt string")
473 (const :tag "Empty" nil)
474 (repeat (cons (integer :tag "Argument")
475 (string :tag "Prompt string")))))
477 (defvar gnus-group-listing-limit 1000
478 "*A limit of the number of groups when listing.
479 If the number of groups is larger than the limit, list them in a
482 ;;; Internal variables
484 (defvar gnus-group-is-exiting-p nil)
485 (defvar gnus-group-is-exiting-without-update-p nil)
486 (defvar gnus-group-sort-alist-function 'gnus-group-sort-flat
487 "Function for sorting the group buffer.")
489 (defvar gnus-group-sort-selected-function 'gnus-group-sort-selected-flat
490 "Function for sorting the selected groups in the group buffer.")
492 (defvar gnus-group-indentation-function nil)
493 (defvar gnus-goto-missing-group-function nil)
494 (defvar gnus-group-update-group-function nil)
495 (defvar gnus-group-goto-next-group-function nil
496 "Function to override finding the next group after listing groups.")
498 (defvar gnus-group-edit-buffer nil)
500 (defvar gnus-group-line-format-alist
501 `((?M gnus-tmp-marked-mark ?c)
502 (?S gnus-tmp-subscribed ?c)
503 (?L gnus-tmp-level ?d)
504 (?N (cond ((eq number t) "*" )
508 (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
509 (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))))))
511 (?R gnus-tmp-number-of-read ?s)
512 (?U (gnus-number-of-unseen-articles-in-group gnus-tmp-group) ?d)
513 (?t gnus-tmp-number-total ?d)
514 (?y gnus-tmp-number-of-unread ?s)
515 (?I (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked))) ?d)
516 (?T (gnus-range-length (cdr (assq 'tick gnus-tmp-marked))) ?d)
517 (?i (+ (gnus-range-length (cdr (assq 'dormant gnus-tmp-marked)))
518 (gnus-range-length (cdr (assq 'tick gnus-tmp-marked)))) ?d)
519 (?g (if (boundp 'gnus-tmp-decoded-group)
520 gnus-tmp-decoded-group
523 (?G gnus-tmp-qualified-group ?s)
524 (?c (gnus-short-group-name (if (boundp 'gnus-tmp-decoded-group)
525 gnus-tmp-decoded-group
528 (?C gnus-tmp-comment ?s)
529 (?D gnus-tmp-newsgroup-description ?s)
530 (?o gnus-tmp-moderated ?c)
531 (?O gnus-tmp-moderated-string ?s)
532 (?p gnus-tmp-process-marked ?c)
533 (?s gnus-tmp-news-server ?s)
534 (?n ,(if (featurep 'xemacs)
535 '(symbol-name gnus-tmp-news-method)
536 'gnus-tmp-news-method)
538 (?P gnus-group-indentation ?s)
539 (?E gnus-tmp-group-icon ?s)
540 (?B gnus-tmp-summary-live ?c)
541 (?z gnus-tmp-news-method-string ?s)
542 (?m (gnus-group-new-mail gnus-tmp-group) ?c)
543 (?d (gnus-group-timestamp-string gnus-tmp-group) ?s)
544 (?u gnus-tmp-user-defined ?s)
545 (?F (gnus-total-fetched-for gnus-tmp-group) ?s)
548 (defvar gnus-group-mode-line-format-alist
549 `((?S gnus-tmp-news-server ?s)
550 (?M gnus-tmp-news-method ?s)
551 (?u gnus-tmp-user-defined ?s)
552 (?: gnus-tmp-colon ?s)))
554 (defvar gnus-topic-topology nil
555 "The complete topic hierarchy.")
557 (defvar gnus-topic-alist nil
558 "The complete topic-group alist.")
560 (defvar gnus-group-marked nil)
562 (defvar gnus-group-list-mode nil)
565 (defvar gnus-group-icon-cache nil)
567 (defvar gnus-group-listed-groups nil)
568 (defvar gnus-group-list-option nil)
574 (put 'gnus-group-mode 'mode-class 'special)
576 (gnus-define-keys gnus-group-mode-map
577 " " gnus-group-read-group
578 "=" gnus-group-select-group
579 "\r" gnus-group-select-group
580 "\M-\r" gnus-group-quick-select-group
581 "\M- " gnus-group-visible-select-group
582 [(meta control return)] gnus-group-select-group-ephemerally
583 "j" gnus-group-jump-to-group
584 "n" gnus-group-next-unread-group
585 "p" gnus-group-prev-unread-group
586 "\177" gnus-group-prev-unread-group
587 [delete] gnus-group-prev-unread-group
588 [backspace] gnus-group-prev-unread-group
589 "N" gnus-group-next-group
590 "P" gnus-group-prev-group
591 "\M-n" gnus-group-next-unread-group-same-level
592 "\M-p" gnus-group-prev-unread-group-same-level
593 "," gnus-group-best-unread-group
594 "." gnus-group-first-unread-group
595 "u" gnus-group-unsubscribe-current-group
596 "U" gnus-group-unsubscribe-group
597 "c" gnus-group-catchup-current
598 "C" gnus-group-catchup-current-all
599 "\M-c" gnus-group-clear-data
600 "l" gnus-group-list-groups
601 "L" gnus-group-list-all-groups
604 "g" gnus-group-get-new-news
605 "\M-g" gnus-group-get-new-news-this-group
606 "R" gnus-group-restart
607 "r" gnus-group-read-init-file
608 "B" gnus-group-browse-foreign-server
609 "b" gnus-group-check-bogus-groups
610 "F" gnus-group-find-new-groups
611 "\C-c\C-d" gnus-group-describe-group
612 "\M-d" gnus-group-describe-all-groups
613 "\C-c\C-a" gnus-group-apropos
614 "\C-c\M-\C-a" gnus-group-description-apropos
615 "a" gnus-group-post-news
616 "\ek" gnus-group-edit-local-kill
617 "\eK" gnus-group-edit-global-kill
618 "\C-k" gnus-group-kill-group
619 "\C-y" gnus-group-yank-group
620 "\C-w" gnus-group-kill-region
621 "\C-x\C-t" gnus-group-transpose-groups
622 "\C-c\C-l" gnus-group-list-killed
623 "\C-c\C-x" gnus-group-expire-articles
624 "\C-c\M-\C-x" gnus-group-expire-all-groups
626 "s" gnus-group-save-newsrc
627 "z" gnus-group-suspend
630 "?" gnus-group-describe-briefly
631 "\C-c\C-i" gnus-info-find-node
632 "\M-e" gnus-group-edit-group-method
633 "^" gnus-group-enter-server-mode
634 gnus-mouse-2 gnus-mouse-pick-group
635 [follow-link] mouse-face
636 "<" beginning-of-buffer
639 "\C-c\C-s" gnus-group-sort-groups
641 "\C-c\M-g" gnus-activate-all-groups
642 "\M-&" gnus-group-universal-argument
643 "#" gnus-group-mark-group
644 "\M-#" gnus-group-unmark-group)
646 (gnus-define-keys (gnus-group-mark-map "M" gnus-group-mode-map)
647 "m" gnus-group-mark-group
648 "u" gnus-group-unmark-group
649 "w" gnus-group-mark-region
650 "b" gnus-group-mark-buffer
651 "r" gnus-group-mark-regexp
652 "U" gnus-group-unmark-all-groups)
654 (gnus-define-keys (gnus-group-sieve-map "D" gnus-group-mode-map)
655 "u" gnus-sieve-update
656 "g" gnus-sieve-generate)
658 (gnus-define-keys (gnus-group-group-map "G" gnus-group-mode-map)
659 "d" gnus-group-make-directory-group
660 "h" gnus-group-make-help-group
661 "u" gnus-group-make-useful-group
662 "a" gnus-group-make-archive-group
663 "k" gnus-group-make-kiboze-group
664 "l" gnus-group-nnimap-edit-acl
665 "m" gnus-group-make-group
666 "E" gnus-group-edit-group
667 "e" gnus-group-edit-group-method
668 "p" gnus-group-edit-group-parameters
669 "v" gnus-group-add-to-virtual
670 "V" gnus-group-make-empty-virtual
671 "D" gnus-group-enter-directory
672 "f" gnus-group-make-doc-group
673 "w" gnus-group-make-web-group
674 "M" gnus-group-read-ephemeral-group
675 "r" gnus-group-rename-group
676 "R" gnus-group-make-rss-group
677 "c" gnus-group-customize
678 "z" gnus-group-compact-group
679 "x" gnus-group-nnimap-expunge
680 "\177" gnus-group-delete-group
681 [delete] gnus-group-delete-group)
683 (gnus-define-keys (gnus-group-sort-map "S" gnus-group-group-map)
684 "s" gnus-group-sort-groups
685 "a" gnus-group-sort-groups-by-alphabet
686 "u" gnus-group-sort-groups-by-unread
687 "l" gnus-group-sort-groups-by-level
688 "v" gnus-group-sort-groups-by-score
689 "r" gnus-group-sort-groups-by-rank
690 "m" gnus-group-sort-groups-by-method
691 "n" gnus-group-sort-groups-by-real-name)
693 (gnus-define-keys (gnus-group-sort-selected-map "P" gnus-group-group-map)
694 "s" gnus-group-sort-selected-groups
695 "a" gnus-group-sort-selected-groups-by-alphabet
696 "u" gnus-group-sort-selected-groups-by-unread
697 "l" gnus-group-sort-selected-groups-by-level
698 "v" gnus-group-sort-selected-groups-by-score
699 "r" gnus-group-sort-selected-groups-by-rank
700 "m" gnus-group-sort-selected-groups-by-method
701 "n" gnus-group-sort-selected-groups-by-real-name)
703 (gnus-define-keys (gnus-group-list-map "A" gnus-group-mode-map)
704 "k" gnus-group-list-killed
705 "z" gnus-group-list-zombies
706 "s" gnus-group-list-groups
707 "u" gnus-group-list-all-groups
708 "A" gnus-group-list-active
709 "a" gnus-group-apropos
710 "d" gnus-group-description-apropos
711 "m" gnus-group-list-matching
712 "M" gnus-group-list-all-matching
713 "l" gnus-group-list-level
714 "c" gnus-group-list-cached
715 "?" gnus-group-list-dormant)
717 (gnus-define-keys (gnus-group-list-limit-map "/" gnus-group-list-map)
718 "k" gnus-group-list-limit
719 "z" gnus-group-list-limit
720 "s" gnus-group-list-limit
721 "u" gnus-group-list-limit
722 "A" gnus-group-list-limit
723 "m" gnus-group-list-limit
724 "M" gnus-group-list-limit
725 "l" gnus-group-list-limit
726 "c" gnus-group-list-limit
727 "?" gnus-group-list-limit)
729 (gnus-define-keys (gnus-group-list-flush-map "f" gnus-group-list-map)
730 "k" gnus-group-list-flush
731 "z" gnus-group-list-flush
732 "s" gnus-group-list-flush
733 "u" gnus-group-list-flush
734 "A" gnus-group-list-flush
735 "m" gnus-group-list-flush
736 "M" gnus-group-list-flush
737 "l" gnus-group-list-flush
738 "c" gnus-group-list-flush
739 "?" gnus-group-list-flush)
741 (gnus-define-keys (gnus-group-list-plus-map "p" gnus-group-list-map)
742 "k" gnus-group-list-plus
743 "z" gnus-group-list-plus
744 "s" gnus-group-list-plus
745 "u" gnus-group-list-plus
746 "A" gnus-group-list-plus
747 "m" gnus-group-list-plus
748 "M" gnus-group-list-plus
749 "l" gnus-group-list-plus
750 "c" gnus-group-list-plus
751 "?" gnus-group-list-plus)
753 (gnus-define-keys (gnus-group-score-map "W" gnus-group-mode-map)
754 "f" gnus-score-flush-cache
755 "e" gnus-score-edit-all-score)
757 (gnus-define-keys (gnus-group-help-map "H" gnus-group-mode-map)
758 "c" gnus-group-fetch-charter
759 "C" gnus-group-fetch-control
760 "d" gnus-group-describe-group
761 "f" gnus-group-fetch-faq
764 (gnus-define-keys (gnus-group-sub-map "S" gnus-group-mode-map)
765 "l" gnus-group-set-current-level
766 "t" gnus-group-unsubscribe-current-group
767 "s" gnus-group-unsubscribe-group
768 "k" gnus-group-kill-group
769 "y" gnus-group-yank-group
770 "w" gnus-group-kill-region
771 "\C-k" gnus-group-kill-level
772 "z" gnus-group-kill-all-zombies)
774 (defun gnus-topic-mode-p ()
775 "Return non-nil in `gnus-topic-mode'."
776 (and (boundp 'gnus-topic-mode)
777 (symbol-value 'gnus-topic-mode)))
779 (defun gnus-group-make-menu-bar ()
780 (gnus-turn-off-edit-menu 'group)
781 (unless (boundp 'gnus-group-reading-menu)
784 gnus-group-reading-menu gnus-group-mode-map ""
786 ["Read" gnus-group-read-group
787 :included (not (gnus-topic-mode-p))
788 :active (gnus-group-group-name)]
789 ["Read " gnus-topic-read-group
790 :included (gnus-topic-mode-p)]
791 ["Select" gnus-group-select-group
792 :included (not (gnus-topic-mode-p))
793 :active (gnus-group-group-name)]
794 ["Select " gnus-topic-select-group
795 :included (gnus-topic-mode-p)]
796 ["See old articles" (gnus-group-select-group 'all)
797 :keys "C-u SPC" :active (gnus-group-group-name)]
798 ["Catch up" gnus-group-catchup-current
799 :included (not (gnus-topic-mode-p))
800 :active (gnus-group-group-name)
801 ,@(if (featurep 'xemacs) nil
802 '(:help "Mark unread articles in the current group as read"))]
803 ["Catch up " gnus-topic-catchup-articles
804 :included (gnus-topic-mode-p)
805 ,@(if (featurep 'xemacs) nil
806 '(:help "Mark unread articles in the current group or topic as read"))]
807 ["Catch up all articles" gnus-group-catchup-current-all
808 (gnus-group-group-name)]
809 ["Check for new articles" gnus-group-get-new-news-this-group
810 :included (not (gnus-topic-mode-p))
811 :active (gnus-group-group-name)
812 ,@(if (featurep 'xemacs) nil
813 '(:help "Check for new messages in current group"))]
814 ["Check for new articles " gnus-topic-get-new-news-this-topic
815 :included (gnus-topic-mode-p)
816 ,@(if (featurep 'xemacs) nil
817 '(:help "Check for new messages in current group or topic"))]
818 ["Toggle subscription" gnus-group-unsubscribe-current-group
819 (gnus-group-group-name)]
820 ["Kill" gnus-group-kill-group :active (gnus-group-group-name)
821 ,@(if (featurep 'xemacs) nil
822 '(:help "Kill (remove) current group"))]
823 ["Yank" gnus-group-yank-group gnus-list-of-killed-groups]
824 ["Describe" gnus-group-describe-group :active (gnus-group-group-name)
825 ,@(if (featurep 'xemacs) nil
826 '(:help "Display description of the current group"))]
827 ["Fetch FAQ" gnus-group-fetch-faq (gnus-group-group-name)]
828 ["Fetch charter" gnus-group-fetch-charter
829 :active (gnus-group-group-name)
830 ,@(if (featurep 'xemacs) nil
831 '(:help "Display the charter of the current group"))]
832 ["Fetch control message" gnus-group-fetch-control
833 :active (gnus-group-group-name)
834 ,@(if (featurep 'xemacs) nil
835 '(:help "Display the archived control message for the current group"))]
836 ;; Actually one should check, if any of the marked groups gives t for
837 ;; (gnus-check-backend-function 'request-expire-articles ...)
838 ["Expire articles" gnus-group-expire-articles
839 :included (not (gnus-topic-mode-p))
840 :active (or (and (gnus-group-group-name)
841 (gnus-check-backend-function
842 'request-expire-articles
843 (gnus-group-group-name))) gnus-group-marked)]
844 ["Expire articles " gnus-topic-expire-articles
845 :included (gnus-topic-mode-p)]
846 ["Set group level..." gnus-group-set-current-level
847 (gnus-group-group-name)]
848 ["Select quick" gnus-group-quick-select-group (gnus-group-group-name)]
849 ["Customize" gnus-group-customize (gnus-group-group-name)]
850 ["Compact" gnus-group-compact-group
851 :active (gnus-group-group-name)]
853 ["Parameters" gnus-group-edit-group-parameters
854 :included (not (gnus-topic-mode-p))
855 :active (gnus-group-group-name)]
856 ["Parameters " gnus-topic-edit-parameters
857 :included (gnus-topic-mode-p)]
858 ["Select method" gnus-group-edit-group-method
859 (gnus-group-group-name)]
860 ["Info" gnus-group-edit-group (gnus-group-group-name)]
861 ["Local kill file" gnus-group-edit-local-kill (gnus-group-group-name)]
862 ["Global kill file" gnus-group-edit-global-kill t])))
865 gnus-group-group-menu gnus-group-mode-map ""
868 ["List unread subscribed groups" gnus-group-list-groups t]
869 ["List (un)subscribed groups" gnus-group-list-all-groups t]
870 ["List killed groups" gnus-group-list-killed gnus-killed-list]
871 ["List zombie groups" gnus-group-list-zombies gnus-zombie-list]
872 ["List level..." gnus-group-list-level t]
873 ["Describe all groups" gnus-group-describe-all-groups t]
874 ["Group apropos..." gnus-group-apropos t]
875 ["Group and description apropos..." gnus-group-description-apropos t]
876 ["List groups matching..." gnus-group-list-matching t]
877 ["List all groups matching..." gnus-group-list-all-matching t]
878 ["List active file" gnus-group-list-active t]
879 ["List groups with cached" gnus-group-list-cached t]
880 ["List groups with dormant" gnus-group-list-dormant t])
882 ["Default sort" gnus-group-sort-groups t]
883 ["Sort by method" gnus-group-sort-groups-by-method t]
884 ["Sort by rank" gnus-group-sort-groups-by-rank t]
885 ["Sort by score" gnus-group-sort-groups-by-score t]
886 ["Sort by level" gnus-group-sort-groups-by-level t]
887 ["Sort by unread" gnus-group-sort-groups-by-unread t]
888 ["Sort by name" gnus-group-sort-groups-by-alphabet t]
889 ["Sort by real name" gnus-group-sort-groups-by-real-name t])
890 ("Sort process/prefixed"
891 ["Default sort" gnus-group-sort-selected-groups
892 (not (gnus-topic-mode-p))]
893 ["Sort by method" gnus-group-sort-selected-groups-by-method
894 (not (gnus-topic-mode-p))]
895 ["Sort by rank" gnus-group-sort-selected-groups-by-rank
896 (not (gnus-topic-mode-p))]
897 ["Sort by score" gnus-group-sort-selected-groups-by-score
898 (not (gnus-topic-mode-p))]
899 ["Sort by level" gnus-group-sort-selected-groups-by-level
900 (not (gnus-topic-mode-p))]
901 ["Sort by unread" gnus-group-sort-selected-groups-by-unread
902 (not (gnus-topic-mode-p))]
903 ["Sort by name" gnus-group-sort-selected-groups-by-alphabet
904 (not (gnus-topic-mode-p))]
905 ["Sort by real name" gnus-group-sort-selected-groups-by-real-name
906 (not (gnus-topic-mode-p))])
908 ["Mark group" gnus-group-mark-group
909 (and (gnus-group-group-name)
910 (not (memq (gnus-group-group-name) gnus-group-marked)))]
911 ["Unmark group" gnus-group-unmark-group
912 (and (gnus-group-group-name)
913 (memq (gnus-group-group-name) gnus-group-marked))]
914 ["Unmark all" gnus-group-unmark-all-groups gnus-group-marked]
915 ["Mark regexp..." gnus-group-mark-regexp t]
916 ["Mark region" gnus-group-mark-region :active (gnus-mark-active-p)]
917 ["Mark buffer" gnus-group-mark-buffer t]
918 ["Execute command" gnus-group-universal-argument
919 (or gnus-group-marked (gnus-group-group-name))])
921 ["Subscribe to a group..." gnus-group-unsubscribe-group t]
922 ["Kill all newsgroups in region" gnus-group-kill-region
923 :active (gnus-mark-active-p)]
924 ["Kill all zombie groups" gnus-group-kill-all-zombies
926 ["Kill all groups on level..." gnus-group-kill-level t])
928 ["Make a foreign group..." gnus-group-make-group t]
929 ["Add a directory group..." gnus-group-make-directory-group t]
930 ["Add the help group" gnus-group-make-help-group t]
931 ["Add the archive group" gnus-group-make-archive-group t]
932 ["Make a doc group..." gnus-group-make-doc-group t]
933 ["Make a web group..." gnus-group-make-web-group t]
934 ["Make a kiboze group..." gnus-group-make-kiboze-group t]
935 ["Make a virtual group..." gnus-group-make-empty-virtual t]
936 ["Add a group to a virtual..." gnus-group-add-to-virtual t]
937 ["Make an ephemeral group..." gnus-group-read-ephemeral-group t]
938 ["Make an RSS group..." gnus-group-make-rss-group t]
939 ["Rename group..." gnus-group-rename-group
940 (gnus-check-backend-function
941 'request-rename-group (gnus-group-group-name))]
942 ["Delete group" gnus-group-delete-group
943 (gnus-check-backend-function
944 'request-delete-group (gnus-group-group-name))])
946 ["Next" gnus-group-next-group t]
947 ["Previous" gnus-group-prev-group t]
948 ["Next unread" gnus-group-next-unread-group t]
949 ["Previous unread" gnus-group-prev-unread-group t]
950 ["Next unread same level" gnus-group-next-unread-group-same-level t]
951 ["Previous unread same level"
952 gnus-group-prev-unread-group-same-level t]
953 ["Jump to group..." gnus-group-jump-to-group t]
954 ["First unread group" gnus-group-first-unread-group t]
955 ["Best unread group" gnus-group-best-unread-group t])
957 ["Generate" gnus-sieve-generate t]
958 ["Generate and update" gnus-sieve-update t])
959 ["Delete bogus groups" gnus-group-check-bogus-groups t]
960 ["Find new newsgroups" gnus-group-find-new-groups t]
961 ["Transpose" gnus-group-transpose-groups
962 (gnus-group-group-name)]
963 ["Read a directory as a group..." gnus-group-enter-directory t]))
966 gnus-group-misc-menu gnus-group-mode-map ""
968 ["Send a mail" gnus-group-mail t]
969 ["Send a message (mail or news)" gnus-group-post-news t]
970 ["Create a local message" gnus-group-news t]
971 ["Check for new news" gnus-group-get-new-news
972 ,@(if (featurep 'xemacs) '(t)
973 '(:help "Get newly arrived articles"))
975 ["Send queued messages" gnus-delay-send-queue
976 ,@(if (featurep 'xemacs) '(t)
977 '(:help "Send all messages that are scheduled to be sent now"))
979 ["Activate all groups" gnus-activate-all-groups t]
980 ["Restart Gnus" gnus-group-restart t]
981 ["Read init file" gnus-group-read-init-file t]
982 ["Browse foreign server..." gnus-group-browse-foreign-server t]
983 ["Enter server buffer" gnus-group-enter-server-mode t]
984 ["Expire all expirable articles" gnus-group-expire-all-groups t]
985 ["Generate any kiboze groups" nnkiboze-generate-groups t]
986 ["Gnus version" gnus-version t]
987 ["Save .newsrc files" gnus-group-save-newsrc t]
988 ["Suspend Gnus" gnus-group-suspend t]
989 ["Clear dribble buffer" gnus-group-clear-dribble t]
990 ["Read manual" gnus-info-find-node t]
991 ["Flush score cache" gnus-score-flush-cache t]
992 ["Toggle topics" gnus-topic-mode t]
993 ["Send a bug report" gnus-bug t]
994 ["Exit from Gnus" gnus-group-exit
995 ,@(if (featurep 'xemacs) '(t)
996 '(:help "Quit reading news"))]
997 ["Exit without saving" gnus-group-quit t]))
999 (gnus-run-hooks 'gnus-group-menu-hook)))
1002 (defvar gnus-group-tool-bar-map nil)
1004 (defun gnus-group-tool-bar-update (&optional symbol value)
1005 "Update group buffer toolbar.
1006 Setter function for custom variables."
1008 (set-default symbol value))
1009 ;; (setq-default gnus-group-tool-bar-map nil)
1010 ;; (use-local-map gnus-group-mode-map)
1011 (when (gnus-alive-p)
1012 (with-current-buffer gnus-group-buffer
1013 (gnus-group-make-tool-bar t))))
1015 (defcustom gnus-group-tool-bar (if (eq gmm-tool-bar-style 'gnome)
1016 'gnus-group-tool-bar-gnome
1017 'gnus-group-tool-bar-retro)
1018 "Specifies the Gnus group tool bar.
1020 It can be either a list or a symbol refering to a list. See
1021 `gmm-tool-bar-from-list' for the format of the list. The
1022 default key map is `gnus-group-mode-map'.
1024 Pre-defined symbols include `gnus-group-tool-bar-gnome' and
1025 `gnus-group-tool-bar-retro'."
1026 :type '(choice (const :tag "GNOME style" gnus-group-tool-bar-gnome)
1027 (const :tag "Retro look" gnus-group-tool-bar-retro)
1028 (repeat :tag "User defined list" gmm-tool-bar-item)
1030 :version "23.1" ;; No Gnus
1031 :initialize 'custom-initialize-default
1032 :set 'gnus-group-tool-bar-update
1035 (defcustom gnus-group-tool-bar-gnome
1036 '((gnus-group-post-news "mail/compose")
1037 ;; Some useful agent icons? I don't use the agent so agent users should
1038 ;; suggest useful commands:
1039 (gnus-agent-toggle-plugged "disconnect" t
1040 :help "Gnus is currently unplugged. Click to work online."
1041 :visible (and gnus-agent (not gnus-plugged)))
1042 (gnus-agent-toggle-plugged "connect" t
1043 :help "Gnus is currently plugged. Click to work offline."
1044 :visible (and gnus-agent gnus-plugged))
1045 ;; FIXME: gnus-agent-toggle-plugged (in gnus-agent-group-make-menu-bar)
1046 ;; should have a better help text.
1047 (gnus-group-send-queue "mail/outbox" t
1048 :visible (and gnus-agent gnus-plugged)
1049 :help "Send articles from the queue group")
1050 (gnus-group-get-new-news "mail/inbox" nil
1051 :visible (or (not gnus-agent)
1053 ;; FIXME: gnus-*-read-group should have a better help text.
1054 (gnus-topic-read-group "open" nil
1055 :visible (and (boundp 'gnus-topic-mode)
1057 (gnus-group-read-group "open" nil
1058 :visible (not (and (boundp 'gnus-topic-mode)
1060 ;; (gnus-group-find-new-groups "???" nil)
1061 (gnus-group-save-newsrc "save")
1062 (gnus-group-describe-group "describe")
1063 (gnus-group-unsubscribe-current-group "gnus/toggle-subscription")
1064 (gnus-group-prev-unread-group "left-arrow")
1065 (gnus-group-next-unread-group "right-arrow")
1066 (gnus-group-exit "exit")
1067 (gmm-customize-mode "preferences" t :help "Edit mode preferences")
1068 (gnus-info-find-node "help"))
1069 "List of functions for the group tool bar (GNOME style).
1071 See `gmm-tool-bar-from-list' for the format of the list."
1072 :type '(repeat gmm-tool-bar-item)
1073 :version "23.1" ;; No Gnus
1074 :initialize 'custom-initialize-default
1075 :set 'gnus-group-tool-bar-update
1078 (defcustom gnus-group-tool-bar-retro
1079 '((gnus-group-get-new-news "gnus/get-news")
1080 (gnus-group-get-new-news-this-group "gnus/gnntg")
1081 (gnus-group-catchup-current "gnus/catchup")
1082 (gnus-group-describe-group "gnus/describe-group")
1083 (gnus-group-subscribe "gnus/subscribe" t
1084 :help "Subscribe to the current group")
1085 (gnus-group-unsubscribe "gnus/unsubscribe" t
1086 :help "Unsubscribe from the current group")
1087 (gnus-group-exit "gnus/exit-gnus" gnus-group-mode-map))
1088 "List of functions for the group tool bar (retro look).
1090 See `gmm-tool-bar-from-list' for the format of the list."
1091 :type '(repeat gmm-tool-bar-item)
1092 :version "23.1" ;; No Gnus
1093 :initialize 'custom-initialize-default
1094 :set 'gnus-group-tool-bar-update
1097 (defcustom gnus-group-tool-bar-zap-list t
1098 "List of icon items from the global tool bar.
1099 These items are not displayed in the Gnus group mode tool bar.
1101 See `gmm-tool-bar-from-list' for the format of the list."
1102 :type 'gmm-tool-bar-zap-list
1103 :version "23.1" ;; No Gnus
1104 :initialize 'custom-initialize-default
1105 :set 'gnus-group-tool-bar-update
1108 (defvar image-load-path)
1109 (defvar tool-bar-map)
1111 (defun gnus-group-make-tool-bar (&optional force)
1112 "Make a group mode tool bar from `gnus-group-tool-bar'.
1113 When FORCE, rebuild the tool bar."
1114 (when (and (not (featurep 'xemacs))
1115 (boundp 'tool-bar-mode)
1117 ;; The Gnus 5.10.6 code checked (default-value 'tool-bar-mode).
1119 (or (not gnus-group-tool-bar-map) force))
1121 (gmm-image-load-path-for-library "gnus"
1122 "gnus/toggle-subscription.xpm"
1124 (image-load-path (cons (car load-path)
1125 (when (boundp 'image-load-path)
1127 (map (gmm-tool-bar-from-list gnus-group-tool-bar
1128 gnus-group-tool-bar-zap-list
1129 'gnus-group-mode-map)))
1131 (set (make-local-variable 'tool-bar-map) map))))
1132 gnus-group-tool-bar-map)
1134 (defun gnus-group-mode ()
1135 "Major mode for reading news.
1137 All normal editing commands are switched off.
1138 \\<gnus-group-mode-map>
1139 The group buffer lists (some of) the groups available. For instance,
1140 `\\[gnus-group-list-groups]' will list all subscribed groups with unread articles, while `\\[gnus-group-list-zombies]'
1141 lists all zombie groups.
1143 Groups that are displayed can be entered with `\\[gnus-group-read-group]'. To subscribe
1144 to a group not displayed, type `\\[gnus-group-unsubscribe-group]'.
1146 For more in-depth information on this mode, read the manual (`\\[gnus-info-find-node]').
1148 The following commands are available:
1150 \\{gnus-group-mode-map}"
1152 (kill-all-local-variables)
1153 (when (gnus-visual-p 'group-menu 'menu)
1154 (gnus-group-make-menu-bar)
1155 (gnus-group-make-tool-bar))
1156 (gnus-simplify-mode-line)
1157 (setq major-mode 'gnus-group-mode)
1158 (setq mode-name "Group")
1159 (gnus-group-set-mode-line)
1160 (setq mode-line-process nil)
1161 (use-local-map gnus-group-mode-map)
1162 (buffer-disable-undo)
1163 (setq truncate-lines t)
1164 (setq buffer-read-only t
1165 show-trailing-whitespace nil)
1166 (gnus-set-default-directory)
1167 (gnus-update-format-specifications nil 'group 'group-mode)
1168 (gnus-update-group-mark-positions)
1173 (gnus-run-mode-hooks 'gnus-group-mode-hook))
1175 (defun gnus-update-group-mark-positions ()
1177 (let ((gnus-process-mark ?\200)
1178 (gnus-group-update-hook nil)
1179 (gnus-group-marked '("dummy.group"))
1180 (gnus-active-hashtb (make-vector 10 0))
1182 (gnus-set-active "dummy.group" '(0 . 0))
1183 (gnus-set-work-buffer)
1184 (gnus-group-insert-group-line "dummy.group" 0 nil 0 nil)
1185 (goto-char (point-min))
1186 (setq gnus-group-mark-positions
1187 (list (cons 'process (and (search-forward
1188 (mm-string-to-multibyte "\200") nil t)
1189 (- (point) (point-min) 1))))))))
1191 (defun gnus-mouse-pick-group (e)
1192 "Enter the group under the mouse pointer."
1195 (gnus-group-read-group nil))
1197 ;; Look at LEVEL and find out what the level is really supposed to be.
1198 ;; If LEVEL is non-nil, LEVEL will be returned, if not, what happens
1199 ;; will depend on whether `gnus-group-use-permanent-levels' is used.
1200 (defun gnus-group-default-level (&optional level number-or-nil)
1202 (gnus-group-use-permanent-levels
1203 (or (setq gnus-group-use-permanent-levels
1204 (or level (if (numberp gnus-group-use-permanent-levels)
1205 gnus-group-use-permanent-levels
1206 (or gnus-group-default-list-level
1207 gnus-level-subscribed))))
1208 gnus-group-default-list-level gnus-level-subscribed))
1212 (or level gnus-group-default-list-level gnus-level-subscribed))))
1214 (defun gnus-group-setup-buffer ()
1215 (set-buffer (gnus-get-buffer-create gnus-group-buffer))
1216 (unless (eq major-mode 'gnus-group-mode)
1219 (gnus-carpal-setup-buffer 'group))))
1221 (defun gnus-group-name-charset (method group)
1223 (setq method (gnus-find-method-for-group group)))
1224 (let ((item (or (assoc method gnus-group-name-charset-method-alist)
1226 (assoc (list (car method) (cadr method))
1227 gnus-group-name-charset-method-alist))))
1228 (alist gnus-group-name-charset-group-alist)
1232 (while (setq item (pop alist))
1233 (if (string-match (car item) group)
1235 result (cdr item))))
1238 (defun gnus-group-name-decode (string charset)
1239 ;; Fixme: Don't decode in unibyte mode.
1240 (if (and string charset (featurep 'mule))
1241 (mm-decode-coding-string string charset)
1244 (defun gnus-group-decoded-name (string)
1245 (let ((charset (gnus-group-name-charset nil string)))
1246 (gnus-group-name-decode string charset)))
1248 (defun gnus-group-list-groups (&optional level unread lowest)
1249 "List newsgroups with level LEVEL or lower that have unread articles.
1250 Default is all subscribed groups.
1251 If argument UNREAD is non-nil, groups with no unread articles are also
1254 Also see the `gnus-group-use-permanent-levels' variable."
1256 (list (if current-prefix-arg
1257 (prefix-numeric-value current-prefix-arg)
1259 (gnus-group-default-level nil t)
1260 gnus-group-default-list-level
1261 gnus-level-subscribed))))
1263 (setq level (car gnus-group-list-mode)
1264 unread (cdr gnus-group-list-mode)))
1265 (setq level (gnus-group-default-level level))
1266 (gnus-group-setup-buffer)
1267 (gnus-update-format-specifications nil 'group 'group-mode)
1268 (let ((case-fold-search nil)
1269 (props (text-properties-at (point-at-bol)))
1270 (empty (= (point-min) (point-max)))
1271 (group (gnus-group-group-name))
1273 (set-buffer gnus-group-buffer)
1274 (setq number (funcall gnus-group-prepare-function level unread lowest))
1275 (when (or (and (numberp number)
1277 (zerop (buffer-size)))
1278 ;; No groups in the buffer.
1279 (gnus-message 5 gnus-no-groups-message))
1280 ;; We have some groups displayed.
1281 (goto-char (point-max))
1282 (when (or (not gnus-group-goto-next-group-function)
1283 (not (funcall gnus-group-goto-next-group-function
1287 (goto-char (point-min)))
1289 ;; Go to the first group with unread articles.
1290 (gnus-group-search-forward t))
1292 ;; Find the right group to put point on. If the current group
1293 ;; has disappeared in the new listing, try to find the next
1294 ;; one. If no next one can be found, just leave point at the
1295 ;; first newsgroup in the buffer.
1296 (when (not (gnus-goto-char
1298 (point-min) (point-max)
1299 'gnus-group (gnus-intern-safe
1300 group gnus-active-hashtb))))
1301 (let ((newsrc (cdddr (gnus-group-entry group))))
1303 (not (gnus-goto-char
1305 (point-min) (point-max) 'gnus-group
1307 (caar newsrc) gnus-active-hashtb)))))
1308 (setq newsrc (cdr newsrc)))
1310 (goto-char (point-max))
1311 (forward-line -1)))))))
1312 ;; Adjust cursor point.
1313 (gnus-group-position-point)))
1315 (defun gnus-group-list-level (level &optional all)
1316 "List groups on LEVEL.
1317 If ALL (the prefix), also list groups that have no unread articles."
1318 (interactive "nList groups on level: \nP")
1319 (gnus-group-list-groups level all level))
1321 (defun gnus-group-prepare-logic (group test)
1322 (or (and gnus-group-listed-groups
1323 (null gnus-group-list-option)
1324 (member group gnus-group-listed-groups))
1326 ((null gnus-group-listed-groups) test)
1327 ((null gnus-group-list-option) test)
1328 (t (and (member group gnus-group-listed-groups)
1329 (if (eq gnus-group-list-option 'flush)
1333 (defun gnus-group-prepare-flat (level &optional predicate lowest regexp)
1334 "List all newsgroups with unread articles of level LEVEL or lower.
1335 If PREDICATE is a function, list groups that the function returns non-nil;
1336 if it is t, list groups that have no unread articles.
1337 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher.
1338 If REGEXP is a function, list dead groups that the function returns non-nil;
1339 if it is a string, only list groups matching REGEXP."
1340 (set-buffer gnus-group-buffer)
1341 (let ((buffer-read-only nil)
1342 (newsrc (cdr gnus-newsrc-alist))
1343 (lowest (or lowest 1))
1344 (not-in-list (and gnus-group-listed-groups
1345 (copy-sequence gnus-group-listed-groups)))
1346 info clevel unread group params)
1348 (when (or (< lowest gnus-level-zombie)
1349 gnus-group-listed-groups)
1350 ;; List living groups.
1352 (setq info (car newsrc)
1353 group (gnus-info-group info)
1354 params (gnus-info-params info)
1356 unread (gnus-group-unread group))
1358 (setq not-in-list (delete group not-in-list)))
1359 (when (gnus-group-prepare-logic
1361 (and (or unread ; This group might be unchecked
1362 predicate) ; Check if this group should be listed
1363 (or (not (stringp regexp))
1364 (string-match regexp group))
1365 (<= (setq clevel (gnus-info-level info)) level)
1368 ((functionp predicate)
1369 (funcall predicate info))
1370 (predicate t) ; We list all groups?
1373 (if (eq unread t) ; Unactivated?
1374 gnus-group-list-inactive-groups
1375 ; We list unactivated
1376 (and (numberp unread) (> unread 0)))
1377 ; We list groups with unread articles
1378 (and gnus-list-groups-with-ticked-articles
1379 (cdr (assq 'tick (gnus-info-marks info))))
1380 ; And groups with tickeds
1381 ;; Check for permanent visibility.
1382 (and gnus-permanently-visible-groups
1383 (string-match gnus-permanently-visible-groups
1385 (memq 'visible params)
1386 (cdr (assq 'visible params)))))))
1387 (gnus-group-insert-group-line
1388 group (gnus-info-level info)
1389 (gnus-info-marks info) unread (gnus-info-method info)))))
1391 ;; List dead groups.
1392 (when (or gnus-group-listed-groups
1393 (and (>= level gnus-level-zombie)
1394 (<= lowest gnus-level-zombie)))
1395 (gnus-group-prepare-flat-list-dead
1396 (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
1397 gnus-level-zombie ?Z
1400 (dolist (group gnus-zombie-list)
1401 (setq not-in-list (delete group not-in-list))))
1402 (when (or gnus-group-listed-groups
1403 (and (>= level gnus-level-killed) (<= lowest gnus-level-killed)))
1404 (gnus-group-prepare-flat-list-dead
1407 (setq gnus-killed-list (sort gnus-killed-list 'string<)))
1408 gnus-level-killed ?K regexp))
1410 (gnus-group-set-mode-line)
1411 (setq gnus-group-list-mode (cons level predicate))
1412 (gnus-run-hooks 'gnus-group-prepare-hook)
1415 (defun gnus-group-prepare-flat-list-dead (groups level mark regexp)
1416 ;; List zombies and killed lists somewhat faster, which was
1417 ;; suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>. It does
1418 ;; this by ignoring the group format specification altogether.
1420 (if (> (length groups) gnus-group-listing-limit)
1422 (setq group (pop groups))
1423 (when (gnus-group-prepare-logic
1426 (and (stringp regexp) (string-match regexp group))
1427 (and (functionp regexp) (funcall regexp group))))
1428 (gnus-add-text-properties
1429 (point) (prog1 (1+ (point))
1430 (insert " " mark " *: "
1431 (gnus-group-decoded-name group)
1433 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
1435 'gnus-level level))))
1437 (setq group (pop groups))
1438 (when (gnus-group-prepare-logic
1441 (and (stringp regexp) (string-match regexp group))
1442 (and (functionp regexp) (funcall regexp group))))
1443 (gnus-group-insert-group-line
1445 (let ((active (gnus-active group)))
1447 (if (zerop (cdr active))
1449 (- (1+ (cdr active)) (car active)))
1451 (gnus-method-simplify (gnus-find-method-for-group group))))))))
1453 (defun gnus-group-update-group-line ()
1454 "Update the current line in the group buffer."
1455 (let* ((buffer-read-only nil)
1456 (group (gnus-group-group-name))
1457 (entry (and group (gnus-group-entry group)))
1458 gnus-group-indentation)
1461 (not (gnus-ephemeral-group-p group))
1463 (concat "(gnus-group-set-info '"
1464 (gnus-prin1-to-string (nth 2 entry))
1466 (setq gnus-group-indentation (gnus-group-group-indentation))
1468 (gnus-group-insert-group-line-info group)
1470 (gnus-group-position-point))))
1472 (defun gnus-group-insert-group-line-info (group)
1473 "Insert GROUP on the current line."
1474 (let ((entry (gnus-group-entry group))
1475 (gnus-group-indentation (gnus-group-group-indentation))
1479 ;; (Un)subscribed group.
1480 (setq info (nth 2 entry))
1481 (gnus-group-insert-group-line
1482 group (gnus-info-level info) (gnus-info-marks info)
1483 (or (car entry) t) (gnus-info-method info)))
1484 ;; This group is dead.
1485 (gnus-group-insert-group-line
1487 (if (member group gnus-zombie-list) gnus-level-zombie gnus-level-killed)
1489 (if (setq active (gnus-active group))
1490 (if (zerop (cdr active))
1492 (- (1+ (cdr active)) (car active)))
1494 (gnus-method-simplify (gnus-find-method-for-group group))))))
1496 (defun gnus-number-of-unseen-articles-in-group (group)
1497 (let* ((info (nth 2 (gnus-group-entry group)))
1498 (marked (gnus-info-marks info))
1499 (seen (cdr (assq 'seen marked)))
1500 (active (gnus-active group)))
1503 (length (gnus-uncompress-range
1504 (gnus-range-difference
1505 (gnus-range-difference (list active) (gnus-info-read info))
1508 ;; Moving through the Group buffer (in topic mode) e.g. with C-n doesn't
1509 ;; update the state (enabled/disabled) of the icon `gnus-group-describe-group'
1510 ;; automatically. After `C-l' the state is correct. See the following report
1512 ;; <http://thread.gmane.org/v9acdmrcse.fsf@marauder.physik.uni-ulm.de>:
1513 ;; From: Reiner Steib
1514 ;; Subject: tool bar icons not updated according to :active condition
1515 ;; Newsgroups: gmane.emacs.devel
1516 ;; Date: Mon, 23 Jan 2006 19:59:13 +0100
1517 ;; Message-ID: <v9acdmrcse.fsf@marauder.physik.uni-ulm.de>
1519 (defcustom gnus-group-update-tool-bar
1520 (and (not (featurep 'xemacs))
1521 (boundp 'tool-bar-mode)
1523 ;; Using `redraw-frame' (see `gnus-tool-bar-update') in Emacs 21 might
1524 ;; be confusing, so maybe we shouldn't call it by default.
1525 (fboundp 'force-window-update))
1526 "Force updating the group buffer tool bar."
1529 :initialize 'custom-initialize-default
1530 :set (lambda (symbol value)
1531 (set-default symbol value)
1532 (when (gnus-alive-p)
1533 (with-current-buffer gnus-group-buffer
1534 ;; FIXME: Is there a better way to redraw the group buffer?
1535 (gnus-group-get-new-news 0))))
1538 (defun gnus-group-insert-group-line (gnus-tmp-group gnus-tmp-level
1539 gnus-tmp-marked number
1541 "Insert a group line in the group buffer."
1542 (let* ((gnus-tmp-method
1543 (gnus-server-get-method gnus-tmp-group gnus-tmp-method))
1544 (group-name-charset (gnus-group-name-charset gnus-tmp-method
1546 (gnus-tmp-active (gnus-active gnus-tmp-group))
1547 (gnus-tmp-number-total
1549 (1+ (- (cdr gnus-tmp-active) (car gnus-tmp-active)))
1551 (gnus-tmp-number-of-unread
1552 (if (numberp number) (int-to-string (max 0 number))
1554 (gnus-tmp-number-of-read
1555 (if (numberp number)
1556 (int-to-string (max 0 (- gnus-tmp-number-total number)))
1558 (gnus-tmp-subscribed
1559 (cond ((<= gnus-tmp-level gnus-level-subscribed) ? )
1560 ((<= gnus-tmp-level gnus-level-unsubscribed) ?U)
1561 ((= gnus-tmp-level gnus-level-zombie) ?Z)
1563 (gnus-tmp-qualified-group
1564 (gnus-group-name-decode (gnus-group-real-name gnus-tmp-group)
1565 group-name-charset))
1567 (or (gnus-group-get-parameter gnus-tmp-group 'comment t)
1569 (gnus-tmp-newsgroup-description
1570 (if gnus-description-hashtb
1571 (or (gnus-group-name-decode
1572 (gnus-gethash gnus-tmp-group gnus-description-hashtb)
1573 group-name-charset) "")
1576 (if (and gnus-moderated-hashtb
1577 (gnus-gethash gnus-tmp-group gnus-moderated-hashtb))
1579 (gnus-tmp-moderated-string
1580 (if (eq gnus-tmp-moderated ?m) "(m)" ""))
1581 (gnus-tmp-group-icon "==&&==")
1582 (gnus-tmp-news-server (or (cadr gnus-tmp-method) ""))
1583 (gnus-tmp-news-method (or (car gnus-tmp-method) ""))
1584 (gnus-tmp-news-method-string
1586 (format "(%s:%s)" (car gnus-tmp-method)
1587 (cadr gnus-tmp-method)) ""))
1588 (gnus-tmp-marked-mark
1589 (if (and (numberp number)
1591 (cdr (assq 'tick gnus-tmp-marked)))
1593 (gnus-tmp-summary-live
1594 (if (and (not gnus-group-is-exiting-p)
1595 (gnus-buffer-live-p (gnus-summary-buffer-name
1598 (gnus-tmp-process-marked
1599 (if (member gnus-tmp-group gnus-group-marked)
1600 gnus-process-mark ? ))
1601 (buffer-read-only nil)
1603 header gnus-tmp-header) ; passed as parameter to user-funcs.
1606 (gnus-add-text-properties
1610 (let ((gnus-tmp-decoded-group (gnus-group-name-decode
1611 gnus-tmp-group group-name-charset)))
1612 (eval gnus-group-line-format-spec)))
1613 `(gnus-group ,(gnus-intern-safe gnus-tmp-group gnus-active-hashtb)
1614 gnus-unread ,(if (numberp number)
1615 (string-to-number gnus-tmp-number-of-unread)
1617 gnus-marked ,gnus-tmp-marked-mark
1618 gnus-indentation ,gnus-group-indentation
1619 gnus-level ,gnus-tmp-level))
1621 (when gnus-group-update-tool-bar
1622 (gnus-put-text-property beg end 'point-entered
1623 'gnus-tool-bar-update)
1624 (gnus-put-text-property beg end 'point-left
1625 'gnus-tool-bar-update))
1627 (when (inline (gnus-visual-p 'group-highlight 'highlight))
1628 (gnus-run-hooks 'gnus-group-update-hook))
1630 ;; Allow XEmacs to remove front-sticky text properties.
1631 (gnus-group-remove-excess-properties)))
1633 (defun gnus-group-highlight-line ()
1634 "Highlight the current line according to `gnus-group-highlight'."
1635 (let* ((list gnus-group-highlight)
1637 (end (point-at-eol))
1638 ;; now find out where the line starts and leave point there.
1639 (beg (progn (beginning-of-line) (point)))
1640 (group (gnus-group-group-name))
1641 (entry (gnus-group-entry group))
1642 (unread (if (numberp (car entry)) (car entry) 0))
1643 (active (gnus-active group))
1644 (total (if active (1+ (- (cdr active) (car active))) 0))
1645 (info (nth 2 entry))
1646 (method (inline (gnus-server-get-method group (gnus-info-method info))))
1647 (marked (gnus-info-marks info))
1648 (mailp (apply 'append
1651 (memq x (assoc (symbol-name
1652 (car (or method gnus-select-method)))
1653 gnus-valid-select-methods)))
1654 '(mail post-mail))))
1655 (level (or (gnus-info-level info) gnus-level-killed))
1656 (score (or (gnus-info-score info) 0))
1657 (ticked (gnus-range-length (cdr (assq 'tick marked))))
1658 (group-age (gnus-group-timestamp-delta group))
1659 (inhibit-read-only t))
1660 ;; FIXME: http://thread.gmane.org/gmane.emacs.gnus.general/65451/focus=65465
1661 ;; ======================================================================
1662 ;; From: Richard Stallman
1663 ;; Subject: Re: Rewriting gnus-group-highlight-line (was: [...])
1664 ;; Cc: ding@gnus.org
1665 ;; Date: Sat, 27 Oct 2007 19:41:20 -0400
1666 ;; Message-ID: <E1IlvHM-0006TS-7t@fencepost.gnu.org>
1669 ;; The kludge is that the alist elements contain expressions that refer
1670 ;; to local variables with short names. Perhaps write your own tiny
1671 ;; evaluator that handles just `and', `or', and numeric comparisons
1672 ;; and just a few specific variables.
1673 ;; ======================================================================
1675 ;; Similar for other evaluated variables. Grep for risky-local-variable
1676 ;; to find them! -- rsteib
1678 ;; Eval the cars of the lists until we find a match.
1680 (not (eval (caar list))))
1681 (setq list (cdr list)))
1682 (let ((face (cdar list)))
1683 (unless (eq face (get-text-property beg 'face))
1684 (gnus-put-text-property-excluding-characters-with-faces
1686 (setq face (if (boundp face) (symbol-value face) face)))
1687 (gnus-extent-start-open beg)))
1690 (defun gnus-group-update-group (group &optional visible-only)
1691 "Update all lines where GROUP appear.
1692 If VISIBLE-ONLY is non-nil, the group won't be displayed if it isn't
1694 ;; Can't use `save-excursion' here, so we do it manually.
1695 (let ((buf (current-buffer))
1697 (set-buffer gnus-group-buffer)
1698 (setq mark (point-marker))
1699 ;; The buffer may be narrowed.
1702 (let ((ident (gnus-intern-safe group gnus-active-hashtb))
1704 found buffer-read-only)
1705 ;; Enter the current status into the dribble buffer.
1706 (let ((entry (gnus-group-entry group)))
1708 (not (gnus-ephemeral-group-p group)))
1710 (concat "(gnus-group-set-info '"
1711 (gnus-prin1-to-string (nth 2 entry))
1713 ;; Find all group instances. If topics are in use, each group
1714 ;; may be listed in more than once.
1715 (while (setq loc (text-property-any
1716 loc (point-max) 'gnus-group ident))
1719 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1721 (gnus-group-insert-group-line-info group)
1724 (gnus-run-hooks 'gnus-group-update-group-hook)))
1725 (setq loc (1+ loc)))
1726 (unless (or found visible-only)
1727 ;; No such line in the buffer, find out where it's supposed to
1728 ;; go, and insert it there (or at the end of the buffer).
1729 (if gnus-goto-missing-group-function
1730 (funcall gnus-goto-missing-group-function group)
1731 (let ((entry (cddr (gnus-group-entry group))))
1732 (while (and entry (car entry)
1736 (point-min) (point-max)
1737 'gnus-group (gnus-intern-safe
1738 (caar entry) gnus-active-hashtb)))))
1739 (setq entry (cdr entry)))
1740 (or entry (goto-char (point-max)))))
1741 ;; Finally insert the line.
1742 (let ((gnus-group-indentation (gnus-group-group-indentation)))
1743 (gnus-group-insert-group-line-info group)
1746 (gnus-run-hooks 'gnus-group-update-group-hook))))
1747 (when gnus-group-update-group-function
1748 (funcall gnus-group-update-group-function group))
1749 (gnus-group-set-mode-line)))
1751 (set-marker mark nil)
1754 (defun gnus-group-set-mode-line ()
1755 "Update the mode line in the group buffer."
1756 (when (memq 'group gnus-updated-mode-lines)
1757 ;; Yes, we want to keep this mode line updated.
1759 (set-buffer gnus-group-buffer)
1760 (let* ((gformat (or gnus-group-mode-line-format-spec
1761 (gnus-set-format 'group-mode)))
1762 (gnus-tmp-news-server (cadr gnus-select-method))
1763 (gnus-tmp-news-method (car gnus-select-method))
1764 (gnus-tmp-colon (if (equal gnus-tmp-news-server "") "" ":"))
1766 gnus-tmp-header ;Dummy binding for user-defined formats
1767 ;; Get the resulting string.
1769 (and gnus-dribble-buffer
1770 (buffer-name gnus-dribble-buffer)
1771 (buffer-modified-p gnus-dribble-buffer)
1773 (set-buffer gnus-dribble-buffer)
1774 (not (zerop (buffer-size))))))
1775 (mode-string (eval gformat)))
1776 ;; Say whether the dribble buffer has been modified.
1777 (setq mode-line-modified
1778 (if modified (car gnus-mode-line-modified)
1779 (cdr gnus-mode-line-modified)))
1780 ;; If the line is too long, we chop it off.
1781 (when (> (length mode-string) max-len)
1782 (setq mode-string (substring mode-string 0 (- max-len 4))))
1784 (setq mode-line-buffer-identification
1785 (gnus-mode-line-buffer-identification
1786 (list mode-string)))
1787 (set-buffer-modified-p modified))))))
1789 (defun gnus-group-group-name ()
1790 "Get the name of the newsgroup on the current line."
1791 (let ((group (get-text-property (point-at-bol) 'gnus-group)))
1793 (symbol-name group))))
1795 (defun gnus-group-group-level ()
1796 "Get the level of the newsgroup on the current line."
1797 (get-text-property (point-at-bol) 'gnus-level))
1799 (defun gnus-group-group-indentation ()
1800 "Get the indentation of the newsgroup on the current line."
1801 (or (get-text-property (point-at-bol) 'gnus-indentation)
1802 (and gnus-group-indentation-function
1803 (funcall gnus-group-indentation-function))
1806 (defun gnus-group-group-unread ()
1807 "Get the number of unread articles of the newsgroup on the current line."
1808 (get-text-property (point-at-bol) 'gnus-unread))
1810 (defun gnus-group-new-mail (group)
1811 (if (nnmail-new-mail-p (gnus-group-real-name group))
1815 (defun gnus-group-level (group)
1816 "Return the estimated level of GROUP."
1817 (or (gnus-info-level (gnus-get-info group))
1818 (and (member group gnus-zombie-list) gnus-level-zombie)
1821 (defun gnus-group-search-forward (&optional backward all level first-too)
1822 "Find the next newsgroup with unread articles.
1823 If BACKWARD is non-nil, find the previous newsgroup instead.
1824 If ALL is non-nil, just find any newsgroup.
1825 If LEVEL is non-nil, find group with level LEVEL, or higher if no such
1827 If FIRST-TOO, the current line is also eligible as a target."
1828 (let ((way (if backward -1 1))
1829 (low gnus-level-killed)
1832 (if (and backward (progn (beginning-of-line)) (bobp))
1841 (get-text-property (point) 'gnus-group)
1845 (get-text-property (point) 'gnus-unread)))
1846 (and (numberp unread) (> unread 0)))
1847 (setq lev (get-text-property (point)
1849 (<= lev gnus-level-subscribed)))
1851 (and (setq lev (get-text-property (point)
1860 (zerop (forward-line way)))))
1862 (progn (gnus-group-position-point) t)
1863 (goto-char (or pos beg))
1866 (defun gnus-total-fetched-for (group)
1867 (let* ((size-in-cache (or (gnus-cache-total-fetched-for group) 0))
1868 (size-in-agent (or (gnus-agent-total-fetched-for group) 0))
1869 (size (+ size-in-cache size-in-agent))
1870 (suffix '("B" "K" "M" "G"))
1873 (while (> size cutoff)
1874 (setq size (/ size scale)
1875 suffix (cdr suffix)))
1876 (format "%5.1f%s" size (car suffix))))
1878 ;;; Gnus group mode commands
1882 (defun gnus-group-mark-line-p ()
1885 (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1886 (eq (char-after) gnus-process-mark)))
1888 (defun gnus-group-mark-group (n &optional unmark no-advance)
1889 "Mark the current group."
1891 (let ((buffer-read-only nil)
1895 (when (setq group (gnus-group-group-name))
1896 ;; Go to the mark position.
1898 (forward-char (or (cdr (assq 'process gnus-group-mark-positions)) 2))
1902 (setq gnus-group-marked (delete group gnus-group-marked))
1903 (insert-char ? 1 t))
1904 (setq gnus-group-marked
1905 (cons group (delete group gnus-group-marked)))
1906 (insert-char gnus-process-mark 1 t)))
1908 (gnus-group-next-group 1))
1910 (gnus-summary-position-point)
1913 (defun gnus-group-unmark-group (n)
1914 "Remove the mark from the current group."
1916 (gnus-group-mark-group n 'unmark)
1917 (gnus-group-position-point))
1919 (defun gnus-group-unmark-all-groups ()
1920 "Unmark all groups."
1923 (mapc 'gnus-group-remove-mark gnus-group-marked))
1924 (gnus-group-position-point))
1926 (defun gnus-group-mark-region (unmark beg end)
1927 "Mark all groups between point and mark.
1928 If UNMARK, remove the mark instead."
1929 (interactive "P\nr")
1930 (let ((num (count-lines beg end)))
1933 (- num (gnus-group-mark-group num unmark)))))
1935 (defun gnus-group-mark-buffer (&optional unmark)
1936 "Mark all groups in the buffer.
1937 If UNMARK, remove the mark instead."
1939 (gnus-group-mark-region unmark (point-min) (point-max)))
1941 (defun gnus-group-mark-regexp (regexp)
1942 "Mark all groups that match some regexp."
1943 (interactive "sMark (regexp): ")
1944 (let ((alist (cdr gnus-newsrc-alist))
1948 (when (string-match regexp (setq group (gnus-info-group (pop alist))))
1949 (gnus-group-jump-to-group group)
1950 (gnus-group-set-mark group)))))
1951 (gnus-group-position-point))
1953 (defun gnus-group-remove-mark (group &optional test-marked)
1954 "Remove the process mark from GROUP and move point there.
1955 Return nil if the group isn't displayed."
1956 (if (gnus-group-goto-group group nil test-marked)
1958 (gnus-group-mark-group 1 'unmark t)
1960 (setq gnus-group-marked
1961 (delete group gnus-group-marked))
1964 (defun gnus-group-set-mark (group)
1965 "Set the process mark on GROUP."
1966 (if (gnus-group-goto-group group)
1968 (gnus-group-mark-group 1 nil t))
1969 (setq gnus-group-marked (cons group (delete group gnus-group-marked)))))
1971 (defun gnus-group-universal-argument (arg &optional groups func)
1972 "Perform any command on all groups according to the process/prefix convention."
1974 (if (eq (setq func (or func
1977 (substitute-command-keys
1978 "\\<gnus-group-mode-map>\\[gnus-group-universal-argument]")))))
1980 (gnus-error 1 "Undefined key")
1981 (gnus-group-iterate arg
1983 (command-execute func))))
1984 (gnus-group-position-point))
1986 (defun gnus-group-process-prefix (n)
1987 "Return a list of groups to work on.
1988 Take into consideration N (the prefix) and the list of marked groups."
1991 (setq n (prefix-numeric-value n))
1992 ;; There is a prefix, so we return a list of the N next
1994 (let ((way (if (< n 0) -1 1))
1999 (if (setq group (gnus-group-group-name))
2000 (push group groups))
2002 (gnus-group-next-group way)))
2004 ((and (gnus-region-active-p) (mark))
2005 ;; Work on the region between point and mark.
2006 (let ((max (max (point) (mark)))
2009 (goto-char (min (point) (mark)))
2012 (push (gnus-group-group-name) groups)
2013 (zerop (gnus-group-next-group 1))
2015 (nreverse groups))))
2017 ;; No prefix, but a list of marked articles.
2018 (reverse gnus-group-marked))
2020 ;; Neither marked articles or a prefix, so we return the
2022 (let ((group (gnus-group-group-name)))
2023 (and group (list group))))))
2025 ;;; !!!Surely gnus-group-iterate should be a macro instead? I can't
2026 ;;; imagine why I went through these contortions...
2028 (let ((function (make-symbol "gnus-group-iterate-function"))
2029 (window (make-symbol "gnus-group-iterate-window"))
2030 (groups (make-symbol "gnus-group-iterate-groups"))
2031 (group (make-symbol "gnus-group-iterate-group")))
2033 `(defun gnus-group-iterate (arg ,function)
2034 "Iterate FUNCTION over all process/prefixed groups.
2035 FUNCTION will be called with the group name as the parameter
2036 and with point over the group in question."
2037 (let ((,groups (gnus-group-process-prefix arg))
2038 (,window (selected-window))
2041 (setq ,group (car ,groups)
2042 ,groups (cdr ,groups))
2043 (select-window ,window)
2044 (gnus-group-remove-mark ,group)
2045 (save-selected-window
2047 (funcall ,function ,group)))))))))
2049 (put 'gnus-group-iterate 'lisp-indent-function 1)
2051 ;; Selecting groups.
2053 (defun gnus-group-read-group (&optional all no-article group select-articles)
2054 "Read news in this newsgroup.
2055 If the prefix argument ALL is non-nil, already read articles become
2058 If ALL is a positive number, fetch this number of the latest
2059 articles in the group. If ALL is a negative number, fetch this
2060 number of the earliest articles in the group.
2062 If the optional argument NO-ARTICLE is non-nil, no article will
2063 be auto-selected upon group entry. If GROUP is non-nil, fetch
2066 (let ((no-display (eq all 0))
2067 (group (or group (gnus-group-group-name)))
2068 number active marked entry)
2072 (error "No group on current line"))
2073 (setq marked (gnus-info-marks
2074 (nth 2 (setq entry (gnus-group-entry group)))))
2075 ;; This group might be a dead group. In that case we have to get
2076 ;; the number of unread articles from `gnus-active-hashtb'.
2078 (cond ((numberp all) all)
2080 ((setq active (gnus-active group))
2081 (- (1+ (cdr active)) (car active)))))
2082 (gnus-summary-read-group
2083 group (or all (and (numberp number)
2084 (zerop (+ number (gnus-range-length
2085 (cdr (assq 'tick marked)))
2087 (cdr (assq 'dormant marked)))))))
2088 no-article nil no-display nil select-articles)))
2090 (defun gnus-group-select-group (&optional all)
2091 "Select this newsgroup.
2092 No article is selected automatically.
2093 If the group is opened, just switch the summary buffer.
2094 If ALL is non-nil, already read articles become readable.
2095 If ALL is a positive number, fetch this number of the latest
2096 articles in the group.
2097 If ALL is a negative number, fetch this number of the earliest
2098 articles in the group."
2100 (when (and (eobp) (not (gnus-group-group-name)))
2102 (gnus-group-read-group all t))
2104 (defun gnus-group-quick-select-group (&optional all group)
2105 "Select the GROUP \"quickly\".
2106 This means that no highlighting or scoring will be performed. If
2107 ALL (the prefix argument) is 0, don't even generate the summary
2108 buffer. If GROUP is nil, use current group.
2110 This might be useful if you want to toggle threading
2111 before entering the group."
2113 (require 'gnus-score)
2115 gnus-score-find-score-files-function
2116 gnus-home-score-file
2117 gnus-apply-kill-hook
2118 gnus-summary-expunge-below)
2119 (gnus-group-read-group all t group)))
2121 (defun gnus-group-visible-select-group (&optional all)
2122 "Select the current group without hiding any articles."
2124 (let ((gnus-inhibit-limiting t))
2125 (gnus-group-read-group all t)))
2127 (defun gnus-group-select-group-ephemerally ()
2128 "Select the current group without doing any processing whatsoever.
2129 You will actually be entered into a group that's a copy of
2130 the current group; no changes you make while in this group will
2133 (require 'gnus-score)
2135 gnus-score-find-score-files-function gnus-apply-kill-hook
2136 gnus-summary-expunge-below gnus-show-threads gnus-suppress-duplicates
2137 gnus-summary-mode-hook gnus-select-group-hook
2138 (group (gnus-group-group-name))
2139 (method (gnus-find-method-for-group group)))
2140 (gnus-group-read-ephemeral-group
2141 (gnus-group-prefixed-name group method) method)))
2143 (defun gnus-group-name-at-point ()
2144 "Return a group name from around point if it exists, or nil."
2145 (if (eq major-mode 'gnus-group-mode)
2146 (let ((group (gnus-group-group-name)))
2148 (gnus-group-decoded-name group)))
2149 (let ((regexp "[][\C-@-\t\v-*,/:-@\\^`{-\C-?]*\
2150 \\(nn[a-z]+\\(?:\\+[^][\C-@-*,/:-@\\^`{-\C-?]+\\)?:\
2151 \[^][\C-@-*,./:-@\\^`{-\C-?]+\\(?:\\.[^][\C-@-*,./:-@\\^`{-\C-?]+\\)*\
2152 \\|[^][\C-@-*,./:-@\\^`{-\C-?]+\\(?:\\.[^][\C-@-*,./:-@\\^`{-\C-?]+\\)+\\)")
2154 (case-fold-search nil))
2156 (if (or (and (not (or (eobp)
2157 (looking-at "[][\C-@-*,/;-@\\^`{-\C-?]")))
2159 (skip-chars-backward "^][\C-@-\t\v-*,/;-@\\^`{-\C-?"
2161 (and (looking-at "[][\C-@-\t\v-*,/;-@\\^`{-\C-?]*$")
2163 (skip-chars-backward "][\C-@-\t\v-*,/;-@\\^`{-\C-?")
2164 (skip-chars-backward "^][\C-@-\t\v-*,/;-@\\^`{-\C-?"
2166 (string-match "\\`[][\C-@-\t\v-*,/;-@\\^`{-\C-?]*\\'"
2167 (buffer-substring (point-at-bol) (point))))
2168 (when (looking-at regexp)
2170 (let (group distance)
2171 (when (looking-at regexp)
2172 (setq group (match-string 1)
2173 distance (- (match-beginning 1) (match-beginning 0))))
2174 (skip-chars-backward "][\C-@-\t\v-*,/;-@\\^`{-\C-?")
2175 (skip-chars-backward "^][\C-@-\t\v-*,/;-@\\^`{-\C-?"
2177 (if (looking-at regexp)
2178 (if (and group (<= distance (- start (match-end 0))))
2182 (goto-char start)))))
2184 (defun gnus-group-completing-read (prompt &optional collection predicate
2185 require-match initial-input hist def
2187 "Read a group name with completion. Non-ASCII group names are allowed.
2188 The arguments are the same as `completing-read' except that COLLECTION
2189 and HIST default to `gnus-active-hashtb' and `gnus-group-history'
2190 respectively if they are omitted."
2191 (let ((completion-styles (and (boundp 'completion-styles)
2194 (push 'substring completion-styles)
2195 (mapatoms (lambda (symbol)
2196 (setq group (symbol-name symbol))
2197 (set (intern (if (string-match "[^\000-\177]" group)
2198 (gnus-group-decoded-name group)
2204 (setq collection (or gnus-active-hashtb [0])))
2205 (setq collection (gnus-make-hashtable (length collection)))))
2206 (setq group (apply 'completing-read prompt collection predicate
2207 require-match initial-input
2208 (or hist 'gnus-group-history)
2211 (symbol-value (intern-soft group collection))
2212 (setq collection nil))
2213 (mm-encode-coding-string group (gnus-group-name-charset nil group)))))
2216 (defun gnus-fetch-group (group &optional articles)
2217 "Start Gnus if necessary and enter GROUP.
2218 If ARTICLES, display those articles.
2219 Returns whether the fetching was successful or not."
2220 (interactive (list (gnus-group-completing-read "Group name: "
2222 (gnus-group-name-at-point))))
2223 (unless (gnus-alive-p)
2225 (gnus-group-read-group (if articles nil t) nil group articles))
2228 (defun gnus-fetch-group-other-frame (group)
2229 "Pop up a frame and enter GROUP."
2231 (let ((window (get-buffer-window gnus-group-buffer)))
2233 (select-frame (window-frame window)))
2234 ((= (length (frame-list)) 1)
2235 (select-frame (make-frame)))
2238 (gnus-fetch-group group))
2240 (defvar gnus-ephemeral-group-server 0)
2242 (defcustom gnus-large-ephemeral-newsgroup 200
2243 "The number of articles which indicates a large ephemeral newsgroup.
2244 Same as `gnus-large-newsgroup', but only used for ephemeral newsgroups.
2246 If the number of articles in a newsgroup is greater than this value,
2247 confirmation is required for selecting the newsgroup. If it is nil, no
2248 confirmation is required."
2250 :group 'gnus-group-select
2251 :type '(choice (const :tag "No limit" nil)
2254 (defcustom gnus-fetch-old-ephemeral-headers nil
2255 "Same as `gnus-fetch-old-headers', but only used for ephemeral newsgroups."
2258 :type '(choice (const :tag "off" nil)
2261 (sexp :menu-tag "other" t)))
2263 ;; Enter a group that is not in the group buffer. Non-nil is returned
2264 ;; if selection was successful.
2265 (defun gnus-group-read-ephemeral-group (group method &optional activate
2266 quit-config request-only
2270 "Read GROUP from METHOD as an ephemeral group.
2271 If ACTIVATE, request the group first.
2272 If QUIT-CONFIG, use that window configuration when exiting from the
2274 If REQUEST-ONLY, don't actually read the group; just request it.
2275 If SELECT-ARTICLES, only select those articles.
2276 If PARAMETERS, use those as the group parameters.
2277 If NUMBER, fetch this number of articles.
2279 Return the name of the group if selection was successful."
2282 ;; (gnus-read-group "Group name: ")
2283 (gnus-group-completing-read "Group: ")
2284 (gnus-read-method "From method: ")))
2285 ;; Transform the select method into a unique server.
2286 (when (stringp method)
2287 (setq method (gnus-server-to-method method)))
2289 `(,(car method) ,(concat (cadr method) "-ephemeral")
2290 (,(intern (format "%s-address" (car method))) ,(cadr method))
2292 (let ((group (if (gnus-group-foreign-p group) group
2293 (gnus-group-prefixed-name (gnus-group-real-name group)
2298 ,gnus-level-default-subscribed nil nil ,method
2301 (cons 'quit-config quit-config)
2303 (cons gnus-summary-buffer
2304 gnus-current-window-configuration)))
2307 (push method gnus-ephemeral-servers)
2308 (set-buffer gnus-group-buffer)
2309 (unless (gnus-check-server method)
2310 (error "Unable to contact server: %s" (gnus-status-message method)))
2312 (gnus-activate-group group 'scan)
2313 (unless (gnus-request-group group)
2314 (error "Couldn't request group: %s"
2315 (nnheader-get-report (car method)))))
2319 (when (let ((gnus-large-newsgroup gnus-large-ephemeral-newsgroup)
2320 (gnus-fetch-old-headers
2321 gnus-fetch-old-ephemeral-headers))
2322 (gnus-group-read-group (or number t) t group select-articles))
2326 (message "Quit reading the ephemeral group")
2329 (defcustom gnus-gmane-group-download-format
2330 "http://download.gmane.org/%s/%s/%s"
2331 "URL for downloading mbox files.
2332 It must contain three \"%s\". They correspond to the group, the
2333 minimal and maximal article numbers, respectively."
2334 :group 'gnus-group-foreign
2335 :version "23.1" ;; No Gnus
2338 (autoload 'url-insert-file-contents "url-handlers")
2340 ;; - Add documentation, menu, key bindings, ...
2342 (defun gnus-read-ephemeral-gmane-group (group start &optional range)
2343 "Read articles from Gmane group GROUP as an ephemeral group.
2344 START is the first article. RANGE specifies how many articles
2345 are fetched. The articles are downloaded via HTTP using the URL
2346 specified by `gnus-gmane-group-download-format'."
2347 ;; See <http://gmane.org/export.php> for more information.
2350 (gnus-group-completing-read "Gmane group: ")
2351 (read-number "Start article number: ")
2352 (read-number "How many articles: ")))
2353 (unless range (setq range 500))
2355 (error "Invalid range: %s" range))
2356 (let ((tmpfile (mm-make-temp-file
2357 (format "%s.start-%s.range-%s." group start range)))
2358 (gnus-thread-sort-functions '(gnus-thread-sort-by-number)))
2359 (with-temp-file tmpfile
2360 (url-insert-file-contents
2361 (format gnus-gmane-group-download-format
2362 group start (+ start range)))
2363 (write-region (point-min) (point-max) tmpfile)
2364 (gnus-group-read-ephemeral-group
2365 (format "%s.start-%s.range-%s" group start range)
2367 (nndoc-article-type mbox))))
2368 (delete-file tmpfile)))
2370 (defun gnus-read-ephemeral-gmane-group-url (url)
2371 "Create an ephemeral Gmane group from URL.
2373 Valid input formats include:
2374 \"http://thread.gmane.org/gmane.foo.bar/12300/focus=12399\",
2375 \"http://thread.gmane.org/gmane.foo.bar/12345/\",
2376 \"http://article.gmane.org/gmane.foo.bar/12345/\",
2377 \"http://news.gmane.org/group/gmane.foo.bar/thread=12345\""
2378 ;; - Feel free to add other useful Gmane URLs here! Maybe the URLs should
2380 ;; - The URLs should be added to `gnus-button-alist'. Probably we should
2381 ;; prompt the user to decide: "View via `browse-url' or in Gnus? "
2382 ;; (`gnus-read-ephemeral-gmane-group-url')
2384 (list (gnus-group-completing-read "Gmane URL: ")))
2385 (let (group start range)
2387 ;; URLs providing `group', `start' and `range':
2389 ;; http://thread.gmane.org/gmane.emacs.devel/86326/focus=86525
2390 "^http://thread\.gmane\.org/\\([^/]+\\)/\\([0-9]+\\)/focus=\\([0-9]+\\)$"
2392 (setq group (match-string 1 url)
2393 start (string-to-number (match-string 2 url))
2394 ;; Ensure that `range' is large enough to ensure focus article is
2396 range (- (string-to-number (match-string 3 url))
2398 ;; URLs providing `group' and `start':
2400 ;; http://article.gmane.org/gmane.comp.gnu.make.bugs/3584
2401 "^http://\\(?:thread\\|article\\|permalink\\)\.gmane\.org/\\([^/]+\\)/\\([0-9]+\\)"
2404 ;; Don't advertise these in the doc string yet:
2405 "^\\(?:nntp\\|news\\)://news\.gmane\.org/\\([^/]+\\)/\\([0-9]+\\)"
2408 ;; http://news.gmane.org/group/gmane.emacs.gnus.general/thread=65099/force_load=t
2409 "^http://news\.gmane\.org/group/\\([^/]+\\)/thread=\\([0-9]+\\)"
2411 (setq group (match-string 1 url)
2412 start (string-to-number (match-string 2 url))))
2414 (error "Can't parse URL %s" url)))
2415 (gnus-read-ephemeral-gmane-group group start range)))
2417 (defcustom gnus-bug-group-download-format-alist
2418 '((emacs . "http://debbugs.gnu.org/%s;mbox=yes")
2420 . "http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=%s&mbox=yes"))
2421 "Alist of symbols for bug trackers and the corresponding URL format string.
2422 The URL format string must contain a single \"%s\", specifying
2423 the bug number, and browsing the URL must return mbox output."
2424 :group 'gnus-group-foreign
2425 :version "23.2" ;; No Gnus
2426 :type '(repeat (cons (symbol) (string :tag "URL format string"))))
2428 (defun gnus-read-ephemeral-bug-group (number mbox-url)
2429 "Browse bug NUMBER as ephemeral group."
2430 (interactive (list (read-string "Enter bug number: "
2431 (thing-at-point 'word) nil)
2432 ;; FIXME: Add completing-read from
2433 ;; `gnus-emacs-bug-group-download-format' ...
2434 (cdr (assoc 'emacs gnus-bug-group-download-format-alist))))
2435 (when (stringp number)
2436 (setq number (string-to-number number)))
2437 (let ((tmpfile (mm-make-temp-file "gnus-temp-group-")))
2438 (with-temp-file tmpfile
2439 (url-insert-file-contents (format mbox-url number))
2440 (write-region (point-min) (point-max) tmpfile)
2441 (gnus-group-read-ephemeral-group
2442 "gnus-read-ephemeral-bug"
2444 (nndoc-article-type mbox))))
2445 (delete-file tmpfile)))
2447 (defun gnus-read-ephemeral-debian-bug-group (number)
2448 "Browse Debian bug NUMBER as ephemeral group."
2449 (interactive (list (read-string "Enter bug number: "
2450 (thing-at-point 'word) nil)))
2451 (gnus-read-ephemeral-bug-group
2453 (cdr (assoc 'debian gnus-bug-group-download-format-alist))))
2455 (defun gnus-read-ephemeral-emacs-bug-group (number)
2456 "Browse Emacs bug NUMBER as ephemeral group."
2457 (interactive (list (read-string "Enter bug number: "
2458 (thing-at-point 'word) nil)))
2459 (gnus-read-ephemeral-bug-group
2461 (cdr (assoc 'emacs gnus-bug-group-download-format-alist))))
2463 (defun gnus-group-jump-to-group (group &optional prompt)
2464 "Jump to newsgroup GROUP.
2466 If PROMPT (the prefix) is a number, use the prompt specified in
2467 `gnus-group-jump-to-group-prompt'."
2469 (list (gnus-group-completing-read
2470 "Group: " nil nil (gnus-read-active-file-p)
2471 (if current-prefix-arg
2472 (cdr (assq current-prefix-arg gnus-group-jump-to-group-prompt))
2473 (or (and (stringp gnus-group-jump-to-group-prompt)
2474 gnus-group-jump-to-group-prompt)
2475 (let ((p (cdr (assq 0 gnus-group-jump-to-group-prompt))))
2476 (and (stringp p) p)))))))
2478 (when (equal group "")
2479 (error "Empty group name"))
2481 (unless (gnus-ephemeral-group-p group)
2482 ;; Either go to the line in the group buffer...
2483 (unless (gnus-group-goto-group group)
2484 ;; ... or insert the line.
2485 (gnus-group-update-group group)
2486 (gnus-group-goto-group group)))
2487 ;; Adjust cursor point.
2488 (gnus-group-position-point))
2490 (defun gnus-group-goto-group (group &optional far test-marked)
2491 "Goto to newsgroup GROUP.
2492 If FAR, it is likely that the group is not on the current line.
2493 If TEST-MARKED, the line must be marked."
2497 ;; It's quite likely that we are on the right line, so
2498 ;; we check the current line first.
2500 (eq (get-text-property (point) 'gnus-group)
2501 (gnus-intern-safe group gnus-active-hashtb))
2502 (or (not test-marked) (gnus-group-mark-line-p)))
2504 ;; Previous and next line are also likely, so we check them as well.
2508 (and (eq (get-text-property (point) 'gnus-group)
2509 (gnus-intern-safe group gnus-active-hashtb))
2510 (or (not test-marked) (gnus-group-mark-line-p)))))
2516 (and (eq (get-text-property (point) 'gnus-group)
2517 (gnus-intern-safe group gnus-active-hashtb))
2518 (or (not test-marked) (gnus-group-mark-line-p)))))
2522 (goto-char (point-min))
2524 (while (and (not found)
2529 (gnus-intern-safe group gnus-active-hashtb))))
2530 (if (gnus-group-mark-line-p)
2535 ;; Search through the entire buffer.
2538 (point-min) (point-max)
2539 'gnus-group (gnus-intern-safe group gnus-active-hashtb)))))))
2541 (defun gnus-group-next-group (n &optional silent)
2542 "Go to next N'th newsgroup.
2543 If N is negative, search backward instead.
2544 Returns the difference between N and the number of skips actually
2547 (gnus-group-next-unread-group n t nil silent))
2549 (defun gnus-group-next-unread-group (n &optional all level silent)
2550 "Go to next N'th unread newsgroup.
2551 If N is negative, search backward instead.
2552 If ALL is non-nil, choose any newsgroup, unread or not.
2553 If LEVEL is non-nil, choose the next group with level LEVEL, or, if no
2554 such group can be found, the next group with a level higher than
2556 Returns the difference between N and the number of skips actually
2559 (let ((backward (< n 0))
2562 (gnus-group-search-forward
2563 backward (or (not gnus-group-goto-unread) all) level))
2567 (gnus-message 7 "No more%s newsgroups%s" (if all "" " unread")
2568 (if level " on this level or higher" "")))
2571 (defun gnus-group-prev-group (n)
2572 "Go to previous N'th newsgroup.
2573 Returns the difference between N and the number of skips actually
2576 (gnus-group-next-unread-group (- n) t))
2578 (defun gnus-group-prev-unread-group (n)
2579 "Go to previous N'th unread newsgroup.
2580 Returns the difference between N and the number of skips actually
2583 (gnus-group-next-unread-group (- n)))
2585 (defun gnus-group-next-unread-group-same-level (n)
2586 "Go to next N'th unread newsgroup on the same level.
2587 If N is negative, search backward instead.
2588 Returns the difference between N and the number of skips actually
2591 (gnus-group-next-unread-group n t (gnus-group-group-level))
2592 (gnus-group-position-point))
2594 (defun gnus-group-prev-unread-group-same-level (n)
2595 "Go to next N'th unread newsgroup on the same level.
2596 Returns the difference between N and the number of skips actually
2599 (gnus-group-next-unread-group (- n) t (gnus-group-group-level))
2600 (gnus-group-position-point))
2602 (defun gnus-group-best-unread-group (&optional exclude-group)
2603 "Go to the group with the highest level.
2604 If EXCLUDE-GROUP, do not go to that group."
2606 (goto-char (point-min))
2610 (setq unread (get-text-property (point) 'gnus-unread))
2611 (when (and (numberp unread) (> unread 0))
2612 (when (and (get-text-property (point) 'gnus-level)
2613 (< (get-text-property (point) 'gnus-level) best)
2614 (or (not exclude-group)
2615 (not (equal exclude-group (gnus-group-group-name)))))
2616 (setq best (get-text-property (point) 'gnus-level))
2617 (setq best-point (point))))
2620 (goto-char best-point))
2621 (gnus-group-position-point)
2622 (and best-point (gnus-group-group-name))))
2624 ;; Is there something like an after-point-motion-hook?
2625 ;; (inhibit-point-motion-hooks?). Is there a tool-bar-update function?
2627 ;; (defun gnus-group-menu-bar-update ()
2628 ;; (let* ((buf (list (with-current-buffer gnus-group-buffer
2629 ;; (current-buffer))))
2630 ;; (name (buffer-name (car buf))))
2632 ;; (if (> (length name) 27)
2633 ;; (concat (substring name 0 12)
2635 ;; (substring name -12))
2637 ;; (menu-bar-update-buffers-1 buf)))
2639 ;; (defun gnus-group-position-point ()
2640 ;; (gnus-goto-colon)
2641 ;; (gnus-group-menu-bar-update))
2643 (defun gnus-group-first-unread-group ()
2644 "Go to the first group with unread articles."
2647 (let ((opoint (point))
2649 (goto-char (point-min))
2650 (if (or (eq (setq unread (gnus-group-group-unread)) t) ; Not active.
2651 (and (numberp unread) ; Not a topic.
2652 (not (zerop unread))) ; Has unread articles.
2653 (zerop (gnus-group-next-unread-group 1))) ; Next unread group.
2656 nil)) ; Not success.
2657 (gnus-group-position-point)))
2659 (defun gnus-group-enter-server-mode ()
2660 "Jump to the server buffer."
2662 (gnus-enter-server-buffer))
2664 (defun gnus-group-make-group-simple (&optional group)
2665 "Add a new newsgroup.
2666 The user will be prompted for GROUP."
2667 (interactive (list (gnus-group-completing-read "Group: ")))
2668 (gnus-group-make-group (gnus-group-real-name group)
2669 (gnus-group-server group)
2672 (defun gnus-group-make-group (name &optional method address args encoded)
2673 "Add a new newsgroup.
2674 The user will be prompted for a NAME, for a select METHOD, and an
2675 ADDRESS. NAME should be a human-readable string (i.e., not be encoded
2676 even if it contains non-ASCII characters) unless ENCODED is non-nil."
2679 (gnus-read-group "Group name: ")
2680 (gnus-read-method "From method: ")))
2682 (when (stringp method)
2683 (setq method (or (gnus-server-to-method method) method)))
2685 (setq name (mm-encode-coding-string
2687 (gnus-group-name-charset method name))))
2688 (let* ((meth (gnus-method-simplify
2690 (not (gnus-server-equal method gnus-select-method)))
2691 (if address (list (intern method) address)
2693 (nname (if method (gnus-group-prefixed-name name meth) name))
2695 (when (gnus-group-entry nname)
2696 (error "Group %s already exists" (gnus-group-decoded-name nname)))
2697 ;; Subscribe to the new group.
2698 (gnus-group-change-level
2699 (setq info (list t nname gnus-level-default-subscribed nil nil meth))
2700 gnus-level-default-subscribed gnus-level-killed
2701 (and (gnus-group-group-name)
2702 (gnus-group-entry (gnus-group-group-name)))
2705 (gnus-set-active nname (cons 1 0))
2706 (unless (gnus-ephemeral-group-p name)
2708 (concat "(gnus-group-set-info '"
2709 (gnus-prin1-to-string (cdr info)) ")")))
2711 (gnus-group-insert-group-line-info nname)
2713 (gnus-group-position-point)
2715 ;; Load the back end and try to make the back end create
2716 ;; the group as well.
2717 (when (assoc (symbol-name (setq backend (car (gnus-server-get-method
2719 gnus-valid-select-methods)
2721 (gnus-check-server meth)
2722 (when (gnus-check-backend-function 'request-create-group nname)
2723 (unless (gnus-request-create-group nname nil args)
2724 (error "Could not create group on server: %s"
2725 (nnheader-get-report backend))))
2728 (defun gnus-group-delete-groups (&optional arg)
2729 "Delete the current group. Only meaningful with editable groups."
2731 (let ((n (length (gnus-group-process-prefix arg))))
2732 (when (gnus-yes-or-no-p
2734 "Delete this 1 group? "
2735 (format "Delete these %d groups? " n)))
2736 (gnus-group-iterate arg
2738 (gnus-group-delete-group group nil t))))))
2740 (defun gnus-group-delete-group (group &optional force no-prompt)
2741 "Delete the current group. Only meaningful with editable groups.
2742 If FORCE (the prefix) is non-nil, all the articles in the group will
2743 be deleted. This is \"deleted\" as in \"removed forever from the face
2744 of the Earth\". There is no undo. The user will be prompted before
2746 Note that you also have to specify FORCE if you want the group to
2747 be removed from the server, even when it's empty."
2749 (list (gnus-group-group-name)
2750 current-prefix-arg))
2752 (error "No group to delete"))
2753 (unless (gnus-check-backend-function 'request-delete-group group)
2754 (error "This back end does not support group deletion"))
2756 (let ((group-decoded (gnus-group-decoded-name group)))
2757 (if (and (not no-prompt)
2758 (not (gnus-yes-or-no-p
2760 "Do you really want to delete %s%s? "
2761 group-decoded (if force " and all its contents" "")))))
2763 (gnus-message 6 "Deleting group %s..." group-decoded)
2764 (if (not (gnus-request-delete-group group force))
2765 (gnus-error 3 "Couldn't delete group %s" group-decoded)
2766 (gnus-message 6 "Deleting group %s...done" group-decoded)
2767 (gnus-group-goto-group group)
2768 (gnus-group-kill-group 1 t)
2769 (gnus-set-active group nil)
2771 (gnus-group-position-point)))
2773 (defun gnus-group-rename-group (group new-name)
2774 "Rename group from GROUP to NEW-NAME.
2775 When used interactively, GROUP is the group under point
2776 and NEW-NAME will be prompted for."
2778 (let ((group (gnus-group-group-name))
2780 (unless (gnus-check-backend-function 'request-rename-group group)
2781 (error "This back end does not support renaming groups"))
2782 (setq new-name (gnus-read-group
2784 (gnus-group-real-name (gnus-group-decoded-name group)))
2785 method (gnus-info-method (gnus-get-info group)))
2786 (list group (mm-encode-coding-string
2788 (gnus-group-name-charset
2790 (gnus-group-prefixed-name new-name method))))))
2792 (unless (gnus-check-backend-function 'request-rename-group group)
2793 (error "This back end does not support renaming groups"))
2795 (error "No group to rename"))
2796 (when (equal (gnus-group-real-name group) new-name)
2797 (error "Can't rename to the same name"))
2799 ;; We find the proper prefixed name.
2801 (if (gnus-group-native-p group)
2805 (gnus-group-prefixed-name
2806 (gnus-group-real-name new-name)
2807 (gnus-info-method (gnus-get-info group)))))
2809 (let ((decoded-group (gnus-group-decoded-name group))
2810 (decoded-new-name (gnus-group-decoded-name new-name)))
2811 (when (gnus-active new-name)
2812 (error "The group %s already exists" decoded-new-name))
2814 (gnus-message 6 "Renaming group %s to %s..."
2815 decoded-group decoded-new-name)
2818 (gnus-group-goto-group group)
2819 (not (when (< (gnus-group-group-level) gnus-level-zombie)
2820 (gnus-request-rename-group group new-name))))
2821 (gnus-error 3 "Couldn't rename group %s to %s"
2822 decoded-group decoded-new-name)
2823 ;; We rename the group internally by killing it...
2824 (gnus-group-kill-group)
2825 ;; ... changing its name ...
2826 (setcar (cdar gnus-list-of-killed-groups) new-name)
2827 ;; ... and then yanking it. Magic!
2828 (gnus-group-yank-group)
2829 (gnus-set-active new-name (gnus-active group))
2830 (gnus-message 6 "Renaming group %s to %s...done"
2831 decoded-group decoded-new-name)
2833 (setq gnus-killed-list (delete group gnus-killed-list))
2834 (gnus-set-active group nil)
2835 (gnus-dribble-touch)
2836 (gnus-group-position-point))))
2838 (defun gnus-group-edit-group (group &optional part)
2839 "Edit the group on the current line."
2840 (interactive (list (gnus-group-group-name)))
2841 (let ((part (or part 'info))
2844 (error "No group on current line"))
2845 (unless (setq info (gnus-get-info group))
2846 (error "Killed group; can't be edited"))
2848 (gnus-close-group group))
2850 ;; Find the proper form to edit.
2851 (cond ((eq part 'method)
2852 (or (gnus-info-method info) "native"))
2854 (gnus-info-params info))
2856 ;; The proper documentation.
2858 "Editing the %s for `%s'."
2860 ((eq part 'method) "select method")
2861 ((eq part 'params) "group parameters")
2863 (gnus-group-decoded-name group))
2865 (gnus-group-edit-group-done ',part ,group form)))
2868 (gnus-create-info-command
2871 "(gnus)Select Methods")
2873 "(gnus)Group Parameters")
2875 "(gnus)Group Info"))))))
2877 (defun gnus-group-edit-group-method (group)
2878 "Edit the select method of GROUP."
2879 (interactive (list (gnus-group-group-name)))
2880 (gnus-group-edit-group group 'method))
2882 (defun gnus-group-edit-group-parameters (group)
2883 "Edit the group parameters of GROUP."
2884 (interactive (list (gnus-group-group-name)))
2885 (gnus-group-edit-group group 'params))
2887 (defun gnus-group-edit-group-done (part group form)
2889 (let* ((method (cond ((eq part 'info) (nth 4 form))
2890 ((eq part 'method) form)
2892 (info (cond ((eq part 'info) form)
2893 ((eq part 'method) (gnus-get-info group))
2896 (if (or (not method)
2898 gnus-select-method method))
2899 (gnus-group-real-name (car info))
2900 (gnus-group-prefixed-name
2901 (gnus-group-real-name (car info)) method))
2903 (when (and new-group
2904 (not (equal new-group group)))
2905 (when (gnus-group-goto-group group)
2906 (gnus-group-kill-group 1))
2907 (gnus-activate-group new-group))
2909 (if (not (and info new-group))
2910 (gnus-group-set-info form (or new-group group) part)
2911 (setq info (gnus-copy-sequence info))
2912 (setcar info new-group)
2913 (unless (gnus-server-equal method "native")
2914 (unless (nthcdr 3 info)
2915 (nconc info (list nil nil)))
2916 (unless (nthcdr 4 info)
2917 (nconc info (list nil)))
2918 (gnus-info-set-method info method))
2919 (gnus-group-set-info info))
2920 (gnus-group-update-group (or new-group group))
2921 (gnus-group-position-point)))
2923 (defun gnus-group-make-useful-group (group method)
2924 "Create one of the groups described in `gnus-useful-groups'."
2926 (let ((entry (assoc (completing-read "Create group: " gnus-useful-groups
2928 gnus-useful-groups)))
2930 ;; Don't use `caddr' here since macros within the `interactive'
2931 ;; form won't be expanded.
2932 (car (cddr entry)))))
2933 (setq method (gnus-copy-sequence method))
2935 (while (setq entry (memq (assq 'eval method) method))
2936 (setcar entry (eval (cadar entry)))))
2937 (gnus-group-make-group group method))
2939 (defun gnus-group-make-help-group (&optional noerror)
2940 "Create the Gnus documentation group.
2941 Optional argument NOERROR modifies the behavior of this function when the
2942 group already exists:
2943 - if not given, and error is signaled,
2944 - if t, stay silent,
2945 - if anything else, just print a message."
2947 (let ((name (gnus-group-prefixed-name "gnus-help" '(nndoc "gnus-help")))
2948 (file (nnheader-find-etc-directory "gnus-tut.txt" t)))
2949 (if (gnus-group-entry name)
2950 (cond ((eq noerror nil)
2951 (error "Documentation group already exists"))
2956 (gnus-message 1 "Documentation group already exists")))
2959 (gnus-message 1 "Couldn't find doc group")
2960 (gnus-group-make-group
2961 (gnus-group-real-name name)
2962 (list 'nndoc "gnus-help"
2963 (list 'nndoc-address file)
2964 (list 'nndoc-article-type 'mbox))))
2966 (gnus-group-position-point))
2968 (defun gnus-group-make-doc-group (file type)
2969 "Create a group that uses a single file as the source.
2971 If called with a prefix argument, ask for the file type."
2973 (list (read-file-name "File name: ")
2974 (and current-prefix-arg 'ask)))
2975 (when (eq type 'ask)
2980 "%sFile type (mbox, babyl, digest, forward, mmdf, guess) [m, b, d, f, a, g]: "
2982 (setq found (cond ((= (setq char (read-char)) ?m) 'mbox)
2983 ((= char ?b) 'babyl)
2984 ((= char ?d) 'digest)
2985 ((= char ?f) 'forward)
2987 ((= char ?g) 'guess)
2988 (t (setq err (format "%c unknown. " char))
2991 (setq file (expand-file-name file))
2992 (let* ((name (gnus-generate-new-group-name
2993 (gnus-group-prefixed-name
2994 (file-name-nondirectory file) '(nndoc ""))))
2995 (method (list 'nndoc file
2996 (list 'nndoc-address file)
2997 (list 'nndoc-article-type (or type 'guess))))
2998 (coding (gnus-group-name-charset method name)))
2999 (setcar (cdr method) (mm-encode-coding-string file coding))
3000 (gnus-group-make-group
3001 (mm-encode-coding-string (gnus-group-real-name name) coding)
3004 (defvar nnweb-type-definition)
3005 (defvar gnus-group-web-type-history nil)
3006 (defvar gnus-group-web-search-history nil)
3007 (defun gnus-group-make-web-group (&optional solid)
3008 "Create an ephemeral nnweb group.
3009 If SOLID (the prefix), create a solid group."
3013 (if solid (gnus-read-group "Group name: ")
3014 (message-unique-id)))
3015 (default-type (or (car gnus-group-web-type-history)
3016 (symbol-name (caar nnweb-type-definition))))
3020 (format "Search engine type (default %s): " default-type)
3021 (mapcar (lambda (elem) (list (symbol-name (car elem))))
3022 nnweb-type-definition)
3023 nil t nil 'gnus-group-web-type-history)
3028 (cons (or (car gnus-group-web-search-history) "") 0)
3029 'gnus-group-web-search-history))
3031 `(nnweb ,group (nnweb-search ,search)
3032 (nnweb-type ,(intern type))
3033 (nnweb-ephemeral-p t))))
3036 (gnus-pull 'nnweb-ephemeral-p method)
3037 (gnus-group-make-group group method))
3038 (gnus-group-read-ephemeral-group
3040 (cons (current-buffer)
3041 (if (eq major-mode 'gnus-summary-mode) 'summary 'group))))))
3043 (defvar nnrss-group-alist)
3045 (defun nnrss-discover-feed (arg))
3046 (defun nnrss-save-server-data (arg)))
3047 (defun gnus-group-make-rss-group (&optional url)
3048 "Given a URL, discover if there is an RSS feed.
3049 If there is, use Gnus to create an nnrss group"
3053 (setq url (read-from-minibuffer "URL to Search for RSS: ")))
3054 (let ((feedinfo (nnrss-discover-feed url)))
3056 (let* ((title (gnus-newsgroup-savable-name
3057 (read-from-minibuffer "Title: "
3058 (gnus-newsgroup-savable-name
3062 (or (cdr (assoc 'title
3066 (desc (read-from-minibuffer "Description: "
3070 (or (cdr (assoc 'description
3074 (href (cdr (assoc 'href feedinfo)))
3075 (coding (gnus-group-name-charset '(nnrss "") title)))
3077 ;; Unify non-ASCII text.
3078 (setq title (mm-decode-coding-string
3079 (mm-encode-coding-string title coding)
3081 (gnus-group-make-group title '(nnrss ""))
3082 (push (list title href desc) nnrss-group-alist)
3083 (nnrss-save-server-data nil))
3084 (error "No feeds found for %s" url))))
3086 (defvar nnwarchive-type-definition)
3087 (defvar gnus-group-warchive-type-history nil)
3088 (defvar gnus-group-warchive-login-history nil)
3089 (defvar gnus-group-warchive-address-history nil)
3091 (defun gnus-group-make-warchive-group ()
3092 "Create a nnwarchive group."
3094 (require 'nnwarchive)
3095 (let* ((group (gnus-read-group "Group name: "))
3096 (default-type (or (car gnus-group-warchive-type-history)
3097 (symbol-name (caar nnwarchive-type-definition))))
3101 (format "Warchive type (default %s): " default-type)
3102 (mapcar (lambda (elem) (list (symbol-name (car elem))))
3103 nnwarchive-type-definition)
3104 nil t nil 'gnus-group-warchive-type-history)
3106 (address (read-string "Warchive address: "
3107 nil 'gnus-group-warchive-address-history))
3108 (default-login (or (car gnus-group-warchive-login-history)
3113 (format "Warchive login (default %s): " user-mail-address)
3114 default-login 'gnus-group-warchive-login-history)
3117 `(nnwarchive ,address
3118 (nnwarchive-type ,(intern type))
3119 (nnwarchive-login ,login))))
3120 (gnus-group-make-group group method)))
3122 (defun gnus-group-make-archive-group (&optional all)
3123 "Create the (ding) Gnus archive group of the most recent articles.
3124 Given a prefix, create a full group."
3126 (let ((group (gnus-group-prefixed-name
3127 (if all "ding.archives" "ding.recent") '(nndir ""))))
3128 (when (gnus-group-entry group)
3129 (error "Archive group already exists"))
3130 (gnus-group-make-group
3131 (gnus-group-real-name group)
3132 (list 'nndir (if all "hpc" "edu")
3133 (list 'nndir-directory
3134 (if all gnus-group-archive-directory
3135 gnus-group-recent-archive-directory))))
3136 (gnus-group-add-parameter group (cons 'to-address "ding@gnus.org"))))
3138 (defun gnus-group-make-directory-group (dir)
3139 "Create an nndir group.
3140 The user will be prompted for a directory. The contents of this
3141 directory will be used as a newsgroup. The directory should contain
3142 mail messages or news articles in files that have numeric names."
3144 (list (read-file-name "Create group from directory: ")))
3145 (unless (file-exists-p dir)
3146 (error "No such directory"))
3147 (unless (file-directory-p dir)
3148 (error "Not a directory"))
3152 (while (or (not group) (gnus-group-entry group))
3154 (gnus-group-prefixed-name
3155 (expand-file-name ext dir)
3157 (setq ext (format "<%d>" (setq i (1+ i)))))
3158 (gnus-group-make-group
3159 (gnus-group-real-name group)
3160 (list 'nndir (gnus-group-real-name group) (list 'nndir-directory dir)))))
3162 (defvar nnkiboze-score-file)
3163 (declare-function nnkiboze-score-file "nnkiboze" (group))
3165 (defun gnus-group-make-kiboze-group (group address scores)
3166 "Create an nnkiboze group.
3167 The user will be prompted for a name, a regexp to match groups, and
3168 score file entries for articles to include in the group."
3171 (read-string "nnkiboze group name: ")
3172 (read-string "Source groups (regexp): ")
3173 (let ((headers (mapcar 'list
3174 '("subject" "from" "number" "date" "message-id"
3175 "references" "chars" "lines" "xref"
3176 "followup" "all" "body" "head")))
3177 scores header regexp regexps)
3178 (while (not (equal "" (setq header (completing-read
3179 "Match on header: " headers nil t))))
3181 (while (not (equal "" (setq regexp (read-string
3182 (format "Match on %s (regexp): "
3184 (push (list regexp nil nil 'r) regexps))
3185 (push (cons header regexps) scores))
3187 (gnus-group-make-group group "nnkiboze" address)
3188 (let* ((nnkiboze-current-group group)
3189 (score-file (car (nnkiboze-score-file "")))
3190 (score-dir (file-name-directory score-file)))
3191 (unless (file-exists-p score-dir)
3192 (make-directory score-dir))
3193 (with-temp-file score-file
3194 (let (emacs-lisp-mode-hook)
3195 (gnus-pp scores)))))
3197 (defun gnus-group-add-to-virtual (n vgroup)
3198 "Add the current group to a virtual group."
3200 (list current-prefix-arg
3201 (completing-read "Add to virtual group: " gnus-newsrc-hashtb nil t
3203 (unless (eq (car (gnus-find-method-for-group vgroup)) 'nnvirtual)
3204 (error "%s is not an nnvirtual group" vgroup))
3205 (gnus-close-group vgroup)
3206 (let* ((groups (gnus-group-process-prefix n))
3207 (method (gnus-info-method (gnus-get-info vgroup))))
3208 (setcar (cdr method)
3210 (nth 1 method) "\\|"
3213 (gnus-group-remove-mark s)
3214 (concat "\\(^" (regexp-quote s) "$\\)"))
3216 (gnus-group-position-point))
3218 (defun gnus-group-make-empty-virtual (group)
3219 "Create a new, fresh, empty virtual group."
3220 (interactive "sCreate new, empty virtual group: ")
3221 (let* ((method (list 'nnvirtual "^$"))
3222 (pgroup (gnus-group-prefixed-name group method)))
3223 ;; Check whether it exists already.
3224 (when (gnus-group-entry pgroup)
3225 (error "Group %s already exists" pgroup))
3226 ;; Subscribe the new group after the group on the current line.
3227 (gnus-subscribe-group pgroup (gnus-group-group-name) method)
3228 (gnus-group-update-group pgroup)
3230 (gnus-group-position-point)))
3232 (defun gnus-group-enter-directory (dir)
3233 "Enter an ephemeral nneething group."
3234 (interactive "DDirectory to read: ")
3235 (let* ((method (list 'nneething dir '(nneething-read-only t)))
3236 (leaf (gnus-group-prefixed-name
3237 (file-name-nondirectory (directory-file-name dir))
3239 (name (gnus-generate-new-group-name leaf)))
3240 (unless (gnus-group-read-ephemeral-group
3242 (cons (current-buffer)
3243 (if (eq major-mode 'gnus-summary-mode)
3245 (error "Couldn't enter %s" dir))))
3247 (autoload 'nnimap-expunge "nnimap")
3248 (autoload 'nnimap-acl-get "nnimap")
3249 (autoload 'nnimap-acl-edit "nnimap")
3251 (defun gnus-group-nnimap-expunge (group)
3252 "Expunge deleted articles in current nnimap GROUP."
3253 (interactive (list (gnus-group-group-name)))
3254 (let ((mailbox (gnus-group-real-name group)) method)
3256 (error "No group on current line"))
3257 (unless (gnus-get-info group)
3258 (error "Killed group; can't be edited"))
3259 (unless (eq 'nnimap (car (setq method (gnus-find-method-for-group group))))
3260 (error "%s is not an nnimap group" group))
3261 (nnimap-expunge mailbox (cadr method))))
3263 (defun gnus-group-nnimap-edit-acl (group)
3264 "Edit the Access Control List of current nnimap GROUP."
3265 (interactive (list (gnus-group-group-name)))
3266 (let ((mailbox (gnus-group-real-name group)) method acl)
3268 (error "No group on current line"))
3269 (unless (gnus-get-info group)
3270 (error "Killed group; can't be edited"))
3271 (unless (eq (car (setq method (gnus-find-method-for-group group))) 'nnimap)
3272 (error "%s is not an nnimap group" group))
3273 (unless (setq acl (nnimap-acl-get mailbox (cadr method)))
3274 (error "Server does not support ACL's"))
3275 (gnus-edit-form acl (format "Editing the access control list for `%s'.
3277 An access control list is a list of (identifier . rights) elements.
3279 The identifier string specifies the corresponding user. The
3280 identifier \"anyone\" is reserved to refer to the universal identity.
3282 Rights is a string listing a (possibly empty) set of alphanumeric
3283 characters, each character listing a set of operations which is being
3284 controlled. Letters are reserved for ``standard'' rights, listed
3285 below. Digits are reserved for implementation or site defined rights.
3287 l - lookup (mailbox is visible to LIST/LSUB commands)
3288 r - read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL,
3289 SEARCH, COPY from mailbox)
3290 s - keep seen/unseen information across sessions (STORE \\SEEN flag)
3291 w - write (STORE flags other than \\SEEN and \\DELETED)
3292 i - insert (perform APPEND, COPY into mailbox)
3293 p - post (send mail to submission address for mailbox,
3294 not enforced by IMAP4 itself)
3295 c - create and delete mailbox (CREATE new sub-mailboxes in any
3296 implementation-defined hierarchy, RENAME or DELETE mailbox)
3297 d - delete messages (STORE \\DELETED flag, perform EXPUNGE)
3298 a - administer (perform SETACL)" group)
3301 ,mailbox ',method ',acl form)))))
3303 ;; Group sorting commands
3304 ;; Suggested by Joe Hildebrand <hildjj@idaho.fuentez.com>.
3306 (defun gnus-group-sort-groups (func &optional reverse)
3307 "Sort the group buffer according to FUNC.
3308 When used interactively, the sorting function used will be
3309 determined by the `gnus-group-sort-function' variable.
3310 If REVERSE (the prefix), reverse the sorting order."
3311 (interactive (list gnus-group-sort-function current-prefix-arg))
3312 (funcall gnus-group-sort-alist-function
3313 (gnus-make-sort-function func) reverse)
3314 (gnus-group-unmark-all-groups)
3315 (gnus-group-list-groups)
3316 (gnus-dribble-touch))
3318 (defun gnus-group-sort-flat (func reverse)
3319 ;; We peel off the dummy group from the alist.
3321 (when (equal (gnus-info-group (car gnus-newsrc-alist)) "dummy.group")
3322 (pop gnus-newsrc-alist))
3324 (setq gnus-newsrc-alist
3325 (sort gnus-newsrc-alist func))
3327 (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist)))
3328 ;; Regenerate the hash table.
3329 (gnus-make-hashtable-from-newsrc-alist)))
3331 (defun gnus-group-sort-groups-by-alphabet (&optional reverse)
3332 "Sort the group buffer alphabetically by group name.
3333 If REVERSE, sort in reverse order."
3335 (gnus-group-sort-groups 'gnus-group-sort-by-alphabet reverse))
3337 (defun gnus-group-sort-groups-by-real-name (&optional reverse)
3338 "Sort the group buffer alphabetically by real (unprefixed) group name.
3339 If REVERSE, sort in reverse order."
3341 (gnus-group-sort-groups 'gnus-group-sort-by-real-name reverse))
3343 (defun gnus-group-sort-groups-by-unread (&optional reverse)
3344 "Sort the group buffer by number of unread articles.
3345 If REVERSE, sort in reverse order."
3347 (gnus-group-sort-groups 'gnus-group-sort-by-unread reverse))
3349 (defun gnus-group-sort-groups-by-level (&optional reverse)
3350 "Sort the group buffer by group level.
3351 If REVERSE, sort in reverse order."
3353 (gnus-group-sort-groups 'gnus-group-sort-by-level reverse))
3355 (defun gnus-group-sort-groups-by-score (&optional reverse)
3356 "Sort the group buffer by group score.
3357 If REVERSE, sort in reverse order."
3359 (gnus-group-sort-groups 'gnus-group-sort-by-score reverse))
3361 (defun gnus-group-sort-groups-by-rank (&optional reverse)
3362 "Sort the group buffer by group rank.
3363 If REVERSE, sort in reverse order."
3365 (gnus-group-sort-groups 'gnus-group-sort-by-rank reverse))
3367 (defun gnus-group-sort-groups-by-method (&optional reverse)
3368 "Sort the group buffer alphabetically by back end name.
3369 If REVERSE, sort in reverse order."
3371 (gnus-group-sort-groups 'gnus-group-sort-by-method reverse))
3373 (defun gnus-group-sort-groups-by-server (&optional reverse)
3374 "Sort the group buffer alphabetically by server name.
3375 If REVERSE, sort in reverse order."
3377 (gnus-group-sort-groups 'gnus-group-sort-by-server reverse))
3379 ;;; Selected group sorting.
3381 (defun gnus-group-sort-selected-groups (n func &optional reverse)
3382 "Sort the process/prefixed groups."
3383 (interactive (list current-prefix-arg gnus-group-sort-function))
3384 (let ((groups (gnus-group-process-prefix n)))
3385 (funcall gnus-group-sort-selected-function
3386 groups (gnus-make-sort-function func) reverse)
3387 (gnus-group-unmark-all-groups)
3388 (gnus-group-list-groups)
3389 (gnus-dribble-touch)))
3391 (defun gnus-group-sort-selected-flat (groups func reverse)
3392 (let (entries infos)
3393 ;; First find all the group entries for these groups.
3395 (push (nthcdr 2 (gnus-group-entry (pop groups)))
3397 ;; Then sort the infos.
3401 (lambda (entry) (car entry))
3402 (setq entries (nreverse entries)))
3405 (setq infos (nreverse infos)))
3406 ;; Go through all the infos and replace the old entries
3407 ;; with the new infos.
3409 (setcar (car entries) (pop infos))
3411 ;; Update the hashtable.
3412 (gnus-make-hashtable-from-newsrc-alist)))
3414 (defun gnus-group-sort-selected-groups-by-alphabet (&optional n reverse)
3415 "Sort the group buffer alphabetically by group name.
3416 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3417 sort in reverse order."
3418 (interactive (gnus-interactive "P\ny"))
3419 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-alphabet reverse))
3421 (defun gnus-group-sort-selected-groups-by-real-name (&optional n reverse)
3422 "Sort the group buffer alphabetically by real group name.
3423 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3424 sort in reverse order."
3425 (interactive (gnus-interactive "P\ny"))
3426 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-real-name reverse))
3428 (defun gnus-group-sort-selected-groups-by-unread (&optional n reverse)
3429 "Sort the group buffer by number of unread articles.
3430 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3431 sort in reverse order."
3432 (interactive (gnus-interactive "P\ny"))
3433 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-unread reverse))
3435 (defun gnus-group-sort-selected-groups-by-level (&optional n reverse)
3436 "Sort the group buffer by group level.
3437 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3438 sort in reverse order."
3439 (interactive (gnus-interactive "P\ny"))
3440 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-level reverse))
3442 (defun gnus-group-sort-selected-groups-by-score (&optional n reverse)
3443 "Sort the group buffer by group score.
3444 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3445 sort in reverse order."
3446 (interactive (gnus-interactive "P\ny"))
3447 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-score reverse))
3449 (defun gnus-group-sort-selected-groups-by-rank (&optional n reverse)
3450 "Sort the group buffer by group rank.
3451 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3452 sort in reverse order."
3453 (interactive (gnus-interactive "P\ny"))
3454 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-rank reverse))
3456 (defun gnus-group-sort-selected-groups-by-method (&optional n reverse)
3457 "Sort the group buffer alphabetically by back end name.
3458 Obeys the process/prefix convention. If REVERSE (the symbolic prefix),
3459 sort in reverse order."
3460 (interactive (gnus-interactive "P\ny"))
3461 (gnus-group-sort-selected-groups n 'gnus-group-sort-by-method reverse))
3463 ;;; Sorting predicates.
3465 (defun gnus-group-sort-by-alphabet (info1 info2)
3466 "Sort alphabetically."
3467 (string< (gnus-info-group info1) (gnus-info-group info2)))
3469 (defun gnus-group-sort-by-real-name (info1 info2)
3470 "Sort alphabetically on real (unprefixed) names."
3471 (string< (gnus-group-real-name (gnus-info-group info1))
3472 (gnus-group-real-name (gnus-info-group info2))))
3474 (defun gnus-group-sort-by-unread (info1 info2)
3475 "Sort by number of unread articles."
3476 (let ((n1 (gnus-group-unread (gnus-info-group info1)))
3477 (n2 (gnus-group-unread (gnus-info-group info2))))
3478 (< (or (and (numberp n1) n1) 0)
3479 (or (and (numberp n2) n2) 0))))
3481 (defun gnus-group-sort-by-level (info1 info2)
3483 (< (gnus-info-level info1) (gnus-info-level info2)))
3485 (defun gnus-group-sort-by-method (info1 info2)
3486 "Sort alphabetically by back end name."
3487 (string< (car (gnus-find-method-for-group
3488 (gnus-info-group info1) info1))
3489 (car (gnus-find-method-for-group
3490 (gnus-info-group info2) info2))))
3492 (defun gnus-group-sort-by-server (info1 info2)
3493 "Sort alphabetically by server name."
3494 (string< (gnus-method-to-full-server-name
3495 (gnus-find-method-for-group
3496 (gnus-info-group info1) info1))
3497 (gnus-method-to-full-server-name
3498 (gnus-find-method-for-group
3499 (gnus-info-group info2) info2))))
3501 (defun gnus-group-sort-by-score (info1 info2)
3502 "Sort by group score."
3503 (> (gnus-info-score info1) (gnus-info-score info2)))
3505 (defun gnus-group-sort-by-rank (info1 info2)
3506 "Sort by level and score."
3507 (let ((level1 (gnus-info-level info1))
3508 (level2 (gnus-info-level info2)))
3509 (or (< level1 level2)
3510 (and (= level1 level2)
3511 (> (gnus-info-score info1) (gnus-info-score info2))))))
3515 (defun gnus-group-clear-data (&optional arg)
3516 "Clear all marks and read ranges from the current group.
3517 Obeys the process/prefix convention."
3519 (gnus-group-iterate arg
3522 (gnus-info-clear-data (setq info (gnus-get-info group)))
3523 (gnus-get-unread-articles-in-group info (gnus-active group) t)
3524 (when (gnus-group-goto-group group)
3525 (gnus-group-update-group-line))))))
3527 (defun gnus-group-clear-data-on-native-groups ()
3528 "Clear all marks and read ranges from all native groups."
3530 (when (gnus-yes-or-no-p "Really clear all data from almost all groups? ")
3531 (let ((alist (cdr gnus-newsrc-alist))
3533 (while (setq info (pop alist))
3534 (when (gnus-group-native-p (gnus-info-group info))
3535 (gnus-info-clear-data info)))
3536 (gnus-get-unread-articles)
3537 (gnus-dribble-touch)
3538 (when (gnus-y-or-n-p
3539 "Move the cache away to avoid problems in the future? ")
3540 (call-interactively 'gnus-cache-move-cache)))))
3542 (defun gnus-info-clear-data (info)
3543 "Clear all marks and read ranges from INFO."
3544 (let ((group (gnus-info-group info))
3546 (dolist (el (gnus-info-marks info))
3547 (push `(,(cdr el) add (,(car el))) action))
3548 (push `(,(gnus-info-read info) add (read)) action)
3551 (gnus-request-set-mark ,group ',action)
3552 (gnus-info-set-marks ',info ',(gnus-info-marks info) t)
3553 (gnus-info-set-read ',info ',(gnus-info-read info))
3554 (when (gnus-group-goto-group ,group)
3555 (gnus-get-unread-articles-in-group ',info ',(gnus-active group) t)
3556 (gnus-group-update-group-line))))
3557 (setq action (mapcar (lambda (el) (list (nth 0 el) 'del (nth 2 el)))
3559 (gnus-request-set-mark group action)
3560 (gnus-info-set-read info nil)
3561 (when (gnus-info-marks info)
3562 (gnus-info-set-marks info nil))))
3564 ;; Group catching up.
3566 (defun gnus-group-catchup-current (&optional n all)
3567 "Mark all unread articles in the current newsgroup as read.
3568 If prefix argument N is numeric, the next N newsgroups will be
3569 caught up. If ALL is non-nil, marked articles will also be marked as
3570 read. Cross references (Xref: header) of articles are ignored.
3571 The number of newsgroups that this function was unable to catch
3574 (let ((groups (gnus-group-process-prefix n))
3577 (unless groups (error "No groups selected"))
3579 (or (not gnus-interactive-catchup) ;Without confirmation?
3584 "Do you really want to mark all articles in %s as read? "
3585 "Mark all unread articles in %s as read? ")
3586 (if (= (length groups) 1)
3587 (gnus-group-decoded-name (car groups))
3588 (format "these %d groups" (length groups)))))))
3590 (while (setq group (pop groups))
3591 (gnus-group-remove-mark group)
3592 ;; Virtual groups have to be given special treatment.
3593 (let ((method (gnus-find-method-for-group group)))
3594 (when (eq 'nnvirtual (car method))
3595 (nnvirtual-catchup-group
3596 (gnus-group-real-name group) (nth 1 method) all)))
3598 ((>= (gnus-group-level group) gnus-level-zombie)
3599 (gnus-message 2 "Dead groups can't be caught up"))
3601 (gnus-group-goto-group group)
3602 (gnus-group-catchup group all))
3603 (gnus-group-update-group-line))
3605 (setq ret (1+ ret)))))
3606 (gnus-group-next-unread-group 1)
3609 (defun gnus-group-catchup-current-all (&optional n)
3610 "Mark all articles in current newsgroup as read.
3611 Cross references (Xref: header) of articles are ignored."
3613 (gnus-group-catchup-current n 'all))
3615 (defun gnus-group-catchup (group &optional all)
3616 "Mark all articles in GROUP as read.
3617 If ALL is non-nil, all articles are marked as read.
3618 The return value is the number of articles that were marked as read,
3619 or nil if no action could be taken."
3620 (let* ((entry (gnus-group-entry group))
3622 (marks (gnus-info-marks (nth 2 entry)))
3623 (unread (gnus-sequence-of-unread-articles group)))
3624 ;; Remove entries for this group.
3625 (nnmail-purge-split-history (gnus-group-real-name group))
3626 ;; Do the updating only if the newsgroup isn't killed.
3627 (if (not (numberp (car entry)))
3628 (gnus-message 1 "Can't catch up %s; non-active group" group)
3629 (gnus-update-read-articles group nil)
3631 ;; Nix out the lists of marks and dormants.
3632 (gnus-request-set-mark group (list (list (cdr (assq 'tick marks))
3634 (list (cdr (assq 'dormant marks))
3636 (setq unread (gnus-range-add (gnus-range-add
3637 unread (cdr (assq 'dormant marks)))
3638 (cdr (assq 'tick marks))))
3639 (gnus-add-marked-articles group 'tick nil nil 'force)
3640 (gnus-add-marked-articles group 'dormant nil nil 'force))
3641 ;; Do auto-expirable marks if that's required.
3642 (when (gnus-group-auto-expirable-p group)
3645 (gnus-add-marked-articles group 'expire (list article))
3646 (gnus-request-set-mark group (list (list (list article)
3649 (let ((gnus-newsgroup-name group))
3650 (gnus-run-hooks 'gnus-group-catchup-group-hook))
3653 (defun gnus-group-expire-articles (&optional n)
3654 "Expire all expirable articles in the current newsgroup.
3655 Uses the process/prefix convention."
3657 (let ((groups (gnus-group-process-prefix n))
3660 (error "No groups to expire"))
3661 (while (setq group (pop groups))
3662 (gnus-group-remove-mark group)
3663 (gnus-group-expire-articles-1 group)
3664 (gnus-dribble-touch)
3665 (gnus-group-position-point))))
3667 (defun gnus-group-expire-articles-1 (group)
3668 (when (gnus-check-backend-function 'request-expire-articles group)
3669 (gnus-message 6 "Expiring articles in %s..."
3670 (gnus-group-decoded-name group))
3671 (let* ((info (gnus-get-info group))
3672 (expirable (if (gnus-group-total-expirable-p group)
3673 (cons nil (gnus-list-of-read-articles group))
3674 (assq 'expire (gnus-info-marks info))))
3675 (expiry-wait (gnus-group-find-parameter group 'expiry-wait))
3676 (nnmail-expiry-target
3677 (or (gnus-group-find-parameter group 'expiry-target)
3678 nnmail-expiry-target)))
3680 (gnus-check-group group)
3683 (gnus-compress-sequence
3685 ;; We set the expiry variables to the group
3687 (let ((nnmail-expiry-wait-function nil)
3688 (nnmail-expiry-wait expiry-wait))
3689 (gnus-request-expire-articles
3690 (gnus-uncompress-sequence (cdr expirable)) group))
3691 ;; Just expire using the normal expiry values.
3692 (gnus-request-expire-articles
3693 (gnus-uncompress-sequence (cdr expirable)) group))))
3694 (gnus-close-group group))
3695 (gnus-message 6 "Expiring articles in %s...done"
3696 (gnus-group-decoded-name group))
3697 ;; Return the list of un-expired articles.
3700 (defun gnus-group-expire-all-groups ()
3701 "Expire all expirable articles in all newsgroups."
3704 (gnus-message 5 "Expiring...")
3705 (let ((gnus-group-marked (mapcar (lambda (info) (gnus-info-group info))
3706 (cdr gnus-newsrc-alist))))
3707 (gnus-group-expire-articles nil)))
3708 (gnus-group-position-point)
3709 (gnus-message 5 "Expiring...done"))
3711 (defun gnus-group-set-current-level (n level)
3712 "Set the level of the next N groups to LEVEL."
3717 (unless (gnus-group-process-prefix current-prefix-arg)
3718 (error "No group on the current line"))
3720 (let ((s (read-string
3721 (format "Level (default %s): "
3722 (or (gnus-group-group-level)
3723 gnus-level-default-subscribed)))))
3724 (if (string-match "^\\s-*$" s)
3725 (int-to-string (or (gnus-group-group-level)
3726 gnus-level-default-subscribed))
3728 (unless (and (>= level 1) (<= level gnus-level-killed))
3729 (error "Invalid level: %d" level))
3730 (dolist (group (gnus-group-process-prefix n))
3731 (gnus-group-remove-mark group)
3732 (gnus-message 6 "Changed level of %s from %d to %d"
3733 (gnus-group-decoded-name group)
3734 (or (gnus-group-group-level) gnus-level-killed)
3736 (gnus-group-change-level
3737 group level (or (gnus-group-group-level) gnus-level-killed))
3738 (gnus-group-update-group-line))
3739 (gnus-group-position-point))
3741 (defun gnus-group-unsubscribe (&optional n)
3742 "Unsubscribe the current group."
3744 (gnus-group-unsubscribe-current-group n 'unsubscribe))
3746 (defun gnus-group-subscribe (&optional n)
3747 "Subscribe the current group."
3749 (gnus-group-unsubscribe-current-group n 'subscribe))
3751 (defun gnus-group-unsubscribe-current-group (&optional n do-sub)
3752 "Toggle subscription of the current group.
3753 If given numerical prefix, toggle the N next groups."
3755 (dolist (group (gnus-group-process-prefix n))
3756 (gnus-group-remove-mark group)
3757 (gnus-group-unsubscribe-group
3760 ((eq do-sub 'unsubscribe)
3761 gnus-level-default-unsubscribed)
3762 ((eq do-sub 'subscribe)
3763 gnus-level-default-subscribed)
3764 ((<= (gnus-group-group-level) gnus-level-subscribed)
3765 gnus-level-default-unsubscribed)
3767 gnus-level-default-subscribed))
3769 (gnus-group-update-group-line))
3770 (gnus-group-next-group 1))
3772 (defun gnus-group-unsubscribe-group (group &optional level silent)
3773 "Toggle subscription to GROUP.
3774 Killed newsgroups are subscribed. If SILENT, don't try to update the
3776 (interactive (list (gnus-group-completing-read
3777 "Group: " nil nil (gnus-read-active-file-p))))
3778 (let ((newsrc (gnus-group-entry group)))
3780 ((string-match "^[ \t]*$" group)
3781 (error "Empty group name"))
3783 ;; Toggle subscription flag.
3784 (gnus-group-change-level
3785 newsrc (if level level (if (<= (gnus-info-level (nth 2 newsrc))
3786 gnus-level-subscribed)
3787 (1+ gnus-level-subscribed)
3788 gnus-level-default-subscribed)))
3790 (gnus-group-update-group group)))
3791 ((and (stringp group)
3792 (or (not (gnus-read-active-file-p))
3793 (gnus-active group)))
3794 ;; Add new newsgroup.
3795 (gnus-group-change-level
3797 (if level level gnus-level-default-subscribed)
3798 (or (and (member group gnus-zombie-list)
3801 (when (gnus-group-group-name)
3802 (gnus-group-entry (gnus-group-group-name))))
3804 (gnus-group-update-group group)))
3805 (t (error "No such newsgroup: %s" group)))
3806 (gnus-group-position-point)))
3808 (defun gnus-group-transpose-groups (n)
3809 "Move the current newsgroup up N places.
3810 If given a negative prefix, move down instead. The difference between
3811 N and the number of steps taken is returned."
3813 (unless (gnus-group-group-name)
3814 (error "No group on current line"))
3815 (gnus-group-kill-group 1)
3817 (forward-line (- n))
3818 (gnus-group-yank-group)
3819 (gnus-group-position-point)))
3821 (defun gnus-group-kill-all-zombies (&optional dummy)
3822 "Kill all zombie newsgroups.
3823 The optional DUMMY should always be nil."
3824 (interactive (list (not (gnus-yes-or-no-p "Really kill all zombies? "))))
3826 (setq gnus-killed-list (nconc gnus-zombie-list gnus-killed-list))
3827 (setq gnus-zombie-list nil)
3828 (gnus-dribble-touch)
3829 (gnus-group-list-groups)))
3831 (defun gnus-group-kill-region (begin end)
3832 "Kill newsgroups in current region (excluding current point).
3833 The killed newsgroups can be yanked by using \\[gnus-group-yank-group]."
3846 (beginning-of-line) ;Important when LINES < 1
3847 (gnus-group-kill-group lines)))
3849 (defun gnus-group-kill-group (&optional n discard)
3850 "Kill the next N groups.
3851 The killed newsgroups can be yanked by using \\[gnus-group-yank-group].
3852 However, only groups that were alive can be yanked; already killed
3853 groups or zombie groups can't be yanked.
3854 The return value is the name of the group that was killed, or a list
3857 (let ((buffer-read-only nil)
3858 (groups (gnus-group-process-prefix n))
3859 group entry level out)
3860 (if (< (length groups) 10)
3861 ;; This is faster when there are few groups.
3863 (push (setq group (pop groups)) out)
3864 (gnus-group-remove-mark group)
3865 (setq level (gnus-group-group-level))
3867 (when (and (not discard)
3868 (setq entry (gnus-group-entry group)))
3871 (gnus-group-goto-group ,(gnus-group-group-name))
3872 (gnus-group-yank-group)))
3873 (push (cons (car entry) (nth 2 entry))
3874 gnus-list-of-killed-groups))
3875 (gnus-group-change-level
3876 (if entry entry group) gnus-level-killed (if entry nil level))
3877 (message "Killed group %s" (gnus-group-decoded-name group)))
3878 ;; If there are lots and lots of groups to be killed, we use
3879 ;; this thing instead.
3880 (dolist (group (nreverse groups))
3881 (gnus-group-remove-mark group)
3883 (push group gnus-killed-list)
3884 (setq gnus-newsrc-alist
3885 (delq (assoc group gnus-newsrc-alist)
3887 (when gnus-group-change-level-function
3888 (funcall gnus-group-change-level-function
3889 group gnus-level-killed 3))
3891 ((setq entry (gnus-group-entry group))
3892 (push (cons (car entry) (nth 2 entry))
3893 gnus-list-of-killed-groups)
3894 (setcdr (cdr entry) (cdddr entry)))
3895 ((member group gnus-zombie-list)
3896 (setq gnus-zombie-list (delete group gnus-zombie-list))))
3897 ;; There may be more than one instance displayed.
3898 (while (gnus-group-goto-group group)
3899 (gnus-delete-line)))
3900 (gnus-make-hashtable-from-newsrc-alist))
3902 (gnus-group-position-point)
3903 (if (< (length out) 2) (car out) (nreverse out))))
3905 (defun gnus-group-yank-group (&optional arg)
3906 "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup.
3907 The numeric ARG specifies how many newsgroups are to be yanked. The
3908 name of the newsgroup yanked is returned, or (if several groups are
3909 yanked) a list of yanked groups is returned."
3911 (setq arg (or arg 1))
3912 (let (info group prev out)
3913 (while (>= (decf arg) 0)
3914 (when (not (setq info (pop gnus-list-of-killed-groups)))
3915 (error "No more newsgroups to yank"))
3916 (push (setq group (nth 1 info)) out)
3917 ;; Find which newsgroup to insert this one before - search
3918 ;; backward until something suitable is found. If there are no
3919 ;; other newsgroups in this buffer, just make this newsgroup the
3921 (setq prev (gnus-group-group-name))
3922 (gnus-group-change-level
3923 info (gnus-info-level (cdr info)) gnus-level-killed
3924 (and prev (gnus-group-entry prev))
3926 (gnus-group-insert-group-line-info group)
3928 `(when (gnus-group-goto-group ,group)
3929 (gnus-group-kill-group 1))))
3931 (gnus-group-position-point)
3932 (if (< (length out) 2) (car out) (nreverse out))))
3934 (defun gnus-group-kill-level (level)
3935 "Kill all groups that is on a certain LEVEL."
3936 (interactive "nKill all groups on level: ")
3938 ((= level gnus-level-zombie)
3939 (setq gnus-killed-list
3940 (nconc gnus-zombie-list gnus-killed-list))
3941 (setq gnus-zombie-list nil))
3942 ((and (< level gnus-level-zombie)
3944 (or gnus-expert-user
3947 "Do you really want to kill all groups on level %d? "
3949 (let* ((prev gnus-newsrc-alist)
3952 (if (= (gnus-info-level (car alist)) level)
3954 (push (gnus-info-group (car alist)) gnus-killed-list)
3955 (setcdr prev (cdr alist)))
3957 (setq alist (cdr alist)))
3958 (gnus-make-hashtable-from-newsrc-alist)
3959 (gnus-group-list-groups)))
3961 (error "Can't kill; invalid level: %d" level))))
3963 (defun gnus-group-list-all-groups (&optional arg)
3964 "List all newsgroups with level ARG or lower.
3965 Default is `gnus-level-unsubscribed', which lists all subscribed and most
3966 unsubscribed groups."
3968 (gnus-group-list-groups (or arg gnus-level-unsubscribed) t))
3970 ;; Redefine this to list ALL killed groups if prefix arg used.
3971 ;; Rewritten by engstrom@src.honeywell.com (Eric Engstrom).
3972 (defun gnus-group-list-killed (&optional arg)
3973 "List all killed newsgroups in the group buffer.
3974 If ARG is non-nil, list ALL killed groups known to Gnus. This may
3975 entail asking the server for the groups."
3977 ;; Find all possible killed newsgroups if arg.
3979 (gnus-get-killed-groups))
3980 (if (not gnus-killed-list)
3981 (gnus-message 6 "No killed groups")
3982 (let (gnus-group-list-mode)
3983 (funcall gnus-group-prepare-function
3984 gnus-level-killed t gnus-level-killed))
3985 (goto-char (point-min)))
3986 (gnus-group-position-point))
3988 (defun gnus-group-list-zombies ()
3989 "List all zombie newsgroups in the group buffer."
3991 (if (not gnus-zombie-list)
3992 (gnus-message 6 "No zombie groups")
3993 (let (gnus-group-list-mode)
3994 (funcall gnus-group-prepare-function
3995 gnus-level-zombie t gnus-level-zombie))
3996 (goto-char (point-min)))
3997 (gnus-group-position-point))
3999 (defun gnus-group-list-active ()
4000 "List all groups that are available from the server(s)."
4002 ;; First we make sure that we have really read the active file.
4003 (unless (gnus-read-active-file-p)
4004 (let ((gnus-read-active-file t)
4005 (gnus-agent gnus-plugged)); If we're actually plugged, store the active file in the agent.
4006 (gnus-read-active-file)))
4007 ;; Find all groups and sort them.
4015 (push (symbol-name sym) list)))
4019 (buffer-read-only nil)
4023 (setq group (pop groups))
4024 (gnus-add-text-properties
4025 (point) (prog1 (1+ (point))
4027 (gnus-group-decoded-name group)
4029 (list 'gnus-group (gnus-intern-safe group gnus-active-hashtb)
4031 'gnus-level (inline (gnus-group-level group)))))
4032 (goto-char (point-min))))
4034 (defun gnus-activate-all-groups (level)
4035 "Activate absolutely all groups."
4036 (interactive (list gnus-level-unsubscribed))
4037 (let ((gnus-activate-level level)
4038 (gnus-activate-foreign-newsgroups level))
4039 (gnus-group-get-new-news)))
4041 (defun gnus-group-get-new-news (&optional arg)
4042 "Get newly arrived articles.
4043 If ARG is a number, it specifies which levels you are interested in
4044 re-scanning. If ARG is non-nil and not a number, this will force
4045 \"hard\" re-reading of the active files from all servers."
4048 (let ((gnus-inhibit-demon t)
4049 ;; Binding this variable will inhibit multiple fetchings
4050 ;; of the same mail source.
4051 (nnmail-fetched-sources (list t)))
4052 (gnus-run-hooks 'gnus-get-top-new-news-hook)
4053 (gnus-run-hooks 'gnus-get-new-news-hook)
4055 ;; Read any slave files.
4057 (gnus-master-read-slave-newsrc))
4059 ;; We might read in new NoCeM messages here.
4060 (when (and gnus-use-nocem
4061 (or (and (numberp gnus-use-nocem)
4063 (>= arg gnus-use-nocem))
4065 (gnus-nocem-scan-groups))
4066 ;; If ARG is not a number, then we read the active file.
4067 (when (and arg (not (numberp arg)))
4068 (let ((gnus-read-active-file t))
4069 (gnus-read-active-file))
4072 ;; If the user wants it, we scan for new groups.
4073 (when (eq gnus-check-new-newsgroups 'always)
4074 (gnus-find-new-newsgroups)))
4076 (setq arg (gnus-group-default-level arg t))
4077 (if (and gnus-read-active-file (not arg))
4079 (gnus-read-active-file)
4080 (gnus-get-unread-articles arg))
4081 (let ((gnus-read-active-file (if arg nil gnus-read-active-file)))
4082 (gnus-get-unread-articles arg)))
4083 (gnus-check-reasonable-setup)
4084 (gnus-run-hooks 'gnus-after-getting-new-news-hook)
4085 (gnus-group-list-groups (and (numberp arg)
4086 (max (car gnus-group-list-mode) arg)))))
4088 (defun gnus-group-get-new-news-this-group (&optional n dont-scan)
4089 "Check for newly arrived news in the current group (and the N-1 next groups).
4090 The difference between N and the number of newsgroup checked is returned.
4091 If N is negative, this group and the N-1 previous groups will be checked.
4092 If DONT-SCAN is non-nil, scan non-activated groups as well."
4094 (let* ((groups (gnus-group-process-prefix n))
4095 (ret (if (numberp n) (- n (length groups)) 0))
4099 (gnus-inhibit-demon t)
4100 ;; Binding this variable will inhibit multiple fetchings
4101 ;; of the same mail source.
4102 (nnmail-fetched-sources (list t)))
4103 (gnus-run-hooks 'gnus-get-new-news-hook)
4104 (while (setq group (pop groups))
4105 (gnus-group-remove-mark group)
4106 ;; Bypass any previous denials from the server.
4107 (gnus-remove-denial (setq method (gnus-find-method-for-group group)))
4108 (if (gnus-activate-group group (if dont-scan nil 'scan) nil method)
4109 (let ((info (gnus-get-info group))
4110 (active (gnus-active group)))
4112 (gnus-request-update-info info method))
4113 (gnus-get-unread-articles-in-group info active)
4114 (unless (gnus-virtual-group-p group)
4115 (gnus-close-group group))
4117 (gnus-agent-save-group-info
4118 method (gnus-group-real-name group) active))
4119 (gnus-group-update-group group))
4120 (if (eq (gnus-server-status (gnus-find-method-for-group group))
4122 (gnus-error 3 "Server denied access")
4123 (gnus-error 3 "%s error: %s" group (gnus-status-message group)))))
4126 (when gnus-goto-next-group-when-activating
4127 (gnus-group-next-unread-group 1 t))
4128 (gnus-summary-position-point)
4131 (defun gnus-group-fetch-faq (group &optional faq-dir)
4132 "Fetch the FAQ for the current group.
4133 If given a prefix argument, prompt for the FAQ dir
4137 (gnus-group-group-name)
4138 (when current-prefix-arg
4140 "FAQ dir: " (and (listp gnus-group-faq-directory)
4142 gnus-group-faq-directory))))))
4144 (error "No group name given"))
4145 (let ((dirs (or faq-dir gnus-group-faq-directory))
4147 (unless (listp dirs)
4148 (setq dirs (list dirs)))
4149 (while (and (not found)
4150 (setq dir (pop dirs)))
4151 (let ((name (gnus-group-real-name group)))
4152 (setq file (expand-file-name name dir)))
4153 (if (not (file-exists-p file))
4154 (gnus-message 1 "No such file: %s" file)
4155 (let ((enable-local-variables nil))
4159 (defun gnus-group-fetch-charter (group)
4160 "Fetch the charter for the current group.
4161 If given a prefix argument, prompt for a group."
4163 (list (or (when current-prefix-arg
4164 (gnus-group-completing-read "Group: "))
4165 (gnus-group-group-name)
4166 gnus-newsgroup-name)))
4168 (error "No group name given"))
4170 (condition-case nil (require 'url-http) (error nil))
4171 (let ((name (mm-url-form-encode-xwfu (gnus-group-real-name group)))
4173 (when (string-match "\\(^[^\\.]+\\)\\..*" name)
4174 (setq hierarchy (match-string 1 name))
4175 (if (and (setq url (cdr (assoc hierarchy gnus-group-charter-alist)))
4176 (if (fboundp 'url-http-file-exists-p)
4177 (url-http-file-exists-p (eval url))
4179 (browse-url (eval url))
4180 (setq url (concat "http://" hierarchy
4181 ".news-admin.org/charters/" name))
4182 (if (and (fboundp 'url-http-file-exists-p)
4183 (url-http-file-exists-p url))
4185 (gnus-group-fetch-control group))))))
4187 (defun gnus-group-fetch-control (group)
4188 "Fetch the archived control messages for the current group.
4189 If given a prefix argument, prompt for a group."
4191 (list (or (when current-prefix-arg
4192 (gnus-group-completing-read "Group: "))
4193 (gnus-group-group-name)
4194 gnus-newsgroup-name)))
4196 (error "No group name given"))
4197 (let ((name (gnus-group-real-name group))
4199 (when (string-match "\\(^[^\\.]+\\)\\..*" name)
4200 (setq hierarchy (match-string 1 name))
4201 (if gnus-group-fetch-control-use-browse-url
4202 (browse-url (concat "ftp://ftp.isc.org/usenet/control/"
4203 hierarchy "/" name ".gz"))
4204 (let ((enable-local-variables nil))
4205 (gnus-group-read-ephemeral-group
4207 `(nndoc ,group (nndoc-address
4208 ,(find-file-noselect
4209 (concat "/ftp@ftp.isc.org:/usenet/control/"
4210 hierarchy "/" name ".gz")))
4211 (nndoc-article-type mbox)) t nil nil))))))
4213 (defun gnus-group-describe-group (force &optional group)
4214 "Display a description of the current newsgroup."
4215 (interactive (list current-prefix-arg (gnus-group-group-name)))
4216 (let* ((method (gnus-find-method-for-group group))
4217 (mname (gnus-group-prefixed-name "" method))
4220 gnus-description-hashtb)
4221 (gnus-sethash mname nil gnus-description-hashtb))
4223 (error "No group name given"))
4224 (when (or (and gnus-description-hashtb
4225 ;; We check whether this group's method has been
4226 ;; queried for a description file.
4227 (gnus-gethash mname gnus-description-hashtb))
4228 (setq desc (gnus-group-get-description group))
4229 (gnus-read-descriptions-file method))
4231 (or desc (gnus-gethash group gnus-description-hashtb)
4232 "No description available")))))
4234 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4235 (defun gnus-group-describe-all-groups (&optional force)
4236 "Pop up a buffer with descriptions of all newsgroups."
4239 (setq gnus-description-hashtb nil))
4240 (when (not (or gnus-description-hashtb
4241 (gnus-read-all-descriptions-files)))
4242 (error "Couldn't request descriptions file"))
4243 (let ((buffer-read-only nil)
4249 (let ((charset (gnus-group-name-charset nil (symbol-name group))))
4250 (insert (format " *: %-20s %s\n"
4251 (gnus-group-name-decode
4252 (symbol-name group) charset)
4253 (gnus-group-name-decode
4254 (symbol-value group) charset))))
4255 (gnus-add-text-properties
4256 b (1+ b) (list 'gnus-group group
4257 'gnus-unread t 'gnus-marked nil
4258 'gnus-level (1+ gnus-level-subscribed))))
4259 gnus-description-hashtb)
4260 (goto-char (point-min))
4261 (gnus-group-position-point)))
4263 ;; Suggested by Daniel Quinlan <quinlan@best.com>.
4264 (defun gnus-group-apropos (regexp &optional search-description)
4265 "List all newsgroups that have names that match a regexp."
4266 (interactive "sGnus apropos (regexp): ")
4268 (obuf (current-buffer))
4270 ;; Go through all newsgroups that are known to Gnus.
4273 (and (symbol-name group)
4274 (string-match regexp (symbol-name group))
4275 (symbol-value group)
4276 (push (symbol-name group) groups)))
4278 ;; Also go through all descriptions that are known to Gnus.
4279 (when search-description
4282 (and (string-match regexp (symbol-value group))
4283 (push (symbol-name group) groups)))
4284 gnus-description-hashtb))
4286 (gnus-message 3 "No groups matched \"%s\"." regexp)
4287 ;; Print out all the groups.
4289 (pop-to-buffer "*Gnus Help*")
4290 (buffer-disable-undo)
4292 (setq groups (sort groups 'string<))
4294 ;; Groups may be entered twice into the list of groups.
4295 (when (not (string= (car groups) prev))
4296 (setq prev (car groups))
4297 (let ((charset (gnus-group-name-charset nil prev)))
4298 (insert (gnus-group-name-decode prev charset) "\n")
4299 (when (and gnus-description-hashtb
4300 (setq des (gnus-gethash (car groups)
4301 gnus-description-hashtb)))
4302 (insert " " (gnus-group-name-decode des charset) "\n"))))
4303 (setq groups (cdr groups)))
4304 (goto-char (point-min))))
4305 (pop-to-buffer obuf)))
4307 (defun gnus-group-description-apropos (regexp)
4308 "List all newsgroups that have names or descriptions that match REGEXP."
4309 (interactive "sGnus description apropos (regexp): ")
4310 (when (not (or gnus-description-hashtb
4311 (gnus-read-all-descriptions-files)))
4312 (error "Couldn't request descriptions file"))
4313 (gnus-group-apropos regexp t))
4315 ;; Suggested by Per Abrahamsen <amanda@iesd.auc.dk>.
4316 (defun gnus-group-list-matching (level regexp &optional all lowest)
4317 "List all groups with unread articles that match REGEXP.
4318 If the prefix LEVEL is non-nil, it should be a number that says which
4319 level to cut off listing groups.
4320 If ALL, also list groups with no unread articles.
4321 If LOWEST, don't list groups with level lower than LOWEST.
4323 This command may read the active file."
4324 (interactive "P\nsList newsgroups matching: ")
4325 ;; First make sure active file has been read.
4327 (> (prefix-numeric-value level) gnus-level-killed))
4328 (gnus-get-killed-groups))
4329 (funcall gnus-group-prepare-function
4330 (or level gnus-level-subscribed) (and all t) (or lowest 1) regexp)
4331 (goto-char (point-min))
4332 (gnus-group-position-point))
4334 (defun gnus-group-list-all-matching (level regexp &optional lowest)
4335 "List all groups that match REGEXP.
4336 If the prefix LEVEL is non-nil, it should be a number that says which
4337 level to cut off listing groups.
4338 If LOWEST, don't list groups with level lower than LOWEST."
4339 (interactive "P\nsList newsgroups matching: ")
4341 (setq level (prefix-numeric-value level)))
4342 (gnus-group-list-matching (or level gnus-level-killed) regexp t lowest))
4344 ;; Suggested by Jack Vinson <vinson@unagi.cis.upenn.edu>.
4345 (defun gnus-group-save-newsrc (&optional force)
4346 "Save the Gnus startup files.
4347 If FORCE, force saving whether it is necessary or not."
4349 (gnus-save-newsrc-file force))
4351 (defun gnus-group-restart (&optional arg)
4352 "Force Gnus to read the .newsrc file."
4354 (when (gnus-yes-or-no-p
4355 (format "Are you sure you want to restart Gnus? "))
4356 (gnus-save-newsrc-file)
4360 (defun gnus-group-read-init-file ()
4361 "Read the Gnus elisp init file."
4363 (gnus-read-init-file)
4364 (gnus-message 5 "Read %s" gnus-init-file))
4366 (defun gnus-group-check-bogus-groups (&optional silent)
4367 "Check bogus newsgroups.
4368 If given a prefix, don't ask for confirmation before removing a bogus
4371 (gnus-check-bogus-newsgroups (and (not silent) (not gnus-expert-user)))
4372 (gnus-group-list-groups))
4374 (defun gnus-group-find-new-groups (&optional arg)
4375 "Search for new groups and add them.
4376 Each new group will be treated with `gnus-subscribe-newsgroup-method'.
4377 With 1 C-u, use the `ask-server' method to query the server for new
4379 With 2 C-u's, use most complete method possible to query the server
4380 for new groups, and subscribe the new groups as zombies."
4382 (gnus-find-new-newsgroups (or arg 1))
4383 (gnus-group-list-groups))
4385 (defun gnus-group-edit-global-kill (&optional article group)
4386 "Edit the global kill file.
4387 If GROUP, edit that local kill file instead."
4389 (setq gnus-current-kill-article article)
4390 (gnus-kill-file-edit-file group)
4393 (substitute-command-keys
4394 (format "Editing a %s kill file (Type \\[gnus-kill-file-exit] to exit)"
4395 (if group "local" "global")))))
4397 (defun gnus-group-edit-local-kill (article group)
4398 "Edit a local kill file."
4399 (interactive (list nil (gnus-group-group-name)))
4400 (gnus-group-edit-global-kill article group))
4402 (defun gnus-group-force-update ()
4403 "Update `.newsrc' file."
4405 (gnus-save-newsrc-file))
4407 (defvar gnus-backlog-articles)
4409 (defun gnus-group-suspend ()
4410 "Suspend the current Gnus session.
4411 In fact, cleanup buffers except for group mode buffer.
4412 The hook `gnus-suspend-gnus-hook' is called before actually suspending."
4414 (gnus-run-hooks 'gnus-suspend-gnus-hook)
4415 (gnus-offer-save-summaries)
4416 ;; Kill Gnus buffers except for group mode buffer.
4417 (let ((group-buf (get-buffer gnus-group-buffer)))
4418 (dolist (buf (gnus-buffers))
4419 (unless (or (eq buf group-buf)
4420 (eq buf gnus-dribble-buffer)
4421 (with-current-buffer buf
4422 (eq major-mode 'message-mode)))
4423 (gnus-kill-buffer buf)))
4424 (setq gnus-backlog-articles nil)
4425 (gnus-kill-gnus-frames)
4427 (bury-buffer group-buf)
4428 (delete-windows-on group-buf t))))
4430 (defun gnus-group-clear-dribble ()
4431 "Clear all information from the dribble buffer."
4433 (gnus-dribble-clear)
4434 (gnus-message 7 "Cleared dribble buffer"))
4436 (defun gnus-group-exit ()
4437 "Quit reading news after updating .newsrc.eld and .newsrc.
4438 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4441 (or noninteractive ;For gnus-batch-kill
4442 (not gnus-interactive-exit) ;Without confirmation
4444 (gnus-y-or-n-p "Are you sure you want to quit reading news? "))
4445 (gnus-run-hooks 'gnus-exit-gnus-hook)
4446 ;; Offer to save data from non-quitted summary buffers.
4447 (gnus-offer-save-summaries)
4448 ;; Save the newsrc file(s).
4449 (gnus-save-newsrc-file)
4451 (gnus-close-backends)
4452 ;; Reset everything.
4454 ;; Allow the user to do things after cleaning up.
4455 (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4457 (defun gnus-group-quit ()
4458 "Quit reading news without updating .newsrc.eld or .newsrc.
4459 The hook `gnus-exit-gnus-hook' is called before actually exiting."
4461 (when (or noninteractive ;For gnus-batch-kill
4462 (zerop (buffer-size))
4463 (not (gnus-server-opened gnus-select-method))
4465 (not gnus-current-startup-file)
4467 (format "Quit reading news without saving %s? "
4468 (file-name-nondirectory gnus-current-startup-file))))
4469 (gnus-run-hooks 'gnus-exit-gnus-hook)
4470 (gnus-configure-windows 'group t)
4471 (when (and (gnus-buffer-live-p gnus-dribble-buffer)
4472 (not (zerop (save-excursion
4473 (set-buffer gnus-dribble-buffer)
4476 ";;; Gnus was exited on purpose without saving the .newsrc files."))
4478 (gnus-close-backends)
4480 (gnus-kill-buffer gnus-group-buffer)
4481 ;; Allow the user to do things after cleaning up.
4482 (gnus-run-hooks 'gnus-after-exiting-gnus-hook)))
4484 (defun gnus-group-describe-briefly ()
4485 "Give a one line description of the group mode commands."
4487 (gnus-message 7 (substitute-command-keys "\\<gnus-group-mode-map>\\[gnus-group-read-group]:Select \\[gnus-group-next-unread-group]:Forward \\[gnus-group-prev-unread-group]:Backward \\[gnus-group-exit]:Exit \\[gnus-info-find-node]:Run Info \\[gnus-group-describe-briefly]:This help")))
4489 (defun gnus-group-browse-foreign-server (method)
4490 "Browse a foreign news server.
4491 If called interactively, this function will ask for a select method
4492 (nntp, nnspool, etc.) and a server address (eg. nntp.some.where).
4493 If not, METHOD should be a list where the first element is the method
4494 and the second element is the address."
4496 (list (let ((how (completing-read
4498 (append gnus-valid-select-methods gnus-server-alist)
4499 nil t (cons "nntp" 0) 'gnus-method-history)))
4500 ;; We either got a back end name or a virtual server name.
4501 ;; If the first, we also need an address.
4502 (if (assoc how gnus-valid-select-methods)
4504 ;; Suggested by mapjph@bath.ac.uk.
4507 (mapcar 'list gnus-secondary-servers)))
4508 ;; We got a server name.
4510 (gnus-browse-foreign-server method))
4512 (defun gnus-group-set-info (info &optional method-only-group part)
4513 (when (or info part)
4514 (let* ((entry (gnus-group-entry
4515 (or method-only-group (gnus-info-group info))))
4517 (info (if method-only-group (nth 2 entry) info))
4519 (when method-only-group
4521 (error "Trying to change non-existent group %s" method-only-group))
4522 ;; We have received parts of the actual group info - either the
4523 ;; select method or the group parameters. We first check
4524 ;; whether we have to extend the info, and if so, do that.
4525 (let ((len (length info))
4526 (total (if (eq part 'method) 5 6)))
4528 (setcdr (nthcdr (1- len) info)
4529 (make-list (- total len) nil)))
4530 ;; Then we enter the new info.
4531 (setcar (nthcdr (1- total) info) part-info)))
4533 ;; This is a new group, so we just create it.
4535 (set-buffer gnus-group-buffer)
4536 (setq method (gnus-info-method info))
4537 (when (gnus-server-equal method "native")
4540 (set-buffer gnus-group-buffer)
4542 ;; It's a foreign group...
4543 (gnus-group-make-group
4544 (gnus-group-real-name (gnus-info-group info))
4545 (if (stringp method) method
4546 (prin1-to-string (car method)))
4548 (nth 1 (gnus-info-method info)))
4550 ;; It's a native group.
4551 (gnus-group-make-group (gnus-info-group info) nil nil nil t)))
4552 (gnus-message 6 "Note: New group created")
4554 (gnus-group-entry (gnus-group-prefixed-name
4555 (gnus-group-real-name (gnus-info-group info))
4556 (or (gnus-info-method info) gnus-select-method))))))
4557 ;; Whether it was a new group or not, we now have the entry, so we
4558 ;; can do the update.
4561 (setcar (nthcdr 2 entry) info)
4562 (when (and (not (eq (car entry) t))
4563 (gnus-active (gnus-info-group info)))
4564 (setcar entry (length
4565 (gnus-list-of-unread-articles (car info))))))
4566 (error "No such group: %s" (gnus-info-group info))))))
4568 (defun gnus-group-set-method-info (group select-method)
4569 (gnus-group-set-info select-method group 'method))
4571 (defun gnus-group-set-params-info (group params)
4572 (gnus-group-set-info params group 'params))
4574 (defun gnus-add-marked-articles (group type articles &optional info force)
4575 ;; Add ARTICLES of TYPE to the info of GROUP.
4576 ;; If INFO is non-nil, use that info. If FORCE is non-nil, don't
4577 ;; add, but replace marked articles of TYPE with ARTICLES.
4578 (let ((info (or info (gnus-get-info group)))
4581 (and (not (setq marked (nthcdr 3 info)))
4583 (setcdr (nthcdr 2 info)
4584 (list (list (cons type (gnus-compress-sequence
4586 (and (not (setq m (assq type (car marked))))
4589 (cons (cons type (gnus-compress-sequence articles t) )
4593 (setcar (nthcdr 3 info)
4594 (gnus-delete-alist type (car marked)))
4595 (setcdr m (gnus-compress-sequence articles t)))
4596 (setcdr m (gnus-compress-sequence
4597 (sort (nconc (gnus-uncompress-range (cdr m))
4598 (copy-sequence articles)) '<) t))))))
4600 (defun gnus-add-mark (group mark article)
4601 "Mark ARTICLE in GROUP with MARK, whether the group is displayed or not."
4602 (let ((buffer (gnus-summary-buffer-name group)))
4603 (if (gnus-buffer-live-p buffer)
4605 (set-buffer (get-buffer buffer))
4606 (gnus-summary-add-mark article mark))
4607 (gnus-add-marked-articles group (cdr (assq mark gnus-article-mark-lists))
4611 ;;; Group timestamps
4614 (defun gnus-group-set-timestamp ()
4615 "Change the timestamp of the current group to the current time.
4616 This function can be used in hooks like `gnus-select-group-hook'
4617 or `gnus-group-catchup-group-hook'."
4618 (when gnus-newsgroup-name
4619 (let ((time (current-time)))
4620 (setcdr (cdr time) nil)
4621 (gnus-group-set-parameter gnus-newsgroup-name 'timestamp time))))
4623 (defsubst gnus-group-timestamp (group)
4624 "Return the timestamp for GROUP."
4625 (gnus-group-get-parameter group 'timestamp t))
4627 (defun gnus-group-timestamp-delta (group)
4628 "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number."
4629 (let* ((time (or (gnus-group-timestamp group)
4631 (delta (subtract-time (current-time) time)))
4632 (+ (* (nth 0 delta) 65536.0)
4635 (defun gnus-group-timestamp-string (group)
4636 "Return a string of the timestamp for GROUP."
4637 (let ((time (gnus-group-timestamp group)))
4640 (gnus-time-iso8601 time))))
4642 (defun gnus-group-list-cached (level &optional lowest)
4643 "List all groups with cached articles.
4644 If the prefix LEVEL is non-nil, it should be a number that says which
4645 level to cut off listing groups.
4646 If LOWEST, don't list groups with level lower than LOWEST.
4648 This command may read the active file."
4651 (setq level (prefix-numeric-value level)))
4652 (when (or (not level) (>= level gnus-level-zombie))
4654 (funcall gnus-group-prepare-function
4655 (or level gnus-level-subscribed)
4657 (let ((marks (gnus-info-marks info)))
4658 (assq 'cache marks)))
4661 (or (gnus-gethash group
4662 gnus-cache-active-hashtb)
4663 ;; Cache active file might use "."
4666 (mapconcat 'identity
4667 (split-string group ":")
4669 gnus-cache-active-hashtb))))
4670 (goto-char (point-min))
4671 (gnus-group-position-point))
4673 (defun gnus-group-list-dormant (level &optional lowest)
4674 "List all groups with dormant articles.
4675 If the prefix LEVEL is non-nil, it should be a number that says which
4676 level to cut off listing groups.
4677 If LOWEST, don't list groups with level lower than LOWEST.
4679 This command may read the active file."
4682 (setq level (prefix-numeric-value level)))
4683 (when (or (not level) (>= level gnus-level-zombie))
4685 (funcall gnus-group-prepare-function
4686 (or level gnus-level-subscribed)
4688 (let ((marks (gnus-info-marks info)))
4689 (assq 'dormant marks)))
4692 (goto-char (point-min))
4693 (gnus-group-position-point))
4695 (defun gnus-group-listed-groups ()
4696 "Return a list of listed groups."
4698 (goto-char (point-min))
4699 (while (setq point (text-property-not-all (point) (point-max)
4702 (push (symbol-name (get-text-property point 'gnus-group)) groups)
4706 (defun gnus-group-list-plus (&optional args)
4707 "List groups plus the current selection."
4709 (let ((gnus-group-listed-groups (gnus-group-listed-groups))
4710 (gnus-group-list-mode gnus-group-list-mode) ;; Save it.
4712 (push last-command-event unread-command-events)
4713 (if (featurep 'xemacs)
4714 (push (make-event 'key-press '(key ?A)) unread-command-events)
4715 (push ?A unread-command-events))
4716 (let (gnus-pick-mode keys)
4717 (setq keys (if (featurep 'xemacs)
4718 (events-to-keys (read-key-sequence nil))
4719 (read-key-sequence nil)))
4720 (setq func (lookup-key (current-local-map) keys)))
4724 (call-interactively func))))
4726 (defun gnus-group-list-flush (&optional args)
4727 "Flush groups from the current selection."
4729 (let ((gnus-group-list-option 'flush))
4730 (gnus-group-list-plus args)))
4732 (defun gnus-group-list-limit (&optional args)
4733 "List groups limited within the current selection."
4735 (let ((gnus-group-list-option 'limit))
4736 (gnus-group-list-plus args)))
4738 (defun gnus-group-mark-article-read (group article)
4739 "Mark ARTICLE read."
4740 (let ((buffer (gnus-summary-buffer-name group))
4741 (mark gnus-read-mark)
4743 (if (get-buffer buffer)
4744 (with-current-buffer buffer
4745 (setq active gnus-newsgroup-active)
4746 (gnus-activate-group group)
4747 (when gnus-newsgroup-prepared
4748 (when (and gnus-newsgroup-auto-expire
4749 (memq mark gnus-auto-expirable-marks))
4750 (setq mark gnus-expirable-mark))
4751 (setq mark (gnus-request-update-mark
4752 group article mark))
4753 (gnus-mark-article-as-read article mark)
4754 (setq gnus-newsgroup-active (gnus-active group))
4756 (setq n (1+ (cdr active)))
4757 (while (<= n (cdr gnus-newsgroup-active))
4758 (unless (eq n article)
4759 (push n gnus-newsgroup-unselected))
4761 (setq gnus-newsgroup-unselected
4762 (nreverse gnus-newsgroup-unselected)))))
4763 (gnus-activate-group group)
4764 (gnus-group-make-articles-read group (list article))
4765 (when (gnus-group-auto-expirable-p group)
4766 (gnus-add-marked-articles
4767 group 'expire (list article))))))
4771 ;;; Group compaction. -- dvl
4774 (defun gnus-group-compact-group (group)
4775 "Compact the current group.
4776 Compaction means removing gaps between article numbers. Hence, this
4777 operation is only meaningful for back ends using one file per article
4780 Note: currently only implemented in nnml."
4781 (interactive (list (gnus-group-group-name)))
4783 (error "No group to compact"))
4784 (unless (gnus-check-backend-function 'request-compact-group group)
4785 (error "This back end does not support group compaction"))
4786 (let ((group-decoded (gnus-group-decoded-name group)))
4788 Compacting group %s... (this may take a long time)"
4791 (if (not (gnus-request-compact-group group))
4792 (gnus-error 3 "Couldn't compact group %s" group-decoded)
4793 (gnus-message 6 "Compacting group %s...done" group-decoded)
4795 ;; Invalidate the "original article" buffer which might be out of date.
4796 ;; #### NOTE: Yes, this might be a bit rude, but since compaction
4797 ;; #### will not happen very often, I think this is acceptable.
4798 (let ((original (get-buffer gnus-original-article-buffer)))
4799 (and original (gnus-kill-buffer original)))
4800 ;; Update the group line to reflect new information (art number etc).
4801 (gnus-group-update-group-line))))
4803 (provide 'gnus-group)
4805 ;; arch-tag: 2eb5440f-0bca-4091-814c-e37817536af6
4806 ;;; gnus-group.el ends here