| blob | b07dfc648c0057e86ec56e8ac5bcce92a4c8160e |
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
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;;; Code:
32 ;; For Emacs < 22.2.
41 ;; These are defined afterwards with gnus-define-group-parameter
55 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
60 "Starting your favorite newsreader."
64 "Dealing with formatting issues."
68 "Group character set issues."
74 "Cache interface."
79 "Article Registry."
83 "Server options at startup."
86 ;; These belong to gnus-group.el.
88 "Group buffers."
93 "Foreign groups."
98 "Automatic subscription of new groups."
102 "Group levels."
107 "Selecting a Group."
112 "Showing slices of the group list."
117 "Sorting the group buffer."
123 "Various group options."
127 ;; These belong to gnus-sum.el.
129 "Summary buffers."
134 "Leaving summary buffers."
139 "Marks used in summary buffers."
144 "Ordering articles according to replies."
149 "Formatting of the summary buffer."
154 "Choosing Articles."
159 "Summary movement commands."
164 "Show pictures of people, domains, and newsgroups."
168 "Mail group commands."
173 "Sorting the summary buffer."
178 "Highlighting and menus in the summary buffer."
184 "Various summary buffer options."
189 "Pick mode in the summary buffer."
195 "Tree display of threads in the summary buffer."
200 ;; Belongs to gnus-uu.el
202 "Viewing extracted files."
206 ;; Belongs to gnus-score.el
208 "Score and kill file handling."
212 "Kill files."
216 "Adaptive score files."
220 "Default values for score files."
224 "Expiring score rules."
228 "Decaying score rules."
232 "Score and kill file names."
237 "Various scoring and killing options."
240 ;; Other
242 "Options controlling the visual fluff."
247 "Offline support for Gnus."
251 "Files used by Gnus."
255 "Auto save file."
260 "Storing Gnus state."
264 "Options related to newsservers and other servers used by Gnus."
268 "Highlighting and menus in the server buffer."
273 "Composing replies and followups in Gnus."
277 "Meta variables controlling major portions of Gnus.
278 In general, modifying these variables does not take affect until Gnus
279 is restarted, and sometimes reloaded."
283 "Other Gnus options."
288 "Exiting Gnus."
293 "Frivolous Gnus extensions."
304 "If non-nil, the startup message will not be displayed.
305 This variable is used before `.gnus.el' is loaded, so it should
306 be set in `.emacs' instead."
311 "If non-nil, play the Gnus jingle at startup."
343 0 5
352 gnus-mode-line-image-cache)
354 "This is %s, %s."
356 str)
358 line)))
364 ;;(defalias 'gnus-decode-rfc1522 'ignore)
365 )
367 ;; We define these group faces here to avoid the display
368 ;; update forced when creating new faces.
378 ()))
379 "Level 1 newsgroup face."
381 ;; backward-compatibility alias
393 ()))
394 "Level 1 empty newsgroup face."
396 ;; backward-compatibility alias
408 ()))
409 "Level 2 newsgroup face."
411 ;; backward-compatibility alias
423 ()))
424 "Level 2 empty newsgroup face."
426 ;; backward-compatibility alias
438 ()))
439 "Level 3 newsgroup face."
441 ;; backward-compatibility alias
448 ())
451 ())
453 ()))
454 "Level 3 empty newsgroup face."
456 ;; backward-compatibility alias
468 ()))
469 "Level 4 newsgroup face."
471 ;; backward-compatibility alias
478 ())
481 ())
483 ()))
484 "Level 4 empty newsgroup face."
486 ;; backward-compatibility alias
498 ()))
499 "Level 5 newsgroup face."
501 ;; backward-compatibility alias
508 ())
511 ())
513 ()))
514 "Level 5 empty newsgroup face."
516 ;; backward-compatibility alias
528 ()))
529 "Level 6 newsgroup face."
531 ;; backward-compatibility alias
538 ())
541 ())
543 ()))
544 "Level 6 empty newsgroup face."
546 ;; backward-compatibility alias
558 ()))
559 "Low level newsgroup face."
561 ;; backward-compatibility alias
573 ()))
574 "Low level empty newsgroup face."
576 ;; backward-compatibility alias
589 "Level 1 mailgroup face."
591 ;; backward-compatibility alias
604 "Level 1 empty mailgroup face."
606 ;; backward-compatibility alias
619 "Level 2 mailgroup face."
621 ;; backward-compatibility alias
634 "Level 2 empty mailgroup face."
636 ;; backward-compatibility alias
649 "Level 3 mailgroup face."
651 ;; backward-compatibility alias
663 ()))
664 "Level 3 empty mailgroup face."
666 ;; backward-compatibility alias
679 "Low level mailgroup face."
681 ;; backward-compatibility alias
694 "Low level empty mailgroup face."
696 ;; backward-compatibility alias
700 ;; Summary mode faces.
703 "Face used for selected articles."
705 ;; backward-compatibility alias
712 "Face used for cancelled articles."
714 ;; backward-compatibility alias
727 "Face used for high interest ticked articles."
729 ;; backward-compatibility alias
742 "Face used for low interest ticked articles."
744 ;; backward-compatibility alias
756 ()))
757 "Face used for normal interest ticked articles."
759 ;; backward-compatibility alias
772 "Face used for high interest ancient articles."
774 ;; backward-compatibility alias
787 "Face used for low interest ancient articles."
789 ;; backward-compatibility alias
801 ()))
802 "Face used for normal interest ancient articles."
804 ;; backward-compatibility alias
815 "Face used for high interest uncached articles."
817 ;; backward-compatibility alias
828 "Face used for low interest uncached articles."
830 ;; backward-compatibility alias
841 "Face used for normal interest uncached articles."
843 ;; backward-compatibility alias
850 "Face used for high interest unread articles."
852 ;; backward-compatibility alias
859 "Face used for low interest unread articles."
861 ;; backward-compatibility alias
867 ()))
868 "Face used for normal interest unread articles."
870 ;; backward-compatibility alias
885 "Face used for high interest read articles."
887 ;; backward-compatibility alias
902 "Face used for low interest read articles."
904 ;; backward-compatibility alias
916 ()))
917 "Face used for normal interest read articles."
919 ;; backward-compatibility alias
924 ;;;
925 ;;; Gnus buffers
926 ;;;
931 "Do the same as `get-buffer-create', but store the created buffer."
936 "Add the current buffer to the list of Gnus buffers."
940 "Kill BUFFER and remove from the list of Gnus buffers."
947 "Return a list of live Gnus buffers."
956 gnus-buffers)
958 ;;; Splash screen.
972 ()))
973 "Face for the splash screen."
975 ;; backward-compatibility alias
991 "Indent rigidly using only spaces and no tabs."
997 ;; We translate tabs into spaces -- not everybody uses
998 ;; an 8-character tab.
1005 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1029 "*Color styles used for the Gnus logo."
1031 gnus-logo-color-alist))
1041 "Insert startup message in current buffer."
1042 ;; Insert the message.
1048 ;; Make sure the library defining `image-load-path' is loaded
1049 ;; (`find-image' is autoloaded) (and discard the result). Else, we may
1050 ;; get "defvar ignored because image-load-path is let-bound" when calling
1051 ;; `find-image' below.
1063 :color-symbols
1069 ;; Account for the pbm's blackground.
1073 ;; Account for the xbm's blackground.
1084 t))))
1088 _ ___ _ _
1089 _ ___ __ ___ __ _ ___
1090 __ _ ___ __ ___
1091 _ ___ _
1092 _ _ __ _
1093 ___ __ _
1094 __ _
1095 _ _ _
1096 _ _ _
1097 _ _ _
1098 __ ___
1099 _ _ _ _
1100 _ _
1101 _ _
1102 _ _
1103 _
1104 __
1106 "
1108 ;; And then hack it.
1117 ;; Fontify some.
1131 ;;; Do the rest.
1137 "Alist of group parameters.
1139 For example:
1141 (gnus-use-scoring nil)
1142 (gnus-summary-line-format
1144 (gcc-self . t)
1145 (display . all))
1148 (broken-reply-to . t)))"
1155 "If it is t, ignore case of group names specified in `gnus-parameters'.
1156 If it is nil, don't ignore case. If it is `default', which is for the
1157 backward compatibility, use the value of `case-fold-search'."
1168 "Define a group parameter PARAM.
1169 REST is a plist of following:
1170 :type One of `bool', `list' or nil.
1171 :function The name of the function.
1172 :function-document The documentation of the function.
1173 :parameter-type The type for customizing the parameter.
1174 :parameter-document The documentation for the parameter.
1175 :variable The name of the variable.
1176 :variable-document The documentation for the variable.
1177 :variable-group The group for customizing the variable.
1178 :variable-type The type for customizing the variable.
1179 :variable-default The default value of the variable."
1196 'progn
1198 ,variable-document
1204 gnus-group-parameters-more))
1207 ,parameter-type
1211 ,function-document
1213 val)
1216 t)
1221 (,variable
1223 elem value)
1231 ,function-document
1235 elem value)
1242 'value
1247 All other Gnus file and directory variables are initialized from this variable."
1253 "*Directory variable from which all other Gnus file variables are derived.
1255 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1256 This means that other directory variables that are initialized from
1257 this variable won't be set properly if you set this variable in `.gnus.el'.
1258 Set this variable in `.emacs' instead."
1263 "*Default directory for all Gnus buffers."
1266 directory))
1268 ;; Site dependent variables. These variables should be defined in
1269 ;; paths.el.
1272 "Specify a default NNTP server.
1273 This variable should be defined in paths.el, and should never be set
1274 by the user.
1275 If you want to change servers, you should use `gnus-select-method'.
1278 ;; Don't touch this variable.
1281 This is an obsolete variable, which is scarcely used. If you use an
1282 nntp server for your newsgroup and want to change the port number
1283 used to 899, you would say something along these lines:
1288 "A file with only the name of the nntp server in it."
1294 "Find default nntp server.
1295 Check the NNTPSERVER environment variable and the
1296 `gnus-nntpserver-file' file."
1304 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1305 ;; starting or even loading Gnus.
1306 ;;;###autoload(when (fboundp 'custom-autoload)
1307 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1317 gnus-default-nntp-server)
1321 nil
1324 "Default method for selecting a newsgroup.
1325 This variable should be a list, where the first element is how the
1326 news is to be fetched, the second is the address.
1329 NNTP, you could say:
1333 If you want to use your local spool, say:
1335 \(setq gnus-select-method (list 'nnspool (system-name)))
1337 If you use this variable, you must set `gnus-nntp-server' to nil.
1339 There is a lot more to know about select methods and virtual servers -
1340 see the manual for details."
1347 "*Method used for archiving messages you've sent.
1348 This should be a mail method.
1350 See also `gnus-update-message-archive-method'."
1354 gnus-select-method))
1359 The archive method is initially set according to the value of
1361 so that it may be used as a real method of the server which is named
1363 updated if the value of this variable is nil, even if you change the
1364 value of `gnus-message-archive-method' afterward. If you want the
1366 `gnus-message-archive-method', set this variable to a non-nil value."
1373 "*Name of the group in which to save the messages you've written.
1374 This can either be a string; a list of strings; or an alist
1375 of regexps/functions/forms to be evaluated to return a string (or a list
1376 of strings). The functions are called with the name of the current
1377 group (or nil) as a parameter.
1379 If you want to save your mail in one group and the news articles you
1380 write in another group, you could say something like:
1382 \(setq gnus-message-archive-group
1383 '((if (message-news-p)
1387 Normally the group names returned by this variable should be
1389 However, you may wish to store the message on some other server. In
1390 that case, just return a fully prefixed name of the group --
1394 function
1395 sexp
1396 string))
1399 "List of NNTP servers that the user can choose between interactively.
1400 To make Gnus query you for a server, you have to give `gnus' a
1401 non-numeric prefix - `C-u M-x gnus', in short."
1406 "*The name of the host running the NNTP server.
1407 This variable is semi-obsolete. Use the `gnus-select-method'
1408 variable instead."
1411 string))
1414 "A list of secondary methods that will be used for reading news.
1415 This is a list where each element is a complete select method (see
1416 `gnus-select-method').
1418 If, for instance, you want to read your mail with the nnml back end,
1419 you could set this variable:
1427 "Default default new newsgroups the first time Gnus is run.
1431 "Local domain name without a host name.
1432 The DOMAINNAME environment variable is used instead if it is defined.
1433 If the function `system-name' returns the full Internet name, there is
1434 no need to set this variable."
1437 string))
1440 "String with a description of what organization (if any) the user belongs to.
1443 ;; Customization variables
1446 "Preferred method for fetching an article by Message-ID.
1447 If you are reading news from the local spool (with nnspool), fetching
1448 articles by Message-ID is painfully slow. By setting this method to an
1449 nntp method, you might get acceptable results.
1451 The value of this variable must be a valid select method as discussed
1452 in the documentation of `gnus-select-method'.
1454 It can also be a list of select methods, as well as the special symbol
1455 `current', which means to use the current select method. If it is a
1456 list, Gnus will try all the methods in the list until it finds a match."
1461 gnus-select-method
1469 gnus-select-method))))
1473 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1474 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1475 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1476 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1477 "/ftp@rtfm.mit.edu:/pub/usenet/"
1478 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1479 "/ftp@ftp.sunet.se:/pub/usenet/"
1480 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1481 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1483 "*Directory where the group FAQs are stored.
1484 This will most commonly be on a remote machine, and the file will be
1485 fetched by ange-ftp.
1487 This variable can also be a list of directories. In that case, the
1488 first element in the list will be used by default. The others can
1489 be used when being prompted for a site.
1491 Note that Gnus uses an aol machine as the default directory. If this
1492 feels fundamentally unclean, just think of it as a way to finally get
1493 something of value back from them.
1495 If the default site is too slow, try one of these:
1497 North America: mirrors.aol.com /pub/rtfm/usenet
1498 ftp.seas.gwu.edu /pub/rtfm
1499 rtfm.mit.edu /pub/usenet
1500 Europe: ftp.uni-paderborn.de /pub/FAQ
1501 src.doc.ic.ac.uk /usenet/news-FAQS
1502 ftp.sunet.se /pub/usenet
1503 ftp.pasteur.fr /pub/FAQ
1504 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1505 hwarang.postech.ac.kr /pub/usenet
1506 ftp.hk.super.net /mirror/faqs"
1533 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1534 When FORM is evaluated `name' is bound to the name of the group."
1541 "*Non-nil means that control messages are displayed using `browse-url'.
1542 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1543 group."
1549 "*Non-nil means that cross referenced articles will be marked as read.
1550 If nil, ignore cross references. If t, mark articles as read in
1551 subscribed newsgroups. If neither t nor nil, mark as read in all
1552 newsgroups."
1560 "*Process mark."
1566 "*The number of articles which indicates a large newsgroup.
1567 If the number of articles in a newsgroup is greater than this value,
1568 confirmation is required for selecting the newsgroup.
1569 If it is nil, no confirmation is required."
1572 integer))
1575 "*Non-nil means that the default name of a file to save articles in is the group name.
1576 If it's nil, the directory form of the group name is used instead.
1578 If this variable is a list, and the list contains the element
1579 `not-score', long file names will not be used for score files; if it
1580 contains the element `not-save', long file names will not be used for
1581 saving; and if it contains the element `not-kill', long file names
1582 will not be used for kill files.
1584 Note that the default for this variable varies according to what system
1585 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1586 to nil while on all other systems it defaults to t."
1604 "*If non-nil, save group scoring info."
1610 "*If non-nil, allow undoing in Gnus group mode buffers."
1615 "*If non-nil, use some adaptive scoring scheme.
1616 If a list, then the values `word' and `line' are meaningful. The
1617 former will perform adaption on individual words in the subject
1618 header while `line' will perform adaption on several headers."
1624 "*If nil, Gnus will ignore the article cache.
1625 If `passive', it will allow entering (and reading) articles
1626 explicitly entered into the cache. If anything else, use the
1627 cache to the full extent of the law."
1635 "*If non-nil, display a thread tree buffer."
1640 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1641 If it is a number N, then Gnus will only keep the last N articles
1642 read. If it is neither nil nor a number, Gnus will keep all read
1643 articles. This is not a good idea."
1646 integer
1651 "*If non-nil, Gnus will read NoCeM cancel messages.
1652 You can also set this variable to a positive number as a group level.
1653 In that case, Gnus scans NoCeM messages when checking new news if this
1654 value is not exceeding a group level that you specify as the prefix
1655 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1656 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1657 level to those commands."
1666 gnus-level-default-subscribed
1670 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1675 "*If non-nil, enable scoring."
1681 "*A hook called when preparing to exit from the summary buffer.
1682 It calls `gnus-summary-expire-articles' by default."
1687 "*Non-nil means that you are a Usenet novice.
1688 If non-nil, verbose messages may be displayed and confirmations may be
1689 required."
1694 "*Non-nil means that you will never be asked for confirmation about anything.
1695 That doesn't mean *anything* anything; particularly destructive
1696 commands will still require prompting."
1701 "*If non-nil, require your confirmation when catching up a group."
1706 "*If non-nil, require your confirmation when exiting Gnus."
1711 "*Function for extracting address components from a From header.
1712 Two pre-defined function exist: `gnus-extract-address-components',
1713 which is the default, quite fast, and too simplistic solution, and
1714 `mail-extract-address-components', which works much better, but is
1715 slower."
1722 "*If non-nil, display clickable icons."
1727 "String used to separate shell commands."
1759 "*An alist of valid select methods.
1760 The first element of each list lists should be a string with the name
1761 of the select method. The other elements may be the category of
1762 this method (i. e., `post', `mail', `none' or whatever) or other
1763 properties that this method has (like being respoolable).
1764 If you implement a new select method, all you should have to change is
1765 this variable. I think."
1780 "Recomputes the select-method widget based on the value of
1781 `gnus-valid-select-methods'."
1783 "Widget for entering a select method."
1790 gnus-valid-select-methods)
1794 :inline t
1796 variable
1802 "List of buffers that should update their mode lines.
1803 The list may contain the symbols `group', `article', `tree' and
1804 `summary'. If the corresponding symbol is present, Gnus will keep
1805 that mode line updated with information that may be pertinent.
1806 If this variable is nil, screen refresh may be quicker."
1813 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1815 "*Max length of mode-line non-string contents.
1816 If this is nil, Gnus will take space as is needed, leaving the rest
1817 of the mode line intact. Note that the default of nil is unlikely
1818 to be desirable; see the manual for further details."
1821 integer))
1823 ;; There should be special validation for this.
1828 to-address
1829 :function-document
1830 "Return GROUP's to-address."
1831 :variable-document
1832 "*Alist of group regexps and correspondent to-addresses."
1833 :variable-group gnus-group-parameter
1836 This will be used when doing followups and posts.
1838 This is primarily useful in mail groups that represent closed
1839 mailing lists--mailing lists where it's expected that everybody that
1840 writes to the mailing list is subscribed to it. Since using this
1841 parameter ensures that the mail only goes to the mailing list itself,
1842 it means that members won't receive two copies of your followups.
1844 Using `to-address' will actually work whether the group is foreign or
1845 not. Let's say there's a group on the server that is called
1846 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1847 articles from a mail-to-news gateway. Posting directly to this group
1848 is therefore impossible--you have to send mail to the mailing list
1849 address instead.
1851 The gnus-group-split mail splitting mechanism will behave as if this
1855 to-list
1856 :function-document
1857 "Return GROUP's to-list."
1858 :variable-document
1859 "*Alist of group regexps and correspondent to-lists."
1860 :variable-group gnus-group-parameter
1863 This address will be used when doing a `a' in the group.
1865 It is totally ignored when doing a followup--except that if it is
1866 present in a news group, you'll get mail group semantics when doing
1867 `f'.
1869 The gnus-group-split mail splitting mechanism will behave as if this
1873 subscribed
1874 :type bool
1875 :function-document
1876 "Return GROUP's subscription status."
1877 :variable-document
1878 "*Groups which are automatically considered subscribed."
1879 :variable-group gnus-group-parameter
1882 Gnus assumed that you are subscribed to the To/List address.
1884 When constructing a list of subscribed groups using
1885 `gnus-find-subscribed-addresses', Gnus includes the To address given
1889 auto-expire
1890 :type bool
1891 :function gnus-group-auto-expirable-p
1892 :function-document
1893 "Check whether GROUP is auto-expirable or not."
1894 :variable gnus-auto-expirable-newsgroups
1895 :variable-default nil
1896 :variable-document
1897 "*Groups in which to automatically mark read articles as expirable.
1898 If non-nil, this should be a regexp that should match all groups in
1899 which to perform auto-expiry. This only makes sense for mail groups."
1900 :variable-group nnmail-expire
1902 regexp)
1904 :parameter-document
1908 total-expire
1909 :type bool
1910 :function gnus-group-total-expirable-p
1911 :function-document
1912 "Check whether GROUP is total-expirable or not."
1913 :variable gnus-total-expirable-newsgroups
1914 :variable-default nil
1915 :variable-document
1916 "*Groups in which to perform expiry of all read articles.
1917 Use with extreme caution. All groups that match this regexp will be
1918 expiring - which means that all read articles will be deleted after
1919 \(say) one week. (This only goes for mail groups and the like, of
1920 course.)"
1921 :variable-group nnmail-expire
1923 regexp)
1925 :parameter-document
1926 "All read articles will be put through the expiry process
1928 This happens even if they are not marked as expirable.
1932 charset
1933 :function-document
1934 "Return the default charset of GROUP."
1935 :variable gnus-group-charset-alist
1936 :variable-default
1949 :variable-document
1950 "Alist of regexps (to match group names) and default charsets to be used when reading."
1951 :variable-group gnus-charset
1959 post-method
1960 :type list
1961 :function-document
1962 "Return a posting method for GROUP."
1963 :variable gnus-post-method-alist
1964 :variable-document
1965 "Alist of regexps (to match group names) and method to be used when
1966 posting an article."
1967 :variable-group gnus-group-foreign
1968 :parameter-type
1976 :parameter-document
1980 large-newsgroup-initial
1981 :type integer
1982 :function-document
1983 "Return GROUP's initial input of the number of articles."
1984 :variable-document
1985 "*Alist of group regexps and its initial input of the number of articles."
1986 :variable-group gnus-group-parameter
1992 This number will be prompted as the initial value of the number of
1993 articles to list when the group is a large newsgroup (see
1994 `gnus-large-newsgroup'). If it is nil, the default value is the
1997 ;; The Gnus registry's ignored groups
1999 registry-ignore
2000 :type list
2001 :function-document
2002 "Whether this group should be ignored by the registry."
2003 :variable gnus-registry-ignored-groups
2004 :variable-default nil
2005 :variable-document
2006 "*Groups in which the registry should be turned off."
2007 :variable-group gnus-registry
2014 :parameter-document
2017 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
2019 "*Disable the group parameters for spam detection.
2020 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
2027 "Spam group classification (requires spam.el).
2028 This group contains spam messages. On summary entry, unread messages
2029 will be marked as spam. On summary exit, the specified spam
2030 processors will be invoked on spam-marked messages, then those
2031 messages will be expired, so the spam processor will only see a
2035 "The ham value for the spam group parameter (requires spam.el).
2036 On summary exit, the specified ham processors will be invoked on
2037 ham-marked messages. Exercise caution, since the ham processor will
2038 see the same message more than once because there is no ham message
2042 spam-contents
2043 :type list
2044 :function-document
2045 "The spam type (spam, ham, or neither) of the group."
2046 :variable gnus-spam-newsgroup-contents
2047 :variable-default nil
2048 :variable-document
2049 "*Group classification (spam, ham, or neither). Only
2050 meaningful when spam.el is loaded. If non-nil, this should be a
2051 list of group name regexps associated with a classification for
2052 each one. In spam groups, new articles are marked as spam on
2053 summary entry. There is other behavior associated with ham and
2054 no classification when spam.el is loaded - see the manual."
2055 :variable-group spam
2069 :parameter-document
2070 "The spam classification (spam, ham, or neither) of this group.
2071 When a spam group is entered, all unread articles are marked as
2072 spam. There is other behavior associated with ham and no
2076 spam-resend-to
2077 :type list
2078 :function-document
2079 "The address to get spam resent (through spam-report-resend)."
2080 :variable gnus-spam-resend-to
2081 :variable-default nil
2082 :variable-document
2083 "The address to get spam resent (through spam-report-resend)."
2084 :variable-group spam
2088 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2089 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2090 :parameter-document
2094 ham-resend-to
2095 :type list
2096 :function-document
2097 "The address to get ham resent (through spam-report-resend)."
2098 :variable gnus-ham-resend-to
2099 :variable-default nil
2100 :variable-document
2101 "The address to get ham resent (through spam-report-resend)."
2102 :variable-group spam
2106 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2107 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2108 :parameter-document
2124 "OBSOLETE: The Gmane reporting summary exit spam processor.
2131 "OBSOLETE: The ifile summary exit ham processor.
2135 "OBSOLETE: The Bogofilter summary exit ham processor.
2139 "OBSOLETE: The spam-stat summary exit ham processor.
2143 "OBSOLETE: The whitelist summary exit ham processor.
2147 "OBSOLETE: The BBDB summary exit ham processor.
2151 "OBSOLETE: The ham copy exit ham processor.
2155 "OBSOLETE: The spamoracle summary exit ham processor.
2159 spam-process
2160 :type list
2161 :parameter-type
2164 :value nil
2201 :function-document
2202 "Which spam or ham processors will be applied when the summary is exited."
2203 :variable gnus-spam-process-newsgroups
2204 :variable-default nil
2205 :variable-document
2206 "*Groups in which to automatically process spam or ham articles with
2207 a backend on summary exit. If non-nil, this should be a list of group
2208 name regexps that should match all groups in which to do automatic
2209 spam processing, associated with the appropriate processor."
2210 :variable-group spam
2211 :variable-type
2252 :parameter-document
2256 spam-autodetect
2257 :type list
2258 :parameter-type
2260 :function-document
2261 "Should spam be autodetected (with spam-split) in this group?"
2262 :variable gnus-spam-autodetect
2263 :variable-default nil
2264 :variable-document
2265 "*Groups in which spam should be autodetected when they are entered.
2266 Only unseen articles will be examined, unless
2267 spam-autodetect-recheck-messages is set."
2268 :variable-group spam
2269 :variable-type
2274 boolean))
2275 :parameter-document
2276 "Spam autodetection.
2277 Only unseen articles will be examined, unless
2281 spam-autodetect-methods
2282 :type list
2283 :parameter-type
2306 :function-document
2307 "Methods to be used for autodetection in each group"
2308 :variable gnus-spam-autodetect-methods
2309 :variable-default nil
2310 :variable-document
2311 "*Methods for autodetecting spam per group.
2312 Requires the spam-autodetect parameter. Only unseen articles
2313 will be examined, unless spam-autodetect-recheck-messages is
2314 set."
2315 :variable-group spam
2316 :variable-type
2343 :parameter-document
2344 "Spam autodetection methods.
2345 Requires the spam-autodetect parameter. Only unseen articles
2346 will be examined, unless spam-autodetect-recheck-messages is
2350 spam-process-destination
2351 :type list
2352 :parameter-type
2358 :function-document
2359 "Where spam-processed articles will go at summary exit."
2360 :variable gnus-spam-process-destinations
2361 :variable-default nil
2362 :variable-document
2363 "*Groups in which to explicitly send spam-processed articles to
2364 another group, or expire them (the default). If non-nil, this should
2365 be a list of group name regexps that should match all groups in which
2366 to do spam-processed article moving, associated with the destination
2367 group or nil for explicit expiration. This only makes sense for
2368 mail groups."
2369 :variable-group spam
2370 :variable-type
2381 :parameter-document
2385 ham-process-destination
2386 :type list
2387 :parameter-type
2395 :function-document
2396 "Where ham articles will go at summary exit from a spam group."
2397 :variable gnus-ham-process-destinations
2398 :variable-default nil
2399 :variable-document
2400 "*Groups in which to explicitly send ham articles to
2401 another group, or do nothing (the default). If non-nil, this should
2402 be a list of group name regexps that should match all groups in which
2403 to do ham article moving, associated with the destination
2404 group or nil for explicit ignoring. This only makes sense for
2405 mail groups, and only works in spam groups."
2406 :variable-group spam
2407 :variable-type
2419 :parameter-document
2423 ham-marks
2434 :parameter-document
2435 "Marks considered ham (positively not spam). Such articles will be
2436 processed as ham (non-spam) on group exit. When nil, the global
2437 spam-ham-marks variable takes precedence."
2439 gnus-read-mark
2440 gnus-killed-mark
2441 gnus-kill-file-mark
2442 gnus-low-score-mark))))
2443 :variable-group spam
2444 :variable-document
2448 spam-marks
2457 :parameter-document
2458 "Marks considered spam.
2459 Such articles will be processed as spam on group exit. When nil, the global
2460 spam-spam-marks variable takes precedence."
2462 :variable-group spam
2463 :variable-document
2467 "Number of group name elements to leave alone when making a short group name."
2472 "*If non-nil, once you set a level, Gnus will use this level."
2476 ;; Hooks.
2479 "A hook run while Gnus is loaded."
2484 "A hook called to apply kill files to a group.
2485 This hook is intended to apply a kill file to the selected newsgroup.
2486 The function `gnus-apply-kill-file' is called by default.
2488 Since a general kill file is too heavy to use only for a few
2489 newsgroups, I recommend you to use a lighter hook function. For
2490 example, if you'd like to apply a kill file to articles which contains
2491 a string `rmgroup' in subject in newsgroup `control', you can use the
2492 following hook:
2494 (setq gnus-apply-kill-hook
2495 (list
2496 (lambda ()
2505 "Function run when a group level is changed.
2506 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2509 function))
2511 ;;; Face thingies.
2515 mouse-face
2516 summary-menu group-menu article-menu
2517 tree-highlight menu highlight
2518 browse-menu server-menu
2519 page-marker tree-menu binary-menu pick-menu)
2520 "*Enable visual features.
2521 If `visual' is disabled, there will be no menus and few faces. Most of
2522 the visual customization options below will be ignored. Gnus will use
2523 less space and be faster as a result.
2525 This variable can also be a list of visual elements to switch on. For
2526 instance, to switch off all visual things except menus, you can say:
2528 (setq gnus-visual '(menu))
2530 Valid elements include `summary-highlight', `group-highlight',
2531 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2532 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2533 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2553 ;; Byte-compiler warning.
2555 ;; Find out whether the gnus-visual TYPE is wanted.
2559 gnus-visual
2563 t))))
2573 "*Face used for group or summary buffer mouse highlighting.
2574 The line beneath the mouse pointer will be highlighted with this
2575 face."
2588 "Controls use of the agent cache while plugged.
2589 When set, Gnus will prefer using the locally stored content rather
2590 than re-fetching it from the server. You also need to enable
2591 `gnus-agent' for this to have any affect."
2597 "Default charset assumed to be used when viewing non-ASCII characters.
2598 This variable is overridden on a group-to-group basis by the
2599 `gnus-group-charset-alist' variable and is only used on groups not
2600 covered by that variable."
2604 ;; Fixme: Doc reference to agent.
2606 "Whether we want to use the Gnus agent or not.
2608 You may customize gnus-agent to disable its use. However, some
2609 back ends have started to use the agent as a client-side cache.
2610 Disabling the agent may result in noticeable loss of performance."
2616 "Function called by the command `gnus-other-frame'."
2624 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2625 This should be an alist for Emacs, or a plist for XEmacs."
2636 "Which information should be exposed in the User-Agent header.
2638 Can be a list of symbols or a string. Valid symbols are `gnus'
2639 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2640 addition to the Emacs version, you can add `codename' \(show
2641 \(S\)XEmacs codename\) or either `config' \(show system
2642 configuration\) or `type' \(show system type\). If you set it to
2643 a string, be sure to use a valid format, see RFC 2616."
2656 ;; Convert old (< 2005-01-10) symbol type values:
2675 \f
2676 ;;; Internal variables
2681 ; Reset each time gnus-agent-covered-methods is changed else
2682 ; gnus-agent-method-p may mis-report a methods status.
2683 )
2707 ;; Dummy variable.
2710 ;; Variable holding the user answers to all method prompts.
2713 ;; Variable holding the user answers to all mail method prompts.
2716 ;; Variable holding the user answers to all group prompts.
2724 "*The directory where cached articles will be stored."
2730 nnspool "cache"
2754 ;; Propagate flags to server, with the following exceptions:
2755 ;; `seen' is private to each gnus installation
2756 ;; `cache' is a internal gnus flag for each gnus installation
2757 ;; `download' is a agent flag private to each gnus installation
2758 ;; `unsend' are for nndraft groups only
2759 ;; `score' is not a proper mark
2760 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2763 "Marks that shouldn't be propagated to back ends.
2764 Typical marks are those that make no sense in a standalone back end,
2765 such as a mark that says whether an article is stored in the cache
2778 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2803 gnus-newsrc-last-checked-date
2804 gnus-newsrc-alist gnus-server-alist
2805 gnus-killed-list gnus-zombie-list
2806 gnus-topic-topology gnus-topic-alist
2807 gnus-format-specs)
2811 "Assoc list of read articles.
2815 "Assoc list of registry data.
2842 ;; Save window configuration.
2855 ;;; End of variables.
2857 ;; Define some autoload functions Gnus might use.
2860 ;; This little mapcar goes through the list below and marks the
2861 ;; symbols in question as autoloaded functions.
2881 message-send-and-exit message-yank-original)
2885 ;; This is only used in message.el, which has an autoload.
2887 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2889 ;; Next two only used in gnus-util.
2890 rmail-summary-exists rmail-select-summary)
2891 ;; Only used in gnus-util, which has an autoload.
2896 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2897 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2901 gnus-Folder-save-name gnus-folder-save-name)
2904 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2905 gnus-demon-add-disconnection gnus-demon-add-handler
2906 gnus-demon-remove-handler)
2908 gnus-demon-init gnus-demon-cancel)
2910 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2911 gnus-face-from-file)
2913 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2915 gnus-nocem-unwanted-article-p)
2917 gnus-server-server-name)
2920 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2921 gnus-article-hide-citation gnus-article-fill-cited-article
2922 gnus-article-hide-citation-in-followups)
2924 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2925 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2927 gnus-cache-possibly-remove-articles gnus-cache-request-article
2928 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2929 gnus-cache-enter-remove-article gnus-cached-article-p
2930 gnus-cache-open gnus-cache-close gnus-cache-update-article
2931 gnus-cache-articles-in-group)
2933 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2935 gnus-summary-increase-score gnus-summary-set-score
2936 gnus-summary-raise-thread gnus-summary-raise-same-subject
2937 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2938 gnus-summary-lower-thread gnus-summary-lower-same-subject
2939 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2940 gnus-summary-current-score gnus-score-delta-default
2941 gnus-score-flush-cache gnus-score-close
2942 gnus-possibly-score-headers gnus-score-followup-article
2943 gnus-score-followup-thread)
2946 gnus-current-score-file-nondirectory gnus-score-adaptive
2947 gnus-score-find-trace gnus-score-file-name)
2951 gnus-subscribe-topics)
2955 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2956 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2957 gnus-uu-mark-by-regexp gnus-uu-mark-all
2958 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2959 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2960 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2961 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2962 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2963 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2964 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2965 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2968 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2970 gnus-group-post-news gnus-group-mail gnus-group-news
2971 gnus-summary-post-news gnus-summary-news-other-window
2972 gnus-summary-followup gnus-summary-followup-with-original
2973 gnus-summary-cancel-article gnus-summary-supersede-article
2974 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2975 gnus-summary-mail-forward gnus-summary-mail-other-window
2976 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2977 gnus-summary-wide-reply gnus-summary-followup-to-mail
2978 gnus-summary-followup-to-mail-with-original gnus-bug
2979 gnus-summary-wide-reply-with-original
2980 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2981 gnus-summary-post-forward)
2986 gnus-list-of-unread-articles gnus-list-of-read-articles
2987 gnus-offer-save-summaries gnus-make-thread-indent-array
2988 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2989 gnus-summary-skip-intangible gnus-summary-article-number
2990 gnus-data-header gnus-data-find)
2992 gnus-group-list-groups gnus-group-first-unread-group
2993 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2994 gnus-group-setup-buffer gnus-group-get-new-news
2995 gnus-group-make-help-group gnus-group-update-group
2996 gnus-group-iterate gnus-group-group-name)
2998 gnus-backlog-remove-article)
3000 gnus-article-prepare gnus-article-set-window-start
3001 gnus-article-next-page gnus-article-prev-page
3002 gnus-request-article-this-buffer gnus-article-mode
3003 gnus-article-setup-buffer gnus-narrow-to-page
3004 gnus-article-delete-invisible-text gnus-treat-article)
3006 gnus-article-hide-headers gnus-article-hide-boring-headers
3007 gnus-article-treat-overstrike
3008 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
3009 gnus-article-display-x-face gnus-article-de-quoted-unreadable
3010 gnus-article-de-base64-unreadable
3011 gnus-article-decode-HZ
3012 gnus-article-wash-html
3013 gnus-article-unsplit-urls
3014 gnus-article-hide-pem gnus-article-hide-signature
3015 gnus-article-strip-leading-blank-lines gnus-article-date-local
3016 gnus-article-date-original gnus-article-date-lapsed
3017 ;;gnus-article-show-all-headers
3018 gnus-article-edit-mode gnus-article-edit-article
3019 gnus-article-edit-done gnus-article-decode-encoded-words
3020 gnus-start-date-timer gnus-stop-date-timer
3021 gnus-mime-view-all-parts)
3024 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
3025 gnus-check-reasonable-setup)
3027 gnus-dup-enter-articles)
3031 gnus-group-move-group-to-server gnus-change-server)
3035 gnus-async-prefetch-article gnus-async-prefetch-remove-group
3036 gnus-async-halt-prefetch)
3038 gnus-agent-save-active gnus-agent-method-p
3039 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
3040 gnus-summary-set-agent-mark gnus-agent-save-group-info
3041 gnus-agent-request-article gnus-agent-retrieve-headers)
3043 gnus-unplugged gnus-agentize gnus-agent-batch)
3045 gnus-summary-save-article-vm)
3050 gnus-group-split-update)
3053 ;;; gnus-sum.el thingies
3057 "*The format specification of the lines in the summary buffer.
3059 It works along the same lines as a normal formatting string,
3060 with some simple extensions.
3062 %N Article number, left padded with spaces (string)
3063 %S Subject (string)
3065 %n Name of the poster (string)
3066 %a Extracted name of the poster (string)
3067 %A Extracted address of the poster (string)
3068 %F Contents of the From: header (string)
3069 %f Contents of the From: or To: headers (string)
3070 %x Contents of the Xref: header (string)
3071 %D Date of the article (string)
3072 %d Date of the article (string) in DD-MMM format
3073 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
3074 %M Message-id of the article (string)
3075 %r References of the article (string)
3076 %c Number of characters in the article (integer)
3077 %k Pretty-printed version of the above (string)
3079 %L Number of lines in the article (integer)
3080 %I Indentation based on thread level (a string of spaces)
3081 %B A complex trn-style thread tree (string)
3082 The variables `gnus-sum-thread-*' can be used for customization.
3083 %T A string with two possible values: 80 spaces if the article
3084 is on thread level two or larger and 0 spaces on level one
3089 %> Spaces of length thread-level (string)
3090 %< Spaces of length (- 20 thread-level) (string)
3091 %i Article score (number)
3092 %z Article zcore (character)
3093 %t Number of articles under the current thread (number).
3094 %e Whether the thread is empty or not (character).
3095 %V Total thread score (number).
3096 %P The line number (number).
3097 %O Download mark (character).
3098 %* If present, indicates desired cursor position
3099 (instead of after first colon).
3100 %u User defined specifier. The next character in the format string should
3101 be a letter. Gnus will call the function gnus-user-format-function-X,
3102 where X is the letter following %u. The function will be passed the
3103 current header as argument. The function should return a string, which
3104 will be inserted into the summary just like information from any other
3105 summary specifier.
3107 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3108 with care. For reasons of efficiency, Gnus will compute what column
3110 it is invalid to have these specs after a variable-length spec. Well,
3111 you might not be arrested, but your summary buffer will look strange,
3112 which is bad enough.
3114 The smart choice is to have these specs as far to the left as
3115 possible.
3117 This restriction may disappear in later versions of Gnus.
3119 General format specifiers can also be used.
3120 See Info node `(gnus)Formatting Variables'."
3125 ;;;
3126 ;;; Skeleton keymaps
3127 ;;;
3132 (while keys
3133 (define-key keymap (pop keys) 'undefined))))
3135 (defvar gnus-article-mode-map
3136 (let ((keymap (make-sparse-keymap)))
3137 (gnus-suppress-keymap keymap)
3138 keymap))
3139 (defvar gnus-summary-mode-map
3140 (let ((keymap (make-keymap)))
3141 (gnus-suppress-keymap keymap)
3142 keymap))
3143 (defvar gnus-group-mode-map
3144 (let ((keymap (make-keymap)))
3145 (gnus-suppress-keymap keymap)
3146 keymap))
3148 \f
3150 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3151 ;; If you want the cursor to go somewhere else, set these two
3152 ;; functions in some startup hook to whatever you want.
3153 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3154 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3156 ;;; Various macros and substs.
3158 (defun gnus-header-from (header)
3159 (mail-header-from header))
3161 (defmacro gnus-gethash (string hashtable)
3162 "Get hash value of STRING in HASHTABLE."
3163 `(symbol-value (intern-soft ,string ,hashtable)))
3165 (defmacro gnus-gethash-safe (string hashtable)
3166 "Get hash value of STRING in HASHTABLE.
3167 Return nil if not defined."
3168 `(let ((sym (intern-soft ,string ,hashtable)))
3169 (and (boundp sym) (symbol-value sym))))
3171 (defmacro gnus-sethash (string value hashtable)
3172 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3173 `(set (intern ,string ,hashtable) ,value))
3174 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3176 (defmacro gnus-group-unread (group)
3177 "Get the currently computed number of unread articles in GROUP."
3178 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3180 (defmacro gnus-group-entry (group)
3181 "Get the newsrc entry for GROUP."
3182 `(gnus-gethash ,group gnus-newsrc-hashtb))
3184 (defmacro gnus-active (group)
3185 "Get active info on GROUP."
3186 `(gnus-gethash ,group gnus-active-hashtb))
3188 (defmacro gnus-set-active (group active)
3189 "Set GROUP's active info."
3190 `(gnus-sethash ,group ,active gnus-active-hashtb))
3192 ;; Info access macros.
3194 (defmacro gnus-info-group (info)
3195 `(nth 0 ,info))
3196 (defmacro gnus-info-rank (info)
3197 `(nth 1 ,info))
3198 (defmacro gnus-info-read (info)
3199 `(nth 2 ,info))
3200 (defmacro gnus-info-marks (info)
3201 `(nth 3 ,info))
3202 (defmacro gnus-info-method (info)
3203 `(nth 4 ,info))
3204 (defmacro gnus-info-params (info)
3205 `(nth 5 ,info))
3207 (defmacro gnus-info-level (info)
3208 `(let ((rank (gnus-info-rank ,info)))
3209 (if (consp rank)
3210 (car rank)
3211 rank)))
3212 (defmacro gnus-info-score (info)
3213 `(let ((rank (gnus-info-rank ,info)))
3214 (or (and (consp rank) (cdr rank)) 0)))
3216 (defmacro gnus-info-set-group (info group)
3217 `(setcar ,info ,group))
3218 (defmacro gnus-info-set-rank (info rank)
3219 `(setcar (nthcdr 1 ,info) ,rank))
3220 (defmacro gnus-info-set-read (info read)
3221 `(setcar (nthcdr 2 ,info) ,read))
3222 (defmacro gnus-info-set-marks (info marks &optional extend)
3223 (if extend
3224 `(gnus-info-set-entry ,info ,marks 3)
3225 `(setcar (nthcdr 3 ,info) ,marks)))
3226 (defmacro gnus-info-set-method (info method &optional extend)
3227 (if extend
3228 `(gnus-info-set-entry ,info ,method 4)
3229 `(setcar (nthcdr 4 ,info) ,method)))
3230 (defmacro gnus-info-set-params (info params &optional extend)
3231 (if extend
3232 `(gnus-info-set-entry ,info ,params 5)
3233 `(setcar (nthcdr 5 ,info) ,params)))
3235 (defun gnus-info-set-entry (info entry number)
3236 ;; Extend the info until we have enough elements.
3237 (while (<= (length info) number)
3238 (nconc info (list nil)))
3239 ;; Set the entry.
3240 (setcar (nthcdr number info) entry))
3242 (defmacro gnus-info-set-level (info level)
3243 `(let ((rank (cdr ,info)))
3244 (if (consp (car rank))
3245 (setcar (car rank) ,level)
3246 (setcar rank ,level))))
3247 (defmacro gnus-info-set-score (info score)
3248 `(let ((rank (cdr ,info)))
3249 (if (consp (car rank))
3250 (setcdr (car rank) ,score)
3251 (setcar rank (cons (car rank) ,score)))))
3253 (defmacro gnus-get-info (group)
3254 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3256 ;;; Load the compatibility functions.
3258 (require 'gnus-ems)
3260 \f
3261 ;;;
3262 ;;; Shutdown
3263 ;;;
3265 (defvar gnus-shutdown-alist nil)
3267 (defun gnus-add-shutdown (function &rest symbols)
3268 "Run FUNCTION whenever one of SYMBOLS is shut down."
3269 (push (cons function symbols) gnus-shutdown-alist))
3271 (defun gnus-shutdown (symbol)
3272 "Shut down everything that waits for SYMBOL."
3273 (dolist (entry gnus-shutdown-alist)
3274 (when (memq symbol (cdr entry))
3275 (funcall (car entry)))))
3277 \f
3278 ;;;
3279 ;;; Gnus Utility Functions
3280 ;;;
3282 (defun gnus-find-subscribed-addresses ()
3283 "Return a regexp matching the addresses of all subscribed mail groups.
3284 It consists of the `to-address' or `to-list' parameter of all groups
3285 with a `subscribed' parameter."
3286 (let (group address addresses)
3287 (dolist (entry (cdr gnus-newsrc-alist))
3288 (setq group (car entry))
3289 (when (gnus-parameter-subscribed group)
3290 (setq address (mail-strip-quoted-names
3291 (or (gnus-group-fast-parameter group 'to-address)
3292 (gnus-group-fast-parameter group 'to-list))))
3293 (when address
3294 (add-to-list 'addresses address))))
3295 (when addresses
3298 (defmacro gnus-string-or (&rest strings)
3299 "Return the first element of STRINGS that is a non-blank string.
3300 STRINGS will be evaluated in normal `or' order."
3301 `(gnus-string-or-1 ',strings))
3303 (defun gnus-string-or-1 (strings)
3304 (let (string)
3305 (while strings
3306 (setq string (eval (pop strings)))
3308 (setq string nil)
3309 (setq strings nil)))
3310 string))
3312 (defun gnus-version (&optional arg)
3313 "Version number of this version of Gnus.
3314 If ARG, insert string at point."
3315 (interactive "P")
3316 (if arg
3317 (insert (message gnus-version))
3318 (message gnus-version)))
3320 (defun gnus-continuum-version (&optional version)
3321 "Return VERSION as a floating point number."
3322 (interactive)
3323 (unless version
3324 (setq version gnus-version))
3327 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3328 (number (match-string 2 version))
3329 major minor least)
3330 (unless (string-match
3332 (error "Invalid version string: %s" version))
3333 (setq major (string-to-number (match-string 1 number))
3334 minor (string-to-number (match-string 2 number))
3335 least (if (match-beginning 3)
3336 (string-to-number (match-string 3 number))
3337 0))
3338 (string-to-number
3339 (if (zerop major)
3340 (format "%s00%02d%02d"
3341 (if (member alpha '("(ding)" "d"))
3342 "4.99"
3343 (+ 5 (* 0.02
3344 (abs
3345 (- (mm-char-int (aref (downcase alpha) 0))
3346 (mm-char-int ?t))))
3347 -0.01))
3348 minor least)
3349 (format "%d.%02d%02d" major minor least))))))
3351 (defun gnus-info-find-node (&optional nodename)
3352 "Find Info documentation of Gnus."
3353 (interactive)
3354 ;; Enlarge info window if needed.
3355 (let (gnus-info-buffer)
3356 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3357 (setq gnus-info-buffer (current-buffer))
3358 (gnus-configure-windows 'info)))
3360 ;;;
3361 ;;; gnus-interactive
3362 ;;;
3364 (defvar gnus-current-prefix-symbol nil
3365 "Current prefix symbol.")
3367 (defvar gnus-current-prefix-symbols nil
3368 "List of current prefix symbols.")
3370 (defun gnus-interactive (string &optional params)
3371 "Return a list that can be fed to `interactive'.
3372 See `interactive' for full documentation.
3374 Adds the following specs:
3376 y -- The current symbolic prefix.
3377 Y -- A list of the current symbolic prefix(es).
3378 A -- Article number.
3379 H -- Article header.
3380 g -- Group name."
3381 (let ((i 0)
3382 out c prompt)
3383 (while (< i (length string))
3385 (setq c (aref string i))
3386 (when (match-end 1)
3387 (setq prompt (match-string 1 string)))
3388 (setq i (match-end 0))
3389 ;; We basically emulate just about everything that
3390 ;; `interactive' does, but add the specs listed above.
3391 (push
3392 (cond
3393 ((= c ?a)
3394 (completing-read prompt obarray 'fboundp t))
3395 ((= c ?b)
3396 (read-buffer prompt (current-buffer) t))
3397 ((= c ?B)
3398 (read-buffer prompt (other-buffer (current-buffer))))
3399 ((= c ?c)
3400 (read-char))
3401 ((= c ?C)
3402 (completing-read prompt obarray 'commandp t))
3403 ((= c ?d)
3404 (point))
3405 ((= c ?D)
3406 (read-file-name prompt nil default-directory 'lambda))
3407 ((= c ?f)
3408 (read-file-name prompt nil nil 'lambda))
3409 ((= c ?F)
3410 (read-file-name prompt))
3411 ((= c ?k)
3412 (read-key-sequence prompt))
3413 ((= c ?K)
3414 (error "Not implemented spec"))
3415 ((= c ?e)
3416 (error "Not implemented spec"))
3417 ((= c ?m)
3418 (mark))
3419 ((= c ?N)
3420 (error "Not implemented spec"))
3421 ((= c ?n)
3422 (string-to-number (read-from-minibuffer prompt)))
3423 ((= c ?p)
3424 (prefix-numeric-value current-prefix-arg))
3425 ((= c ?P)
3426 current-prefix-arg)
3427 ((= c ?r)
3428 'gnus-prefix-nil)
3429 ((= c ?s)
3430 (read-string prompt))
3431 ((= c ?S)
3432 (intern (read-string prompt)))
3433 ((= c ?v)
3434 (read-variable prompt))
3435 ((= c ?x)
3436 (read-minibuffer prompt))
3437 ((= c ?x)
3438 (eval-minibuffer prompt))
3439 ;; And here the new specs come.
3440 ((= c ?y)
3441 gnus-current-prefix-symbol)
3442 ((= c ?Y)
3443 gnus-current-prefix-symbols)
3444 ((= c ?g)
3445 (gnus-group-group-name))
3446 ((= c ?A)
3447 (gnus-summary-skip-intangible)
3448 (or (get-text-property (point) 'gnus-number)
3449 (gnus-summary-last-subject)))
3450 ((= c ?H)
3451 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3452 (t
3453 (error "Non-implemented spec")))
3454 out)
3455 (cond
3456 ((= c ?r)
3457 (push (if (< (point) (mark)) (point) (mark)) out)
3458 (push (if (> (point) (mark)) (point) (mark)) out))))
3459 (setq out (delq 'gnus-prefix-nil out))
3460 (nreverse out)))
3462 (defun gnus-symbolic-argument (&optional arg)
3463 "Read a symbolic argument and a command, and then execute command."
3464 (interactive "P")
3465 (let* ((in-command (this-command-keys))
3466 (command in-command)
3467 gnus-current-prefix-symbols
3468 gnus-current-prefix-symbol
3469 syms)
3470 (while (equal in-command command)
3471 (message "%s-" (key-description (this-command-keys)))
3472 (push (intern (char-to-string (read-char))) syms)
3473 (setq command (read-key-sequence nil t)))
3474 (setq gnus-current-prefix-symbols (nreverse syms)
3475 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3476 (call-interactively (key-binding command t))))
3478 ;;; More various functions.
3480 (defsubst gnus-check-backend-function (func group)
3481 "Check whether GROUP supports function FUNC.
3482 GROUP can either be a string (a group name) or a select method."
3483 (ignore-errors
3484 (let ((method (if (stringp group)
3485 (car (gnus-find-method-for-group group))
3486 group)))
3487 (unless (featurep method)
3488 (require method))
3489 (fboundp (intern (format "%s-%s" method func))))))
3491 (defun gnus-group-read-only-p (&optional group)
3492 "Check whether GROUP supports editing or not.
3493 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3494 that that variable is buffer-local to the summary buffers."
3495 (let ((group (or group gnus-newsgroup-name)))
3496 (not (gnus-check-backend-function 'request-replace-article group))))
3498 (defun gnus-virtual-group-p (group)
3499 "Say whether GROUP is virtual or not."
3500 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3501 gnus-valid-select-methods)))
3503 (defun gnus-news-group-p (group &optional article)
3504 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3505 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3506 t) ;is news of course.
3507 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3508 nil) ;must be mail then.
3509 ((vectorp article) ;Has header info.
3510 (eq (gnus-request-type group (mail-header-id article)) 'news))
3511 ((null article) ;Hasn't header info
3512 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3513 ((< article 0) ;Virtual message
3514 nil) ;we don't know, guess mail.
3515 (t ;Has positive number
3516 (eq (gnus-request-type group article) 'news)))) ;use it.
3518 ;; Returns a list of writable groups.
3519 (defun gnus-writable-groups ()
3520 (let ((alist gnus-newsrc-alist)
3521 groups group)
3522 (while (setq group (car (pop alist)))
3523 (unless (gnus-group-read-only-p group)
3524 (push group groups)))
3525 (nreverse groups)))
3527 ;; Check whether to use long file names.
3528 (defun gnus-use-long-file-name (symbol)
3529 ;; The variable has to be set...
3530 (and gnus-use-long-file-name
3531 ;; If it isn't a list, then we return t.
3532 (or (not (listp gnus-use-long-file-name))
3533 ;; If it is a list, and the list contains `symbol', we
3534 ;; return nil.
3535 (not (memq symbol gnus-use-long-file-name)))))
3537 ;; Generate a unique new group name.
3538 (defun gnus-generate-new-group-name (leaf)
3539 (let ((name leaf)
3540 (num 0))
3541 (while (gnus-group-entry name)
3542 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3543 name))
3545 (defun gnus-ephemeral-group-p (group)
3546 "Say whether GROUP is ephemeral or not."
3547 (gnus-group-get-parameter group 'quit-config t))
3549 (defun gnus-group-quit-config (group)
3550 "Return the quit-config of GROUP."
3551 (gnus-group-get-parameter group 'quit-config t))
3553 (defun gnus-kill-ephemeral-group (group)
3554 "Remove ephemeral GROUP from relevant structures."
3555 (gnus-sethash group nil gnus-newsrc-hashtb))
3557 (defun gnus-simplify-mode-line ()
3558 "Make mode lines a bit simpler."
3559 (setq mode-line-modified (cdr gnus-mode-line-modified))
3560 (when (listp mode-line-format)
3561 (make-local-variable 'mode-line-format)
3562 (setq mode-line-format (copy-sequence mode-line-format))
3563 (when (equal (nth 3 mode-line-format) " ")
3564 (setcar (nthcdr 3 mode-line-format) " "))))
3566 ;;; Servers and groups.
3568 (defsubst gnus-server-add-address (method)
3569 (let ((method-name (symbol-name (car method))))
3570 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3571 (not (assq (intern (concat method-name "-address")) method))
3572 (memq 'physical-address (assq (car method)
3573 gnus-valid-select-methods)))
3574 (append method (list (list (intern (concat method-name "-address"))
3575 (nth 1 method))))
3576 method)))
3578 (defsubst gnus-method-to-server (method &optional nocache)
3579 (catch 'server-name
3580 (setq method (or method gnus-select-method))
3582 ;; Perhaps it is already in the cache.
3583 (unless nocache
3584 (mapc (lambda (name-method)
3585 (if (equal (cdr name-method) method)
3586 (throw 'server-name (car name-method))))
3587 gnus-server-method-cache))
3589 (mapc
3590 (lambda (server-alist)
3591 (mapc (lambda (name-method)
3592 (when (gnus-methods-equal-p (cdr name-method) method)
3593 (unless (member name-method gnus-server-method-cache)
3594 (push name-method gnus-server-method-cache))
3595 (throw 'server-name (car name-method))))
3596 server-alist))
3597 (list gnus-server-alist
3598 gnus-predefined-server-alist))
3600 (let* ((name (if (member (cadr method) '(nil ""))
3601 (format "%s" (car method))
3602 (format "%s:%s" (car method) (cadr method))))
3603 (name-method (cons name method)))
3604 (unless (member name-method gnus-server-method-cache)
3605 (push name-method gnus-server-method-cache))
3606 name)))
3608 (defsubst gnus-server-to-method (server)
3609 "Map virtual server names to select methods."
3610 (or (and server (listp server) server)
3611 (cdr (assoc server gnus-server-method-cache))
3612 (let ((result
3613 (or
3614 ;; Perhaps this is the native server?
3615 (and (equal server "native") gnus-select-method)
3616 ;; It should be in the server alist.
3617 (cdr (assoc server gnus-server-alist))
3618 ;; It could be in the predefined server alist.
3619 (cdr (assoc server gnus-predefined-server-alist))
3620 ;; If not, we look through all the opened server
3621 ;; to see whether we can find it there.
3622 (let ((opened gnus-opened-servers))
3623 (while (and opened
3624 (not (equal server (format "%s:%s" (caaar opened)
3625 (cadaar opened)))))
3626 (pop opened))
3627 (caar opened))
3628 ;; It could be a named method, search all servers
3629 (let ((servers gnus-secondary-select-methods))
3630 (while (and servers
3631 (not (equal server (format "%s:%s" (caar servers)
3632 (cadar servers)))))
3633 (pop servers))
3634 (car servers))
3635 ;; This could be some sort of foreign server that I
3636 ;; simply haven't opened (yet). Do a brute-force scan
3637 ;; of the entire gnus-newsrc-alist for the server name
3638 ;; of every method. As a side-effect, loads the
3639 ;; gnus-server-method-cache so this only happens once,
3640 ;; if at all.
3641 (let ((alist (cdr gnus-newsrc-alist))
3642 method match)
3643 (while alist
3644 (setq method (gnus-info-method (pop alist)))
3645 (when (and (not (stringp method))
3646 (equal server (gnus-method-to-server method)))
3647 (setq match method
3648 alist nil)))
3649 match))))
3650 (when result
3651 (push (cons server result) gnus-server-method-cache))
3652 result)))
3654 (defsubst gnus-server-get-method (group method)
3655 ;; Input either a server name, and extended server name, or a
3656 ;; select method, and return a select method.
3657 (cond ((stringp method)
3658 (gnus-server-to-method method))
3659 ((equal method gnus-select-method)
3660 gnus-select-method)
3661 ((and (stringp (car method))
3662 group)
3663 (gnus-server-extend-method group method))
3664 ((and method
3665 (not group)
3666 (equal (cadr method) ""))
3667 method)
3668 (t
3669 (gnus-server-add-address method))))
3671 (defmacro gnus-method-equal (ss1 ss2)
3672 "Say whether two servers are equal."
3673 `(let ((s1 ,ss1)
3674 (s2 ,ss2))
3675 (or (equal s1 s2)
3676 (and (= (length s1) (length s2))
3677 (progn
3678 (while (and s1 (member (car s1) s2))
3679 (setq s1 (cdr s1)))
3680 (null s1))))))
3682 (defun gnus-methods-equal-p (m1 m2)
3683 (let ((m1 (or m1 gnus-select-method))
3684 (m2 (or m2 gnus-select-method)))
3685 (or (equal m1 m2)
3686 (and (eq (car m1) (car m2))
3687 (or (not (memq 'address (assoc (symbol-name (car m1))
3688 gnus-valid-select-methods)))
3689 (equal (nth 1 m1) (nth 1 m2)))))))
3691 (defun gnus-server-equal (m1 m2)
3692 "Say whether two methods are equal."
3693 (let ((m1 (cond ((null m1) gnus-select-method)
3694 ((stringp m1) (gnus-server-to-method m1))
3695 (t m1)))
3696 (m2 (cond ((null m2) gnus-select-method)
3697 ((stringp m2) (gnus-server-to-method m2))
3698 (t m2))))
3699 (gnus-method-equal m1 m2)))
3701 (defun gnus-servers-using-backend (backend)
3702 "Return a list of known servers using BACKEND."
3703 (let ((opened gnus-opened-servers)
3704 out)
3705 (while opened
3706 (when (eq backend (caaar opened))
3707 (push (caar opened) out))
3708 (pop opened))
3709 out))
3711 (defun gnus-archive-server-wanted-p ()
3712 "Say whether the user wants to use the archive server."
3713 (cond
3714 ((or (not gnus-message-archive-method)
3715 (not gnus-message-archive-group))
3716 nil)
3717 ((and gnus-message-archive-method gnus-message-archive-group)
3718 t)
3719 (t
3720 (let ((active (cadr (assq 'nnfolder-active-file
3721 gnus-message-archive-method))))
3722 (and active
3723 (file-exists-p active))))))
3725 (defsubst gnus-method-to-server-name (method)
3726 (concat
3727 (format "%s" (car method))
3728 (when (and
3729 (or (assoc (format "%s" (car method))
3730 (gnus-methods-using 'address))
3731 (gnus-server-equal method gnus-message-archive-method))
3732 (nth 1 method)
3733 (not (string= (nth 1 method) "")))
3734 (concat "+" (nth 1 method)))))
3736 (defsubst gnus-method-to-full-server-name (method)
3737 (format "%s+%s" (car method) (nth 1 method)))
3739 (defun gnus-group-prefixed-name (group method &optional full)
3740 "Return the whole name from GROUP and METHOD.
3741 Call with full set to get the fully qualified group name (even if the
3742 server is native)."
3743 (when (stringp method)
3744 (setq method (gnus-server-to-method method)))
3745 (if (or (not method)
3746 (and (not full) (gnus-server-equal method "native"))
3747 ;;;!!! This might not be right. We'll see...
3748 ;(string-match ":" group)
3749 )
3750 group
3751 (concat (gnus-method-to-server-name method) ":" group)))
3753 (defun gnus-group-guess-prefixed-name (group)
3754 "Guess the whole name from GROUP and METHOD."
3755 (gnus-group-prefixed-name group (gnus-find-method-for-group
3756 group)))
3758 (defun gnus-group-full-name (group method)
3759 "Return the full name from GROUP and METHOD, even if the method is native."
3760 (gnus-group-prefixed-name group method t))
3762 (defun gnus-group-guess-full-name (group)
3763 "Guess the full name from GROUP, even if the method is native."
3764 (if (gnus-group-prefixed-p group)
3765 group
3766 (gnus-group-full-name group (gnus-find-method-for-group group))))
3768 (defun gnus-group-guess-full-name-from-command-method (group)
3769 "Guess the full name from GROUP, even if the method is native."
3770 (if (gnus-group-prefixed-p group)
3771 group
3772 (gnus-group-full-name group gnus-command-method)))
3774 (defun gnus-group-real-prefix (group)
3775 "Return the prefix of the current group name."
3776 (if (stringp group)
3777 (if (string-match "^[^:]+:" group)
3778 (substring group 0 (match-end 0))
3779 "")
3780 nil))
3782 (defun gnus-group-short-name (group)
3783 "Return the short group name."
3784 (let ((prefix (gnus-group-real-prefix group)))
3785 (if (< 0 (length prefix))
3786 (substring group (length prefix) nil)
3787 group)))
3789 (defun gnus-group-prefixed-p (group)
3790 "Return the prefix of the current group name."
3791 (< 0 (length (gnus-group-real-prefix group))))
3793 (declare-function gnus-group-decoded-name "gnus-group" (string))
3795 (defun gnus-summary-buffer-name (group)
3796 "Return the summary buffer name of GROUP."
3797 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3799 (defun gnus-group-method (group)
3800 "Return the server or method used for selecting GROUP.
3801 You should probably use `gnus-find-method-for-group' instead."
3802 (let ((prefix (gnus-group-real-prefix group)))
3803 (if (equal prefix "")
3804 gnus-select-method
3805 (let ((servers gnus-opened-servers)
3806 (server "")
3807 backend possible found)
3809 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3810 server (substring prefix (match-end 0) (1- (length prefix))))
3811 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3812 (while servers
3813 (when (eq (caaar servers) backend)
3814 (setq possible (caar servers))
3815 (when (equal (cadaar servers) server)
3816 (setq found (caar servers))))
3817 (pop servers))
3818 (or (car (rassoc found gnus-server-alist))
3819 found
3820 (car (rassoc possible gnus-server-alist))
3821 possible
3822 (list backend server))))))
3824 (defsubst gnus-native-method-p (method)
3825 "Return whether METHOD is the native select method."
3826 (gnus-method-equal method gnus-select-method))
3828 (defsubst gnus-secondary-method-p (method)
3829 "Return whether METHOD is a secondary select method."
3830 (let ((methods gnus-secondary-select-methods)
3831 (gmethod (inline (gnus-server-get-method nil method))))
3832 (while (and methods
3833 (not (gnus-method-equal
3834 (inline (gnus-server-get-method nil (car methods)))
3835 gmethod)))
3836 (setq methods (cdr methods)))
3837 methods))
3839 (defun gnus-method-simplify (method)
3840 "Return the shortest uniquely identifying string or method for METHOD."
3841 (cond ((stringp method)
3842 method)
3843 ((gnus-native-method-p method)
3844 nil)
3845 ((gnus-secondary-method-p method)
3846 (format "%s:%s" (nth 0 method) (nth 1 method)))
3847 (t
3848 method)))
3850 (defun gnus-groups-from-server (server)
3851 "Return a list of all groups that are fetched from SERVER."
3852 (let ((alist (cdr gnus-newsrc-alist))
3853 info groups)
3854 (while (setq info (pop alist))
3855 (when (gnus-server-equal (gnus-info-method info) server)
3856 (push (gnus-info-group info) groups)))
3857 (sort groups 'string<)))
3859 (defun gnus-group-foreign-p (group)
3860 "Say whether a group is foreign or not."
3861 (and (not (gnus-group-native-p group))
3862 (not (gnus-group-secondary-p group))))
3864 (defun gnus-group-native-p (group)
3865 "Say whether the group is native or not."
3866 (not (string-match ":" group)))
3868 (defun gnus-group-secondary-p (group)
3869 "Say whether the group is secondary or not."
3870 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3872 (defun gnus-parameters-get-parameter (group)
3873 "Return the group parameters for GROUP from `gnus-parameters'."
3874 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3875 case-fold-search
3876 gnus-parameters-case-fold-search))
3877 params-list)
3878 (dolist (elem gnus-parameters)
3879 (when (string-match (car elem) group)
3880 (setq params-list
3881 (nconc (gnus-expand-group-parameters
3882 (car elem) (cdr elem) group)
3883 params-list))))
3884 params-list))
3886 (defun gnus-expand-group-parameter (match value group)
3887 "Use MATCH to expand VALUE in GROUP."
3888 (with-temp-buffer
3889 (insert group)
3890 (goto-char (point-min))
3891 (while (re-search-forward match nil t)
3892 (replace-match value))
3893 (buffer-string)))
3895 (defun gnus-expand-group-parameters (match parameters group)
3896 "Go through PARAMETERS and expand them according to the match data."
3897 (let (new)
3898 (dolist (elem parameters)
3899 (if (and (stringp (cdr elem))
3901 (push (cons (car elem)
3902 (gnus-expand-group-parameter match (cdr elem) group))
3903 new)
3904 (push elem new)))
3905 new))
3907 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3908 "For GROUP, return the value of SYMBOL.
3910 You should call this in the `gnus-group-buffer' buffer.
3911 The function `gnus-group-find-parameter' will do that for you."
3912 ;; The speed trick: No cons'ing and quit early.
3913 (let* ((params (funcall gnus-group-get-parameter-function group))
3914 ;; Start easy, check the "real" group parameters.
3915 (simple-results
3916 (gnus-group-parameter-value params symbol allow-list t)))
3917 (if simple-results
3918 ;; Found results; return them.
3919 (car simple-results)
3920 ;; We didn't find it there, try `gnus-parameters'.
3921 (let ((result nil)
3922 (head nil)
3923 (tail gnus-parameters))
3924 ;; A good old-fashioned non-cl loop.
3925 (while tail
3926 (setq head (car tail)
3927 tail (cdr tail))
3928 ;; The car is regexp matching for matching the group name.
3929 (when (string-match (car head) group)
3930 ;; The cdr is the parameters.
3931 (setq result (gnus-group-parameter-value (cdr head)
3932 symbol allow-list))
3933 (when result
3934 ;; Expand if necessary.
3936 (setq result (gnus-expand-group-parameter (car head)
3937 result group)))
3938 ;; Exit the loop early.
3939 (setq tail nil))))
3940 ;; Done.
3941 result))))
3943 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3944 "Return the group parameters for GROUP.
3945 If SYMBOL, return the value of that symbol in the group parameters.
3947 If you call this function inside a loop, consider using the faster
3948 `gnus-group-fast-parameter' instead."
3949 (save-excursion
3950 (set-buffer gnus-group-buffer)
3951 (if symbol
3952 (gnus-group-fast-parameter group symbol allow-list)
3953 (nconc
3954 (copy-sequence
3955 (funcall gnus-group-get-parameter-function group))
3956 (gnus-parameters-get-parameter group)))))
3958 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3959 "Return the group parameters for GROUP.
3960 If SYMBOL, return the value of that symbol in the group parameters.
3961 If ALLOW-LIST, also allow list as a result.
3962 Most functions should use `gnus-group-find-parameter', which
3963 also examines the topic parameters."
3964 (let ((params (gnus-info-params (gnus-get-info group))))
3965 (if symbol
3966 (gnus-group-parameter-value params symbol allow-list)
3967 params)))
3969 (defun gnus-group-parameter-value (params symbol &optional
3970 allow-list present-p)
3971 "Return the value of SYMBOL in group PARAMS.
3972 If ALLOW-LIST, also allow list as a result."
3973 ;; We only wish to return group parameters (dotted lists) and
3974 ;; not local variables, which may have the same names.
3975 ;; But first we handle single elements...
3976 (or (car (memq symbol params))
3977 ;; Handle alist.
3978 (let (elem)
3979 (catch 'found
3980 (while (setq elem (pop params))
3981 (when (and (consp elem)
3982 (eq (car elem) symbol)
3983 (or allow-list
3984 (atom (cdr elem))))
3985 (throw 'found (if present-p (list (cdr elem))
3986 (cdr elem)))))))))
3988 (defun gnus-group-add-parameter (group param)
3989 "Add parameter PARAM to GROUP."
3990 (let ((info (gnus-get-info group)))
3991 (when info
3992 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3993 ;; Cons the new param to the old one and update.
3994 (gnus-group-set-info (cons param (gnus-info-params info))
3995 group 'params))))
3997 (defun gnus-group-set-parameter (group name value)
3998 "Set parameter NAME to VALUE in GROUP."
3999 (let ((info (gnus-get-info group)))
4000 (when info
4001 (gnus-group-remove-parameter group name)
4002 (let ((old-params (gnus-info-params info))
4003 (new-params (list (cons name value))))
4004 (while old-params
4005 (when (or (not (listp (car old-params)))
4006 (not (eq (caar old-params) name)))
4007 (setq new-params (append new-params (list (car old-params)))))
4008 (setq old-params (cdr old-params)))
4009 (gnus-group-set-info new-params group 'params)))))
4011 (defun gnus-group-remove-parameter (group name)
4012 "Remove parameter NAME from GROUP."
4013 (let ((info (gnus-get-info group)))
4014 (when info
4015 (let ((params (gnus-info-params info)))
4016 (when params
4017 (setq params (delq name params))
4018 (while (assq name params)
4019 (gnus-pull name params))
4020 (gnus-info-set-params info params))))))
4022 (defun gnus-group-add-score (group &optional score)
4023 "Add SCORE to the GROUP score.
4024 If SCORE is nil, add 1 to the score of GROUP."
4025 (let ((info (gnus-get-info group)))
4026 (when info
4027 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
4029 (defun gnus-short-group-name (group &optional levels)
4030 "Collapse GROUP name LEVELS.
4031 Select methods are stripped and any remote host name is stripped down to
4032 just the host name."
4033 (let* ((name "")
4034 (foreign "")
4035 (depth 0)
4036 (skip 1)
4037 (levels (or levels
4038 gnus-group-uncollapsed-levels
4039 (progn
4041 (setq skip (match-end 0)
4042 depth (+ depth 1)))
4043 depth))))
4044 ;; Separate foreign select method from group name and collapse.
4045 ;; If method contains a server, collapse to non-domain server name,
4046 ;; otherwise collapse to select method.
4047 (let* ((colon (string-match ":" group))
4048 (server (and colon (substring group 0 colon)))
4049 (plus (and server (string-match "+" server))))
4050 (when server
4051 (if plus
4052 (setq foreign (substring server (+ 1 plus)
4054 group (substring group (+ 1 colon)))
4055 (setq foreign server
4056 group (substring group (+ 1 colon))))
4057 (setq foreign (concat foreign ":")))
4058 ;; Collapse group name leaving LEVELS uncollapsed elements
4059 (let* ((slist (split-string group "/"))
4060 (slen (length slist))
4062 (dlen (length dlist))
4063 glist
4064 glen
4065 gsep
4066 res)
4067 (if (> slen dlen)
4068 (setq glist slist
4069 glen slen
4070 gsep "/")
4071 (setq glist dlist
4072 glen dlen
4073 gsep "."))
4074 (setq levels (- glen levels))
4075 (dolist (g glist)
4076 (push (if (>= (decf levels) 0)
4077 (if (zerop (length g))
4078 ""
4079 (substring g 0 1))
4080 g)
4081 res))
4082 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4084 (defun gnus-narrow-to-body ()
4085 "Narrow to the body of an article."
4086 (narrow-to-region
4087 (progn
4088 (goto-char (point-min))
4090 (point-max)))
4091 (point-max)))
4093 \f
4094 ;;;
4095 ;;; Kill file handling.
4096 ;;;
4098 (defun gnus-apply-kill-file ()
4099 "Apply a kill file to the current newsgroup.
4100 Returns the number of articles marked as read."
4101 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4102 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4103 (gnus-apply-kill-file-internal)
4104 0))
4106 (defun gnus-kill-save-kill-buffer ()
4107 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4108 (when (get-file-buffer file)
4109 (save-excursion
4110 (set-buffer (get-file-buffer file))
4111 (when (buffer-modified-p)
4112 (save-buffer))
4113 (kill-buffer (current-buffer))))))
4115 (defcustom gnus-kill-file-name "KILL"
4116 "Suffix of the kill files."
4117 :group 'gnus-score-kill
4118 :group 'gnus-score-files
4119 :type 'string)
4121 (defun gnus-newsgroup-kill-file (newsgroup)
4122 "Return the name of a kill file name for NEWSGROUP.
4123 If NEWSGROUP is nil, return the global kill file name instead."
4124 (cond
4125 ;; The global KILL file is placed at top of the directory.
4126 ((or (null newsgroup)
4127 (string-equal newsgroup ""))
4128 (expand-file-name gnus-kill-file-name
4129 gnus-kill-files-directory))
4130 ;; Append ".KILL" to newsgroup name.
4131 ((gnus-use-long-file-name 'not-kill)
4132 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4133 "." gnus-kill-file-name)
4134 gnus-kill-files-directory))
4135 ;; Place "KILL" under the hierarchical directory.
4136 (t
4137 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4138 "/" gnus-kill-file-name)
4139 gnus-kill-files-directory))))
4141 ;;; Server things.
4143 (defun gnus-member-of-valid (symbol group)
4145 (memq symbol (assoc
4146 (symbol-name (car (gnus-find-method-for-group group)))
4147 gnus-valid-select-methods)))
4149 (defun gnus-method-option-p (method option)
4150 "Return non-nil if select METHOD has OPTION as a parameter."
4151 (when (stringp method)
4152 (setq method (gnus-server-to-method method)))
4153 (memq option (assoc (format "%s" (car method))
4154 gnus-valid-select-methods)))
4156 (defun gnus-similar-server-opened (method)
4157 (let ((opened gnus-opened-servers))
4158 (while (and method opened)
4159 (when (and (equal (cadr method) (cadaar opened))
4160 (equal (car method) (caaar opened))
4161 (not (equal method (caar opened))))
4162 (setq method nil))
4163 (pop opened))
4164 (not method)))
4166 (defun gnus-server-extend-method (group method)
4167 ;; This function "extends" a virtual server. If the server is
4168 ;; "hello", and the select method is ("hello" (my-var "something"))
4169 ;; in the group "alt.alt", this will result in a new virtual server
4170 ;; called "hello+alt.alt".
4171 (if (or (not (inline (gnus-similar-server-opened method)))
4172 (not (cddr method)))
4173 method
4174 `(,(car method) ,(concat (cadr method) "+" group)
4175 (,(intern (format "%s-address" (car method))) ,(cadr method))
4176 ,@(cddr method))))
4178 (defun gnus-server-status (method)
4179 "Return the status of METHOD."
4180 (nth 1 (assoc method gnus-opened-servers)))
4182 (defun gnus-group-name-to-method (group)
4183 "Guess a select method based on GROUP."
4184 (if (string-match ":" group)
4185 (let ((server (substring group 0 (match-beginning 0))))
4187 (list (intern (substring server 0 (match-beginning 0)))
4188 (substring server (match-end 0)))
4189 (list (intern server) "")))
4190 gnus-select-method))
4192 (defun gnus-server-string (server)
4193 "Return a readable string that describes SERVER."
4194 (let* ((server (gnus-server-to-method server))
4195 (address (nth 1 server)))
4196 (if (and address
4197 (not (zerop (length address))))
4198 (format "%s using %s" address (car server))
4199 (format "%s" (car server)))))
4201 (defun gnus-find-method-for-group (group &optional info)
4202 "Find the select method that GROUP uses."
4203 (or gnus-override-method
4204 (and (not group)
4205 gnus-select-method)
4206 (and (not (gnus-group-entry group))
4207 ;; Killed or otherwise unknown group.
4208 (or
4209 ;; If we know a virtual server by that name, return its method.
4210 (gnus-server-to-method (gnus-group-server group))
4211 ;; Guess a new method as last resort.
4212 (gnus-group-name-to-method group)))
4213 (let ((info (or info (gnus-get-info group)))
4214 method)
4215 (if (or (not info)
4216 (not (setq method (gnus-info-method info)))
4217 (equal method "native"))
4218 gnus-select-method
4219 (setq method
4220 (cond ((stringp method)
4221 (inline (gnus-server-to-method method)))
4222 ((stringp (cadr method))
4223 (inline (gnus-server-extend-method group method)))
4224 (t
4225 method)))
4226 (cond ((equal (cadr method) "")
4227 method)
4228 ((null (cadr method))
4229 (list (car method) ""))
4230 (t
4231 (gnus-server-add-address method)))))))
4233 (defun gnus-methods-using (feature)
4234 "Find all methods that have FEATURE."
4235 (let ((valids gnus-valid-select-methods)
4236 outs)
4237 (while valids
4238 (when (memq feature (car valids))
4239 (push (car valids) outs))
4240 (setq valids (cdr valids)))
4241 outs))
4243 (eval-and-compile
4244 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4246 (defun gnus-read-group (prompt &optional default)
4247 "Prompt the user for a group name.
4248 Disallow invalid group names."
4249 (let ((prefix "")
4250 group)
4251 (while (not group)
4252 (when (string-match
4253 gnus-invalid-group-regexp
4254 (setq group (read-string (concat prefix prompt)
4255 (cons (or default "") 0)
4256 'gnus-group-history)))
4257 (let ((match (match-string 0 group)))
4258 ;; Might be okay (e.g. for nnimap), so ask the user:
4260 (message-y-or-n-p
4261 "Proceed and create group anyway? " t
4264 Usually, it's dangerous to create a group with this name, because it's not
4265 supported by all back ends and servers. On IMAP servers it should work,
4266 though. If you are really sure, you can proceed anyway and create the group.
4268 You may customize the variable `gnus-invalid-group-regexp', which currently is
4272 group nil)))))
4273 group))
4275 (defun gnus-read-method (prompt)
4276 "Prompt the user for a method.
4277 Allow completion over sensible values."
4278 (let* ((open-servers
4279 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4280 gnus-opened-servers))
4281 (valid-methods
4282 (let (methods)
4283 (dolist (method gnus-valid-select-methods)
4284 (if (or (memq 'prompt-address method)
4285 (not (assoc (format "%s:" (car method)) open-servers)))
4286 (push method methods)))
4287 methods))
4288 (servers
4289 (append valid-methods
4290 open-servers
4291 gnus-predefined-server-alist
4292 gnus-server-alist))
4293 (method
4294 (completing-read
4295 prompt servers
4296 nil t nil 'gnus-method-history)))
4297 (cond
4298 ((equal method "")
4299 (setq method gnus-select-method))
4300 ((assoc method gnus-valid-select-methods)
4301 (let ((address (if (memq 'prompt-address
4302 (assoc method gnus-valid-select-methods))
4303 (read-string "Address: ")
4304 "")))
4305 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4306 (list (intern method) address))))
4307 ((assoc method servers)
4308 method)
4309 (t
4310 (list (intern method) "")))))
4312 ;;; Agent functions
4314 (defun gnus-agent-method-p (method-or-server)
4315 "Say whether METHOD is covered by the agent."
4316 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4317 (let* ((method (if (stringp method-or-server)
4318 (gnus-server-to-method method-or-server)
4319 method-or-server))
4320 (server (gnus-method-to-server method t)))
4321 (setq gnus-agent-method-p-cache
4322 (cons method-or-server
4323 (member server gnus-agent-covered-methods)))))
4324 (cdr gnus-agent-method-p-cache))
4326 (defun gnus-online (method)
4327 (not
4328 (if gnus-plugged
4329 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4330 (gnus-agent-method-p method))))
4332 ;;; User-level commands.
4334 ;;;###autoload
4335 (defun gnus-slave-no-server (&optional arg)
4336 "Read network news as a slave, without connecting to the local server."
4337 (interactive "P")
4338 (gnus-no-server arg t))
4340 ;;;###autoload
4341 (defun gnus-no-server (&optional arg slave)
4342 "Read network news.
4343 If ARG is a positive number, Gnus will use that as the startup
4344 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4345 non-nil and not a positive number, Gnus will prompt the user for the
4346 name of an NNTP server to use.
4347 As opposed to `gnus', this command will not connect to the local
4348 server."
4349 (interactive "P")
4350 (gnus-no-server-1 arg slave))
4352 ;;;###autoload
4353 (defun gnus-slave (&optional arg)
4354 "Read news as a slave."
4355 (interactive "P")
4356 (gnus arg nil 'slave))
4358 ;;;###autoload
4359 (defun gnus-other-frame (&optional arg display)
4360 "Pop up a frame to read news.
4361 This will call one of the Gnus commands which is specified by the user
4362 option `gnus-other-frame-function' (default `gnus') with the argument
4363 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4364 optional second argument DISPLAY should be a standard display string
4366 omitted or the function `make-frame-on-display' is not available, the
4367 current display is used."
4368 (interactive "P")
4369 (if (fboundp 'make-frame-on-display)
4370 (unless display
4371 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4372 (setq display nil))
4373 (let ((alive (gnus-alive-p)))
4374 (unless (and alive
4375 (catch 'found
4376 (walk-windows
4377 (lambda (window)
4378 (when (and (or (not display)
4379 (equal display
4380 (gnus-frame-or-window-display-name
4381 window)))
4382 (with-current-buffer (window-buffer window)
4384 (symbol-name major-mode))))
4385 (gnus-select-frame-set-input-focus
4386 (setq gnus-other-frame-object (window-frame window)))
4387 (select-window window)
4388 (throw 'found t)))
4389 'ignore t)))
4390 (gnus-select-frame-set-input-focus
4391 (setq gnus-other-frame-object
4392 (if display
4393 (make-frame-on-display display gnus-other-frame-parameters)
4394 (make-frame gnus-other-frame-parameters))))
4395 (if alive
4396 (switch-to-buffer gnus-group-buffer)
4397 (funcall gnus-other-frame-function arg)
4398 (add-hook 'gnus-exit-gnus-hook
4399 '(lambda nil
4400 (when (and (frame-live-p gnus-other-frame-object)
4401 (cdr (frame-list)))
4402 (delete-frame gnus-other-frame-object))
4403 (setq gnus-other-frame-object nil)))))))
4405 ;;;###autoload
4406 (defun gnus (&optional arg dont-connect slave)
4407 "Read network news.
4408 If ARG is non-nil and a positive number, Gnus will use that as the
4409 startup level. If ARG is non-nil and not a positive number, Gnus will
4410 prompt the user for the name of an NNTP server to use."
4411 (interactive "P")
4412 (unless (byte-code-function-p (symbol-function 'gnus))
4413 (message "You should byte-compile Gnus")
4414 (sit-for 2))
4415 (gnus-1 arg dont-connect slave))
4417 ;; Allow redefinition of Gnus functions.
4419 (gnus-ems-redefine)
4421 (provide 'gnus)
4423 ;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4424 ;;; gnus.el ends here