| blob | 0f8111c32bad281eae15e46bb6e8dfde41c1541a |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; Keywords: news, mail
10 ;; Version: 5.13
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;;; Code:
33 ;; For Emacs < 22.2.
42 ;; These are defined afterwards with gnus-define-group-parameter
56 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
61 "Starting your favorite newsreader."
65 "Dealing with formatting issues."
69 "Group character set issues."
75 "Cache interface."
80 "Article Registry."
84 "Server options at startup."
87 ;; These belong to gnus-group.el.
89 "Group buffers."
94 "Foreign groups."
99 "Automatic subscription of new groups."
103 "Group levels."
108 "Selecting a Group."
113 "Showing slices of the group list."
118 "Sorting the group buffer."
124 "Various group options."
128 ;; These belong to gnus-sum.el.
130 "Summary buffers."
135 "Leaving summary buffers."
140 "Marks used in summary buffers."
145 "Ordering articles according to replies."
150 "Formatting of the summary buffer."
155 "Choosing Articles."
160 "Summary movement commands."
165 "Show pictures of people, domains, and newsgroups."
169 "Mail group commands."
174 "Sorting the summary buffer."
179 "Highlighting and menus in the summary buffer."
185 "Various summary buffer options."
190 "Pick mode in the summary buffer."
196 "Tree display of threads in the summary buffer."
201 ;; Belongs to gnus-uu.el
203 "Viewing extracted files."
207 ;; Belongs to gnus-score.el
209 "Score and kill file handling."
213 "Kill files."
217 "Adaptive score files."
221 "Default values for score files."
225 "Expiring score rules."
229 "Decaying score rules."
233 "Score and kill file names."
238 "Various scoring and killing options."
241 ;; Other
243 "Options controlling the visual fluff."
248 "Offline support for Gnus."
252 "Files used by Gnus."
256 "Auto save file."
261 "Storing Gnus state."
265 "Options related to newsservers and other servers used by Gnus."
269 "Highlighting and menus in the server buffer."
274 "Composing replies and followups in Gnus."
278 "Meta variables controlling major portions of Gnus.
279 In general, modifying these variables does not take affect until Gnus
280 is restarted, and sometimes reloaded."
284 "Other Gnus options."
289 "Exiting Gnus."
294 "Frivolous Gnus extensions."
305 "If non-nil, the startup message will not be displayed.
306 This variable is used before `.gnus.el' is loaded, so it should
307 be set in `.emacs' instead."
312 "If non-nil, play the Gnus jingle at startup."
344 0 5
353 gnus-mode-line-image-cache)
355 "This is %s, %s."
357 str)
359 line)))
365 ;;(defalias 'gnus-decode-rfc1522 'ignore)
366 )
368 ;; We define these group faces here to avoid the display
369 ;; update forced when creating new faces.
379 ()))
380 "Level 1 newsgroup face."
382 ;; backward-compatibility alias
394 ()))
395 "Level 1 empty newsgroup face."
397 ;; backward-compatibility alias
409 ()))
410 "Level 2 newsgroup face."
412 ;; backward-compatibility alias
424 ()))
425 "Level 2 empty newsgroup face."
427 ;; backward-compatibility alias
439 ()))
440 "Level 3 newsgroup face."
442 ;; backward-compatibility alias
449 ())
452 ())
454 ()))
455 "Level 3 empty newsgroup face."
457 ;; backward-compatibility alias
469 ()))
470 "Level 4 newsgroup face."
472 ;; backward-compatibility alias
479 ())
482 ())
484 ()))
485 "Level 4 empty newsgroup face."
487 ;; backward-compatibility alias
499 ()))
500 "Level 5 newsgroup face."
502 ;; backward-compatibility alias
509 ())
512 ())
514 ()))
515 "Level 5 empty newsgroup face."
517 ;; backward-compatibility alias
529 ()))
530 "Level 6 newsgroup face."
532 ;; backward-compatibility alias
539 ())
542 ())
544 ()))
545 "Level 6 empty newsgroup face."
547 ;; backward-compatibility alias
559 ()))
560 "Low level newsgroup face."
562 ;; backward-compatibility alias
574 ()))
575 "Low level empty newsgroup face."
577 ;; backward-compatibility alias
590 "Level 1 mailgroup face."
592 ;; backward-compatibility alias
605 "Level 1 empty mailgroup face."
607 ;; backward-compatibility alias
620 "Level 2 mailgroup face."
622 ;; backward-compatibility alias
635 "Level 2 empty mailgroup face."
637 ;; backward-compatibility alias
650 "Level 3 mailgroup face."
652 ;; backward-compatibility alias
664 ()))
665 "Level 3 empty mailgroup face."
667 ;; backward-compatibility alias
680 "Low level mailgroup face."
682 ;; backward-compatibility alias
695 "Low level empty mailgroup face."
697 ;; backward-compatibility alias
701 ;; Summary mode faces.
704 "Face used for selected articles."
706 ;; backward-compatibility alias
713 "Face used for cancelled articles."
715 ;; backward-compatibility alias
728 "Face used for high interest ticked articles."
730 ;; backward-compatibility alias
743 "Face used for low interest ticked articles."
745 ;; backward-compatibility alias
757 ()))
758 "Face used for normal interest ticked articles."
760 ;; backward-compatibility alias
773 "Face used for high interest ancient articles."
775 ;; backward-compatibility alias
788 "Face used for low interest ancient articles."
790 ;; backward-compatibility alias
802 ()))
803 "Face used for normal interest ancient articles."
805 ;; backward-compatibility alias
816 "Face used for high interest uncached articles."
818 ;; backward-compatibility alias
829 "Face used for low interest uncached articles."
831 ;; backward-compatibility alias
842 "Face used for normal interest uncached articles."
844 ;; backward-compatibility alias
851 "Face used for high interest unread articles."
853 ;; backward-compatibility alias
860 "Face used for low interest unread articles."
862 ;; backward-compatibility alias
868 ()))
869 "Face used for normal interest unread articles."
871 ;; backward-compatibility alias
886 "Face used for high interest read articles."
888 ;; backward-compatibility alias
903 "Face used for low interest read articles."
905 ;; backward-compatibility alias
917 ()))
918 "Face used for normal interest read articles."
920 ;; backward-compatibility alias
925 ;;;
926 ;;; Gnus buffers
927 ;;;
932 "Do the same as `get-buffer-create', but store the created buffer."
937 "Add the current buffer to the list of Gnus buffers."
941 "Kill BUFFER and remove from the list of Gnus buffers."
948 "Return a list of live Gnus buffers."
957 gnus-buffers)
959 ;;; Splash screen.
973 ()))
974 "Face for the splash screen."
976 ;; backward-compatibility alias
992 "Indent rigidly using only spaces and no tabs."
998 ;; We translate tabs into spaces -- not everybody uses
999 ;; an 8-character tab.
1006 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1030 "*Color styles used for the Gnus logo."
1032 gnus-logo-color-alist))
1042 "Insert startup message in current buffer."
1043 ;; Insert the message.
1049 ;; Make sure the library defining `image-load-path' is loaded
1050 ;; (`find-image' is autoloaded) (and discard the result). Else, we may
1051 ;; get "defvar ignored because image-load-path is let-bound" when calling
1052 ;; `find-image' below.
1062 :color-symbols
1070 ;; Account for the pbm's blackground.
1074 ;; Account for the xbm's blackground.
1085 t))))
1089 _ ___ _ _
1090 _ ___ __ ___ __ _ ___
1091 __ _ ___ __ ___
1092 _ ___ _
1093 _ _ __ _
1094 ___ __ _
1095 __ _
1096 _ _ _
1097 _ _ _
1098 _ _ _
1099 __ ___
1100 _ _ _ _
1101 _ _
1102 _ _
1103 _ _
1104 _
1105 __
1107 "
1109 ;; And then hack it.
1118 ;; Fontify some.
1132 ;;; Do the rest.
1138 "Alist of group parameters.
1140 For example:
1142 (gnus-use-scoring nil)
1143 (gnus-summary-line-format
1145 (gcc-self . t)
1146 (display . all))
1149 (broken-reply-to . t)))"
1156 "If it is t, ignore case of group names specified in `gnus-parameters'.
1157 If it is nil, don't ignore case. If it is `default', which is for the
1158 backward compatibility, use the value of `case-fold-search'."
1169 "Define a group parameter PARAM.
1170 REST is a plist of following:
1171 :type One of `bool', `list' or nil.
1172 :function The name of the function.
1173 :function-document The documentation of the function.
1174 :parameter-type The type for customizing the parameter.
1175 :parameter-document The documentation for the parameter.
1176 :variable The name of the variable.
1177 :variable-document The documentation for the variable.
1178 :variable-group The group for customizing the variable.
1179 :variable-type The type for customizing the variable.
1180 :variable-default The default value of the variable."
1197 'progn
1199 ,variable-document
1205 gnus-group-parameters-more))
1208 ,parameter-type
1212 ,function-document
1214 val)
1217 t)
1222 (,variable
1224 elem value)
1232 ,function-document
1236 elem value)
1243 'value
1248 All other Gnus file and directory variables are initialized from this variable."
1254 "*Directory variable from which all other Gnus file variables are derived.
1256 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1257 This means that other directory variables that are initialized from
1258 this variable won't be set properly if you set this variable in `.gnus.el'.
1259 Set this variable in `.emacs' instead."
1264 "*Default directory for all Gnus buffers."
1267 directory))
1269 ;; Site dependent variables. These variables should be defined in
1270 ;; paths.el.
1273 "Specify a default NNTP server.
1274 This variable should be defined in paths.el, and should never be set
1275 by the user.
1276 If you want to change servers, you should use `gnus-select-method'.
1279 ;; Don't touch this variable.
1282 This is an obsolete variable, which is scarcely used. If you use an
1283 nntp server for your newsgroup and want to change the port number
1284 used to 899, you would say something along these lines:
1289 "A file with only the name of the nntp server in it."
1295 "Find default nntp server.
1296 Check the NNTPSERVER environment variable and the
1297 `gnus-nntpserver-file' file."
1305 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1306 ;; starting or even loading Gnus.
1307 ;;;###autoload(when (fboundp 'custom-autoload)
1308 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1318 gnus-default-nntp-server)
1322 nil
1325 "Default method for selecting a newsgroup.
1326 This variable should be a list, where the first element is how the
1327 news is to be fetched, the second is the address.
1330 NNTP, you could say:
1334 If you want to use your local spool, say:
1336 \(setq gnus-select-method (list 'nnspool (system-name)))
1338 If you use this variable, you must set `gnus-nntp-server' to nil.
1340 There is a lot more to know about select methods and virtual servers -
1341 see the manual for details."
1348 "*Method used for archiving messages you've sent.
1349 This should be a mail method.
1351 See also `gnus-update-message-archive-method'."
1355 gnus-select-method))
1360 The archive method is initially set according to the value of
1362 so that it may be used as a real method of the server which is named
1364 updated if the value of this variable is nil, even if you change the
1365 value of `gnus-message-archive-method' afterward. If you want the
1367 `gnus-message-archive-method', set this variable to a non-nil value."
1374 "*Name of the group in which to save the messages you've written.
1375 This can either be a string; a list of strings; or an alist
1376 of regexps/functions/forms to be evaluated to return a string (or a list
1377 of strings). The functions are called with the name of the current
1378 group (or nil) as a parameter.
1380 If you want to save your mail in one group and the news articles you
1381 write in another group, you could say something like:
1383 \(setq gnus-message-archive-group
1384 '((if (message-news-p)
1388 Normally the group names returned by this variable should be
1390 However, you may wish to store the message on some other server. In
1391 that case, just return a fully prefixed name of the group --
1395 function
1396 sexp
1397 string))
1400 "List of NNTP servers that the user can choose between interactively.
1401 To make Gnus query you for a server, you have to give `gnus' a
1402 non-numeric prefix - `C-u M-x gnus', in short."
1407 "*The name of the host running the NNTP server.
1408 This variable is semi-obsolete. Use the `gnus-select-method'
1409 variable instead."
1412 string))
1415 "A list of secondary methods that will be used for reading news.
1416 This is a list where each element is a complete select method (see
1417 `gnus-select-method').
1419 If, for instance, you want to read your mail with the nnml back end,
1420 you could set this variable:
1428 "Default default new newsgroups the first time Gnus is run.
1432 "Local domain name without a host name.
1433 The DOMAINNAME environment variable is used instead if it is defined.
1434 If the function `system-name' returns the full Internet name, there is
1435 no need to set this variable."
1438 string))
1441 "String with a description of what organization (if any) the user belongs to.
1444 ;; Customization variables
1447 "Preferred method for fetching an article by Message-ID.
1448 If you are reading news from the local spool (with nnspool), fetching
1449 articles by Message-ID is painfully slow. By setting this method to an
1450 nntp method, you might get acceptable results.
1452 The value of this variable must be a valid select method as discussed
1453 in the documentation of `gnus-select-method'.
1455 It can also be a list of select methods, as well as the special symbol
1456 `current', which means to use the current select method. If it is a
1457 list, Gnus will try all the methods in the list until it finds a match."
1462 gnus-select-method
1470 gnus-select-method))))
1474 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1475 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1476 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1477 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1478 "/ftp@rtfm.mit.edu:/pub/usenet/"
1479 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1480 "/ftp@ftp.sunet.se:/pub/usenet/"
1481 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1482 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1484 "*Directory where the group FAQs are stored.
1485 This will most commonly be on a remote machine, and the file will be
1486 fetched by ange-ftp.
1488 This variable can also be a list of directories. In that case, the
1489 first element in the list will be used by default. The others can
1490 be used when being prompted for a site.
1492 Note that Gnus uses an aol machine as the default directory. If this
1493 feels fundamentally unclean, just think of it as a way to finally get
1494 something of value back from them.
1496 If the default site is too slow, try one of these:
1498 North America: mirrors.aol.com /pub/rtfm/usenet
1499 ftp.seas.gwu.edu /pub/rtfm
1500 rtfm.mit.edu /pub/usenet
1501 Europe: ftp.uni-paderborn.de /pub/FAQ
1502 src.doc.ic.ac.uk /usenet/news-FAQS
1503 ftp.sunet.se /pub/usenet
1504 ftp.pasteur.fr /pub/FAQ
1505 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1506 hwarang.postech.ac.kr /pub/usenet
1507 ftp.hk.super.net /mirror/faqs"
1534 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1535 When FORM is evaluated `name' is bound to the name of the group."
1542 "*Non-nil means that control messages are displayed using `browse-url'.
1543 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1544 group."
1550 "*Non-nil means that cross referenced articles will be marked as read.
1551 If nil, ignore cross references. If t, mark articles as read in
1552 subscribed newsgroups. If neither t nor nil, mark as read in all
1553 newsgroups."
1561 "*Process mark."
1567 "*The number of articles which indicates a large newsgroup.
1568 If the number of articles in a newsgroup is greater than this value,
1569 confirmation is required for selecting the newsgroup.
1570 If it is nil, no confirmation is required."
1573 integer))
1576 "*Non-nil means that the default name of a file to save articles in is the group name.
1577 If it's nil, the directory form of the group name is used instead.
1579 If this variable is a list, and the list contains the element
1580 `not-score', long file names will not be used for score files; if it
1581 contains the element `not-save', long file names will not be used for
1582 saving; and if it contains the element `not-kill', long file names
1583 will not be used for kill files.
1585 Note that the default for this variable varies according to what system
1586 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1587 to nil while on all other systems it defaults to t."
1605 "*If non-nil, save group scoring info."
1611 "*If non-nil, allow undoing in Gnus group mode buffers."
1616 "*If non-nil, use some adaptive scoring scheme.
1617 If a list, then the values `word' and `line' are meaningful. The
1618 former will perform adaption on individual words in the subject
1619 header while `line' will perform adaption on several headers."
1625 "*If nil, Gnus will ignore the article cache.
1626 If `passive', it will allow entering (and reading) articles
1627 explicitly entered into the cache. If anything else, use the
1628 cache to the full extent of the law."
1636 "*If non-nil, display a thread tree buffer."
1641 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1642 If it is a number N, then Gnus will only keep the last N articles
1643 read. If it is neither nil nor a number, Gnus will keep all read
1644 articles. This is not a good idea."
1647 integer
1652 "*If non-nil, Gnus will read NoCeM cancel messages.
1653 You can also set this variable to a positive number as a group level.
1654 In that case, Gnus scans NoCeM messages when checking new news if this
1655 value is not exceeding a group level that you specify as the prefix
1656 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1657 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1658 level to those commands."
1667 gnus-level-default-subscribed
1671 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1676 "*If non-nil, enable scoring."
1682 "*A hook called when preparing to exit from the summary buffer.
1683 It calls `gnus-summary-expire-articles' by default."
1688 "*Non-nil means that you are a Usenet novice.
1689 If non-nil, verbose messages may be displayed and confirmations may be
1690 required."
1695 "*Non-nil means that you will never be asked for confirmation about anything.
1696 That doesn't mean *anything* anything; particularly destructive
1697 commands will still require prompting."
1702 "*If non-nil, require your confirmation when catching up a group."
1707 "*If non-nil, require your confirmation when exiting Gnus."
1712 "*Function for extracting address components from a From header.
1713 Two pre-defined function exist: `gnus-extract-address-components',
1714 which is the default, quite fast, and too simplistic solution, and
1715 `mail-extract-address-components', which works much better, but is
1716 slower."
1723 "*If non-nil, display clickable icons."
1728 "String used to separate shell commands."
1758 "*An alist of valid select methods.
1759 The first element of each list lists should be a string with the name
1760 of the select method. The other elements may be the category of
1761 this method (i. e., `post', `mail', `none' or whatever) or other
1762 properties that this method has (like being respoolable).
1763 If you implement a new select method, all you should have to change is
1764 this variable. I think."
1779 "Recomputes the select-method widget based on the value of
1780 `gnus-valid-select-methods'."
1782 "Widget for entering a select method."
1789 gnus-valid-select-methods)
1793 :inline t
1795 variable
1801 "List of buffers that should update their mode lines.
1802 The list may contain the symbols `group', `article', `tree' and
1803 `summary'. If the corresponding symbol is present, Gnus will keep
1804 that mode line updated with information that may be pertinent.
1805 If this variable is nil, screen refresh may be quicker."
1812 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1814 "*Max length of mode-line non-string contents.
1815 If this is nil, Gnus will take space as is needed, leaving the rest
1816 of the mode line intact. Note that the default of nil is unlikely
1817 to be desirable; see the manual for further details."
1820 integer))
1822 ;; There should be special validation for this.
1827 to-address
1828 :function-document
1829 "Return GROUP's to-address."
1830 :variable-document
1831 "*Alist of group regexps and correspondent to-addresses."
1832 :variable-group gnus-group-parameter
1835 This will be used when doing followups and posts.
1837 This is primarily useful in mail groups that represent closed
1838 mailing lists--mailing lists where it's expected that everybody that
1839 writes to the mailing list is subscribed to it. Since using this
1840 parameter ensures that the mail only goes to the mailing list itself,
1841 it means that members won't receive two copies of your followups.
1843 Using `to-address' will actually work whether the group is foreign or
1844 not. Let's say there's a group on the server that is called
1845 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1846 articles from a mail-to-news gateway. Posting directly to this group
1847 is therefore impossible--you have to send mail to the mailing list
1848 address instead.
1850 The gnus-group-split mail splitting mechanism will behave as if this
1854 to-list
1855 :function-document
1856 "Return GROUP's to-list."
1857 :variable-document
1858 "*Alist of group regexps and correspondent to-lists."
1859 :variable-group gnus-group-parameter
1862 This address will be used when doing a `a' in the group.
1864 It is totally ignored when doing a followup--except that if it is
1865 present in a news group, you'll get mail group semantics when doing
1866 `f'.
1868 The gnus-group-split mail splitting mechanism will behave as if this
1872 subscribed
1873 :type bool
1874 :function-document
1875 "Return GROUP's subscription status."
1876 :variable-document
1877 "*Groups which are automatically considered subscribed."
1878 :variable-group gnus-group-parameter
1881 Gnus assumed that you are subscribed to the To/List address.
1883 When constructing a list of subscribed groups using
1884 `gnus-find-subscribed-addresses', Gnus includes the To address given
1888 auto-expire
1889 :type bool
1890 :function gnus-group-auto-expirable-p
1891 :function-document
1892 "Check whether GROUP is auto-expirable or not."
1893 :variable gnus-auto-expirable-newsgroups
1894 :variable-default nil
1895 :variable-document
1896 "*Groups in which to automatically mark read articles as expirable.
1897 If non-nil, this should be a regexp that should match all groups in
1898 which to perform auto-expiry. This only makes sense for mail groups."
1899 :variable-group nnmail-expire
1901 regexp)
1903 :parameter-document
1907 total-expire
1908 :type bool
1909 :function gnus-group-total-expirable-p
1910 :function-document
1911 "Check whether GROUP is total-expirable or not."
1912 :variable gnus-total-expirable-newsgroups
1913 :variable-default nil
1914 :variable-document
1915 "*Groups in which to perform expiry of all read articles.
1916 Use with extreme caution. All groups that match this regexp will be
1917 expiring - which means that all read articles will be deleted after
1918 \(say) one week. (This only goes for mail groups and the like, of
1919 course.)"
1920 :variable-group nnmail-expire
1922 regexp)
1924 :parameter-document
1925 "All read articles will be put through the expiry process
1927 This happens even if they are not marked as expirable.
1931 charset
1932 :function-document
1933 "Return the default charset of GROUP."
1934 :variable gnus-group-charset-alist
1935 :variable-default
1948 :variable-document
1949 "Alist of regexps (to match group names) and default charsets to be used when reading."
1950 :variable-group gnus-charset
1958 post-method
1959 :type list
1960 :function-document
1961 "Return a posting method for GROUP."
1962 :variable gnus-post-method-alist
1963 :variable-document
1964 "Alist of regexps (to match group names) and method to be used when
1965 posting an article."
1966 :variable-group gnus-group-foreign
1967 :parameter-type
1975 :parameter-document
1979 large-newsgroup-initial
1980 :type integer
1981 :function-document
1982 "Return GROUP's initial input of the number of articles."
1983 :variable-document
1984 "*Alist of group regexps and its initial input of the number of articles."
1985 :variable-group gnus-group-parameter
1991 This number will be prompted as the initial value of the number of
1992 articles to list when the group is a large newsgroup (see
1993 `gnus-large-newsgroup'). If it is nil, the default value is the
1996 ;; The Gnus registry's ignored groups
1998 registry-ignore
1999 :type list
2000 :function-document
2001 "Whether this group should be ignored by the registry."
2002 :variable gnus-registry-ignored-groups
2003 :variable-default nil
2004 :variable-document
2005 "*Groups in which the registry should be turned off."
2006 :variable-group gnus-registry
2013 :parameter-document
2016 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
2018 "*Disable the group parameters for spam detection.
2019 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
2026 "Spam group classification (requires spam.el).
2027 This group contains spam messages. On summary entry, unread messages
2028 will be marked as spam. On summary exit, the specified spam
2029 processors will be invoked on spam-marked messages, then those
2030 messages will be expired, so the spam processor will only see a
2034 "The ham value for the spam group parameter (requires spam.el).
2035 On summary exit, the specified ham processors will be invoked on
2036 ham-marked messages. Exercise caution, since the ham processor will
2037 see the same message more than once because there is no ham message
2041 spam-contents
2042 :type list
2043 :function-document
2044 "The spam type (spam, ham, or neither) of the group."
2045 :variable gnus-spam-newsgroup-contents
2046 :variable-default nil
2047 :variable-document
2048 "*Group classification (spam, ham, or neither). Only
2049 meaningful when spam.el is loaded. If non-nil, this should be a
2050 list of group name regexps associated with a classification for
2051 each one. In spam groups, new articles are marked as spam on
2052 summary entry. There is other behavior associated with ham and
2053 no classification when spam.el is loaded - see the manual."
2054 :variable-group spam
2068 :parameter-document
2069 "The spam classification (spam, ham, or neither) of this group.
2070 When a spam group is entered, all unread articles are marked as
2071 spam. There is other behavior associated with ham and no
2075 spam-resend-to
2076 :type list
2077 :function-document
2078 "The address to get spam resent (through spam-report-resend)."
2079 :variable gnus-spam-resend-to
2080 :variable-default nil
2081 :variable-document
2082 "The address to get spam resent (through spam-report-resend)."
2083 :variable-group spam
2087 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2088 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2089 :parameter-document
2093 ham-resend-to
2094 :type list
2095 :function-document
2096 "The address to get ham resent (through spam-report-resend)."
2097 :variable gnus-ham-resend-to
2098 :variable-default nil
2099 :variable-document
2100 "The address to get ham resent (through spam-report-resend)."
2101 :variable-group spam
2105 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2106 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2107 :parameter-document
2123 "OBSOLETE: The Gmane reporting summary exit spam processor.
2130 "OBSOLETE: The ifile summary exit ham processor.
2134 "OBSOLETE: The Bogofilter summary exit ham processor.
2138 "OBSOLETE: The spam-stat summary exit ham processor.
2142 "OBSOLETE: The whitelist summary exit ham processor.
2146 "OBSOLETE: The BBDB summary exit ham processor.
2150 "OBSOLETE: The ham copy exit ham processor.
2154 "OBSOLETE: The spamoracle summary exit ham processor.
2158 spam-process
2159 :type list
2160 :parameter-type
2163 :value nil
2200 :function-document
2201 "Which spam or ham processors will be applied when the summary is exited."
2202 :variable gnus-spam-process-newsgroups
2203 :variable-default nil
2204 :variable-document
2205 "*Groups in which to automatically process spam or ham articles with
2206 a backend on summary exit. If non-nil, this should be a list of group
2207 name regexps that should match all groups in which to do automatic
2208 spam processing, associated with the appropriate processor."
2209 :variable-group spam
2210 :variable-type
2251 :parameter-document
2255 spam-autodetect
2256 :type list
2257 :parameter-type
2259 :function-document
2260 "Should spam be autodetected (with spam-split) in this group?"
2261 :variable gnus-spam-autodetect
2262 :variable-default nil
2263 :variable-document
2264 "*Groups in which spam should be autodetected when they are entered.
2265 Only unseen articles will be examined, unless
2266 spam-autodetect-recheck-messages is set."
2267 :variable-group spam
2268 :variable-type
2273 boolean))
2274 :parameter-document
2275 "Spam autodetection.
2276 Only unseen articles will be examined, unless
2280 spam-autodetect-methods
2281 :type list
2282 :parameter-type
2305 :function-document
2306 "Methods to be used for autodetection in each group"
2307 :variable gnus-spam-autodetect-methods
2308 :variable-default nil
2309 :variable-document
2310 "*Methods for autodetecting spam per group.
2311 Requires the spam-autodetect parameter. Only unseen articles
2312 will be examined, unless spam-autodetect-recheck-messages is
2313 set."
2314 :variable-group spam
2315 :variable-type
2342 :parameter-document
2343 "Spam autodetection methods.
2344 Requires the spam-autodetect parameter. Only unseen articles
2345 will be examined, unless spam-autodetect-recheck-messages is
2349 spam-process-destination
2350 :type list
2351 :parameter-type
2357 :function-document
2358 "Where spam-processed articles will go at summary exit."
2359 :variable gnus-spam-process-destinations
2360 :variable-default nil
2361 :variable-document
2362 "*Groups in which to explicitly send spam-processed articles to
2363 another group, or expire them (the default). If non-nil, this should
2364 be a list of group name regexps that should match all groups in which
2365 to do spam-processed article moving, associated with the destination
2366 group or nil for explicit expiration. This only makes sense for
2367 mail groups."
2368 :variable-group spam
2369 :variable-type
2380 :parameter-document
2384 ham-process-destination
2385 :type list
2386 :parameter-type
2394 :function-document
2395 "Where ham articles will go at summary exit from a spam group."
2396 :variable gnus-ham-process-destinations
2397 :variable-default nil
2398 :variable-document
2399 "*Groups in which to explicitly send ham articles to
2400 another group, or do nothing (the default). If non-nil, this should
2401 be a list of group name regexps that should match all groups in which
2402 to do ham article moving, associated with the destination
2403 group or nil for explicit ignoring. This only makes sense for
2404 mail groups, and only works in spam groups."
2405 :variable-group spam
2406 :variable-type
2418 :parameter-document
2422 ham-marks
2433 :parameter-document
2434 "Marks considered ham (positively not spam). Such articles will be
2435 processed as ham (non-spam) on group exit. When nil, the global
2436 spam-ham-marks variable takes precedence."
2438 gnus-read-mark
2439 gnus-killed-mark
2440 gnus-kill-file-mark
2441 gnus-low-score-mark))))
2442 :variable-group spam
2443 :variable-document
2447 spam-marks
2456 :parameter-document
2457 "Marks considered spam.
2458 Such articles will be processed as spam on group exit. When nil, the global
2459 spam-spam-marks variable takes precedence."
2461 :variable-group spam
2462 :variable-document
2466 "Number of group name elements to leave alone when making a short group name."
2471 "*If non-nil, once you set a level, Gnus will use this level."
2475 ;; Hooks.
2478 "A hook run while Gnus is loaded."
2483 "A hook called to apply kill files to a group.
2484 This hook is intended to apply a kill file to the selected newsgroup.
2485 The function `gnus-apply-kill-file' is called by default.
2487 Since a general kill file is too heavy to use only for a few
2488 newsgroups, I recommend you to use a lighter hook function. For
2489 example, if you'd like to apply a kill file to articles which contains
2490 a string `rmgroup' in subject in newsgroup `control', you can use the
2491 following hook:
2493 (setq gnus-apply-kill-hook
2494 (list
2495 (lambda ()
2504 "Function run when a group level is changed.
2505 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2508 function))
2510 ;;; Face thingies.
2514 mouse-face
2515 summary-menu group-menu article-menu
2516 tree-highlight menu highlight
2517 browse-menu server-menu
2518 page-marker tree-menu binary-menu pick-menu)
2519 "*Enable visual features.
2520 If `visual' is disabled, there will be no menus and few faces. Most of
2521 the visual customization options below will be ignored. Gnus will use
2522 less space and be faster as a result.
2524 This variable can also be a list of visual elements to switch on. For
2525 instance, to switch off all visual things except menus, you can say:
2527 (setq gnus-visual '(menu))
2529 Valid elements include `summary-highlight', `group-highlight',
2530 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2531 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2532 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2552 ;; Byte-compiler warning.
2554 ;; Find out whether the gnus-visual TYPE is wanted.
2558 gnus-visual
2562 t))))
2572 "*Face used for group or summary buffer mouse highlighting.
2573 The line beneath the mouse pointer will be highlighted with this
2574 face."
2587 "Controls use of the agent cache while plugged.
2588 When set, Gnus will prefer using the locally stored content rather
2589 than re-fetching it from the server. You also need to enable
2590 `gnus-agent' for this to have any affect."
2596 "Default charset assumed to be used when viewing non-ASCII characters.
2597 This variable is overridden on a group-to-group basis by the
2598 `gnus-group-charset-alist' variable and is only used on groups not
2599 covered by that variable."
2603 ;; Fixme: Doc reference to agent.
2605 "Whether we want to use the Gnus agent or not.
2607 You may customize gnus-agent to disable its use. However, some
2608 back ends have started to use the agent as a client-side cache.
2609 Disabling the agent may result in noticeable loss of performance."
2615 "Function called by the command `gnus-other-frame'."
2623 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2624 This should be an alist for Emacs, or a plist for XEmacs."
2635 "Which information should be exposed in the User-Agent header.
2637 Can be a list of symbols or a string. Valid symbols are `gnus'
2638 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2639 addition to the Emacs version, you can add `codename' \(show
2640 \(S\)XEmacs codename\) or either `config' \(show system
2641 configuration\) or `type' \(show system type\). If you set it to
2642 a string, be sure to use a valid format, see RFC 2616."
2655 ;; Convert old (< 2005-01-10) symbol type values:
2674 \f
2675 ;;; Internal variables
2680 ; Reset each time gnus-agent-covered-methods is changed else
2681 ; gnus-agent-method-p may mis-report a methods status.
2682 )
2706 ;; Dummy variable.
2709 ;; Variable holding the user answers to all method prompts.
2712 ;; Variable holding the user answers to all mail method prompts.
2715 ;; Variable holding the user answers to all group prompts.
2723 "*The directory where cached articles will be stored."
2729 nnspool "cache"
2753 ;; Propagate flags to server, with the following exceptions:
2754 ;; `seen' is private to each gnus installation
2755 ;; `cache' is a internal gnus flag for each gnus installation
2756 ;; `download' is a agent flag private to each gnus installation
2757 ;; `unsend' are for nndraft groups only
2758 ;; `score' is not a proper mark
2759 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2762 "Marks that shouldn't be propagated to back ends.
2763 Typical marks are those that make no sense in a standalone back end,
2764 such as a mark that says whether an article is stored in the cache
2777 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2802 gnus-newsrc-last-checked-date
2803 gnus-newsrc-alist gnus-server-alist
2804 gnus-killed-list gnus-zombie-list
2805 gnus-topic-topology gnus-topic-alist
2806 gnus-format-specs)
2810 "Assoc list of read articles.
2814 "Assoc list of registry data.
2841 ;; Save window configuration.
2854 ;;; End of variables.
2856 ;; Define some autoload functions Gnus might use.
2859 ;; This little mapcar goes through the list below and marks the
2860 ;; symbols in question as autoloaded functions.
2880 message-send-and-exit message-yank-original)
2884 ;; This is only used in message.el, which has an autoload.
2886 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2888 ;; Next two only used in gnus-util.
2889 rmail-summary-exists rmail-select-summary)
2890 ;; Only used in gnus-util, which has an autoload.
2895 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2896 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2900 gnus-Folder-save-name gnus-folder-save-name)
2903 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2904 gnus-demon-add-disconnection gnus-demon-add-handler
2905 gnus-demon-remove-handler)
2907 gnus-demon-init gnus-demon-cancel)
2909 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2910 gnus-face-from-file)
2912 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2914 gnus-nocem-unwanted-article-p)
2916 gnus-server-server-name)
2919 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2920 gnus-article-hide-citation gnus-article-fill-cited-article
2921 gnus-article-hide-citation-in-followups)
2923 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2924 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2926 gnus-cache-possibly-remove-articles gnus-cache-request-article
2927 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2928 gnus-cache-enter-remove-article gnus-cached-article-p
2929 gnus-cache-open gnus-cache-close gnus-cache-update-article
2930 gnus-cache-articles-in-group)
2932 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2934 gnus-summary-increase-score gnus-summary-set-score
2935 gnus-summary-raise-thread gnus-summary-raise-same-subject
2936 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2937 gnus-summary-lower-thread gnus-summary-lower-same-subject
2938 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2939 gnus-summary-current-score gnus-score-delta-default
2940 gnus-score-flush-cache gnus-score-close
2941 gnus-possibly-score-headers gnus-score-followup-article
2942 gnus-score-followup-thread)
2945 gnus-current-score-file-nondirectory gnus-score-adaptive
2946 gnus-score-find-trace gnus-score-file-name)
2950 gnus-subscribe-topics)
2954 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2955 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2956 gnus-uu-mark-by-regexp gnus-uu-mark-all
2957 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2958 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2959 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2960 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2961 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2962 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2963 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2964 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2967 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2969 gnus-group-post-news gnus-group-mail gnus-group-news
2970 gnus-summary-post-news gnus-summary-news-other-window
2971 gnus-summary-followup gnus-summary-followup-with-original
2972 gnus-summary-cancel-article gnus-summary-supersede-article
2973 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2974 gnus-summary-mail-forward gnus-summary-mail-other-window
2975 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2976 gnus-summary-wide-reply gnus-summary-followup-to-mail
2977 gnus-summary-followup-to-mail-with-original gnus-bug
2978 gnus-summary-wide-reply-with-original
2979 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2980 gnus-summary-post-forward)
2985 gnus-list-of-unread-articles gnus-list-of-read-articles
2986 gnus-offer-save-summaries gnus-make-thread-indent-array
2987 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2988 gnus-summary-skip-intangible gnus-summary-article-number
2989 gnus-data-header gnus-data-find)
2991 gnus-group-list-groups gnus-group-first-unread-group
2992 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2993 gnus-group-setup-buffer gnus-group-get-new-news
2994 gnus-group-make-help-group gnus-group-update-group
2995 gnus-group-iterate gnus-group-group-name)
2997 gnus-backlog-remove-article)
2999 gnus-article-prepare gnus-article-set-window-start
3000 gnus-article-next-page gnus-article-prev-page
3001 gnus-request-article-this-buffer gnus-article-mode
3002 gnus-article-setup-buffer gnus-narrow-to-page
3003 gnus-article-delete-invisible-text gnus-treat-article)
3005 gnus-article-hide-headers gnus-article-hide-boring-headers
3006 gnus-article-treat-overstrike
3007 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
3008 gnus-article-display-x-face gnus-article-de-quoted-unreadable
3009 gnus-article-de-base64-unreadable
3010 gnus-article-decode-HZ
3011 gnus-article-wash-html
3012 gnus-article-unsplit-urls
3013 gnus-article-hide-pem gnus-article-hide-signature
3014 gnus-article-strip-leading-blank-lines gnus-article-date-local
3015 gnus-article-date-original gnus-article-date-lapsed
3016 ;;gnus-article-show-all-headers
3017 gnus-article-edit-mode gnus-article-edit-article
3018 gnus-article-edit-done gnus-article-decode-encoded-words
3019 gnus-start-date-timer gnus-stop-date-timer
3020 gnus-mime-view-all-parts)
3023 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
3024 gnus-check-reasonable-setup)
3026 gnus-dup-enter-articles)
3030 gnus-group-move-group-to-server gnus-change-server)
3034 gnus-async-prefetch-article gnus-async-prefetch-remove-group
3035 gnus-async-halt-prefetch)
3037 gnus-agent-save-active gnus-agent-method-p
3038 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
3039 gnus-summary-set-agent-mark gnus-agent-save-group-info
3040 gnus-agent-request-article gnus-agent-retrieve-headers)
3042 gnus-unplugged gnus-agentize gnus-agent-batch)
3044 gnus-summary-save-article-vm)
3049 gnus-group-split-update)
3052 ;;; gnus-sum.el thingies
3056 "*The format specification of the lines in the summary buffer.
3058 It works along the same lines as a normal formatting string,
3059 with some simple extensions.
3061 %N Article number, left padded with spaces (string)
3062 %S Subject (string)
3064 %n Name of the poster (string)
3065 %a Extracted name of the poster (string)
3066 %A Extracted address of the poster (string)
3067 %F Contents of the From: header (string)
3068 %f Contents of the From: or To: headers (string)
3069 %x Contents of the Xref: header (string)
3070 %D Date of the article (string)
3071 %d Date of the article (string) in DD-MMM format
3072 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
3073 %M Message-id of the article (string)
3074 %r References of the article (string)
3075 %c Number of characters in the article (integer)
3076 %k Pretty-printed version of the above (string)
3078 %L Number of lines in the article (integer)
3079 %I Indentation based on thread level (a string of spaces)
3080 %B A complex trn-style thread tree (string)
3081 The variables `gnus-sum-thread-*' can be used for customization.
3082 %T A string with two possible values: 80 spaces if the article
3083 is on thread level two or larger and 0 spaces on level one
3088 %> Spaces of length thread-level (string)
3089 %< Spaces of length (- 20 thread-level) (string)
3090 %i Article score (number)
3091 %z Article zcore (character)
3092 %t Number of articles under the current thread (number).
3093 %e Whether the thread is empty or not (character).
3094 %V Total thread score (number).
3095 %P The line number (number).
3096 %O Download mark (character).
3097 %* If present, indicates desired cursor position
3098 (instead of after first colon).
3099 %u User defined specifier. The next character in the format string should
3100 be a letter. Gnus will call the function gnus-user-format-function-X,
3101 where X is the letter following %u. The function will be passed the
3102 current header as argument. The function should return a string, which
3103 will be inserted into the summary just like information from any other
3104 summary specifier.
3106 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3107 with care. For reasons of efficiency, Gnus will compute what column
3109 it is invalid to have these specs after a variable-length spec. Well,
3110 you might not be arrested, but your summary buffer will look strange,
3111 which is bad enough.
3113 The smart choice is to have these specs as far to the left as
3114 possible.
3116 This restriction may disappear in later versions of Gnus.
3118 General format specifiers can also be used.
3119 See Info node `(gnus)Formatting Variables'."
3124 ;;;
3125 ;;; Skeleton keymaps
3126 ;;;
3131 (while keys
3132 (define-key keymap (pop keys) 'undefined))))
3134 (defvar gnus-article-mode-map
3135 (let ((keymap (make-sparse-keymap)))
3136 (gnus-suppress-keymap keymap)
3137 keymap))
3138 (defvar gnus-summary-mode-map
3139 (let ((keymap (make-keymap)))
3140 (gnus-suppress-keymap keymap)
3141 keymap))
3142 (defvar gnus-group-mode-map
3143 (let ((keymap (make-keymap)))
3144 (gnus-suppress-keymap keymap)
3145 keymap))
3147 \f
3149 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3150 ;; If you want the cursor to go somewhere else, set these two
3151 ;; functions in some startup hook to whatever you want.
3152 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3153 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3155 ;;; Various macros and substs.
3157 (defun gnus-header-from (header)
3158 (mail-header-from header))
3160 (defmacro gnus-gethash (string hashtable)
3161 "Get hash value of STRING in HASHTABLE."
3162 `(symbol-value (intern-soft ,string ,hashtable)))
3164 (defmacro gnus-gethash-safe (string hashtable)
3165 "Get hash value of STRING in HASHTABLE.
3166 Return nil if not defined."
3167 `(let ((sym (intern-soft ,string ,hashtable)))
3168 (and (boundp sym) (symbol-value sym))))
3170 (defmacro gnus-sethash (string value hashtable)
3171 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3172 `(set (intern ,string ,hashtable) ,value))
3173 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3175 (defmacro gnus-group-unread (group)
3176 "Get the currently computed number of unread articles in GROUP."
3177 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3179 (defmacro gnus-group-entry (group)
3180 "Get the newsrc entry for GROUP."
3181 `(gnus-gethash ,group gnus-newsrc-hashtb))
3183 (defmacro gnus-active (group)
3184 "Get active info on GROUP."
3185 `(gnus-gethash ,group gnus-active-hashtb))
3187 (defmacro gnus-set-active (group active)
3188 "Set GROUP's active info."
3189 `(gnus-sethash ,group ,active gnus-active-hashtb))
3191 ;; Info access macros.
3193 (defmacro gnus-info-group (info)
3194 `(nth 0 ,info))
3195 (defmacro gnus-info-rank (info)
3196 `(nth 1 ,info))
3197 (defmacro gnus-info-read (info)
3198 `(nth 2 ,info))
3199 (defmacro gnus-info-marks (info)
3200 `(nth 3 ,info))
3201 (defmacro gnus-info-method (info)
3202 `(nth 4 ,info))
3203 (defmacro gnus-info-params (info)
3204 `(nth 5 ,info))
3206 (defmacro gnus-info-level (info)
3207 `(let ((rank (gnus-info-rank ,info)))
3208 (if (consp rank)
3209 (car rank)
3210 rank)))
3211 (defmacro gnus-info-score (info)
3212 `(let ((rank (gnus-info-rank ,info)))
3213 (or (and (consp rank) (cdr rank)) 0)))
3215 (defmacro gnus-info-set-group (info group)
3216 `(setcar ,info ,group))
3217 (defmacro gnus-info-set-rank (info rank)
3218 `(setcar (nthcdr 1 ,info) ,rank))
3219 (defmacro gnus-info-set-read (info read)
3220 `(setcar (nthcdr 2 ,info) ,read))
3221 (defmacro gnus-info-set-marks (info marks &optional extend)
3222 (if extend
3223 `(gnus-info-set-entry ,info ,marks 3)
3224 `(setcar (nthcdr 3 ,info) ,marks)))
3225 (defmacro gnus-info-set-method (info method &optional extend)
3226 (if extend
3227 `(gnus-info-set-entry ,info ,method 4)
3228 `(setcar (nthcdr 4 ,info) ,method)))
3229 (defmacro gnus-info-set-params (info params &optional extend)
3230 (if extend
3231 `(gnus-info-set-entry ,info ,params 5)
3232 `(setcar (nthcdr 5 ,info) ,params)))
3234 (defun gnus-info-set-entry (info entry number)
3235 ;; Extend the info until we have enough elements.
3236 (while (<= (length info) number)
3237 (nconc info (list nil)))
3238 ;; Set the entry.
3239 (setcar (nthcdr number info) entry))
3241 (defmacro gnus-info-set-level (info level)
3242 `(let ((rank (cdr ,info)))
3243 (if (consp (car rank))
3244 (setcar (car rank) ,level)
3245 (setcar rank ,level))))
3246 (defmacro gnus-info-set-score (info score)
3247 `(let ((rank (cdr ,info)))
3248 (if (consp (car rank))
3249 (setcdr (car rank) ,score)
3250 (setcar rank (cons (car rank) ,score)))))
3252 (defmacro gnus-get-info (group)
3253 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3255 ;;; Load the compatibility functions.
3257 (require 'gnus-ems)
3259 \f
3260 ;;;
3261 ;;; Shutdown
3262 ;;;
3264 (defvar gnus-shutdown-alist nil)
3266 (defun gnus-add-shutdown (function &rest symbols)
3267 "Run FUNCTION whenever one of SYMBOLS is shut down."
3268 (push (cons function symbols) gnus-shutdown-alist))
3270 (defun gnus-shutdown (symbol)
3271 "Shut down everything that waits for SYMBOL."
3272 (dolist (entry gnus-shutdown-alist)
3273 (when (memq symbol (cdr entry))
3274 (funcall (car entry)))))
3276 \f
3277 ;;;
3278 ;;; Gnus Utility Functions
3279 ;;;
3281 (defun gnus-find-subscribed-addresses ()
3282 "Return a regexp matching the addresses of all subscribed mail groups.
3283 It consists of the `to-address' or `to-list' parameter of all groups
3284 with a `subscribed' parameter."
3285 (let (group address addresses)
3286 (dolist (entry (cdr gnus-newsrc-alist))
3287 (setq group (car entry))
3288 (when (gnus-parameter-subscribed group)
3289 (setq address (mail-strip-quoted-names
3290 (or (gnus-group-fast-parameter group 'to-address)
3291 (gnus-group-fast-parameter group 'to-list))))
3292 (when address
3293 (add-to-list 'addresses address))))
3294 (when addresses
3297 (defmacro gnus-string-or (&rest strings)
3298 "Return the first element of STRINGS that is a non-blank string.
3299 STRINGS will be evaluated in normal `or' order."
3300 `(gnus-string-or-1 ',strings))
3302 (defun gnus-string-or-1 (strings)
3303 (let (string)
3304 (while strings
3305 (setq string (eval (pop strings)))
3307 (setq string nil)
3308 (setq strings nil)))
3309 string))
3311 (defun gnus-version (&optional arg)
3312 "Version number of this version of Gnus.
3313 If ARG, insert string at point."
3314 (interactive "P")
3315 (if arg
3316 (insert (message gnus-version))
3317 (message gnus-version)))
3319 (defun gnus-continuum-version (&optional version)
3320 "Return VERSION as a floating point number."
3321 (interactive)
3322 (unless version
3323 (setq version gnus-version))
3326 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3327 (number (match-string 2 version))
3328 major minor least)
3329 (unless (string-match
3331 (error "Invalid version string: %s" version))
3332 (setq major (string-to-number (match-string 1 number))
3333 minor (string-to-number (match-string 2 number))
3334 least (if (match-beginning 3)
3335 (string-to-number (match-string 3 number))
3336 0))
3337 (string-to-number
3338 (if (zerop major)
3339 (format "%s00%02d%02d"
3340 (if (member alpha '("(ding)" "d"))
3341 "4.99"
3342 (+ 5 (* 0.02
3343 (abs
3344 (- (mm-char-int (aref (downcase alpha) 0))
3345 (mm-char-int ?t))))
3346 -0.01))
3347 minor least)
3348 (format "%d.%02d%02d" major minor least))))))
3350 (defun gnus-info-find-node (&optional nodename)
3351 "Find Info documentation of Gnus."
3352 (interactive)
3353 ;; Enlarge info window if needed.
3354 (let (gnus-info-buffer)
3355 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3356 (setq gnus-info-buffer (current-buffer))
3357 (gnus-configure-windows 'info)))
3359 ;;;
3360 ;;; gnus-interactive
3361 ;;;
3363 (defvar gnus-current-prefix-symbol nil
3364 "Current prefix symbol.")
3366 (defvar gnus-current-prefix-symbols nil
3367 "List of current prefix symbols.")
3369 (defun gnus-interactive (string &optional params)
3370 "Return a list that can be fed to `interactive'.
3371 See `interactive' for full documentation.
3373 Adds the following specs:
3375 y -- The current symbolic prefix.
3376 Y -- A list of the current symbolic prefix(es).
3377 A -- Article number.
3378 H -- Article header.
3379 g -- Group name."
3380 (let ((i 0)
3381 out c prompt)
3382 (while (< i (length string))
3384 (setq c (aref string i))
3385 (when (match-end 1)
3386 (setq prompt (match-string 1 string)))
3387 (setq i (match-end 0))
3388 ;; We basically emulate just about everything that
3389 ;; `interactive' does, but add the specs listed above.
3390 (push
3391 (cond
3392 ((= c ?a)
3393 (completing-read prompt obarray 'fboundp t))
3394 ((= c ?b)
3395 (read-buffer prompt (current-buffer) t))
3396 ((= c ?B)
3397 (read-buffer prompt (other-buffer (current-buffer))))
3398 ((= c ?c)
3399 (read-char))
3400 ((= c ?C)
3401 (completing-read prompt obarray 'commandp t))
3402 ((= c ?d)
3403 (point))
3404 ((= c ?D)
3405 (read-file-name prompt nil default-directory 'lambda))
3406 ((= c ?f)
3407 (read-file-name prompt nil nil 'lambda))
3408 ((= c ?F)
3409 (read-file-name prompt))
3410 ((= c ?k)
3411 (read-key-sequence prompt))
3412 ((= c ?K)
3413 (error "Not implemented spec"))
3414 ((= c ?e)
3415 (error "Not implemented spec"))
3416 ((= c ?m)
3417 (mark))
3418 ((= c ?N)
3419 (error "Not implemented spec"))
3420 ((= c ?n)
3421 (string-to-number (read-from-minibuffer prompt)))
3422 ((= c ?p)
3423 (prefix-numeric-value current-prefix-arg))
3424 ((= c ?P)
3425 current-prefix-arg)
3426 ((= c ?r)
3427 'gnus-prefix-nil)
3428 ((= c ?s)
3429 (read-string prompt))
3430 ((= c ?S)
3431 (intern (read-string prompt)))
3432 ((= c ?v)
3433 (read-variable prompt))
3434 ((= c ?x)
3435 (read-minibuffer prompt))
3436 ((= c ?x)
3437 (eval-minibuffer prompt))
3438 ;; And here the new specs come.
3439 ((= c ?y)
3440 gnus-current-prefix-symbol)
3441 ((= c ?Y)
3442 gnus-current-prefix-symbols)
3443 ((= c ?g)
3444 (gnus-group-group-name))
3445 ((= c ?A)
3446 (gnus-summary-skip-intangible)
3447 (or (get-text-property (point) 'gnus-number)
3448 (gnus-summary-last-subject)))
3449 ((= c ?H)
3450 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3451 (t
3452 (error "Non-implemented spec")))
3453 out)
3454 (cond
3455 ((= c ?r)
3456 (push (if (< (point) (mark)) (point) (mark)) out)
3457 (push (if (> (point) (mark)) (point) (mark)) out))))
3458 (setq out (delq 'gnus-prefix-nil out))
3459 (nreverse out)))
3461 (defun gnus-symbolic-argument (&optional arg)
3462 "Read a symbolic argument and a command, and then execute command."
3463 (interactive "P")
3464 (let* ((in-command (this-command-keys))
3465 (command in-command)
3466 gnus-current-prefix-symbols
3467 gnus-current-prefix-symbol
3468 syms)
3469 (while (equal in-command command)
3470 (message "%s-" (key-description (this-command-keys)))
3471 (push (intern (char-to-string (read-char))) syms)
3472 (setq command (read-key-sequence nil t)))
3473 (setq gnus-current-prefix-symbols (nreverse syms)
3474 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3475 (call-interactively (key-binding command t))))
3477 ;;; More various functions.
3479 (defsubst gnus-check-backend-function (func group)
3480 "Check whether GROUP supports function FUNC.
3481 GROUP can either be a string (a group name) or a select method."
3482 (ignore-errors
3483 (let ((method (if (stringp group)
3484 (car (gnus-find-method-for-group group))
3485 group)))
3486 (unless (featurep method)
3487 (require method))
3488 (fboundp (intern (format "%s-%s" method func))))))
3490 (defun gnus-group-read-only-p (&optional group)
3491 "Check whether GROUP supports editing or not.
3492 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3493 that that variable is buffer-local to the summary buffers."
3494 (let ((group (or group gnus-newsgroup-name)))
3495 (not (gnus-check-backend-function 'request-replace-article group))))
3497 (defun gnus-virtual-group-p (group)
3498 "Say whether GROUP is virtual or not."
3499 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3500 gnus-valid-select-methods)))
3502 (defun gnus-news-group-p (group &optional article)
3503 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3504 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3505 t) ;is news of course.
3506 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3507 nil) ;must be mail then.
3508 ((vectorp article) ;Has header info.
3509 (eq (gnus-request-type group (mail-header-id article)) 'news))
3510 ((null article) ;Hasn't header info
3511 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3512 ((< article 0) ;Virtual message
3513 nil) ;we don't know, guess mail.
3514 (t ;Has positive number
3515 (eq (gnus-request-type group article) 'news)))) ;use it.
3517 ;; Returns a list of writable groups.
3518 (defun gnus-writable-groups ()
3519 (let ((alist gnus-newsrc-alist)
3520 groups group)
3521 (while (setq group (car (pop alist)))
3522 (unless (gnus-group-read-only-p group)
3523 (push group groups)))
3524 (nreverse groups)))
3526 ;; Check whether to use long file names.
3527 (defun gnus-use-long-file-name (symbol)
3528 ;; The variable has to be set...
3529 (and gnus-use-long-file-name
3530 ;; If it isn't a list, then we return t.
3531 (or (not (listp gnus-use-long-file-name))
3532 ;; If it is a list, and the list contains `symbol', we
3533 ;; return nil.
3534 (not (memq symbol gnus-use-long-file-name)))))
3536 ;; Generate a unique new group name.
3537 (defun gnus-generate-new-group-name (leaf)
3538 (let ((name leaf)
3539 (num 0))
3540 (while (gnus-group-entry name)
3541 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3542 name))
3544 (defun gnus-ephemeral-group-p (group)
3545 "Say whether GROUP is ephemeral or not."
3546 (gnus-group-get-parameter group 'quit-config t))
3548 (defun gnus-group-quit-config (group)
3549 "Return the quit-config of GROUP."
3550 (gnus-group-get-parameter group 'quit-config t))
3552 (defun gnus-kill-ephemeral-group (group)
3553 "Remove ephemeral GROUP from relevant structures."
3554 (gnus-sethash group nil gnus-newsrc-hashtb))
3556 (defun gnus-simplify-mode-line ()
3557 "Make mode lines a bit simpler."
3558 (setq mode-line-modified (cdr gnus-mode-line-modified))
3559 (when (listp mode-line-format)
3560 (make-local-variable 'mode-line-format)
3561 (setq mode-line-format (copy-sequence mode-line-format))
3562 (when (equal (nth 3 mode-line-format) " ")
3563 (setcar (nthcdr 3 mode-line-format) " "))))
3565 ;;; Servers and groups.
3567 (defsubst gnus-server-add-address (method)
3568 (let ((method-name (symbol-name (car method))))
3569 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3570 (not (assq (intern (concat method-name "-address")) method))
3571 (memq 'physical-address (assq (car method)
3572 gnus-valid-select-methods)))
3573 (append method (list (list (intern (concat method-name "-address"))
3574 (nth 1 method))))
3575 method)))
3577 (defsubst gnus-method-to-server (method &optional nocache)
3578 (catch 'server-name
3579 (setq method (or method gnus-select-method))
3581 ;; Perhaps it is already in the cache.
3582 (unless nocache
3583 (mapc (lambda (name-method)
3584 (if (equal (cdr name-method) method)
3585 (throw 'server-name (car name-method))))
3586 gnus-server-method-cache))
3588 (mapc
3589 (lambda (server-alist)
3590 (mapc (lambda (name-method)
3591 (when (gnus-methods-equal-p (cdr name-method) method)
3592 (unless (member name-method gnus-server-method-cache)
3593 (push name-method gnus-server-method-cache))
3594 (throw 'server-name (car name-method))))
3595 server-alist))
3596 (list gnus-server-alist
3597 gnus-predefined-server-alist))
3599 (let* ((name (if (member (cadr method) '(nil ""))
3600 (format "%s" (car method))
3601 (format "%s:%s" (car method) (cadr method))))
3602 (name-method (cons name method)))
3603 (unless (member name-method gnus-server-method-cache)
3604 (push name-method gnus-server-method-cache))
3605 name)))
3607 (defsubst gnus-server-to-method (server)
3608 "Map virtual server names to select methods."
3609 (or (and server (listp server) server)
3610 (cdr (assoc server gnus-server-method-cache))
3611 (let ((result
3612 (or
3613 ;; Perhaps this is the native server?
3614 (and (equal server "native") gnus-select-method)
3615 ;; It should be in the server alist.
3616 (cdr (assoc server gnus-server-alist))
3617 ;; It could be in the predefined server alist.
3618 (cdr (assoc server gnus-predefined-server-alist))
3619 ;; If not, we look through all the opened server
3620 ;; to see whether we can find it there.
3621 (let ((opened gnus-opened-servers))
3622 (while (and opened
3623 (not (equal server (format "%s:%s" (caaar opened)
3624 (cadaar opened)))))
3625 (pop opened))
3626 (caar opened))
3627 ;; It could be a named method, search all servers
3628 (let ((servers gnus-secondary-select-methods))
3629 (while (and servers
3630 (not (equal server (format "%s:%s" (caar servers)
3631 (cadar servers)))))
3632 (pop servers))
3633 (car servers))
3634 ;; This could be some sort of foreign server that I
3635 ;; simply haven't opened (yet). Do a brute-force scan
3636 ;; of the entire gnus-newsrc-alist for the server name
3637 ;; of every method. As a side-effect, loads the
3638 ;; gnus-server-method-cache so this only happens once,
3639 ;; if at all.
3640 (let ((alist (cdr gnus-newsrc-alist))
3641 method match)
3642 (while alist
3643 (setq method (gnus-info-method (pop alist)))
3644 (when (and (not (stringp method))
3645 (equal server (gnus-method-to-server method)))
3646 (setq match method
3647 alist nil)))
3648 match))))
3649 (when result
3650 (push (cons server result) gnus-server-method-cache))
3651 result)))
3653 (defsubst gnus-server-get-method (group method)
3654 ;; Input either a server name, and extended server name, or a
3655 ;; select method, and return a select method.
3656 (cond ((stringp method)
3657 (gnus-server-to-method method))
3658 ((equal method gnus-select-method)
3659 gnus-select-method)
3660 ((and (stringp (car method))
3661 group)
3662 (gnus-server-extend-method group method))
3663 ((and method
3664 (not group)
3665 (equal (cadr method) ""))
3666 method)
3667 (t
3668 (gnus-server-add-address method))))
3670 (defmacro gnus-method-equal (ss1 ss2)
3671 "Say whether two servers are equal."
3672 `(let ((s1 ,ss1)
3673 (s2 ,ss2))
3674 (or (equal s1 s2)
3675 (and (= (length s1) (length s2))
3676 (progn
3677 (while (and s1 (member (car s1) s2))
3678 (setq s1 (cdr s1)))
3679 (null s1))))))
3681 (defun gnus-methods-equal-p (m1 m2)
3682 (let ((m1 (or m1 gnus-select-method))
3683 (m2 (or m2 gnus-select-method)))
3684 (or (equal m1 m2)
3685 (and (eq (car m1) (car m2))
3686 (or (not (memq 'address (assoc (symbol-name (car m1))
3687 gnus-valid-select-methods)))
3688 (equal (nth 1 m1) (nth 1 m2)))))))
3690 (defun gnus-server-equal (m1 m2)
3691 "Say whether two methods are equal."
3692 (let ((m1 (cond ((null m1) gnus-select-method)
3693 ((stringp m1) (gnus-server-to-method m1))
3694 (t m1)))
3695 (m2 (cond ((null m2) gnus-select-method)
3696 ((stringp m2) (gnus-server-to-method m2))
3697 (t m2))))
3698 (gnus-method-equal m1 m2)))
3700 (defun gnus-servers-using-backend (backend)
3701 "Return a list of known servers using BACKEND."
3702 (let ((opened gnus-opened-servers)
3703 out)
3704 (while opened
3705 (when (eq backend (caaar opened))
3706 (push (caar opened) out))
3707 (pop opened))
3708 out))
3710 (defun gnus-archive-server-wanted-p ()
3711 "Say whether the user wants to use the archive server."
3712 (cond
3713 ((or (not gnus-message-archive-method)
3714 (not gnus-message-archive-group))
3715 nil)
3716 ((and gnus-message-archive-method gnus-message-archive-group)
3717 t)
3718 (t
3719 (let ((active (cadr (assq 'nnfolder-active-file
3720 gnus-message-archive-method))))
3721 (and active
3722 (file-exists-p active))))))
3724 (defsubst gnus-method-to-server-name (method)
3725 (concat
3726 (format "%s" (car method))
3727 (when (and
3728 (or (assoc (format "%s" (car method))
3729 (gnus-methods-using 'address))
3730 (gnus-server-equal method gnus-message-archive-method))
3731 (nth 1 method)
3732 (not (string= (nth 1 method) "")))
3733 (concat "+" (nth 1 method)))))
3735 (defsubst gnus-method-to-full-server-name (method)
3736 (format "%s+%s" (car method) (nth 1 method)))
3738 (defun gnus-group-prefixed-name (group method &optional full)
3739 "Return the whole name from GROUP and METHOD.
3740 Call with full set to get the fully qualified group name (even if the
3741 server is native)."
3742 (when (stringp method)
3743 (setq method (gnus-server-to-method method)))
3744 (if (or (not method)
3745 (and (not full) (gnus-server-equal method "native"))
3746 ;;;!!! This might not be right. We'll see...
3747 ;(string-match ":" group)
3748 )
3749 group
3750 (concat (gnus-method-to-server-name method) ":" group)))
3752 (defun gnus-group-guess-prefixed-name (group)
3753 "Guess the whole name from GROUP and METHOD."
3754 (gnus-group-prefixed-name group (gnus-find-method-for-group
3755 group)))
3757 (defun gnus-group-full-name (group method)
3758 "Return the full name from GROUP and METHOD, even if the method is native."
3759 (gnus-group-prefixed-name group method t))
3761 (defun gnus-group-guess-full-name (group)
3762 "Guess the full name from GROUP, even if the method is native."
3763 (if (gnus-group-prefixed-p group)
3764 group
3765 (gnus-group-full-name group (gnus-find-method-for-group group))))
3767 (defun gnus-group-guess-full-name-from-command-method (group)
3768 "Guess the full name from GROUP, even if the method is native."
3769 (if (gnus-group-prefixed-p group)
3770 group
3771 (gnus-group-full-name group gnus-command-method)))
3773 (defun gnus-group-real-prefix (group)
3774 "Return the prefix of the current group name."
3775 (if (stringp group)
3776 (if (string-match "^[^:]+:" group)
3777 (substring group 0 (match-end 0))
3778 "")
3779 nil))
3781 (defun gnus-group-short-name (group)
3782 "Return the short group name."
3783 (let ((prefix (gnus-group-real-prefix group)))
3784 (if (< 0 (length prefix))
3785 (substring group (length prefix) nil)
3786 group)))
3788 (defun gnus-group-prefixed-p (group)
3789 "Return the prefix of the current group name."
3790 (< 0 (length (gnus-group-real-prefix group))))
3792 (declare-function gnus-group-decoded-name "gnus-group" (string))
3794 (defun gnus-summary-buffer-name (group)
3795 "Return the summary buffer name of GROUP."
3796 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3798 (defun gnus-group-method (group)
3799 "Return the server or method used for selecting GROUP.
3800 You should probably use `gnus-find-method-for-group' instead."
3801 (let ((prefix (gnus-group-real-prefix group)))
3802 (if (equal prefix "")
3803 gnus-select-method
3804 (let ((servers gnus-opened-servers)
3805 (server "")
3806 backend possible found)
3808 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3809 server (substring prefix (match-end 0) (1- (length prefix))))
3810 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3811 (while servers
3812 (when (eq (caaar servers) backend)
3813 (setq possible (caar servers))
3814 (when (equal (cadaar servers) server)
3815 (setq found (caar servers))))
3816 (pop servers))
3817 (or (car (rassoc found gnus-server-alist))
3818 found
3819 (car (rassoc possible gnus-server-alist))
3820 possible
3821 (list backend server))))))
3823 (defsubst gnus-native-method-p (method)
3824 "Return whether METHOD is the native select method."
3825 (gnus-method-equal method gnus-select-method))
3827 (defsubst gnus-secondary-method-p (method)
3828 "Return whether METHOD is a secondary select method."
3829 (let ((methods gnus-secondary-select-methods)
3830 (gmethod (inline (gnus-server-get-method nil method))))
3831 (while (and methods
3832 (not (gnus-method-equal
3833 (inline (gnus-server-get-method nil (car methods)))
3834 gmethod)))
3835 (setq methods (cdr methods)))
3836 methods))
3838 (defun gnus-method-simplify (method)
3839 "Return the shortest uniquely identifying string or method for METHOD."
3840 (cond ((stringp method)
3841 method)
3842 ((gnus-native-method-p method)
3843 nil)
3844 ((gnus-secondary-method-p method)
3845 (format "%s:%s" (nth 0 method) (nth 1 method)))
3846 (t
3847 method)))
3849 (defun gnus-groups-from-server (server)
3850 "Return a list of all groups that are fetched from SERVER."
3851 (let ((alist (cdr gnus-newsrc-alist))
3852 info groups)
3853 (while (setq info (pop alist))
3854 (when (gnus-server-equal (gnus-info-method info) server)
3855 (push (gnus-info-group info) groups)))
3856 (sort groups 'string<)))
3858 (defun gnus-group-foreign-p (group)
3859 "Say whether a group is foreign or not."
3860 (and (not (gnus-group-native-p group))
3861 (not (gnus-group-secondary-p group))))
3863 (defun gnus-group-native-p (group)
3864 "Say whether the group is native or not."
3865 (not (string-match ":" group)))
3867 (defun gnus-group-secondary-p (group)
3868 "Say whether the group is secondary or not."
3869 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3871 (defun gnus-parameters-get-parameter (group)
3872 "Return the group parameters for GROUP from `gnus-parameters'."
3873 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3874 case-fold-search
3875 gnus-parameters-case-fold-search))
3876 params-list)
3877 (dolist (elem gnus-parameters)
3878 (when (string-match (car elem) group)
3879 (setq params-list
3880 (nconc (gnus-expand-group-parameters
3881 (car elem) (cdr elem) group)
3882 params-list))))
3883 params-list))
3885 (defun gnus-expand-group-parameter (match value group)
3886 "Use MATCH to expand VALUE in GROUP."
3887 (with-temp-buffer
3888 (insert group)
3889 (goto-char (point-min))
3890 (while (re-search-forward match nil t)
3891 (replace-match value))
3892 (buffer-string)))
3894 (defun gnus-expand-group-parameters (match parameters group)
3895 "Go through PARAMETERS and expand them according to the match data."
3896 (let (new)
3897 (dolist (elem parameters)
3898 (if (and (stringp (cdr elem))
3900 (push (cons (car elem)
3901 (gnus-expand-group-parameter match (cdr elem) group))
3902 new)
3903 (push elem new)))
3904 new))
3906 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3907 "For GROUP, return the value of SYMBOL.
3909 You should call this in the `gnus-group-buffer' buffer.
3910 The function `gnus-group-find-parameter' will do that for you."
3911 ;; The speed trick: No cons'ing and quit early.
3912 (let* ((params (funcall gnus-group-get-parameter-function group))
3913 ;; Start easy, check the "real" group parameters.
3914 (simple-results
3915 (gnus-group-parameter-value params symbol allow-list t)))
3916 (if simple-results
3917 ;; Found results; return them.
3918 (car simple-results)
3919 ;; We didn't find it there, try `gnus-parameters'.
3920 (let ((result nil)
3921 (head nil)
3922 (tail gnus-parameters))
3923 ;; A good old-fashioned non-cl loop.
3924 (while tail
3925 (setq head (car tail)
3926 tail (cdr tail))
3927 ;; The car is regexp matching for matching the group name.
3928 (when (string-match (car head) group)
3929 ;; The cdr is the parameters.
3930 (setq result (gnus-group-parameter-value (cdr head)
3931 symbol allow-list))
3932 (when result
3933 ;; Expand if necessary.
3935 (setq result (gnus-expand-group-parameter (car head)
3936 result group)))
3937 ;; Exit the loop early.
3938 (setq tail nil))))
3939 ;; Done.
3940 result))))
3942 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3943 "Return the group parameters for GROUP.
3944 If SYMBOL, return the value of that symbol in the group parameters.
3946 If you call this function inside a loop, consider using the faster
3947 `gnus-group-fast-parameter' instead."
3948 (save-excursion
3949 (set-buffer gnus-group-buffer)
3950 (if symbol
3951 (gnus-group-fast-parameter group symbol allow-list)
3952 (nconc
3953 (copy-sequence
3954 (funcall gnus-group-get-parameter-function group))
3955 (gnus-parameters-get-parameter group)))))
3957 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3958 "Return the group parameters for GROUP.
3959 If SYMBOL, return the value of that symbol in the group parameters.
3960 If ALLOW-LIST, also allow list as a result.
3961 Most functions should use `gnus-group-find-parameter', which
3962 also examines the topic parameters."
3963 (let ((params (gnus-info-params (gnus-get-info group))))
3964 (if symbol
3965 (gnus-group-parameter-value params symbol allow-list)
3966 params)))
3968 (defun gnus-group-parameter-value (params symbol &optional
3969 allow-list present-p)
3970 "Return the value of SYMBOL in group PARAMS.
3971 If ALLOW-LIST, also allow list as a result."
3972 ;; We only wish to return group parameters (dotted lists) and
3973 ;; not local variables, which may have the same names.
3974 ;; But first we handle single elements...
3975 (or (car (memq symbol params))
3976 ;; Handle alist.
3977 (let (elem)
3978 (catch 'found
3979 (while (setq elem (pop params))
3980 (when (and (consp elem)
3981 (eq (car elem) symbol)
3982 (or allow-list
3983 (atom (cdr elem))))
3984 (throw 'found (if present-p (list (cdr elem))
3985 (cdr elem)))))))))
3987 (defun gnus-group-add-parameter (group param)
3988 "Add parameter PARAM to GROUP."
3989 (let ((info (gnus-get-info group)))
3990 (when info
3991 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3992 ;; Cons the new param to the old one and update.
3993 (gnus-group-set-info (cons param (gnus-info-params info))
3994 group 'params))))
3996 (defun gnus-group-set-parameter (group name value)
3997 "Set parameter NAME to VALUE in GROUP."
3998 (let ((info (gnus-get-info group)))
3999 (when info
4000 (gnus-group-remove-parameter group name)
4001 (let ((old-params (gnus-info-params info))
4002 (new-params (list (cons name value))))
4003 (while old-params
4004 (when (or (not (listp (car old-params)))
4005 (not (eq (caar old-params) name)))
4006 (setq new-params (append new-params (list (car old-params)))))
4007 (setq old-params (cdr old-params)))
4008 (gnus-group-set-info new-params group 'params)))))
4010 (defun gnus-group-remove-parameter (group name)
4011 "Remove parameter NAME from GROUP."
4012 (let ((info (gnus-get-info group)))
4013 (when info
4014 (let ((params (gnus-info-params info)))
4015 (when params
4016 (setq params (delq name params))
4017 (while (assq name params)
4018 (gnus-pull name params))
4019 (gnus-info-set-params info params))))))
4021 (defun gnus-group-add-score (group &optional score)
4022 "Add SCORE to the GROUP score.
4023 If SCORE is nil, add 1 to the score of GROUP."
4024 (let ((info (gnus-get-info group)))
4025 (when info
4026 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
4028 (defun gnus-short-group-name (group &optional levels)
4029 "Collapse GROUP name LEVELS.
4030 Select methods are stripped and any remote host name is stripped down to
4031 just the host name."
4032 (let* ((name "")
4033 (foreign "")
4034 (depth 0)
4035 (skip 1)
4036 (levels (or levels
4037 gnus-group-uncollapsed-levels
4038 (progn
4040 (setq skip (match-end 0)
4041 depth (+ depth 1)))
4042 depth))))
4043 ;; Separate foreign select method from group name and collapse.
4044 ;; If method contains a server, collapse to non-domain server name,
4045 ;; otherwise collapse to select method.
4046 (let* ((colon (string-match ":" group))
4047 (server (and colon (substring group 0 colon)))
4048 (plus (and server (string-match "+" server))))
4049 (when server
4050 (if plus
4051 (setq foreign (substring server (+ 1 plus)
4053 group (substring group (+ 1 colon)))
4054 (setq foreign server
4055 group (substring group (+ 1 colon))))
4056 (setq foreign (concat foreign ":")))
4057 ;; Collapse group name leaving LEVELS uncollapsed elements
4058 (let* ((slist (split-string group "/"))
4059 (slen (length slist))
4061 (dlen (length dlist))
4062 glist
4063 glen
4064 gsep
4065 res)
4066 (if (> slen dlen)
4067 (setq glist slist
4068 glen slen
4069 gsep "/")
4070 (setq glist dlist
4071 glen dlen
4072 gsep "."))
4073 (setq levels (- glen levels))
4074 (dolist (g glist)
4075 (push (if (>= (decf levels) 0)
4076 (if (zerop (length g))
4077 ""
4078 (substring g 0 1))
4079 g)
4080 res))
4081 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4083 (defun gnus-narrow-to-body ()
4084 "Narrow to the body of an article."
4085 (narrow-to-region
4086 (progn
4087 (goto-char (point-min))
4089 (point-max)))
4090 (point-max)))
4092 \f
4093 ;;;
4094 ;;; Kill file handling.
4095 ;;;
4097 (defun gnus-apply-kill-file ()
4098 "Apply a kill file to the current newsgroup.
4099 Returns the number of articles marked as read."
4100 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4101 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4102 (gnus-apply-kill-file-internal)
4103 0))
4105 (defun gnus-kill-save-kill-buffer ()
4106 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4107 (when (get-file-buffer file)
4108 (save-excursion
4109 (set-buffer (get-file-buffer file))
4110 (when (buffer-modified-p)
4111 (save-buffer))
4112 (kill-buffer (current-buffer))))))
4114 (defcustom gnus-kill-file-name "KILL"
4115 "Suffix of the kill files."
4116 :group 'gnus-score-kill
4117 :group 'gnus-score-files
4118 :type 'string)
4120 (defun gnus-newsgroup-kill-file (newsgroup)
4121 "Return the name of a kill file name for NEWSGROUP.
4122 If NEWSGROUP is nil, return the global kill file name instead."
4123 (cond
4124 ;; The global KILL file is placed at top of the directory.
4125 ((or (null newsgroup)
4126 (string-equal newsgroup ""))
4127 (expand-file-name gnus-kill-file-name
4128 gnus-kill-files-directory))
4129 ;; Append ".KILL" to newsgroup name.
4130 ((gnus-use-long-file-name 'not-kill)
4131 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4132 "." gnus-kill-file-name)
4133 gnus-kill-files-directory))
4134 ;; Place "KILL" under the hierarchical directory.
4135 (t
4136 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4137 "/" gnus-kill-file-name)
4138 gnus-kill-files-directory))))
4140 ;;; Server things.
4142 (defun gnus-member-of-valid (symbol group)
4144 (memq symbol (assoc
4145 (symbol-name (car (gnus-find-method-for-group group)))
4146 gnus-valid-select-methods)))
4148 (defun gnus-method-option-p (method option)
4149 "Return non-nil if select METHOD has OPTION as a parameter."
4150 (when (stringp method)
4151 (setq method (gnus-server-to-method method)))
4152 (memq option (assoc (format "%s" (car method))
4153 gnus-valid-select-methods)))
4155 (defun gnus-similar-server-opened (method)
4156 (let ((opened gnus-opened-servers))
4157 (while (and method opened)
4158 (when (and (equal (cadr method) (cadaar opened))
4159 (equal (car method) (caaar opened))
4160 (not (equal method (caar opened))))
4161 (setq method nil))
4162 (pop opened))
4163 (not method)))
4165 (defun gnus-server-extend-method (group method)
4166 ;; This function "extends" a virtual server. If the server is
4167 ;; "hello", and the select method is ("hello" (my-var "something"))
4168 ;; in the group "alt.alt", this will result in a new virtual server
4169 ;; called "hello+alt.alt".
4170 (if (or (not (inline (gnus-similar-server-opened method)))
4171 (not (cddr method)))
4172 method
4173 `(,(car method) ,(concat (cadr method) "+" group)
4174 (,(intern (format "%s-address" (car method))) ,(cadr method))
4175 ,@(cddr method))))
4177 (defun gnus-server-status (method)
4178 "Return the status of METHOD."
4179 (nth 1 (assoc method gnus-opened-servers)))
4181 (defun gnus-group-name-to-method (group)
4182 "Guess a select method based on GROUP."
4183 (if (string-match ":" group)
4184 (let ((server (substring group 0 (match-beginning 0))))
4186 (list (intern (substring server 0 (match-beginning 0)))
4187 (substring server (match-end 0)))
4188 (list (intern server) "")))
4189 gnus-select-method))
4191 (defun gnus-server-string (server)
4192 "Return a readable string that describes SERVER."
4193 (let* ((server (gnus-server-to-method server))
4194 (address (nth 1 server)))
4195 (if (and address
4196 (not (zerop (length address))))
4197 (format "%s using %s" address (car server))
4198 (format "%s" (car server)))))
4200 (defun gnus-find-method-for-group (group &optional info)
4201 "Find the select method that GROUP uses."
4202 (or gnus-override-method
4203 (and (not group)
4204 gnus-select-method)
4205 (and (not (gnus-group-entry group))
4206 ;; Killed or otherwise unknown group.
4207 (or
4208 ;; If we know a virtual server by that name, return its method.
4209 (gnus-server-to-method (gnus-group-server group))
4210 ;; Guess a new method as last resort.
4211 (gnus-group-name-to-method group)))
4212 (let ((info (or info (gnus-get-info group)))
4213 method)
4214 (if (or (not info)
4215 (not (setq method (gnus-info-method info)))
4216 (equal method "native"))
4217 gnus-select-method
4218 (setq method
4219 (cond ((stringp method)
4220 (inline (gnus-server-to-method method)))
4221 ((stringp (cadr method))
4222 (inline (gnus-server-extend-method group method)))
4223 (t
4224 method)))
4225 (cond ((equal (cadr method) "")
4226 method)
4227 ((null (cadr method))
4228 (list (car method) ""))
4229 (t
4230 (gnus-server-add-address method)))))))
4232 (defun gnus-methods-using (feature)
4233 "Find all methods that have FEATURE."
4234 (let ((valids gnus-valid-select-methods)
4235 outs)
4236 (while valids
4237 (when (memq feature (car valids))
4238 (push (car valids) outs))
4239 (setq valids (cdr valids)))
4240 outs))
4242 (eval-and-compile
4243 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4245 (defun gnus-read-group (prompt &optional default)
4246 "Prompt the user for a group name.
4247 Disallow invalid group names."
4248 (let ((prefix "")
4249 group)
4250 (while (not group)
4251 (when (string-match
4252 gnus-invalid-group-regexp
4253 (setq group (read-string (concat prefix prompt)
4254 (cons (or default "") 0)
4255 'gnus-group-history)))
4256 (let ((match (match-string 0 group)))
4257 ;; Might be okay (e.g. for nnimap), so ask the user:
4259 (message-y-or-n-p
4260 "Proceed and create group anyway? " t
4263 Usually, it's dangerous to create a group with this name, because it's not
4264 supported by all back ends and servers. On IMAP servers it should work,
4265 though. If you are really sure, you can proceed anyway and create the group.
4267 You may customize the variable `gnus-invalid-group-regexp', which currently is
4271 group nil)))))
4272 group))
4274 (defun gnus-read-method (prompt)
4275 "Prompt the user for a method.
4276 Allow completion over sensible values."
4277 (let* ((open-servers
4278 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4279 gnus-opened-servers))
4280 (valid-methods
4281 (let (methods)
4282 (dolist (method gnus-valid-select-methods)
4283 (if (or (memq 'prompt-address method)
4284 (not (assoc (format "%s:" (car method)) open-servers)))
4285 (push method methods)))
4286 methods))
4287 (servers
4288 (append valid-methods
4289 open-servers
4290 gnus-predefined-server-alist
4291 gnus-server-alist))
4292 (method
4293 (completing-read
4294 prompt servers
4295 nil t nil 'gnus-method-history)))
4296 (cond
4297 ((equal method "")
4298 (setq method gnus-select-method))
4299 ((assoc method gnus-valid-select-methods)
4300 (let ((address (if (memq 'prompt-address
4301 (assoc method gnus-valid-select-methods))
4302 (read-string "Address: ")
4303 "")))
4304 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4305 (list (intern method) address))))
4306 ((assoc method servers)
4307 method)
4308 (t
4309 (list (intern method) "")))))
4311 ;;; Agent functions
4313 (defun gnus-agent-method-p (method-or-server)
4314 "Say whether METHOD is covered by the agent."
4315 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4316 (let* ((method (if (stringp method-or-server)
4317 (gnus-server-to-method method-or-server)
4318 method-or-server))
4319 (server (gnus-method-to-server method t)))
4320 (setq gnus-agent-method-p-cache
4321 (cons method-or-server
4322 (member server gnus-agent-covered-methods)))))
4323 (cdr gnus-agent-method-p-cache))
4325 (defun gnus-online (method)
4326 (not
4327 (if gnus-plugged
4328 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4329 (gnus-agent-method-p method))))
4331 ;;; User-level commands.
4333 ;;;###autoload
4334 (defun gnus-slave-no-server (&optional arg)
4335 "Read network news as a slave, without connecting to the local server."
4336 (interactive "P")
4337 (gnus-no-server arg t))
4339 ;;;###autoload
4340 (defun gnus-no-server (&optional arg slave)
4341 "Read network news.
4342 If ARG is a positive number, Gnus will use that as the startup
4343 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4344 non-nil and not a positive number, Gnus will prompt the user for the
4345 name of an NNTP server to use.
4346 As opposed to `gnus', this command will not connect to the local
4347 server."
4348 (interactive "P")
4349 (gnus-no-server-1 arg slave))
4351 ;;;###autoload
4352 (defun gnus-slave (&optional arg)
4353 "Read news as a slave."
4354 (interactive "P")
4355 (gnus arg nil 'slave))
4357 ;;;###autoload
4358 (defun gnus-other-frame (&optional arg display)
4359 "Pop up a frame to read news.
4360 This will call one of the Gnus commands which is specified by the user
4361 option `gnus-other-frame-function' (default `gnus') with the argument
4362 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4363 optional second argument DISPLAY should be a standard display string
4365 omitted or the function `make-frame-on-display' is not available, the
4366 current display is used."
4367 (interactive "P")
4368 (if (fboundp 'make-frame-on-display)
4369 (unless display
4370 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4371 (setq display nil))
4372 (let ((alive (gnus-alive-p)))
4373 (unless (and alive
4374 (catch 'found
4375 (walk-windows
4376 (lambda (window)
4377 (when (and (or (not display)
4378 (equal display
4379 (gnus-frame-or-window-display-name
4380 window)))
4381 (with-current-buffer (window-buffer window)
4383 (symbol-name major-mode))))
4384 (gnus-select-frame-set-input-focus
4385 (setq gnus-other-frame-object (window-frame window)))
4386 (select-window window)
4387 (throw 'found t)))
4388 'ignore t)))
4389 (gnus-select-frame-set-input-focus
4390 (setq gnus-other-frame-object
4391 (if display
4392 (make-frame-on-display display gnus-other-frame-parameters)
4393 (make-frame gnus-other-frame-parameters))))
4394 (if alive
4395 (switch-to-buffer gnus-group-buffer)
4396 (funcall gnus-other-frame-function arg)
4397 (add-hook 'gnus-exit-gnus-hook
4398 '(lambda nil
4399 (when (and (frame-live-p gnus-other-frame-object)
4400 (cdr (frame-list)))
4401 (delete-frame gnus-other-frame-object))
4402 (setq gnus-other-frame-object nil)))))))
4404 ;;;###autoload
4405 (defun gnus (&optional arg dont-connect slave)
4406 "Read network news.
4407 If ARG is non-nil and a positive number, Gnus will use that as the
4408 startup level. If ARG is non-nil and not a positive number, Gnus will
4409 prompt the user for the name of an NNTP server to use."
4410 (interactive "P")
4411 (unless (byte-code-function-p (symbol-function 'gnus))
4412 (message "You should byte-compile Gnus")
4413 (sit-for 2))
4414 (gnus-1 arg dont-connect slave))
4416 ;; Allow redefinition of Gnus functions.
4418 (gnus-ems-redefine)
4420 (provide 'gnus)
4422 ;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4423 ;;; gnus.el ends here