| blob | b3752506c8fd51ea06881b76c9670d72033f801f |
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."
1755 "*An alist of valid select methods.
1756 The first element of each list lists should be a string with the name
1757 of the select method. The other elements may be the category of
1758 this method (i. e., `post', `mail', `none' or whatever) or other
1759 properties that this method has (like being respoolable).
1760 If you implement a new select method, all you should have to change is
1761 this variable. I think."
1777 "Recomputes the select-method widget based on the value of
1778 `gnus-valid-select-methods'."
1780 "Widget for entering a select method."
1787 gnus-valid-select-methods)
1791 :inline t
1793 variable
1799 "List of buffers that should update their mode lines.
1800 The list may contain the symbols `group', `article', `tree' and
1801 `summary'. If the corresponding symbol is present, Gnus will keep
1802 that mode line updated with information that may be pertinent.
1803 If this variable is nil, screen refresh may be quicker."
1810 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1812 "*Max length of mode-line non-string contents.
1813 If this is nil, Gnus will take space as is needed, leaving the rest
1814 of the mode line intact. Note that the default of nil is unlikely
1815 to be desirable; see the manual for further details."
1818 integer))
1820 ;; There should be special validation for this.
1825 to-address
1826 :function-document
1827 "Return GROUP's to-address."
1828 :variable-document
1829 "*Alist of group regexps and correspondent to-addresses."
1830 :variable-group gnus-group-parameter
1833 This will be used when doing followups and posts.
1835 This is primarily useful in mail groups that represent closed
1836 mailing lists--mailing lists where it's expected that everybody that
1837 writes to the mailing list is subscribed to it. Since using this
1838 parameter ensures that the mail only goes to the mailing list itself,
1839 it means that members won't receive two copies of your followups.
1841 Using `to-address' will actually work whether the group is foreign or
1842 not. Let's say there's a group on the server that is called
1843 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1844 articles from a mail-to-news gateway. Posting directly to this group
1845 is therefore impossible--you have to send mail to the mailing list
1846 address instead.
1848 The gnus-group-split mail splitting mechanism will behave as if this
1852 to-list
1853 :function-document
1854 "Return GROUP's to-list."
1855 :variable-document
1856 "*Alist of group regexps and correspondent to-lists."
1857 :variable-group gnus-group-parameter
1860 This address will be used when doing a `a' in the group.
1862 It is totally ignored when doing a followup--except that if it is
1863 present in a news group, you'll get mail group semantics when doing
1864 `f'.
1866 The gnus-group-split mail splitting mechanism will behave as if this
1870 subscribed
1871 :type bool
1872 :function-document
1873 "Return GROUP's subscription status."
1874 :variable-document
1875 "*Groups which are automatically considered subscribed."
1876 :variable-group gnus-group-parameter
1879 Gnus assumed that you are subscribed to the To/List address.
1881 When constructing a list of subscribed groups using
1882 `gnus-find-subscribed-addresses', Gnus includes the To address given
1886 auto-expire
1887 :type bool
1888 :function gnus-group-auto-expirable-p
1889 :function-document
1890 "Check whether GROUP is auto-expirable or not."
1891 :variable gnus-auto-expirable-newsgroups
1892 :variable-default nil
1893 :variable-document
1894 "*Groups in which to automatically mark read articles as expirable.
1895 If non-nil, this should be a regexp that should match all groups in
1896 which to perform auto-expiry. This only makes sense for mail groups."
1897 :variable-group nnmail-expire
1899 regexp)
1901 :parameter-document
1905 total-expire
1906 :type bool
1907 :function gnus-group-total-expirable-p
1908 :function-document
1909 "Check whether GROUP is total-expirable or not."
1910 :variable gnus-total-expirable-newsgroups
1911 :variable-default nil
1912 :variable-document
1913 "*Groups in which to perform expiry of all read articles.
1914 Use with extreme caution. All groups that match this regexp will be
1915 expiring - which means that all read articles will be deleted after
1916 \(say) one week. (This only goes for mail groups and the like, of
1917 course.)"
1918 :variable-group nnmail-expire
1920 regexp)
1922 :parameter-document
1923 "All read articles will be put through the expiry process
1925 This happens even if they are not marked as expirable.
1929 charset
1930 :function-document
1931 "Return the default charset of GROUP."
1932 :variable gnus-group-charset-alist
1933 :variable-default
1946 :variable-document
1947 "Alist of regexps (to match group names) and default charsets to be used when reading."
1948 :variable-group gnus-charset
1956 post-method
1957 :type list
1958 :function-document
1959 "Return a posting method for GROUP."
1960 :variable gnus-post-method-alist
1961 :variable-document
1962 "Alist of regexps (to match group names) and method to be used when
1963 posting an article."
1964 :variable-group gnus-group-foreign
1965 :parameter-type
1973 :parameter-document
1977 large-newsgroup-initial
1978 :type integer
1979 :function-document
1980 "Return GROUP's initial input of the number of articles."
1981 :variable-document
1982 "*Alist of group regexps and its initial input of the number of articles."
1983 :variable-group gnus-group-parameter
1989 This number will be prompted as the initial value of the number of
1990 articles to list when the group is a large newsgroup (see
1991 `gnus-large-newsgroup'). If it is nil, the default value is the
1994 ;; The Gnus registry's ignored groups
1996 registry-ignore
1997 :type list
1998 :function-document
1999 "Whether this group should be ignored by the registry."
2000 :variable gnus-registry-ignored-groups
2001 :variable-default nil
2002 :variable-document
2003 "*Groups in which the registry should be turned off."
2004 :variable-group gnus-registry
2011 :parameter-document
2014 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
2016 "*Disable the group parameters for spam detection.
2017 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
2024 "Spam group classification (requires spam.el).
2025 This group contains spam messages. On summary entry, unread messages
2026 will be marked as spam. On summary exit, the specified spam
2027 processors will be invoked on spam-marked messages, then those
2028 messages will be expired, so the spam processor will only see a
2032 "The ham value for the spam group parameter (requires spam.el).
2033 On summary exit, the specified ham processors will be invoked on
2034 ham-marked messages. Exercise caution, since the ham processor will
2035 see the same message more than once because there is no ham message
2039 spam-contents
2040 :type list
2041 :function-document
2042 "The spam type (spam, ham, or neither) of the group."
2043 :variable gnus-spam-newsgroup-contents
2044 :variable-default nil
2045 :variable-document
2046 "*Group classification (spam, ham, or neither). Only
2047 meaningful when spam.el is loaded. If non-nil, this should be a
2048 list of group name regexps associated with a classification for
2049 each one. In spam groups, new articles are marked as spam on
2050 summary entry. There is other behavior associated with ham and
2051 no classification when spam.el is loaded - see the manual."
2052 :variable-group spam
2066 :parameter-document
2067 "The spam classification (spam, ham, or neither) of this group.
2068 When a spam group is entered, all unread articles are marked as
2069 spam. There is other behavior associated with ham and no
2073 spam-resend-to
2074 :type list
2075 :function-document
2076 "The address to get spam resent (through spam-report-resend)."
2077 :variable gnus-spam-resend-to
2078 :variable-default nil
2079 :variable-document
2080 "The address to get spam resent (through spam-report-resend)."
2081 :variable-group spam
2085 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2086 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2087 :parameter-document
2091 ham-resend-to
2092 :type list
2093 :function-document
2094 "The address to get ham resent (through spam-report-resend)."
2095 :variable gnus-ham-resend-to
2096 :variable-default nil
2097 :variable-document
2098 "The address to get ham resent (through spam-report-resend)."
2099 :variable-group spam
2103 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2104 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2105 :parameter-document
2121 "OBSOLETE: The Gmane reporting summary exit spam processor.
2128 "OBSOLETE: The ifile summary exit ham processor.
2132 "OBSOLETE: The Bogofilter summary exit ham processor.
2136 "OBSOLETE: The spam-stat summary exit ham processor.
2140 "OBSOLETE: The whitelist summary exit ham processor.
2144 "OBSOLETE: The BBDB summary exit ham processor.
2148 "OBSOLETE: The ham copy exit ham processor.
2152 "OBSOLETE: The spamoracle summary exit ham processor.
2156 spam-process
2157 :type list
2158 :parameter-type
2161 :value nil
2198 :function-document
2199 "Which spam or ham processors will be applied when the summary is exited."
2200 :variable gnus-spam-process-newsgroups
2201 :variable-default nil
2202 :variable-document
2203 "*Groups in which to automatically process spam or ham articles with
2204 a backend on summary exit. If non-nil, this should be a list of group
2205 name regexps that should match all groups in which to do automatic
2206 spam processing, associated with the appropriate processor."
2207 :variable-group spam
2208 :variable-type
2249 :parameter-document
2253 spam-autodetect
2254 :type list
2255 :parameter-type
2257 :function-document
2258 "Should spam be autodetected (with spam-split) in this group?"
2259 :variable gnus-spam-autodetect
2260 :variable-default nil
2261 :variable-document
2262 "*Groups in which spam should be autodetected when they are entered.
2263 Only unseen articles will be examined, unless
2264 spam-autodetect-recheck-messages is set."
2265 :variable-group spam
2266 :variable-type
2271 boolean))
2272 :parameter-document
2273 "Spam autodetection.
2274 Only unseen articles will be examined, unless
2278 spam-autodetect-methods
2279 :type list
2280 :parameter-type
2303 :function-document
2304 "Methods to be used for autodetection in each group"
2305 :variable gnus-spam-autodetect-methods
2306 :variable-default nil
2307 :variable-document
2308 "*Methods for autodetecting spam per group.
2309 Requires the spam-autodetect parameter. Only unseen articles
2310 will be examined, unless spam-autodetect-recheck-messages is
2311 set."
2312 :variable-group spam
2313 :variable-type
2340 :parameter-document
2341 "Spam autodetection methods.
2342 Requires the spam-autodetect parameter. Only unseen articles
2343 will be examined, unless spam-autodetect-recheck-messages is
2347 spam-process-destination
2348 :type list
2349 :parameter-type
2355 :function-document
2356 "Where spam-processed articles will go at summary exit."
2357 :variable gnus-spam-process-destinations
2358 :variable-default nil
2359 :variable-document
2360 "*Groups in which to explicitly send spam-processed articles to
2361 another group, or expire them (the default). If non-nil, this should
2362 be a list of group name regexps that should match all groups in which
2363 to do spam-processed article moving, associated with the destination
2364 group or nil for explicit expiration. This only makes sense for
2365 mail groups."
2366 :variable-group spam
2367 :variable-type
2378 :parameter-document
2382 ham-process-destination
2383 :type list
2384 :parameter-type
2392 :function-document
2393 "Where ham articles will go at summary exit from a spam group."
2394 :variable gnus-ham-process-destinations
2395 :variable-default nil
2396 :variable-document
2397 "*Groups in which to explicitly send ham articles to
2398 another group, or do nothing (the default). If non-nil, this should
2399 be a list of group name regexps that should match all groups in which
2400 to do ham article moving, associated with the destination
2401 group or nil for explicit ignoring. This only makes sense for
2402 mail groups, and only works in spam groups."
2403 :variable-group spam
2404 :variable-type
2416 :parameter-document
2420 ham-marks
2431 :parameter-document
2432 "Marks considered ham (positively not spam). Such articles will be
2433 processed as ham (non-spam) on group exit. When nil, the global
2434 spam-ham-marks variable takes precedence."
2436 gnus-read-mark
2437 gnus-killed-mark
2438 gnus-kill-file-mark
2439 gnus-low-score-mark))))
2440 :variable-group spam
2441 :variable-document
2445 spam-marks
2454 :parameter-document
2455 "Marks considered spam.
2456 Such articles will be processed as spam on group exit. When nil, the global
2457 spam-spam-marks variable takes precedence."
2459 :variable-group spam
2460 :variable-document
2464 "Number of group name elements to leave alone when making a short group name."
2469 "*If non-nil, once you set a level, Gnus will use this level."
2473 ;; Hooks.
2476 "A hook run while Gnus is loaded."
2481 "A hook called to apply kill files to a group.
2482 This hook is intended to apply a kill file to the selected newsgroup.
2483 The function `gnus-apply-kill-file' is called by default.
2485 Since a general kill file is too heavy to use only for a few
2486 newsgroups, I recommend you to use a lighter hook function. For
2487 example, if you'd like to apply a kill file to articles which contains
2488 a string `rmgroup' in subject in newsgroup `control', you can use the
2489 following hook:
2491 (setq gnus-apply-kill-hook
2492 (list
2493 (lambda ()
2502 "Function run when a group level is changed.
2503 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2506 function))
2508 ;;; Face thingies.
2512 mouse-face
2513 summary-menu group-menu article-menu
2514 tree-highlight menu highlight
2515 browse-menu server-menu
2516 page-marker tree-menu binary-menu pick-menu)
2517 "*Enable visual features.
2518 If `visual' is disabled, there will be no menus and few faces. Most of
2519 the visual customization options below will be ignored. Gnus will use
2520 less space and be faster as a result.
2522 This variable can also be a list of visual elements to switch on. For
2523 instance, to switch off all visual things except menus, you can say:
2525 (setq gnus-visual '(menu))
2527 Valid elements include `summary-highlight', `group-highlight',
2528 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2529 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2530 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2550 ;; Byte-compiler warning.
2552 ;; Find out whether the gnus-visual TYPE is wanted.
2556 gnus-visual
2560 t))))
2570 "*Face used for group or summary buffer mouse highlighting.
2571 The line beneath the mouse pointer will be highlighted with this
2572 face."
2585 "Controls use of the agent cache while plugged.
2586 When set, Gnus will prefer using the locally stored content rather
2587 than re-fetching it from the server. You also need to enable
2588 `gnus-agent' for this to have any affect."
2594 "Default charset assumed to be used when viewing non-ASCII characters.
2595 This variable is overridden on a group-to-group basis by the
2596 `gnus-group-charset-alist' variable and is only used on groups not
2597 covered by that variable."
2601 ;; Fixme: Doc reference to agent.
2603 "Whether we want to use the Gnus agent or not.
2605 You may customize gnus-agent to disable its use. However, some
2606 back ends have started to use the agent as a client-side cache.
2607 Disabling the agent may result in noticeable loss of performance."
2613 "Function called by the command `gnus-other-frame'."
2621 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2622 This should be an alist for Emacs, or a plist for XEmacs."
2633 "Which information should be exposed in the User-Agent header.
2635 Can be a list of symbols or a string. Valid symbols are `gnus'
2636 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2637 addition to the Emacs version, you can add `codename' \(show
2638 \(S\)XEmacs codename\) or either `config' \(show system
2639 configuration\) or `type' \(show system type\). If you set it to
2640 a string, be sure to use a valid format, see RFC 2616."
2653 ;; Convert old (< 2005-01-10) symbol type values:
2672 \f
2673 ;;; Internal variables
2678 ; Reset each time gnus-agent-covered-methods is changed else
2679 ; gnus-agent-method-p may mis-report a methods status.
2680 )
2704 ;; Dummy variable.
2707 ;; Variable holding the user answers to all method prompts.
2710 ;; Variable holding the user answers to all mail method prompts.
2713 ;; Variable holding the user answers to all group prompts.
2721 "*The directory where cached articles will be stored."
2727 nnspool "cache"
2751 ;; Propagate flags to server, with the following exceptions:
2752 ;; `seen' is private to each gnus installation
2753 ;; `cache' is a internal gnus flag for each gnus installation
2754 ;; `download' is a agent flag private to each gnus installation
2755 ;; `unsend' are for nndraft groups only
2756 ;; `score' is not a proper mark
2757 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2760 "Marks that shouldn't be propagated to back ends.
2761 Typical marks are those that make no sense in a standalone back end,
2762 such as a mark that says whether an article is stored in the cache
2775 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2800 gnus-newsrc-last-checked-date
2801 gnus-newsrc-alist gnus-server-alist
2802 gnus-killed-list gnus-zombie-list
2803 gnus-topic-topology gnus-topic-alist
2804 gnus-format-specs)
2808 "Assoc list of read articles.
2812 "Assoc list of registry data.
2839 ;; Save window configuration.
2852 ;;; End of variables.
2854 ;; Define some autoload functions Gnus might use.
2857 ;; This little mapcar goes through the list below and marks the
2858 ;; symbols in question as autoloaded functions.
2878 message-send-and-exit message-yank-original)
2882 ;; This is only used in message.el, which has an autoload.
2884 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2886 ;; Next two only used in gnus-util.
2887 rmail-summary-exists rmail-select-summary)
2888 ;; Only used in gnus-util, which has an autoload.
2894 gnus-Folder-save-name gnus-folder-save-name)
2897 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2898 gnus-demon-add-disconnection gnus-demon-add-handler
2899 gnus-demon-remove-handler)
2901 gnus-demon-init gnus-demon-cancel)
2903 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2904 gnus-face-from-file)
2906 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2908 gnus-nocem-unwanted-article-p)
2910 gnus-server-server-name)
2913 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2914 gnus-article-hide-citation gnus-article-fill-cited-article
2915 gnus-article-hide-citation-in-followups)
2917 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2918 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2920 gnus-cache-possibly-remove-articles gnus-cache-request-article
2921 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2922 gnus-cache-enter-remove-article gnus-cached-article-p
2923 gnus-cache-open gnus-cache-close gnus-cache-update-article
2924 gnus-cache-articles-in-group)
2926 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2928 gnus-summary-increase-score gnus-summary-set-score
2929 gnus-summary-raise-thread gnus-summary-raise-same-subject
2930 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2931 gnus-summary-lower-thread gnus-summary-lower-same-subject
2932 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2933 gnus-summary-current-score gnus-score-delta-default
2934 gnus-score-flush-cache gnus-score-close
2935 gnus-possibly-score-headers gnus-score-followup-article
2936 gnus-score-followup-thread)
2939 gnus-current-score-file-nondirectory gnus-score-adaptive
2940 gnus-score-find-trace gnus-score-file-name)
2944 gnus-subscribe-topics)
2948 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2949 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2950 gnus-uu-mark-by-regexp gnus-uu-mark-all
2951 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2952 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2953 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2954 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2955 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2956 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2957 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2958 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2961 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2963 gnus-group-post-news gnus-group-mail gnus-group-news
2964 gnus-summary-post-news gnus-summary-news-other-window
2965 gnus-summary-followup gnus-summary-followup-with-original
2966 gnus-summary-cancel-article gnus-summary-supersede-article
2967 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2968 gnus-summary-mail-forward gnus-summary-mail-other-window
2969 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2970 gnus-summary-wide-reply gnus-summary-followup-to-mail
2971 gnus-summary-followup-to-mail-with-original gnus-bug
2972 gnus-summary-wide-reply-with-original
2973 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2974 gnus-summary-post-forward)
2979 gnus-list-of-unread-articles gnus-list-of-read-articles
2980 gnus-offer-save-summaries gnus-make-thread-indent-array
2981 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2982 gnus-summary-skip-intangible gnus-summary-article-number
2983 gnus-data-header gnus-data-find)
2985 gnus-group-list-groups gnus-group-first-unread-group
2986 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2987 gnus-group-setup-buffer gnus-group-get-new-news
2988 gnus-group-make-help-group gnus-group-update-group
2989 gnus-group-iterate gnus-group-group-name)
2991 gnus-backlog-remove-article)
2993 gnus-article-prepare gnus-article-set-window-start
2994 gnus-article-next-page gnus-article-prev-page
2995 gnus-request-article-this-buffer gnus-article-mode
2996 gnus-article-setup-buffer gnus-narrow-to-page
2997 gnus-article-delete-invisible-text gnus-treat-article)
2999 gnus-article-hide-headers gnus-article-hide-boring-headers
3000 gnus-article-treat-overstrike
3001 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
3002 gnus-article-display-x-face gnus-article-de-quoted-unreadable
3003 gnus-article-de-base64-unreadable
3004 gnus-article-decode-HZ
3005 gnus-article-wash-html
3006 gnus-article-unsplit-urls
3007 gnus-article-hide-pem gnus-article-hide-signature
3008 gnus-article-strip-leading-blank-lines gnus-article-date-local
3009 gnus-article-date-original gnus-article-date-lapsed
3010 ;;gnus-article-show-all-headers
3011 gnus-article-edit-mode gnus-article-edit-article
3012 gnus-article-edit-done gnus-article-decode-encoded-words
3013 gnus-start-date-timer gnus-stop-date-timer
3014 gnus-mime-view-all-parts)
3017 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
3018 gnus-check-reasonable-setup)
3020 gnus-dup-enter-articles)
3026 gnus-async-prefetch-article gnus-async-prefetch-remove-group
3027 gnus-async-halt-prefetch)
3029 gnus-agent-save-active gnus-agent-method-p
3030 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
3031 gnus-summary-set-agent-mark gnus-agent-save-group-info
3032 gnus-agent-request-article gnus-agent-retrieve-headers)
3034 gnus-unplugged gnus-agentize gnus-agent-batch)
3036 gnus-summary-save-article-vm)
3041 gnus-group-split-update)
3044 ;;; gnus-sum.el thingies
3048 "*The format specification of the lines in the summary buffer.
3050 It works along the same lines as a normal formatting string,
3051 with some simple extensions.
3053 %N Article number, left padded with spaces (string)
3054 %S Subject (string)
3056 %n Name of the poster (string)
3057 %a Extracted name of the poster (string)
3058 %A Extracted address of the poster (string)
3059 %F Contents of the From: header (string)
3060 %f Contents of the From: or To: headers (string)
3061 %x Contents of the Xref: header (string)
3062 %D Date of the article (string)
3063 %d Date of the article (string) in DD-MMM format
3064 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
3065 %M Message-id of the article (string)
3066 %r References of the article (string)
3067 %c Number of characters in the article (integer)
3068 %k Pretty-printed version of the above (string)
3070 %L Number of lines in the article (integer)
3071 %I Indentation based on thread level (a string of spaces)
3072 %B A complex trn-style thread tree (string)
3073 The variables `gnus-sum-thread-*' can be used for customization.
3074 %T A string with two possible values: 80 spaces if the article
3075 is on thread level two or larger and 0 spaces on level one
3080 %> Spaces of length thread-level (string)
3081 %< Spaces of length (- 20 thread-level) (string)
3082 %i Article score (number)
3083 %z Article zcore (character)
3084 %t Number of articles under the current thread (number).
3085 %e Whether the thread is empty or not (character).
3086 %V Total thread score (number).
3087 %P The line number (number).
3088 %O Download mark (character).
3089 %* If present, indicates desired cursor position
3090 (instead of after first colon).
3091 %u User defined specifier. The next character in the format string should
3092 be a letter. Gnus will call the function gnus-user-format-function-X,
3093 where X is the letter following %u. The function will be passed the
3094 current header as argument. The function should return a string, which
3095 will be inserted into the summary just like information from any other
3096 summary specifier.
3098 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3099 with care. For reasons of efficiency, Gnus will compute what column
3101 it is invalid to have these specs after a variable-length spec. Well,
3102 you might not be arrested, but your summary buffer will look strange,
3103 which is bad enough.
3105 The smart choice is to have these specs as far to the left as
3106 possible.
3108 This restriction may disappear in later versions of Gnus.
3110 General format specifiers can also be used.
3111 See Info node `(gnus)Formatting Variables'."
3116 ;;;
3117 ;;; Skeleton keymaps
3118 ;;;
3123 (while keys
3124 (define-key keymap (pop keys) 'undefined))))
3126 (defvar gnus-article-mode-map
3127 (let ((keymap (make-sparse-keymap)))
3128 (gnus-suppress-keymap keymap)
3129 keymap))
3130 (defvar gnus-summary-mode-map
3131 (let ((keymap (make-keymap)))
3132 (gnus-suppress-keymap keymap)
3133 keymap))
3134 (defvar gnus-group-mode-map
3135 (let ((keymap (make-keymap)))
3136 (gnus-suppress-keymap keymap)
3137 keymap))
3139 \f
3141 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3142 ;; If you want the cursor to go somewhere else, set these two
3143 ;; functions in some startup hook to whatever you want.
3144 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3145 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3147 ;;; Various macros and substs.
3149 (defun gnus-header-from (header)
3150 (mail-header-from header))
3152 (defmacro gnus-gethash (string hashtable)
3153 "Get hash value of STRING in HASHTABLE."
3154 `(symbol-value (intern-soft ,string ,hashtable)))
3156 (defmacro gnus-gethash-safe (string hashtable)
3157 "Get hash value of STRING in HASHTABLE.
3158 Return nil if not defined."
3159 `(let ((sym (intern-soft ,string ,hashtable)))
3160 (and (boundp sym) (symbol-value sym))))
3162 (defmacro gnus-sethash (string value hashtable)
3163 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3164 `(set (intern ,string ,hashtable) ,value))
3165 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3167 (defmacro gnus-group-unread (group)
3168 "Get the currently computed number of unread articles in GROUP."
3169 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3171 (defmacro gnus-group-entry (group)
3172 "Get the newsrc entry for GROUP."
3173 `(gnus-gethash ,group gnus-newsrc-hashtb))
3175 (defmacro gnus-active (group)
3176 "Get active info on GROUP."
3177 `(gnus-gethash ,group gnus-active-hashtb))
3179 (defmacro gnus-set-active (group active)
3180 "Set GROUP's active info."
3181 `(gnus-sethash ,group ,active gnus-active-hashtb))
3183 ;; Info access macros.
3185 (defmacro gnus-info-group (info)
3186 `(nth 0 ,info))
3187 (defmacro gnus-info-rank (info)
3188 `(nth 1 ,info))
3189 (defmacro gnus-info-read (info)
3190 `(nth 2 ,info))
3191 (defmacro gnus-info-marks (info)
3192 `(nth 3 ,info))
3193 (defmacro gnus-info-method (info)
3194 `(nth 4 ,info))
3195 (defmacro gnus-info-params (info)
3196 `(nth 5 ,info))
3198 (defmacro gnus-info-level (info)
3199 `(let ((rank (gnus-info-rank ,info)))
3200 (if (consp rank)
3201 (car rank)
3202 rank)))
3203 (defmacro gnus-info-score (info)
3204 `(let ((rank (gnus-info-rank ,info)))
3205 (or (and (consp rank) (cdr rank)) 0)))
3207 (defmacro gnus-info-set-group (info group)
3208 `(setcar ,info ,group))
3209 (defmacro gnus-info-set-rank (info rank)
3210 `(setcar (nthcdr 1 ,info) ,rank))
3211 (defmacro gnus-info-set-read (info read)
3212 `(setcar (nthcdr 2 ,info) ,read))
3213 (defmacro gnus-info-set-marks (info marks &optional extend)
3214 (if extend
3215 `(gnus-info-set-entry ,info ,marks 3)
3216 `(setcar (nthcdr 3 ,info) ,marks)))
3217 (defmacro gnus-info-set-method (info method &optional extend)
3218 (if extend
3219 `(gnus-info-set-entry ,info ,method 4)
3220 `(setcar (nthcdr 4 ,info) ,method)))
3221 (defmacro gnus-info-set-params (info params &optional extend)
3222 (if extend
3223 `(gnus-info-set-entry ,info ,params 5)
3224 `(setcar (nthcdr 5 ,info) ,params)))
3226 (defun gnus-info-set-entry (info entry number)
3227 ;; Extend the info until we have enough elements.
3228 (while (<= (length info) number)
3229 (nconc info (list nil)))
3230 ;; Set the entry.
3231 (setcar (nthcdr number info) entry))
3233 (defmacro gnus-info-set-level (info level)
3234 `(let ((rank (cdr ,info)))
3235 (if (consp (car rank))
3236 (setcar (car rank) ,level)
3237 (setcar rank ,level))))
3238 (defmacro gnus-info-set-score (info score)
3239 `(let ((rank (cdr ,info)))
3240 (if (consp (car rank))
3241 (setcdr (car rank) ,score)
3242 (setcar rank (cons (car rank) ,score)))))
3244 (defmacro gnus-get-info (group)
3245 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3247 ;;; Load the compatibility functions.
3249 (require 'gnus-ems)
3251 \f
3252 ;;;
3253 ;;; Shutdown
3254 ;;;
3256 (defvar gnus-shutdown-alist nil)
3258 (defun gnus-add-shutdown (function &rest symbols)
3259 "Run FUNCTION whenever one of SYMBOLS is shut down."
3260 (push (cons function symbols) gnus-shutdown-alist))
3262 (defun gnus-shutdown (symbol)
3263 "Shut down everything that waits for SYMBOL."
3264 (dolist (entry gnus-shutdown-alist)
3265 (when (memq symbol (cdr entry))
3266 (funcall (car entry)))))
3268 \f
3269 ;;;
3270 ;;; Gnus Utility Functions
3271 ;;;
3273 (defun gnus-find-subscribed-addresses ()
3274 "Return a regexp matching the addresses of all subscribed mail groups.
3275 It consists of the `to-address' or `to-list' parameter of all groups
3276 with a `subscribed' parameter."
3277 (let (group address addresses)
3278 (dolist (entry (cdr gnus-newsrc-alist))
3279 (setq group (car entry))
3280 (when (gnus-parameter-subscribed group)
3281 (setq address (mail-strip-quoted-names
3282 (or (gnus-group-fast-parameter group 'to-address)
3283 (gnus-group-fast-parameter group 'to-list))))
3284 (when address
3285 (add-to-list 'addresses address))))
3286 (when addresses
3289 (defmacro gnus-string-or (&rest strings)
3290 "Return the first element of STRINGS that is a non-blank string.
3291 STRINGS will be evaluated in normal `or' order."
3292 `(gnus-string-or-1 ',strings))
3294 (defun gnus-string-or-1 (strings)
3295 (let (string)
3296 (while strings
3297 (setq string (eval (pop strings)))
3299 (setq string nil)
3300 (setq strings nil)))
3301 string))
3303 (defun gnus-version (&optional arg)
3304 "Version number of this version of Gnus.
3305 If ARG, insert string at point."
3306 (interactive "P")
3307 (if arg
3308 (insert (message gnus-version))
3309 (message gnus-version)))
3311 (defun gnus-continuum-version (&optional version)
3312 "Return VERSION as a floating point number."
3313 (interactive)
3314 (unless version
3315 (setq version gnus-version))
3318 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3319 (number (match-string 2 version))
3320 major minor least)
3321 (unless (string-match
3323 (error "Invalid version string: %s" version))
3324 (setq major (string-to-number (match-string 1 number))
3325 minor (string-to-number (match-string 2 number))
3326 least (if (match-beginning 3)
3327 (string-to-number (match-string 3 number))
3328 0))
3329 (string-to-number
3330 (if (zerop major)
3331 (format "%s00%02d%02d"
3332 (if (member alpha '("(ding)" "d"))
3333 "4.99"
3334 (+ 5 (* 0.02
3335 (abs
3336 (- (mm-char-int (aref (downcase alpha) 0))
3337 (mm-char-int ?t))))
3338 -0.01))
3339 minor least)
3340 (format "%d.%02d%02d" major minor least))))))
3342 (defun gnus-info-find-node (&optional nodename)
3343 "Find Info documentation of Gnus."
3344 (interactive)
3345 ;; Enlarge info window if needed.
3346 (let (gnus-info-buffer)
3347 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3348 (setq gnus-info-buffer (current-buffer))
3349 (gnus-configure-windows 'info)))
3351 ;;;
3352 ;;; gnus-interactive
3353 ;;;
3355 (defvar gnus-current-prefix-symbol nil
3356 "Current prefix symbol.")
3358 (defvar gnus-current-prefix-symbols nil
3359 "List of current prefix symbols.")
3361 (defun gnus-interactive (string &optional params)
3362 "Return a list that can be fed to `interactive'.
3363 See `interactive' for full documentation.
3365 Adds the following specs:
3367 y -- The current symbolic prefix.
3368 Y -- A list of the current symbolic prefix(es).
3369 A -- Article number.
3370 H -- Article header.
3371 g -- Group name."
3372 (let ((i 0)
3373 out c prompt)
3374 (while (< i (length string))
3376 (setq c (aref string i))
3377 (when (match-end 1)
3378 (setq prompt (match-string 1 string)))
3379 (setq i (match-end 0))
3380 ;; We basically emulate just about everything that
3381 ;; `interactive' does, but add the specs listed above.
3382 (push
3383 (cond
3384 ((= c ?a)
3385 (completing-read prompt obarray 'fboundp t))
3386 ((= c ?b)
3387 (read-buffer prompt (current-buffer) t))
3388 ((= c ?B)
3389 (read-buffer prompt (other-buffer (current-buffer))))
3390 ((= c ?c)
3391 (read-char))
3392 ((= c ?C)
3393 (completing-read prompt obarray 'commandp t))
3394 ((= c ?d)
3395 (point))
3396 ((= c ?D)
3397 (read-file-name prompt nil default-directory 'lambda))
3398 ((= c ?f)
3399 (read-file-name prompt nil nil 'lambda))
3400 ((= c ?F)
3401 (read-file-name prompt))
3402 ((= c ?k)
3403 (read-key-sequence prompt))
3404 ((= c ?K)
3405 (error "Not implemented spec"))
3406 ((= c ?e)
3407 (error "Not implemented spec"))
3408 ((= c ?m)
3409 (mark))
3410 ((= c ?N)
3411 (error "Not implemented spec"))
3412 ((= c ?n)
3413 (string-to-number (read-from-minibuffer prompt)))
3414 ((= c ?p)
3415 (prefix-numeric-value current-prefix-arg))
3416 ((= c ?P)
3417 current-prefix-arg)
3418 ((= c ?r)
3419 'gnus-prefix-nil)
3420 ((= c ?s)
3421 (read-string prompt))
3422 ((= c ?S)
3423 (intern (read-string prompt)))
3424 ((= c ?v)
3425 (read-variable prompt))
3426 ((= c ?x)
3427 (read-minibuffer prompt))
3428 ((= c ?x)
3429 (eval-minibuffer prompt))
3430 ;; And here the new specs come.
3431 ((= c ?y)
3432 gnus-current-prefix-symbol)
3433 ((= c ?Y)
3434 gnus-current-prefix-symbols)
3435 ((= c ?g)
3436 (gnus-group-group-name))
3437 ((= c ?A)
3438 (gnus-summary-skip-intangible)
3439 (or (get-text-property (point) 'gnus-number)
3440 (gnus-summary-last-subject)))
3441 ((= c ?H)
3442 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3443 (t
3444 (error "Non-implemented spec")))
3445 out)
3446 (cond
3447 ((= c ?r)
3448 (push (if (< (point) (mark)) (point) (mark)) out)
3449 (push (if (> (point) (mark)) (point) (mark)) out))))
3450 (setq out (delq 'gnus-prefix-nil out))
3451 (nreverse out)))
3453 (defun gnus-symbolic-argument (&optional arg)
3454 "Read a symbolic argument and a command, and then execute command."
3455 (interactive "P")
3456 (let* ((in-command (this-command-keys))
3457 (command in-command)
3458 gnus-current-prefix-symbols
3459 gnus-current-prefix-symbol
3460 syms)
3461 (while (equal in-command command)
3462 (message "%s-" (key-description (this-command-keys)))
3463 (push (intern (char-to-string (read-char))) syms)
3464 (setq command (read-key-sequence nil t)))
3465 (setq gnus-current-prefix-symbols (nreverse syms)
3466 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3467 (call-interactively (key-binding command t))))
3469 ;;; More various functions.
3471 (defsubst gnus-check-backend-function (func group)
3472 "Check whether GROUP supports function FUNC.
3473 GROUP can either be a string (a group name) or a select method."
3474 (ignore-errors
3475 (let ((method (if (stringp group)
3476 (car (gnus-find-method-for-group group))
3477 group)))
3478 (unless (featurep method)
3479 (require method))
3480 (fboundp (intern (format "%s-%s" method func))))))
3482 (defun gnus-group-read-only-p (&optional group)
3483 "Check whether GROUP supports editing or not.
3484 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3485 that that variable is buffer-local to the summary buffers."
3486 (let ((group (or group gnus-newsgroup-name)))
3487 (not (gnus-check-backend-function 'request-replace-article group))))
3489 (defun gnus-virtual-group-p (group)
3490 "Say whether GROUP is virtual or not."
3491 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3492 gnus-valid-select-methods)))
3494 (defun gnus-news-group-p (group &optional article)
3495 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3496 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3497 t) ;is news of course.
3498 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3499 nil) ;must be mail then.
3500 ((vectorp article) ;Has header info.
3501 (eq (gnus-request-type group (mail-header-id article)) 'news))
3502 ((null article) ;Hasn't header info
3503 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3504 ((< article 0) ;Virtual message
3505 nil) ;we don't know, guess mail.
3506 (t ;Has positive number
3507 (eq (gnus-request-type group article) 'news)))) ;use it.
3509 ;; Returns a list of writable groups.
3510 (defun gnus-writable-groups ()
3511 (let ((alist gnus-newsrc-alist)
3512 groups group)
3513 (while (setq group (car (pop alist)))
3514 (unless (gnus-group-read-only-p group)
3515 (push group groups)))
3516 (nreverse groups)))
3518 ;; Check whether to use long file names.
3519 (defun gnus-use-long-file-name (symbol)
3520 ;; The variable has to be set...
3521 (and gnus-use-long-file-name
3522 ;; If it isn't a list, then we return t.
3523 (or (not (listp gnus-use-long-file-name))
3524 ;; If it is a list, and the list contains `symbol', we
3525 ;; return nil.
3526 (not (memq symbol gnus-use-long-file-name)))))
3528 ;; Generate a unique new group name.
3529 (defun gnus-generate-new-group-name (leaf)
3530 (let ((name leaf)
3531 (num 0))
3532 (while (gnus-group-entry name)
3533 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3534 name))
3536 (defun gnus-ephemeral-group-p (group)
3537 "Say whether GROUP is ephemeral or not."
3538 (gnus-group-get-parameter group 'quit-config t))
3540 (defun gnus-group-quit-config (group)
3541 "Return the quit-config of GROUP."
3542 (gnus-group-get-parameter group 'quit-config t))
3544 (defun gnus-kill-ephemeral-group (group)
3545 "Remove ephemeral GROUP from relevant structures."
3546 (gnus-sethash group nil gnus-newsrc-hashtb))
3548 (defun gnus-simplify-mode-line ()
3549 "Make mode lines a bit simpler."
3550 (setq mode-line-modified (cdr gnus-mode-line-modified))
3551 (when (listp mode-line-format)
3552 (make-local-variable 'mode-line-format)
3553 (setq mode-line-format (copy-sequence mode-line-format))
3554 (when (equal (nth 3 mode-line-format) " ")
3555 (setcar (nthcdr 3 mode-line-format) " "))))
3557 ;;; Servers and groups.
3559 (defsubst gnus-server-add-address (method)
3560 (let ((method-name (symbol-name (car method))))
3561 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3562 (not (assq (intern (concat method-name "-address")) method))
3563 (memq 'physical-address (assq (car method)
3564 gnus-valid-select-methods)))
3565 (append method (list (list (intern (concat method-name "-address"))
3566 (nth 1 method))))
3567 method)))
3569 (defsubst gnus-method-to-server (method &optional nocache)
3570 (catch 'server-name
3571 (setq method (or method gnus-select-method))
3573 ;; Perhaps it is already in the cache.
3574 (unless nocache
3575 (mapc (lambda (name-method)
3576 (if (equal (cdr name-method) method)
3577 (throw 'server-name (car name-method))))
3578 gnus-server-method-cache))
3580 (mapc
3581 (lambda (server-alist)
3582 (mapc (lambda (name-method)
3583 (when (gnus-methods-equal-p (cdr name-method) method)
3584 (unless (member name-method gnus-server-method-cache)
3585 (push name-method gnus-server-method-cache))
3586 (throw 'server-name (car name-method))))
3587 server-alist))
3588 (list gnus-server-alist
3589 gnus-predefined-server-alist))
3591 (let* ((name (if (member (cadr method) '(nil ""))
3592 (format "%s" (car method))
3593 (format "%s:%s" (car method) (cadr method))))
3594 (name-method (cons name method)))
3595 (unless (member name-method gnus-server-method-cache)
3596 (push name-method gnus-server-method-cache))
3597 name)))
3599 (defsubst gnus-server-to-method (server)
3600 "Map virtual server names to select methods."
3601 (or (and server (listp server) server)
3602 (cdr (assoc server gnus-server-method-cache))
3603 (let ((result
3604 (or
3605 ;; Perhaps this is the native server?
3606 (and (equal server "native") gnus-select-method)
3607 ;; It should be in the server alist.
3608 (cdr (assoc server gnus-server-alist))
3609 ;; It could be in the predefined server alist.
3610 (cdr (assoc server gnus-predefined-server-alist))
3611 ;; If not, we look through all the opened server
3612 ;; to see whether we can find it there.
3613 (let ((opened gnus-opened-servers))
3614 (while (and opened
3615 (not (equal server (format "%s:%s" (caaar opened)
3616 (cadaar opened)))))
3617 (pop opened))
3618 (caar opened))
3619 ;; It could be a named method, search all servers
3620 (let ((servers gnus-secondary-select-methods))
3621 (while (and servers
3622 (not (equal server (format "%s:%s" (caar servers)
3623 (cadar servers)))))
3624 (pop servers))
3625 (car servers))
3626 ;; This could be some sort of foreign server that I
3627 ;; simply haven't opened (yet). Do a brute-force scan
3628 ;; of the entire gnus-newsrc-alist for the server name
3629 ;; of every method. As a side-effect, loads the
3630 ;; gnus-server-method-cache so this only happens once,
3631 ;; if at all.
3632 (let ((alist (cdr gnus-newsrc-alist))
3633 method match)
3634 (while alist
3635 (setq method (gnus-info-method (pop alist)))
3636 (when (and (not (stringp method))
3637 (equal server (gnus-method-to-server method)))
3638 (setq match method
3639 alist nil)))
3640 match))))
3641 (when result
3642 (push (cons server result) gnus-server-method-cache))
3643 result)))
3645 (defsubst gnus-server-get-method (group method)
3646 ;; Input either a server name, and extended server name, or a
3647 ;; select method, and return a select method.
3648 (cond ((stringp method)
3649 (gnus-server-to-method method))
3650 ((equal method gnus-select-method)
3651 gnus-select-method)
3652 ((and (stringp (car method))
3653 group)
3654 (gnus-server-extend-method group method))
3655 ((and method
3656 (not group)
3657 (equal (cadr method) ""))
3658 method)
3659 (t
3660 (gnus-server-add-address method))))
3662 (defmacro gnus-method-equal (ss1 ss2)
3663 "Say whether two servers are equal."
3664 `(let ((s1 ,ss1)
3665 (s2 ,ss2))
3666 (or (equal s1 s2)
3667 (and (= (length s1) (length s2))
3668 (progn
3669 (while (and s1 (member (car s1) s2))
3670 (setq s1 (cdr s1)))
3671 (null s1))))))
3673 (defun gnus-methods-equal-p (m1 m2)
3674 (let ((m1 (or m1 gnus-select-method))
3675 (m2 (or m2 gnus-select-method)))
3676 (or (equal m1 m2)
3677 (and (eq (car m1) (car m2))
3678 (or (not (memq 'address (assoc (symbol-name (car m1))
3679 gnus-valid-select-methods)))
3680 (equal (nth 1 m1) (nth 1 m2)))))))
3682 (defun gnus-server-equal (m1 m2)
3683 "Say whether two methods are equal."
3684 (let ((m1 (cond ((null m1) gnus-select-method)
3685 ((stringp m1) (gnus-server-to-method m1))
3686 (t m1)))
3687 (m2 (cond ((null m2) gnus-select-method)
3688 ((stringp m2) (gnus-server-to-method m2))
3689 (t m2))))
3690 (gnus-method-equal m1 m2)))
3692 (defun gnus-servers-using-backend (backend)
3693 "Return a list of known servers using BACKEND."
3694 (let ((opened gnus-opened-servers)
3695 out)
3696 (while opened
3697 (when (eq backend (caaar opened))
3698 (push (caar opened) out))
3699 (pop opened))
3700 out))
3702 (defun gnus-archive-server-wanted-p ()
3703 "Say whether the user wants to use the archive server."
3704 (cond
3705 ((or (not gnus-message-archive-method)
3706 (not gnus-message-archive-group))
3707 nil)
3708 ((and gnus-message-archive-method gnus-message-archive-group)
3709 t)
3710 (t
3711 (let ((active (cadr (assq 'nnfolder-active-file
3712 gnus-message-archive-method))))
3713 (and active
3714 (file-exists-p active))))))
3716 (defsubst gnus-method-to-server-name (method)
3717 (concat
3718 (format "%s" (car method))
3719 (when (and
3720 (or (assoc (format "%s" (car method))
3721 (gnus-methods-using 'address))
3722 (gnus-server-equal method gnus-message-archive-method))
3723 (nth 1 method)
3724 (not (string= (nth 1 method) "")))
3725 (concat "+" (nth 1 method)))))
3727 (defsubst gnus-method-to-full-server-name (method)
3728 (format "%s+%s" (car method) (nth 1 method)))
3730 (defun gnus-group-prefixed-name (group method &optional full)
3731 "Return the whole name from GROUP and METHOD.
3732 Call with full set to get the fully qualified group name (even if the
3733 server is native)."
3734 (when (stringp method)
3735 (setq method (gnus-server-to-method method)))
3736 (if (or (not method)
3737 (and (not full) (gnus-server-equal method "native"))
3738 ;;;!!! This might not be right. We'll see...
3739 ;(string-match ":" group)
3740 )
3741 group
3742 (concat (gnus-method-to-server-name method) ":" group)))
3744 (defun gnus-group-guess-prefixed-name (group)
3745 "Guess the whole name from GROUP and METHOD."
3746 (gnus-group-prefixed-name group (gnus-find-method-for-group
3747 group)))
3749 (defun gnus-group-full-name (group method)
3750 "Return the full name from GROUP and METHOD, even if the method is native."
3751 (gnus-group-prefixed-name group method t))
3753 (defun gnus-group-guess-full-name (group)
3754 "Guess the full name from GROUP, even if the method is native."
3755 (if (gnus-group-prefixed-p group)
3756 group
3757 (gnus-group-full-name group (gnus-find-method-for-group group))))
3759 (defun gnus-group-guess-full-name-from-command-method (group)
3760 "Guess the full name from GROUP, even if the method is native."
3761 (if (gnus-group-prefixed-p group)
3762 group
3763 (gnus-group-full-name group gnus-command-method)))
3765 (defun gnus-group-real-prefix (group)
3766 "Return the prefix of the current group name."
3767 (if (stringp group)
3768 (if (string-match "^[^:]+:" group)
3769 (substring group 0 (match-end 0))
3770 "")
3771 nil))
3773 (defun gnus-group-short-name (group)
3774 "Return the short group name."
3775 (let ((prefix (gnus-group-real-prefix group)))
3776 (if (< 0 (length prefix))
3777 (substring group (length prefix) nil)
3778 group)))
3780 (defun gnus-group-prefixed-p (group)
3781 "Return the prefix of the current group name."
3782 (< 0 (length (gnus-group-real-prefix group))))
3784 (declare-function gnus-group-decoded-name "gnus-group" (string))
3786 (defun gnus-summary-buffer-name (group)
3787 "Return the summary buffer name of GROUP."
3788 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3790 (defun gnus-group-method (group)
3791 "Return the server or method used for selecting GROUP.
3792 You should probably use `gnus-find-method-for-group' instead."
3793 (let ((prefix (gnus-group-real-prefix group)))
3794 (if (equal prefix "")
3795 gnus-select-method
3796 (let ((servers gnus-opened-servers)
3797 (server "")
3798 backend possible found)
3800 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3801 server (substring prefix (match-end 0) (1- (length prefix))))
3802 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3803 (while servers
3804 (when (eq (caaar servers) backend)
3805 (setq possible (caar servers))
3806 (when (equal (cadaar servers) server)
3807 (setq found (caar servers))))
3808 (pop servers))
3809 (or (car (rassoc found gnus-server-alist))
3810 found
3811 (car (rassoc possible gnus-server-alist))
3812 possible
3813 (list backend server))))))
3815 (defsubst gnus-native-method-p (method)
3816 "Return whether METHOD is the native select method."
3817 (gnus-method-equal method gnus-select-method))
3819 (defsubst gnus-secondary-method-p (method)
3820 "Return whether METHOD is a secondary select method."
3821 (let ((methods gnus-secondary-select-methods)
3822 (gmethod (inline (gnus-server-get-method nil method))))
3823 (while (and methods
3824 (not (gnus-method-equal
3825 (inline (gnus-server-get-method nil (car methods)))
3826 gmethod)))
3827 (setq methods (cdr methods)))
3828 methods))
3830 (defun gnus-method-simplify (method)
3831 "Return the shortest uniquely identifying string or method for METHOD."
3832 (cond ((stringp method)
3833 method)
3834 ((gnus-native-method-p method)
3835 nil)
3836 ((gnus-secondary-method-p method)
3837 (format "%s:%s" (nth 0 method) (nth 1 method)))
3838 (t
3839 method)))
3841 (defun gnus-groups-from-server (server)
3842 "Return a list of all groups that are fetched from SERVER."
3843 (let ((alist (cdr gnus-newsrc-alist))
3844 info groups)
3845 (while (setq info (pop alist))
3846 (when (gnus-server-equal (gnus-info-method info) server)
3847 (push (gnus-info-group info) groups)))
3848 (sort groups 'string<)))
3850 (defun gnus-group-foreign-p (group)
3851 "Say whether a group is foreign or not."
3852 (and (not (gnus-group-native-p group))
3853 (not (gnus-group-secondary-p group))))
3855 (defun gnus-group-native-p (group)
3856 "Say whether the group is native or not."
3857 (not (string-match ":" group)))
3859 (defun gnus-group-secondary-p (group)
3860 "Say whether the group is secondary or not."
3861 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3863 (defun gnus-parameters-get-parameter (group)
3864 "Return the group parameters for GROUP from `gnus-parameters'."
3865 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3866 case-fold-search
3867 gnus-parameters-case-fold-search))
3868 params-list)
3869 (dolist (elem gnus-parameters)
3870 (when (string-match (car elem) group)
3871 (setq params-list
3872 (nconc (gnus-expand-group-parameters
3873 (car elem) (cdr elem) group)
3874 params-list))))
3875 params-list))
3877 (defun gnus-expand-group-parameter (match value group)
3878 "Use MATCH to expand VALUE in GROUP."
3879 (with-temp-buffer
3880 (insert group)
3881 (goto-char (point-min))
3882 (while (re-search-forward match nil t)
3883 (replace-match value))
3884 (buffer-string)))
3886 (defun gnus-expand-group-parameters (match parameters group)
3887 "Go through PARAMETERS and expand them according to the match data."
3888 (let (new)
3889 (dolist (elem parameters)
3890 (if (and (stringp (cdr elem))
3892 (push (cons (car elem)
3893 (gnus-expand-group-parameter match (cdr elem) group))
3894 new)
3895 (push elem new)))
3896 new))
3898 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3899 "For GROUP, return the value of SYMBOL.
3901 You should call this in the `gnus-group-buffer' buffer.
3902 The function `gnus-group-find-parameter' will do that for you."
3903 ;; The speed trick: No cons'ing and quit early.
3904 (let* ((params (funcall gnus-group-get-parameter-function group))
3905 ;; Start easy, check the "real" group parameters.
3906 (simple-results
3907 (gnus-group-parameter-value params symbol allow-list t)))
3908 (if simple-results
3909 ;; Found results; return them.
3910 (car simple-results)
3911 ;; We didn't find it there, try `gnus-parameters'.
3912 (let ((result nil)
3913 (head nil)
3914 (tail gnus-parameters))
3915 ;; A good old-fashioned non-cl loop.
3916 (while tail
3917 (setq head (car tail)
3918 tail (cdr tail))
3919 ;; The car is regexp matching for matching the group name.
3920 (when (string-match (car head) group)
3921 ;; The cdr is the parameters.
3922 (setq result (gnus-group-parameter-value (cdr head)
3923 symbol allow-list))
3924 (when result
3925 ;; Expand if necessary.
3927 (setq result (gnus-expand-group-parameter (car head)
3928 result group)))
3929 ;; Exit the loop early.
3930 (setq tail nil))))
3931 ;; Done.
3932 result))))
3934 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3935 "Return the group parameters for GROUP.
3936 If SYMBOL, return the value of that symbol in the group parameters.
3938 If you call this function inside a loop, consider using the faster
3939 `gnus-group-fast-parameter' instead."
3940 (with-current-buffer gnus-group-buffer
3941 (if symbol
3942 (gnus-group-fast-parameter group symbol allow-list)
3943 (nconc
3944 (copy-sequence
3945 (funcall gnus-group-get-parameter-function group))
3946 (gnus-parameters-get-parameter group)))))
3948 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3949 "Return the group parameters for GROUP.
3950 If SYMBOL, return the value of that symbol in the group parameters.
3951 If ALLOW-LIST, also allow list as a result.
3952 Most functions should use `gnus-group-find-parameter', which
3953 also examines the topic parameters."
3954 (let ((params (gnus-info-params (gnus-get-info group))))
3955 (if symbol
3956 (gnus-group-parameter-value params symbol allow-list)
3957 params)))
3959 (defun gnus-group-parameter-value (params symbol &optional
3960 allow-list present-p)
3961 "Return the value of SYMBOL in group PARAMS.
3962 If ALLOW-LIST, also allow list as a result."
3963 ;; We only wish to return group parameters (dotted lists) and
3964 ;; not local variables, which may have the same names.
3965 ;; But first we handle single elements...
3966 (or (car (memq symbol params))
3967 ;; Handle alist.
3968 (let (elem)
3969 (catch 'found
3970 (while (setq elem (pop params))
3971 (when (and (consp elem)
3972 (eq (car elem) symbol)
3973 (or allow-list
3974 (atom (cdr elem))))
3975 (throw 'found (if present-p (list (cdr elem))
3976 (cdr elem)))))))))
3978 (defun gnus-group-add-parameter (group param)
3979 "Add parameter PARAM to GROUP."
3980 (let ((info (gnus-get-info group)))
3981 (when info
3982 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3983 ;; Cons the new param to the old one and update.
3984 (gnus-group-set-info (cons param (gnus-info-params info))
3985 group 'params))))
3987 (defun gnus-group-set-parameter (group name value)
3988 "Set parameter NAME to VALUE in GROUP."
3989 (let ((info (gnus-get-info group)))
3990 (when info
3991 (gnus-group-remove-parameter group name)
3992 (let ((old-params (gnus-info-params info))
3993 (new-params (list (cons name value))))
3994 (while old-params
3995 (when (or (not (listp (car old-params)))
3996 (not (eq (caar old-params) name)))
3997 (setq new-params (append new-params (list (car old-params)))))
3998 (setq old-params (cdr old-params)))
3999 (gnus-group-set-info new-params group 'params)))))
4001 (defun gnus-group-remove-parameter (group name)
4002 "Remove parameter NAME from GROUP."
4003 (let ((info (gnus-get-info group)))
4004 (when info
4005 (let ((params (gnus-info-params info)))
4006 (when params
4007 (setq params (delq name params))
4008 (while (assq name params)
4009 (gnus-pull name params))
4010 (gnus-info-set-params info params))))))
4012 (defun gnus-group-add-score (group &optional score)
4013 "Add SCORE to the GROUP score.
4014 If SCORE is nil, add 1 to the score of GROUP."
4015 (let ((info (gnus-get-info group)))
4016 (when info
4017 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
4019 (defun gnus-short-group-name (group &optional levels)
4020 "Collapse GROUP name LEVELS.
4021 Select methods are stripped and any remote host name is stripped down to
4022 just the host name."
4023 (let* ((name "")
4024 (foreign "")
4025 (depth 0)
4026 (skip 1)
4027 (levels (or levels
4028 gnus-group-uncollapsed-levels
4029 (progn
4031 (setq skip (match-end 0)
4032 depth (+ depth 1)))
4033 depth))))
4034 ;; Separate foreign select method from group name and collapse.
4035 ;; If method contains a server, collapse to non-domain server name,
4036 ;; otherwise collapse to select method.
4037 (let* ((colon (string-match ":" group))
4038 (server (and colon (substring group 0 colon)))
4039 (plus (and server (string-match "+" server))))
4040 (when server
4041 (if plus
4042 (setq foreign (substring server (+ 1 plus)
4044 group (substring group (+ 1 colon)))
4045 (setq foreign server
4046 group (substring group (+ 1 colon))))
4047 (setq foreign (concat foreign ":")))
4048 ;; Collapse group name leaving LEVELS uncollapsed elements
4049 (let* ((slist (split-string group "/"))
4050 (slen (length slist))
4052 (dlen (length dlist))
4053 glist
4054 glen
4055 gsep
4056 res)
4057 (if (> slen dlen)
4058 (setq glist slist
4059 glen slen
4060 gsep "/")
4061 (setq glist dlist
4062 glen dlen
4063 gsep "."))
4064 (setq levels (- glen levels))
4065 (dolist (g glist)
4066 (push (if (>= (decf levels) 0)
4067 (if (zerop (length g))
4068 ""
4069 (substring g 0 1))
4070 g)
4071 res))
4072 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4074 (defun gnus-narrow-to-body ()
4075 "Narrow to the body of an article."
4076 (narrow-to-region
4077 (progn
4078 (goto-char (point-min))
4080 (point-max)))
4081 (point-max)))
4083 \f
4084 ;;;
4085 ;;; Kill file handling.
4086 ;;;
4088 (defun gnus-apply-kill-file ()
4089 "Apply a kill file to the current newsgroup.
4090 Returns the number of articles marked as read."
4091 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4092 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4093 (gnus-apply-kill-file-internal)
4094 0))
4096 (defun gnus-kill-save-kill-buffer ()
4097 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4098 (when (get-file-buffer file)
4099 (with-current-buffer (get-file-buffer file)
4100 (when (buffer-modified-p)
4101 (save-buffer))
4102 (kill-buffer (current-buffer))))))
4104 (defcustom gnus-kill-file-name "KILL"
4105 "Suffix of the kill files."
4106 :group 'gnus-score-kill
4107 :group 'gnus-score-files
4108 :type 'string)
4110 (defun gnus-newsgroup-kill-file (newsgroup)
4111 "Return the name of a kill file name for NEWSGROUP.
4112 If NEWSGROUP is nil, return the global kill file name instead."
4113 (cond
4114 ;; The global KILL file is placed at top of the directory.
4115 ((or (null newsgroup)
4116 (string-equal newsgroup ""))
4117 (expand-file-name gnus-kill-file-name
4118 gnus-kill-files-directory))
4119 ;; Append ".KILL" to newsgroup name.
4120 ((gnus-use-long-file-name 'not-kill)
4121 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4122 "." gnus-kill-file-name)
4123 gnus-kill-files-directory))
4124 ;; Place "KILL" under the hierarchical directory.
4125 (t
4126 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4127 "/" gnus-kill-file-name)
4128 gnus-kill-files-directory))))
4130 ;;; Server things.
4132 (defun gnus-member-of-valid (symbol group)
4134 (memq symbol (assoc
4135 (symbol-name (car (gnus-find-method-for-group group)))
4136 gnus-valid-select-methods)))
4138 (defun gnus-method-option-p (method option)
4139 "Return non-nil if select METHOD has OPTION as a parameter."
4140 (when (stringp method)
4141 (setq method (gnus-server-to-method method)))
4142 (memq option (assoc (format "%s" (car method))
4143 gnus-valid-select-methods)))
4145 (defun gnus-similar-server-opened (method)
4146 (let ((opened gnus-opened-servers))
4147 (while (and method opened)
4148 (when (and (equal (cadr method) (cadaar opened))
4149 (equal (car method) (caaar opened))
4150 (not (equal method (caar opened))))
4151 (setq method nil))
4152 (pop opened))
4153 (not method)))
4155 (defun gnus-server-extend-method (group method)
4156 ;; This function "extends" a virtual server. If the server is
4157 ;; "hello", and the select method is ("hello" (my-var "something"))
4158 ;; in the group "alt.alt", this will result in a new virtual server
4159 ;; called "hello+alt.alt".
4160 (if (or (not (inline (gnus-similar-server-opened method)))
4161 (not (cddr method)))
4162 method
4163 `(,(car method) ,(concat (cadr method) "+" group)
4164 (,(intern (format "%s-address" (car method))) ,(cadr method))
4165 ,@(cddr method))))
4167 (defun gnus-server-status (method)
4168 "Return the status of METHOD."
4169 (nth 1 (assoc method gnus-opened-servers)))
4171 (defun gnus-group-name-to-method (group)
4172 "Guess a select method based on GROUP."
4173 (if (string-match ":" group)
4174 (let ((server (substring group 0 (match-beginning 0))))
4176 (list (intern (substring server 0 (match-beginning 0)))
4177 (substring server (match-end 0)))
4178 (list (intern server) "")))
4179 gnus-select-method))
4181 (defun gnus-server-string (server)
4182 "Return a readable string that describes SERVER."
4183 (let* ((server (gnus-server-to-method server))
4184 (address (nth 1 server)))
4185 (if (and address
4186 (not (zerop (length address))))
4187 (format "%s using %s" address (car server))
4188 (format "%s" (car server)))))
4190 (defun gnus-find-method-for-group (group &optional info)
4191 "Find the select method that GROUP uses."
4192 (or gnus-override-method
4193 (and (not group)
4194 gnus-select-method)
4195 (and (not (gnus-group-entry group))
4196 ;; Killed or otherwise unknown group.
4197 (or
4198 ;; If we know a virtual server by that name, return its method.
4199 (gnus-server-to-method (gnus-group-server group))
4200 ;; Guess a new method as last resort.
4201 (gnus-group-name-to-method group)))
4202 (let ((info (or info (gnus-get-info group)))
4203 method)
4204 (if (or (not info)
4205 (not (setq method (gnus-info-method info)))
4206 (equal method "native"))
4207 gnus-select-method
4208 (setq method
4209 (cond ((stringp method)
4210 (inline (gnus-server-to-method method)))
4211 ((stringp (cadr method))
4212 (inline (gnus-server-extend-method group method)))
4213 (t
4214 method)))
4215 (cond ((equal (cadr method) "")
4216 method)
4217 ((null (cadr method))
4218 (list (car method) ""))
4219 (t
4220 (gnus-server-add-address method)))))))
4222 (defun gnus-methods-using (feature)
4223 "Find all methods that have FEATURE."
4224 (let ((valids gnus-valid-select-methods)
4225 outs)
4226 (while valids
4227 (when (memq feature (car valids))
4228 (push (car valids) outs))
4229 (setq valids (cdr valids)))
4230 outs))
4232 (eval-and-compile
4233 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4235 (defun gnus-read-group (prompt &optional default)
4236 "Prompt the user for a group name.
4237 Disallow invalid group names."
4238 (let ((prefix "")
4239 group)
4240 (while (not group)
4241 (when (string-match
4242 gnus-invalid-group-regexp
4243 (setq group (read-string (concat prefix prompt)
4244 (cons (or default "") 0)
4245 'gnus-group-history)))
4246 (let ((match (match-string 0 group)))
4247 ;; Might be okay (e.g. for nnimap), so ask the user:
4249 (message-y-or-n-p
4250 "Proceed and create group anyway? " t
4253 Usually, it's dangerous to create a group with this name, because it's not
4254 supported by all back ends and servers. On IMAP servers it should work,
4255 though. If you are really sure, you can proceed anyway and create the group.
4257 You may customize the variable `gnus-invalid-group-regexp', which currently is
4261 group nil)))))
4262 group))
4264 (defun gnus-read-method (prompt)
4265 "Prompt the user for a method.
4266 Allow completion over sensible values."
4267 (let* ((open-servers
4268 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4269 gnus-opened-servers))
4270 (valid-methods
4271 (let (methods)
4272 (dolist (method gnus-valid-select-methods)
4273 (if (or (memq 'prompt-address method)
4274 (not (assoc (format "%s:" (car method)) open-servers)))
4275 (push method methods)))
4276 methods))
4277 (servers
4278 (append valid-methods
4279 open-servers
4280 gnus-predefined-server-alist
4281 gnus-server-alist))
4282 (method
4283 (completing-read
4284 prompt servers
4285 nil t nil 'gnus-method-history)))
4286 (cond
4287 ((equal method "")
4288 (setq method gnus-select-method))
4289 ((assoc method gnus-valid-select-methods)
4290 (let ((address (if (memq 'prompt-address
4291 (assoc method gnus-valid-select-methods))
4292 (read-string "Address: ")
4293 "")))
4294 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4295 (list (intern method) address))))
4296 ((assoc method servers)
4297 method)
4298 (t
4299 (list (intern method) "")))))
4301 ;;; Agent functions
4303 (defun gnus-agent-method-p (method-or-server)
4304 "Say whether METHOD is covered by the agent."
4305 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4306 (let* ((method (if (stringp method-or-server)
4307 (gnus-server-to-method method-or-server)
4308 method-or-server))
4309 (server (gnus-method-to-server method t)))
4310 (setq gnus-agent-method-p-cache
4311 (cons method-or-server
4312 (member server gnus-agent-covered-methods)))))
4313 (cdr gnus-agent-method-p-cache))
4315 (defun gnus-online (method)
4316 (not
4317 (if gnus-plugged
4318 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4319 (gnus-agent-method-p method))))
4321 ;;; User-level commands.
4323 ;;;###autoload
4324 (defun gnus-slave-no-server (&optional arg)
4325 "Read network news as a slave, without connecting to the local server."
4326 (interactive "P")
4327 (gnus-no-server arg t))
4329 ;;;###autoload
4330 (defun gnus-no-server (&optional arg slave)
4331 "Read network news.
4332 If ARG is a positive number, Gnus will use that as the startup
4333 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4334 non-nil and not a positive number, Gnus will prompt the user for the
4335 name of an NNTP server to use.
4336 As opposed to `gnus', this command will not connect to the local
4337 server."
4338 (interactive "P")
4339 (gnus-no-server-1 arg slave))
4341 ;;;###autoload
4342 (defun gnus-slave (&optional arg)
4343 "Read news as a slave."
4344 (interactive "P")
4345 (gnus arg nil 'slave))
4347 ;;;###autoload
4348 (defun gnus-other-frame (&optional arg display)
4349 "Pop up a frame to read news.
4350 This will call one of the Gnus commands which is specified by the user
4351 option `gnus-other-frame-function' (default `gnus') with the argument
4352 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4353 optional second argument DISPLAY should be a standard display string
4355 omitted or the function `make-frame-on-display' is not available, the
4356 current display is used."
4357 (interactive "P")
4358 (if (fboundp 'make-frame-on-display)
4359 (unless display
4360 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4361 (setq display nil))
4362 (let ((alive (gnus-alive-p)))
4363 (unless (and alive
4364 (catch 'found
4365 (walk-windows
4366 (lambda (window)
4367 (when (and (or (not display)
4368 (equal display
4369 (gnus-frame-or-window-display-name
4370 window)))
4371 (with-current-buffer (window-buffer window)
4373 (symbol-name major-mode))))
4374 (gnus-select-frame-set-input-focus
4375 (setq gnus-other-frame-object (window-frame window)))
4376 (select-window window)
4377 (throw 'found t)))
4378 'ignore t)))
4379 (gnus-select-frame-set-input-focus
4380 (setq gnus-other-frame-object
4381 (if display
4382 (make-frame-on-display display gnus-other-frame-parameters)
4383 (make-frame gnus-other-frame-parameters))))
4384 (if alive
4385 (switch-to-buffer gnus-group-buffer)
4386 (funcall gnus-other-frame-function arg)
4387 (add-hook 'gnus-exit-gnus-hook
4388 '(lambda nil
4389 (when (and (frame-live-p gnus-other-frame-object)
4390 (cdr (frame-list)))
4391 (delete-frame gnus-other-frame-object))
4392 (setq gnus-other-frame-object nil)))))))
4394 ;;;###autoload
4395 (defun gnus (&optional arg dont-connect slave)
4396 "Read network news.
4397 If ARG is non-nil and a positive number, Gnus will use that as the
4398 startup level. If ARG is non-nil and not a positive number, Gnus will
4399 prompt the user for the name of an NNTP server to use."
4400 (interactive "P")
4401 (unless (byte-code-function-p (symbol-function 'gnus))
4402 (message "You should byte-compile Gnus")
4403 (sit-for 2))
4404 (gnus-1 arg dont-connect slave))
4406 ;; Allow redefinition of Gnus functions.
4408 (gnus-ems-redefine)
4410 (provide 'gnus)
4412 ;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4413 ;;; gnus.el ends here