| blob | baed48d7733afb19762ebba70a91677d325dbf68 |
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 and XEmacs.
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."
336 0 5
345 gnus-mode-line-image-cache)
347 "This is %s, %s."
349 str)
351 line)))
356 ;;(defalias 'gnus-decode-rfc1522 'ignore)
357 )
359 ;; We define these group faces here to avoid the display
360 ;; update forced when creating new faces.
370 ()))
371 "Level 1 newsgroup face."
373 ;; backward-compatibility alias
385 ()))
386 "Level 1 empty newsgroup face."
388 ;; backward-compatibility alias
400 ()))
401 "Level 2 newsgroup face."
403 ;; backward-compatibility alias
415 ()))
416 "Level 2 empty newsgroup face."
418 ;; backward-compatibility alias
430 ()))
431 "Level 3 newsgroup face."
433 ;; backward-compatibility alias
440 ())
443 ())
445 ()))
446 "Level 3 empty newsgroup face."
448 ;; backward-compatibility alias
460 ()))
461 "Level 4 newsgroup face."
463 ;; backward-compatibility alias
470 ())
473 ())
475 ()))
476 "Level 4 empty newsgroup face."
478 ;; backward-compatibility alias
490 ()))
491 "Level 5 newsgroup face."
493 ;; backward-compatibility alias
500 ())
503 ())
505 ()))
506 "Level 5 empty newsgroup face."
508 ;; backward-compatibility alias
520 ()))
521 "Level 6 newsgroup face."
523 ;; backward-compatibility alias
530 ())
533 ())
535 ()))
536 "Level 6 empty newsgroup face."
538 ;; backward-compatibility alias
550 ()))
551 "Low level newsgroup face."
553 ;; backward-compatibility alias
565 ()))
566 "Low level empty newsgroup face."
568 ;; backward-compatibility alias
581 "Level 1 mailgroup face."
583 ;; backward-compatibility alias
596 "Level 1 empty mailgroup face."
598 ;; backward-compatibility alias
611 "Level 2 mailgroup face."
613 ;; backward-compatibility alias
626 "Level 2 empty mailgroup face."
628 ;; backward-compatibility alias
641 "Level 3 mailgroup face."
643 ;; backward-compatibility alias
655 ()))
656 "Level 3 empty mailgroup face."
658 ;; backward-compatibility alias
671 "Low level mailgroup face."
673 ;; backward-compatibility alias
686 "Low level empty mailgroup face."
688 ;; backward-compatibility alias
692 ;; Summary mode faces.
695 "Face used for selected articles."
697 ;; backward-compatibility alias
704 "Face used for cancelled articles."
706 ;; backward-compatibility alias
719 "Face used for high interest ticked articles."
721 ;; backward-compatibility alias
734 "Face used for low interest ticked articles."
736 ;; backward-compatibility alias
748 ()))
749 "Face used for normal interest ticked articles."
751 ;; backward-compatibility alias
764 "Face used for high interest ancient articles."
766 ;; backward-compatibility alias
779 "Face used for low interest ancient articles."
781 ;; backward-compatibility alias
793 ()))
794 "Face used for normal interest ancient articles."
796 ;; backward-compatibility alias
807 "Face used for high interest uncached articles."
809 ;; backward-compatibility alias
820 "Face used for low interest uncached articles."
822 ;; backward-compatibility alias
833 "Face used for normal interest uncached articles."
835 ;; backward-compatibility alias
842 "Face used for high interest unread articles."
844 ;; backward-compatibility alias
851 "Face used for low interest unread articles."
853 ;; backward-compatibility alias
859 ()))
860 "Face used for normal interest unread articles."
862 ;; backward-compatibility alias
877 "Face used for high interest read articles."
879 ;; backward-compatibility alias
894 "Face used for low interest read articles."
896 ;; backward-compatibility alias
908 ()))
909 "Face used for normal interest read articles."
911 ;; backward-compatibility alias
916 ;;;
917 ;;; Gnus buffers
918 ;;;
924 "Do the same as `get-buffer-create', but store the created buffer."
929 "Add the current buffer to the list of Gnus buffers."
933 "Kill BUFFER and remove from the list of Gnus buffers."
940 "Return a list of live Gnus buffers."
949 gnus-buffers)
951 ;;; Splash screen.
964 ()))
965 "Face for the splash screen."
967 ;; backward-compatibility alias
981 "Indent rigidly using only spaces and no tabs."
987 ;; We translate tabs into spaces -- not everybody uses
988 ;; an 8-character tab.
993 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1017 "*Color styles used for the Gnus logo."
1019 gnus-logo-color-alist))
1029 "Insert startup message in current buffer."
1030 ;; Insert the message.
1035 ;; Make sure the library defining `image-load-path' is loaded
1036 ;; (`find-image' is autoloaded) (and discard the result). Else, we may
1037 ;; get "defvar ignored because image-load-path is let-bound" when calling
1038 ;; `find-image' below.
1048 :color-symbols
1054 ;; Account for the pbm's background.
1058 ;; Account for the xbm's background.
1068 t)))
1071 _ ___ _ _
1072 _ ___ __ ___ __ _ ___
1073 __ _ ___ __ ___
1074 _ ___ _
1075 _ _ __ _
1076 ___ __ _
1077 __ _
1078 _ _ _
1079 _ _ _
1080 _ _ _
1081 __ ___
1082 _ _ _ _
1083 _ _
1084 _ _
1085 _ _
1086 _
1087 __
1090 ;; And then hack it.
1099 ;; Fontify some.
1112 ;;; Do the rest.
1118 "Alist of group parameters.
1120 For example:
1122 (gnus-use-scoring nil)
1123 (gnus-summary-line-format
1125 (gcc-self . t)
1126 (display . all))
1129 (broken-reply-to . t)))"
1136 "If it is t, ignore case of group names specified in `gnus-parameters'.
1137 If it is nil, don't ignore case. If it is `default', which is for the
1138 backward compatibility, use the value of `case-fold-search'."
1149 "Define a group parameter PARAM.
1150 REST is a plist of following:
1151 :type One of `bool', `list' or nil.
1152 :function The name of the function.
1153 :function-document The documentation of the function.
1154 :parameter-type The type for customizing the parameter.
1155 :parameter-document The documentation for the parameter.
1156 :variable The name of the variable.
1157 :variable-document The documentation for the variable.
1158 :variable-group The group for customizing the variable.
1159 :variable-type The type for customizing the variable.
1160 :variable-default The default value of the variable."
1177 'progn
1179 ,variable-document
1185 gnus-group-parameters-more))
1188 ,parameter-type
1192 ,function-document
1194 val)
1197 t)
1202 (,variable
1204 elem value)
1212 ,function-document
1216 elem value)
1223 'value
1228 All other Gnus file and directory variables are initialized from this variable."
1234 "*Directory variable from which all other Gnus file variables are derived.
1236 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1237 This means that other directory variables that are initialized from
1238 this variable won't be set properly if you set this variable in `.gnus.el'.
1239 Set this variable in `.emacs' instead."
1244 "*Default directory for all Gnus buffers."
1247 directory))
1249 ;; Site dependent variables. These variables should be defined in
1250 ;; paths.el.
1253 "Specify a default NNTP server.
1254 This variable should be defined in paths.el, and should never be set
1255 by the user.
1256 If you want to change servers, you should use `gnus-select-method'.
1259 ;; Don't touch this variable.
1262 This is an obsolete variable, which is scarcely used. If you use an
1263 nntp server for your newsgroup and want to change the port number
1264 used to 899, you would say something along these lines:
1269 "A file with only the name of the nntp server in it."
1275 "Find default nntp server.
1276 Check the NNTPSERVER environment variable and the
1277 `gnus-nntpserver-file' file."
1285 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1286 ;; starting or even loading Gnus.
1287 ;;;###autoload(when (fboundp 'custom-autoload)
1288 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1298 gnus-default-nntp-server)
1302 nil
1305 "Default method for selecting a newsgroup.
1306 This variable should be a list, where the first element is how the
1307 news is to be fetched, the second is the address.
1310 NNTP, you could say:
1314 If you want to use your local spool, say:
1316 \(setq gnus-select-method (list 'nnspool (system-name)))
1318 If you use this variable, you must set `gnus-nntp-server' to nil.
1320 There is a lot more to know about select methods and virtual servers -
1321 see the manual for details."
1328 "*Method used for archiving messages you've sent.
1329 This should be a mail method.
1331 See also `gnus-update-message-archive-method'."
1335 gnus-select-method))
1340 The archive method is initially set according to the value of
1342 so that it may be used as a real method of the server which is named
1344 updated if the value of this variable is nil, even if you change the
1345 value of `gnus-message-archive-method' afterward. If you want the
1347 `gnus-message-archive-method', set this variable to a non-nil value."
1354 "*Name of the group in which to save the messages you've written.
1355 This can either be a string; a list of strings; or an alist
1356 of regexps/functions/forms to be evaluated to return a string (or a list
1357 of strings). The functions are called with the name of the current
1358 group (or nil) as a parameter.
1360 If you want to save your mail in one group and the news articles you
1361 write in another group, you could say something like:
1363 \(setq gnus-message-archive-group
1364 '((if (message-news-p)
1368 Normally the group names returned by this variable should be
1370 However, you may wish to store the message on some other server. In
1371 that case, just return a fully prefixed name of the group --
1379 function
1380 sexp
1381 string))
1384 "List of NNTP servers that the user can choose between interactively.
1385 To make Gnus query you for a server, you have to give `gnus' a
1386 non-numeric prefix - `C-u M-x gnus', in short."
1391 "*The name of the host running the NNTP server.
1392 This variable is semi-obsolete. Use the `gnus-select-method'
1393 variable instead."
1396 string))
1399 "A list of secondary methods that will be used for reading news.
1400 This is a list where each element is a complete select method (see
1401 `gnus-select-method').
1403 If, for instance, you want to read your mail with the nnml back end,
1404 you could set this variable:
1412 "Default default new newsgroups the first time Gnus is run.
1416 "Local domain name without a host name.
1417 The DOMAINNAME environment variable is used instead if it is defined.
1418 If the function `system-name' returns the full Internet name, there is
1419 no need to set this variable."
1422 string))
1426 "String with a description of what organization (if any) the user belongs to.
1429 ;; Customization variables
1432 "Preferred method for fetching an article by Message-ID.
1433 If you are reading news from the local spool (with nnspool), fetching
1434 articles by Message-ID is painfully slow. By setting this method to an
1435 nntp method, you might get acceptable results.
1437 The value of this variable must be a valid select method as discussed
1438 in the documentation of `gnus-select-method'.
1440 It can also be a list of select methods, as well as the special symbol
1441 `current', which means to use the current select method. If it is a
1442 list, Gnus will try all the methods in the list until it finds a match."
1448 gnus-select-method
1456 gnus-select-method))))
1459 "*Non-nil means that control messages are displayed using `browse-url'.
1460 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1461 group."
1467 "*Non-nil means that cross referenced articles will be marked as read.
1468 If nil, ignore cross references. If t, mark articles as read in
1469 subscribed newsgroups. If neither t nor nil, mark as read in all
1470 newsgroups."
1478 "*Process mark."
1484 "*The number of articles which indicates a large newsgroup.
1485 If the number of articles in a newsgroup is greater than this value,
1486 confirmation is required for selecting the newsgroup.
1487 If it is nil, no confirmation is required.
1489 Also see `gnus-large-ephemeral-newsgroup'."
1492 integer))
1495 "*Non-nil means that the default name of a file to save articles in is the group name.
1496 If it's nil, the directory form of the group name is used instead.
1498 If this variable is a list, and the list contains the element
1499 `not-score', long file names will not be used for score files; if it
1500 contains the element `not-save', long file names will not be used for
1501 saving; and if it contains the element `not-kill', long file names
1502 will not be used for kill files.
1504 Note that the default for this variable varies according to what system
1505 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1506 to nil while on all other systems it defaults to t."
1524 "*If non-nil, save group scoring info."
1530 "*If non-nil, allow undoing in Gnus group mode buffers."
1535 "*If non-nil, use some adaptive scoring scheme.
1536 If a list, then the values `word' and `line' are meaningful. The
1537 former will perform adaption on individual words in the subject
1538 header while `line' will perform adaption on several headers."
1544 "*If nil, Gnus will ignore the article cache.
1545 If `passive', it will allow entering (and reading) articles
1546 explicitly entered into the cache. If anything else, use the
1547 cache to the full extent of the law."
1555 "*If non-nil, display a thread tree buffer."
1560 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1561 If it is a number N, then Gnus will only keep the last N articles
1562 read. If it is neither nil nor a number, Gnus will keep all read
1563 articles. This is not a good idea."
1566 integer
1571 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1576 "*If non-nil, enable scoring."
1582 "*A hook called when preparing to exit from the summary buffer.
1583 It calls `gnus-summary-expire-articles' by default."
1588 "*Non-nil means that you are a Usenet novice.
1589 If non-nil, verbose messages may be displayed and confirmations may be
1590 required."
1595 "*Non-nil means that you will never be asked for confirmation about anything.
1596 That doesn't mean *anything* anything; particularly destructive
1597 commands will still require prompting."
1602 "*If non-nil, require your confirmation when catching up a group."
1607 "*If non-nil, require your confirmation when exiting Gnus."
1612 "*Function for extracting address components from a From header.
1613 Two pre-defined function exist: `gnus-extract-address-components',
1614 which is the default, quite fast, and too simplistic solution, and
1615 `mail-extract-address-components', which works much better, but is
1616 slower."
1623 "String used to separate shell commands."
1647 "*An alist of valid select methods.
1648 The first element of each list lists should be a string with the name
1649 of the select method. The other elements may be the category of
1650 this method (i. e., `post', `mail', `none' or whatever) or other
1651 properties that this method has (like being respoolable).
1652 If you implement a new select method, all you should have to change is
1653 this variable. I think."
1669 "Recomputes the select-method widget based on the value of
1670 `gnus-valid-select-methods'."
1672 "Widget for entering a select method."
1679 gnus-valid-select-methods)
1683 :inline t
1685 variable
1691 "List of buffers that should update their mode lines.
1692 The list may contain the symbols `group', `article', `tree' and
1693 `summary'. If the corresponding symbol is present, Gnus will keep
1694 that mode line updated with information that may be pertinent.
1695 If this variable is nil, screen refresh may be quicker."
1703 "*Max length of mode-line non-string contents.
1704 If this is nil, Gnus will take space as is needed, leaving the rest
1705 of the mode line intact."
1709 integer))
1711 ;; There should be special validation for this.
1716 to-address
1717 :function-document
1718 "Return GROUP's to-address."
1719 :variable-document
1720 "*Alist of group regexps and correspondent to-addresses."
1721 :variable-group gnus-group-parameter
1724 This will be used when doing followups and posts.
1726 This is primarily useful in mail groups that represent closed
1727 mailing lists--mailing lists where it's expected that everybody that
1728 writes to the mailing list is subscribed to it. Since using this
1729 parameter ensures that the mail only goes to the mailing list itself,
1730 it means that members won't receive two copies of your followups.
1732 Using `to-address' will actually work whether the group is foreign or
1733 not. Let's say there's a group on the server that is called
1734 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1735 articles from a mail-to-news gateway. Posting directly to this group
1736 is therefore impossible--you have to send mail to the mailing list
1737 address instead.
1739 The gnus-group-split mail splitting mechanism will behave as if this
1743 to-list
1744 :function-document
1745 "Return GROUP's to-list."
1746 :variable-document
1747 "*Alist of group regexps and correspondent to-lists."
1748 :variable-group gnus-group-parameter
1751 This address will be used when doing a `a' in the group.
1753 It is totally ignored when doing a followup--except that if it is
1754 present in a news group, you'll get mail group semantics when doing
1755 `f'.
1757 The gnus-group-split mail splitting mechanism will behave as if this
1761 subscribed
1762 :type bool
1763 :function-document
1764 "Return GROUP's subscription status."
1765 :variable-document
1766 "*Groups which are automatically considered subscribed."
1767 :variable-group gnus-group-parameter
1770 Gnus assumed that you are subscribed to the To/List address.
1772 When constructing a list of subscribed groups using
1773 `gnus-find-subscribed-addresses', Gnus includes the To address given
1777 auto-expire
1778 :type bool
1779 :function gnus-group-auto-expirable-p
1780 :function-document
1781 "Check whether GROUP is auto-expirable or not."
1782 :variable gnus-auto-expirable-newsgroups
1783 :variable-default nil
1784 :variable-document
1785 "*Groups in which to automatically mark read articles as expirable.
1786 If non-nil, this should be a regexp that should match all groups in
1787 which to perform auto-expiry. This only makes sense for mail groups."
1788 :variable-group nnmail-expire
1790 regexp)
1792 :parameter-document
1796 total-expire
1797 :type bool
1798 :function gnus-group-total-expirable-p
1799 :function-document
1800 "Check whether GROUP is total-expirable or not."
1801 :variable gnus-total-expirable-newsgroups
1802 :variable-default nil
1803 :variable-document
1804 "*Groups in which to perform expiry of all read articles.
1805 Use with extreme caution. All groups that match this regexp will be
1806 expiring - which means that all read articles will be deleted after
1807 \(say) one week. (This only goes for mail groups and the like, of
1808 course.)"
1809 :variable-group nnmail-expire
1811 regexp)
1813 :parameter-document
1814 "All read articles will be put through the expiry process
1816 This happens even if they are not marked as expirable.
1820 charset
1821 :function-document
1822 "Return the default charset of GROUP."
1823 :variable gnus-group-charset-alist
1824 :variable-default
1837 :variable-document
1838 "Alist of regexps (to match group names) and default charsets to be used when reading."
1839 :variable-group gnus-charset
1847 post-method
1848 :type list
1849 :function-document
1850 "Return a posting method for GROUP."
1851 :variable gnus-post-method-alist
1852 :variable-document
1853 "Alist of regexps (to match group names) and method to be used when
1854 posting an article."
1855 :variable-group gnus-group-foreign
1856 :parameter-type
1864 :parameter-document
1868 large-newsgroup-initial
1869 :type integer
1870 :function-document
1871 "Return GROUP's initial input of the number of articles."
1872 :variable-document
1873 "*Alist of group regexps and its initial input of the number of articles."
1874 :variable-group gnus-group-parameter
1880 This number will be prompted as the initial value of the number of
1881 articles to list when the group is a large newsgroup (see
1882 `gnus-large-newsgroup'). If it is nil, the default value is the
1885 ;; The Gnus registry's ignored groups
1887 registry-ignore
1888 :type list
1889 :function-document
1890 "Whether this group should be ignored by the registry."
1891 :variable gnus-registry-ignored-groups
1892 :variable-default nil
1893 :variable-document
1894 "*Groups in which the registry should be turned off."
1895 :variable-group gnus-registry
1902 :parameter-document
1905 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1907 "*Disable the group parameters for spam detection.
1908 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1915 "Spam group classification (requires spam.el).
1916 This group contains spam messages. On summary entry, unread messages
1917 will be marked as spam. On summary exit, the specified spam
1918 processors will be invoked on spam-marked messages, then those
1919 messages will be expired, so the spam processor will only see a
1923 "The ham value for the spam group parameter (requires spam.el).
1924 On summary exit, the specified ham processors will be invoked on
1925 ham-marked messages. Exercise caution, since the ham processor will
1926 see the same message more than once because there is no ham message
1930 spam-contents
1931 :type list
1932 :function-document
1933 "The spam type (spam, ham, or neither) of the group."
1934 :variable gnus-spam-newsgroup-contents
1935 :variable-default nil
1936 :variable-document
1937 "*Group classification (spam, ham, or neither). Only
1938 meaningful when spam.el is loaded. If non-nil, this should be a
1939 list of group name regexps associated with a classification for
1940 each one. In spam groups, new articles are marked as spam on
1941 summary entry. There is other behavior associated with ham and
1942 no classification when spam.el is loaded - see the manual."
1943 :variable-group spam
1957 :parameter-document
1958 "The spam classification (spam, ham, or neither) of this group.
1959 When a spam group is entered, all unread articles are marked as
1960 spam. There is other behavior associated with ham and no
1964 spam-resend-to
1965 :type list
1966 :function-document
1967 "The address to get spam resent (through spam-report-resend)."
1968 :variable gnus-spam-resend-to
1969 :variable-default nil
1970 :variable-document
1971 "The address to get spam resent (through spam-report-resend)."
1972 :variable-group spam
1976 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1977 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1978 :parameter-document
1982 ham-resend-to
1983 :type list
1984 :function-document
1985 "The address to get ham resent (through spam-report-resend)."
1986 :variable gnus-ham-resend-to
1987 :variable-default nil
1988 :variable-document
1989 "The address to get ham resent (through spam-report-resend)."
1990 :variable-group spam
1994 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1995 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1996 :parameter-document
2012 "OBSOLETE: The Gmane reporting summary exit spam processor.
2019 "OBSOLETE: The ifile summary exit ham processor.
2023 "OBSOLETE: The Bogofilter summary exit ham processor.
2027 "OBSOLETE: The spam-stat summary exit ham processor.
2031 "OBSOLETE: The whitelist summary exit ham processor.
2035 "OBSOLETE: The BBDB summary exit ham processor.
2039 "OBSOLETE: The ham copy exit ham processor.
2043 "OBSOLETE: The spamoracle summary exit ham processor.
2047 spam-process
2048 :type list
2049 :parameter-type
2052 :value nil
2089 :function-document
2090 "Which spam or ham processors will be applied when the summary is exited."
2091 :variable gnus-spam-process-newsgroups
2092 :variable-default nil
2093 :variable-document
2094 "*Groups in which to automatically process spam or ham articles with
2095 a backend on summary exit. If non-nil, this should be a list of group
2096 name regexps that should match all groups in which to do automatic
2097 spam processing, associated with the appropriate processor."
2098 :variable-group spam
2099 :variable-type
2140 :parameter-document
2144 spam-autodetect
2145 :type list
2146 :parameter-type
2148 :function-document
2149 "Should spam be autodetected (with spam-split) in this group?"
2150 :variable gnus-spam-autodetect
2151 :variable-default nil
2152 :variable-document
2153 "*Groups in which spam should be autodetected when they are entered.
2154 Only unseen articles will be examined, unless
2155 spam-autodetect-recheck-messages is set."
2156 :variable-group spam
2157 :variable-type
2162 boolean))
2163 :parameter-document
2164 "Spam autodetection.
2165 Only unseen articles will be examined, unless
2169 spam-autodetect-methods
2170 :type list
2171 :parameter-type
2194 :function-document
2195 "Methods to be used for autodetection in each group"
2196 :variable gnus-spam-autodetect-methods
2197 :variable-default nil
2198 :variable-document
2199 "*Methods for autodetecting spam per group.
2200 Requires the spam-autodetect parameter. Only unseen articles
2201 will be examined, unless spam-autodetect-recheck-messages is
2202 set."
2203 :variable-group spam
2204 :variable-type
2231 :parameter-document
2232 "Spam autodetection methods.
2233 Requires the spam-autodetect parameter. Only unseen articles
2234 will be examined, unless spam-autodetect-recheck-messages is
2238 spam-process-destination
2239 :type list
2240 :parameter-type
2246 :function-document
2247 "Where spam-processed articles will go at summary exit."
2248 :variable gnus-spam-process-destinations
2249 :variable-default nil
2250 :variable-document
2251 "*Groups in which to explicitly send spam-processed articles to
2252 another group, or expire them (the default). If non-nil, this should
2253 be a list of group name regexps that should match all groups in which
2254 to do spam-processed article moving, associated with the destination
2255 group or nil for explicit expiration. This only makes sense for
2256 mail groups."
2257 :variable-group spam
2258 :variable-type
2269 :parameter-document
2273 ham-process-destination
2274 :type list
2275 :parameter-type
2283 :function-document
2284 "Where ham articles will go at summary exit from a spam group."
2285 :variable gnus-ham-process-destinations
2286 :variable-default nil
2287 :variable-document
2288 "*Groups in which to explicitly send ham articles to
2289 another group, or do nothing (the default). If non-nil, this should
2290 be a list of group name regexps that should match all groups in which
2291 to do ham article moving, associated with the destination
2292 group or nil for explicit ignoring. This only makes sense for
2293 mail groups, and only works in spam groups."
2294 :variable-group spam
2295 :variable-type
2307 :parameter-document
2311 ham-marks
2322 :parameter-document
2323 "Marks considered ham (positively not spam). Such articles will be
2324 processed as ham (non-spam) on group exit. When nil, the global
2325 spam-ham-marks variable takes precedence."
2327 gnus-read-mark
2328 gnus-killed-mark
2329 gnus-kill-file-mark
2330 gnus-low-score-mark))))
2331 :variable-group spam
2332 :variable-document
2336 spam-marks
2345 :parameter-document
2346 "Marks considered spam.
2347 Such articles will be processed as spam on group exit. When nil, the global
2348 spam-spam-marks variable takes precedence."
2350 :variable-group spam
2351 :variable-document
2355 "Number of group name elements to leave alone when making a short group name."
2360 "*If non-nil, once you set a level, Gnus will use this level."
2364 ;; Hooks.
2367 "A hook run while Gnus is loaded."
2372 "A hook called to apply kill files to a group.
2373 This hook is intended to apply a kill file to the selected newsgroup.
2374 The function `gnus-apply-kill-file' is called by default.
2376 Since a general kill file is too heavy to use only for a few
2377 newsgroups, I recommend you to use a lighter hook function. For
2378 example, if you'd like to apply a kill file to articles which contains
2379 a string `rmgroup' in subject in newsgroup `control', you can use the
2380 following hook:
2382 (setq gnus-apply-kill-hook
2383 (list
2384 (lambda ()
2393 "Function run when a group level is changed.
2394 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2397 function))
2399 ;;; Face thingies.
2403 mouse-face
2404 summary-menu group-menu article-menu
2405 tree-highlight menu highlight
2406 browse-menu server-menu
2407 page-marker tree-menu binary-menu pick-menu)
2408 "*Enable visual features.
2409 If `visual' is disabled, there will be no menus and few faces. Most of
2410 the visual customization options below will be ignored. Gnus will use
2411 less space and be faster as a result.
2413 This variable can also be a list of visual elements to switch on. For
2414 instance, to switch off all visual things except menus, you can say:
2416 (setq gnus-visual '(menu))
2418 Valid elements include `summary-highlight', `group-highlight',
2419 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2420 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2421 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2441 ;; Byte-compiler warning.
2443 ;; Find out whether the gnus-visual TYPE is wanted.
2447 gnus-visual
2451 t))))
2461 "*Face used for group or summary buffer mouse highlighting.
2462 The line beneath the mouse pointer will be highlighted with this
2463 face."
2476 "Controls use of the agent cache while plugged.
2477 When set, Gnus will prefer using the locally stored content rather
2478 than re-fetching it from the server. You also need to enable
2479 `gnus-agent' for this to have any affect."
2485 "Default charset assumed to be used when viewing non-ASCII characters.
2486 This variable is overridden on a group-to-group basis by the
2487 `gnus-group-charset-alist' variable and is only used on groups not
2488 covered by that variable."
2492 ;; Fixme: Doc reference to agent.
2494 "Whether we want to use the Gnus agent or not.
2496 You may customize gnus-agent to disable its use. However, some
2497 back ends have started to use the agent as a client-side cache.
2498 Disabling the agent may result in noticeable loss of performance."
2504 "Function called by the command `gnus-other-frame'."
2512 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2513 This should be an alist for Emacs, or a plist for XEmacs."
2524 "Which information should be exposed in the User-Agent header.
2526 Can be a list of symbols or a string. Valid symbols are `gnus'
2527 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2528 addition to the Emacs version, you can add `codename' \(show
2529 \(S\)XEmacs codename\) or either `config' \(show system
2530 configuration\) or `type' \(show system type\). If you set it to
2531 a string, be sure to use a valid format, see RFC 2616."
2544 ;; Convert old (< 2005-01-10) symbol type values:
2563 \f
2564 ;;; Internal variables
2569 ; Reset each time gnus-agent-covered-methods is changed else
2570 ; gnus-agent-method-p may mis-report a methods status.
2571 )
2581 ;; The carpal mode has been removed, but define the variable for
2582 ;; backwards compatability.
2601 ;; Variable holding the user answers to all method prompts.
2604 ;; Variable holding the user answers to all mail method prompts.
2607 ;; Variable holding the user answers to all group prompts.
2615 "*The directory where cached articles will be stored."
2621 nnspool "cache"
2645 ;; Propagate flags to server, with the following exceptions:
2646 ;; `seen' is private to each gnus installation
2647 ;; `cache' is a internal gnus flag for each gnus installation
2648 ;; `download' is a agent flag private to each gnus installation
2649 ;; `unsend' are for nndraft groups only
2650 ;; `score' is not a proper mark
2651 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2654 "Marks that shouldn't be propagated to back ends.
2655 Typical marks are those that make no sense in a standalone back end,
2656 such as a mark that says whether an article is stored in the cache
2669 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2694 gnus-newsrc-last-checked-date
2695 gnus-newsrc-alist gnus-server-alist
2696 gnus-killed-list gnus-zombie-list
2697 gnus-topic-topology gnus-topic-alist
2698 gnus-format-specs)
2702 "Assoc list of read articles.
2706 "Assoc list of registry data.
2733 ;; Save window configuration.
2746 ;;; End of variables.
2748 ;; Define some autoload functions Gnus might use.
2751 ;; This little mapcar goes through the list below and marks the
2752 ;; symbols in question as autoloaded functions.
2772 message-send-and-exit message-yank-original)
2776 ;; This is only used in message.el, which has an autoload.
2778 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2780 ;; Next two only used in gnus-util.
2781 rmail-summary-exists rmail-select-summary)
2782 ;; Only used in gnus-util, which has an autoload.
2787 gnus-Folder-save-name gnus-folder-save-name)
2790 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2791 gnus-demon-add-disconnection gnus-demon-add-handler
2792 gnus-demon-remove-handler)
2794 gnus-demon-init gnus-demon-cancel)
2796 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2797 gnus-face-from-file)
2799 gnus-tree-open gnus-tree-close)
2801 gnus-server-server-name)
2804 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2805 gnus-article-hide-citation gnus-article-fill-cited-article
2806 gnus-article-hide-citation-in-followups)
2808 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2809 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2811 gnus-cache-possibly-remove-articles gnus-cache-request-article
2812 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2813 gnus-cache-enter-remove-article gnus-cached-article-p
2814 gnus-cache-open gnus-cache-close gnus-cache-update-article
2815 gnus-cache-articles-in-group)
2817 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2819 gnus-summary-increase-score gnus-summary-set-score
2820 gnus-summary-raise-thread gnus-summary-raise-same-subject
2821 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2822 gnus-summary-lower-thread gnus-summary-lower-same-subject
2823 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2824 gnus-summary-current-score gnus-score-delta-default
2825 gnus-score-flush-cache gnus-score-close
2826 gnus-possibly-score-headers gnus-score-followup-article
2827 gnus-score-followup-thread)
2830 gnus-current-score-file-nondirectory gnus-score-adaptive
2831 gnus-score-find-trace gnus-score-file-name)
2835 gnus-subscribe-topics)
2839 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2840 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2841 gnus-uu-mark-by-regexp gnus-uu-mark-all
2842 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2843 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2844 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2845 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2846 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2847 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2848 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2849 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2852 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2854 gnus-group-post-news gnus-group-mail gnus-group-news
2855 gnus-summary-post-news gnus-summary-news-other-window
2856 gnus-summary-followup gnus-summary-followup-with-original
2857 gnus-summary-cancel-article gnus-summary-supersede-article
2858 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2859 gnus-summary-mail-forward gnus-summary-mail-other-window
2860 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2861 gnus-summary-wide-reply gnus-summary-followup-to-mail
2862 gnus-summary-followup-to-mail-with-original gnus-bug
2863 gnus-summary-wide-reply-with-original
2864 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2865 gnus-summary-post-forward)
2870 gnus-list-of-unread-articles gnus-list-of-read-articles
2871 gnus-offer-save-summaries gnus-make-thread-indent-array
2872 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2873 gnus-summary-skip-intangible gnus-summary-article-number
2874 gnus-data-header gnus-data-find)
2876 gnus-group-list-groups gnus-group-first-unread-group
2877 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2878 gnus-group-setup-buffer gnus-group-get-new-news
2879 gnus-group-make-help-group gnus-group-update-group
2880 gnus-group-iterate gnus-group-group-name)
2882 gnus-backlog-remove-article)
2884 gnus-article-prepare gnus-article-set-window-start
2885 gnus-article-next-page gnus-article-prev-page
2886 gnus-request-article-this-buffer gnus-article-mode
2887 gnus-article-setup-buffer gnus-narrow-to-page
2888 gnus-article-delete-invisible-text gnus-treat-article)
2890 gnus-article-hide-headers gnus-article-hide-boring-headers
2891 gnus-article-treat-overstrike
2892 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2893 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2894 gnus-article-de-base64-unreadable
2895 gnus-article-decode-HZ
2896 gnus-article-wash-html
2897 gnus-article-unsplit-urls
2898 gnus-article-hide-pem gnus-article-hide-signature
2899 gnus-article-strip-leading-blank-lines gnus-article-date-local
2900 gnus-article-date-original gnus-article-date-lapsed
2901 ;;gnus-article-show-all-headers
2902 gnus-article-edit-mode gnus-article-edit-article
2903 gnus-article-edit-done gnus-article-decode-encoded-words
2904 gnus-start-date-timer gnus-stop-date-timer
2905 gnus-mime-view-all-parts)
2909 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2910 gnus-check-reasonable-setup)
2912 gnus-dup-enter-articles)
2918 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2919 gnus-async-halt-prefetch)
2921 gnus-agent-save-active gnus-agent-method-p
2922 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2923 gnus-summary-set-agent-mark gnus-agent-save-group-info
2924 gnus-agent-request-article gnus-agent-retrieve-headers)
2926 gnus-unplugged gnus-agentize gnus-agent-batch)
2928 gnus-summary-save-article-vm)
2933 gnus-group-split-update)
2936 ;;; gnus-sum.el thingies
2940 "*The format specification of the lines in the summary buffer.
2942 It works along the same lines as a normal formatting string,
2943 with some simple extensions.
2945 %N Article number, left padded with spaces (string)
2946 %S Subject (string)
2948 %n Name of the poster (string)
2949 %a Extracted name of the poster (string)
2950 %A Extracted address of the poster (string)
2951 %F Contents of the From: header (string)
2952 %f Contents of the From: or To: headers (string)
2953 %x Contents of the Xref: header (string)
2954 %D Date of the article (string)
2955 %d Date of the article (string) in DD-MMM format
2956 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2957 %M Message-id of the article (string)
2958 %r References of the article (string)
2959 %c Number of characters in the article (integer)
2960 %k Pretty-printed version of the above (string)
2962 %L Number of lines in the article (integer)
2963 %I Indentation based on thread level (a string of spaces)
2964 %B A complex trn-style thread tree (string)
2965 The variables `gnus-sum-thread-*' can be used for customization.
2966 %T A string with two possible values: 80 spaces if the article
2967 is on thread level two or larger and 0 spaces on level one
2972 %> Spaces of length thread-level (string)
2973 %< Spaces of length (- 20 thread-level) (string)
2974 %i Article score (number)
2975 %z Article zcore (character)
2976 %t Number of articles under the current thread (number).
2977 %e Whether the thread is empty or not (character).
2978 %V Total thread score (number).
2979 %P The line number (number).
2980 %O Download mark (character).
2981 %* If present, indicates desired cursor position
2982 (instead of after first colon).
2983 %u User defined specifier. The next character in the format string should
2984 be a letter. Gnus will call the function gnus-user-format-function-X,
2985 where X is the letter following %u. The function will be passed the
2986 current header as argument. The function should return a string, which
2987 will be inserted into the summary just like information from any other
2988 summary specifier.
2990 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2991 with care. For reasons of efficiency, Gnus will compute what column
2993 it is invalid to have these specs after a variable-length spec. Well,
2994 you might not be arrested, but your summary buffer will look strange,
2995 which is bad enough.
2997 The smart choice is to have these specs as far to the left as
2998 possible.
3000 This restriction may disappear in later versions of Gnus.
3002 General format specifiers can also be used.
3003 See Info node `(gnus)Formatting Variables'."
3008 ;;;
3009 ;;; Skeleton keymaps
3010 ;;;
3015 (while keys
3016 (define-key keymap (pop keys) 'undefined))))
3018 (defvar gnus-article-mode-map
3019 (let ((keymap (make-sparse-keymap)))
3020 (gnus-suppress-keymap keymap)
3021 keymap))
3022 (defvar gnus-summary-mode-map
3023 (let ((keymap (make-keymap)))
3024 (gnus-suppress-keymap keymap)
3025 keymap))
3026 (defvar gnus-group-mode-map
3027 (let ((keymap (make-keymap)))
3028 (gnus-suppress-keymap keymap)
3029 keymap))
3031 \f
3033 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3034 ;; If you want the cursor to go somewhere else, set these two
3035 ;; functions in some startup hook to whatever you want.
3036 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3037 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3039 ;;; Various macros and substs.
3041 (defun gnus-header-from (header)
3042 (mail-header-from header))
3044 (defmacro gnus-gethash (string hashtable)
3045 "Get hash value of STRING in HASHTABLE."
3046 `(symbol-value (intern-soft ,string ,hashtable)))
3048 (defmacro gnus-gethash-safe (string hashtable)
3049 "Get hash value of STRING in HASHTABLE.
3050 Return nil if not defined."
3051 `(let ((sym (intern-soft ,string ,hashtable)))
3052 (and (boundp sym) (symbol-value sym))))
3054 (defmacro gnus-sethash (string value hashtable)
3055 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3056 `(set (intern ,string ,hashtable) ,value))
3057 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3059 (defmacro gnus-group-unread (group)
3060 "Get the currently computed number of unread articles in GROUP."
3061 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3063 (defmacro gnus-group-entry (group)
3064 "Get the newsrc entry for GROUP."
3065 `(gnus-gethash ,group gnus-newsrc-hashtb))
3067 (defmacro gnus-active (group)
3068 "Get active info on GROUP."
3069 `(gnus-gethash ,group gnus-active-hashtb))
3071 (defmacro gnus-set-active (group active)
3072 "Set GROUP's active info."
3073 `(gnus-sethash ,group ,active gnus-active-hashtb))
3075 ;; Info access macros.
3077 (defmacro gnus-info-group (info)
3078 `(nth 0 ,info))
3079 (defmacro gnus-info-rank (info)
3080 `(nth 1 ,info))
3081 (defmacro gnus-info-read (info)
3082 `(nth 2 ,info))
3083 (defmacro gnus-info-marks (info)
3084 `(nth 3 ,info))
3085 (defmacro gnus-info-method (info)
3086 `(nth 4 ,info))
3087 (defmacro gnus-info-params (info)
3088 `(nth 5 ,info))
3090 (defmacro gnus-info-level (info)
3091 `(let ((rank (gnus-info-rank ,info)))
3092 (if (consp rank)
3093 (car rank)
3094 rank)))
3095 (defmacro gnus-info-score (info)
3096 `(let ((rank (gnus-info-rank ,info)))
3097 (or (and (consp rank) (cdr rank)) 0)))
3099 (defmacro gnus-info-set-group (info group)
3100 `(setcar ,info ,group))
3101 (defmacro gnus-info-set-rank (info rank)
3102 `(setcar (nthcdr 1 ,info) ,rank))
3103 (defmacro gnus-info-set-read (info read)
3104 `(setcar (nthcdr 2 ,info) ,read))
3105 (defmacro gnus-info-set-marks (info marks &optional extend)
3106 (if extend
3107 `(gnus-info-set-entry ,info ,marks 3)
3108 `(setcar (nthcdr 3 ,info) ,marks)))
3109 (defmacro gnus-info-set-method (info method &optional extend)
3110 (if extend
3111 `(gnus-info-set-entry ,info ,method 4)
3112 `(setcar (nthcdr 4 ,info) ,method)))
3113 (defmacro gnus-info-set-params (info params &optional extend)
3114 (if extend
3115 `(gnus-info-set-entry ,info ,params 5)
3116 `(setcar (nthcdr 5 ,info) ,params)))
3118 (defun gnus-info-set-entry (info entry number)
3119 ;; Extend the info until we have enough elements.
3120 (while (<= (length info) number)
3121 (nconc info (list nil)))
3122 ;; Set the entry.
3123 (setcar (nthcdr number info) entry))
3125 (defmacro gnus-info-set-level (info level)
3126 `(let ((rank (cdr ,info)))
3127 (if (consp (car rank))
3128 (setcar (car rank) ,level)
3129 (setcar rank ,level))))
3130 (defmacro gnus-info-set-score (info score)
3131 `(let ((rank (cdr ,info)))
3132 (if (consp (car rank))
3133 (setcdr (car rank) ,score)
3134 (setcar rank (cons (car rank) ,score)))))
3136 (defmacro gnus-get-info (group)
3137 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3139 ;;; Load the compatibility functions.
3141 (require 'gnus-ems)
3143 \f
3144 ;;;
3145 ;;; Shutdown
3146 ;;;
3148 (defvar gnus-shutdown-alist nil)
3150 (defun gnus-add-shutdown (function &rest symbols)
3151 "Run FUNCTION whenever one of SYMBOLS is shut down."
3152 (push (cons function symbols) gnus-shutdown-alist))
3154 (defun gnus-shutdown (symbol)
3155 "Shut down everything that waits for SYMBOL."
3156 (dolist (entry gnus-shutdown-alist)
3157 (when (memq symbol (cdr entry))
3158 (funcall (car entry)))))
3160 \f
3161 ;;;
3162 ;;; Gnus Utility Functions
3163 ;;;
3165 (defun gnus-find-subscribed-addresses ()
3166 "Return a regexp matching the addresses of all subscribed mail groups.
3167 It consists of the `to-address' or `to-list' parameter of all groups
3168 with a `subscribed' parameter."
3169 (let (group address addresses)
3170 (dolist (entry (cdr gnus-newsrc-alist))
3171 (setq group (car entry))
3172 (when (gnus-parameter-subscribed group)
3173 (setq address (mail-strip-quoted-names
3174 (or (gnus-group-fast-parameter group 'to-address)
3175 (gnus-group-fast-parameter group 'to-list))))
3176 (when address
3177 (add-to-list 'addresses address))))
3178 (when addresses
3181 (defmacro gnus-string-or (&rest strings)
3182 "Return the first element of STRINGS that is a non-blank string.
3183 STRINGS will be evaluated in normal `or' order."
3184 `(gnus-string-or-1 (list ,@strings)))
3186 (defun gnus-string-or-1 (strings)
3187 (let (string)
3188 (while strings
3189 (setq string (pop strings))
3191 (setq string nil)
3192 (setq strings nil)))
3193 string))
3195 (defun gnus-version (&optional arg)
3196 "Version number of this version of Gnus.
3197 If ARG, insert string at point."
3198 (interactive "P")
3199 (if arg
3200 (insert (message gnus-version))
3201 (message gnus-version)))
3203 (defun gnus-continuum-version (&optional version)
3204 "Return VERSION as a floating point number."
3205 (unless version
3206 (setq version gnus-version))
3209 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3210 (number (match-string 2 version))
3211 major minor least)
3212 (unless (string-match
3214 (error "Invalid version string: %s" version))
3215 (setq major (string-to-number (match-string 1 number))
3216 minor (string-to-number (match-string 2 number))
3217 least (if (match-beginning 3)
3218 (string-to-number (match-string 3 number))
3219 0))
3220 (string-to-number
3221 (if (zerop major)
3222 (format "%s00%02d%02d"
3223 (if (member alpha '("(ding)" "d"))
3224 "4.99"
3225 (+ 5 (* 0.02
3226 (abs
3227 (- (mm-char-int (aref (downcase alpha) 0))
3228 (mm-char-int ?t))))
3229 -0.01))
3230 minor least)
3231 (format "%d.%02d%02d" major minor least))))))
3233 (defun gnus-info-find-node (&optional nodename)
3234 "Find Info documentation of Gnus."
3235 (interactive)
3236 ;; Enlarge info window if needed.
3237 (let (gnus-info-buffer)
3238 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3239 (setq gnus-info-buffer (current-buffer))
3240 (gnus-configure-windows 'info)))
3242 ;;;
3243 ;;; gnus-interactive
3244 ;;;
3246 (defvar gnus-current-prefix-symbol nil
3247 "Current prefix symbol.")
3249 (defvar gnus-current-prefix-symbols nil
3250 "List of current prefix symbols.")
3252 (defun gnus-interactive (string &optional params)
3253 "Return a list that can be fed to `interactive'.
3254 See `interactive' for full documentation.
3256 Adds the following specs:
3258 y -- The current symbolic prefix.
3259 Y -- A list of the current symbolic prefix(es).
3260 A -- Article number.
3261 H -- Article header.
3262 g -- Group name."
3263 (let ((i 0)
3264 out c prompt)
3265 (while (< i (length string))
3267 (setq c (aref string i))
3268 (when (match-end 1)
3269 (setq prompt (match-string 1 string)))
3270 (setq i (match-end 0))
3271 ;; We basically emulate just about everything that
3272 ;; `interactive' does, but add the specs listed above.
3273 (push
3274 (cond
3275 ((= c ?a)
3276 (completing-read prompt obarray 'fboundp t))
3277 ((= c ?b)
3278 (read-buffer prompt (current-buffer) t))
3279 ((= c ?B)
3280 (read-buffer prompt (other-buffer (current-buffer))))
3281 ((= c ?c)
3282 (read-char))
3283 ((= c ?C)
3284 (completing-read prompt obarray 'commandp t))
3285 ((= c ?d)
3286 (point))
3287 ((= c ?D)
3288 (read-file-name prompt nil default-directory 'lambda))
3289 ((= c ?f)
3290 (read-file-name prompt nil nil 'lambda))
3291 ((= c ?F)
3292 (read-file-name prompt))
3293 ((= c ?k)
3294 (read-key-sequence prompt))
3295 ((= c ?K)
3296 (error "Not implemented spec"))
3297 ((= c ?e)
3298 (error "Not implemented spec"))
3299 ((= c ?m)
3300 (mark))
3301 ((= c ?N)
3302 (error "Not implemented spec"))
3303 ((= c ?n)
3304 (string-to-number (read-from-minibuffer prompt)))
3305 ((= c ?p)
3306 (prefix-numeric-value current-prefix-arg))
3307 ((= c ?P)
3308 current-prefix-arg)
3309 ((= c ?r)
3310 'gnus-prefix-nil)
3311 ((= c ?s)
3312 (read-string prompt))
3313 ((= c ?S)
3314 (intern (read-string prompt)))
3315 ((= c ?v)
3316 (read-variable prompt))
3317 ((= c ?x)
3318 (read-minibuffer prompt))
3319 ((= c ?x)
3320 (eval-minibuffer prompt))
3321 ;; And here the new specs come.
3322 ((= c ?y)
3323 gnus-current-prefix-symbol)
3324 ((= c ?Y)
3325 gnus-current-prefix-symbols)
3326 ((= c ?g)
3327 (gnus-group-group-name))
3328 ((= c ?A)
3329 (gnus-summary-skip-intangible)
3330 (or (get-text-property (point) 'gnus-number)
3331 (gnus-summary-last-subject)))
3332 ((= c ?H)
3333 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3334 (t
3335 (error "Non-implemented spec")))
3336 out)
3337 (cond
3338 ((= c ?r)
3339 (push (if (< (point) (mark)) (point) (mark)) out)
3340 (push (if (> (point) (mark)) (point) (mark)) out))))
3341 (setq out (delq 'gnus-prefix-nil out))
3342 (nreverse out)))
3344 (defun gnus-symbolic-argument (&optional arg)
3345 "Read a symbolic argument and a command, and then execute command."
3346 (interactive "P")
3347 (let* ((in-command (this-command-keys))
3348 (command in-command)
3349 gnus-current-prefix-symbols
3350 gnus-current-prefix-symbol
3351 syms)
3352 (while (equal in-command command)
3353 (message "%s-" (key-description (this-command-keys)))
3354 (push (intern (char-to-string (read-char))) syms)
3355 (setq command (read-key-sequence nil t)))
3356 (setq gnus-current-prefix-symbols (nreverse syms)
3357 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3358 (call-interactively (key-binding command t))))
3360 ;;; More various functions.
3362 (defsubst gnus-check-backend-function (func group)
3363 "Check whether GROUP supports function FUNC.
3364 GROUP can either be a string (a group name) or a select method."
3365 (ignore-errors
3366 (let ((method (if (stringp group)
3367 (car (gnus-find-method-for-group group))
3368 group)))
3369 (unless (featurep method)
3370 (require method))
3371 (fboundp (intern (format "%s-%s" method func))))))
3373 (defun gnus-group-read-only-p (&optional group)
3374 "Check whether GROUP supports editing or not.
3375 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3376 that that variable is buffer-local to the summary buffers."
3377 (let ((group (or group gnus-newsgroup-name)))
3378 (not (gnus-check-backend-function 'request-replace-article group))))
3380 (defun gnus-virtual-group-p (group)
3381 "Say whether GROUP is virtual or not."
3382 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3383 gnus-valid-select-methods)))
3385 (defun gnus-news-group-p (group &optional article)
3386 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3387 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3388 t) ;is news of course.
3389 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3390 nil) ;must be mail then.
3391 ((vectorp article) ;Has header info.
3392 (eq (gnus-request-type group (mail-header-id article)) 'news))
3393 ((null article) ;Hasn't header info
3394 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3395 ((< article 0) ;Virtual message
3396 nil) ;we don't know, guess mail.
3397 (t ;Has positive number
3398 (eq (gnus-request-type group article) 'news)))) ;use it.
3400 ;; Returns a list of writable groups.
3401 (defun gnus-writable-groups ()
3402 (let ((alist gnus-newsrc-alist)
3403 groups group)
3404 (while (setq group (car (pop alist)))
3405 (unless (gnus-group-read-only-p group)
3406 (push group groups)))
3407 (nreverse groups)))
3409 ;; Check whether to use long file names.
3410 (defun gnus-use-long-file-name (symbol)
3411 ;; The variable has to be set...
3412 (and gnus-use-long-file-name
3413 ;; If it isn't a list, then we return t.
3414 (or (not (listp gnus-use-long-file-name))
3415 ;; If it is a list, and the list contains `symbol', we
3416 ;; return nil.
3417 (not (memq symbol gnus-use-long-file-name)))))
3419 ;; Generate a unique new group name.
3420 (defun gnus-generate-new-group-name (leaf)
3421 (let ((name leaf)
3422 (num 0))
3423 (while (gnus-group-entry name)
3424 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3425 name))
3427 (defun gnus-ephemeral-group-p (group)
3428 "Say whether GROUP is ephemeral or not."
3429 (gnus-group-get-parameter group 'quit-config t))
3431 (defun gnus-group-quit-config (group)
3432 "Return the quit-config of GROUP."
3433 (gnus-group-get-parameter group 'quit-config t))
3435 (defun gnus-kill-ephemeral-group (group)
3436 "Remove ephemeral GROUP from relevant structures."
3437 (gnus-sethash group nil gnus-newsrc-hashtb))
3439 (defun gnus-simplify-mode-line ()
3440 "Make mode lines a bit simpler."
3441 (setq mode-line-modified (cdr gnus-mode-line-modified))
3442 (when (listp mode-line-format)
3443 (make-local-variable 'mode-line-format)
3444 (setq mode-line-format (copy-sequence mode-line-format))
3445 (when (equal (nth 3 mode-line-format) " ")
3446 (setcar (nthcdr 3 mode-line-format) " "))))
3448 ;;; Servers and groups.
3450 (defsubst gnus-server-add-address (method)
3451 (let ((method-name (symbol-name (car method))))
3452 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3453 (not (assq (intern (concat method-name "-address")) method))
3454 (memq 'physical-address (assq (car method)
3455 gnus-valid-select-methods)))
3456 (append method (list (list (intern (concat method-name "-address"))
3457 (nth 1 method))))
3458 method)))
3460 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3461 (catch 'server-name
3462 (setq method (or method gnus-select-method))
3464 ;; Perhaps it is already in the cache.
3465 (unless nocache
3466 (mapc (lambda (name-method)
3467 (if (equal (cdr name-method) method)
3468 (throw 'server-name (car name-method))))
3469 gnus-server-method-cache))
3471 (mapc
3472 (lambda (server-alist)
3473 (mapc (lambda (name-method)
3474 (when (gnus-methods-equal-p (cdr name-method) method)
3475 (unless (member name-method gnus-server-method-cache)
3476 (push name-method gnus-server-method-cache))
3477 (throw 'server-name (car name-method))))
3478 server-alist))
3479 (list gnus-server-alist
3480 gnus-predefined-server-alist))
3482 (let* ((name (if (member (cadr method) '(nil ""))
3483 (format "%s" (car method))
3484 (format "%s:%s" (car method) (cadr method))))
3485 (name-method (cons name method)))
3486 (when (and (not (member name-method gnus-server-method-cache))
3487 (not no-enter-cache)
3488 (not (assoc (car name-method) gnus-server-method-cache)))
3489 (push name-method gnus-server-method-cache))
3490 name)))
3492 (defsubst gnus-server-to-method (server)
3493 "Map virtual server names to select methods."
3494 (or (and server (listp server) server)
3495 (cdr (assoc server gnus-server-method-cache))
3496 (let ((result
3497 (or
3498 ;; Perhaps this is the native server?
3499 (and (equal server "native") gnus-select-method)
3500 ;; It should be in the server alist.
3501 (cdr (assoc server gnus-server-alist))
3502 ;; It could be in the predefined server alist.
3503 (cdr (assoc server gnus-predefined-server-alist))
3504 ;; If not, we look through all the opened server
3505 ;; to see whether we can find it there.
3506 (let ((opened gnus-opened-servers))
3507 (while (and opened
3508 (not (equal server (format "%s:%s" (caaar opened)
3509 (cadaar opened)))))
3510 (pop opened))
3511 (caar opened))
3512 ;; It could be a named method, search all servers
3513 (let ((servers gnus-secondary-select-methods))
3514 (while (and servers
3515 (not (equal server (format "%s:%s" (caar servers)
3516 (cadar servers)))))
3517 (pop servers))
3518 (car servers))
3519 ;; This could be some sort of foreign server that I
3520 ;; simply haven't opened (yet). Do a brute-force scan
3521 ;; of the entire gnus-newsrc-alist for the server name
3522 ;; of every method. As a side-effect, loads the
3523 ;; gnus-server-method-cache so this only happens once,
3524 ;; if at all.
3525 (let ((alist (cdr gnus-newsrc-alist))
3526 method match)
3527 (while alist
3528 (setq method (gnus-info-method (pop alist)))
3529 (when (and (not (stringp method))
3530 (equal server
3531 (gnus-method-to-server method nil t)))
3532 (setq match method
3533 alist nil)))
3534 match))))
3535 (when (and result
3536 (not (assoc server gnus-server-method-cache)))
3537 (push (cons server result) gnus-server-method-cache))
3538 result)))
3540 (defsubst gnus-server-get-method (group method)
3541 ;; Input either a server name, and extended server name, or a
3542 ;; select method, and return a select method.
3543 (cond ((stringp method)
3544 (gnus-server-to-method method))
3545 ((equal method gnus-select-method)
3546 gnus-select-method)
3547 ((and (stringp (car method))
3548 group)
3549 (gnus-server-extend-method group method))
3550 ((and method
3551 (not group)
3552 (equal (cadr method) ""))
3553 method)
3554 (t
3555 (gnus-server-add-address method))))
3557 (defmacro gnus-method-equal (ss1 ss2)
3558 "Say whether two servers are equal."
3559 `(let ((s1 ,ss1)
3560 (s2 ,ss2))
3561 (or (equal s1 s2)
3562 (and (= (length s1) (length s2))
3563 (progn
3564 (while (and s1 (member (car s1) s2))
3565 (setq s1 (cdr s1)))
3566 (null s1))))))
3568 (defun gnus-methods-equal-p (m1 m2)
3569 (let ((m1 (or m1 gnus-select-method))
3570 (m2 (or m2 gnus-select-method)))
3571 (or (equal m1 m2)
3572 (and (eq (car m1) (car m2))
3573 (or (not (memq 'address (assoc (symbol-name (car m1))
3574 gnus-valid-select-methods)))
3575 (equal (nth 1 m1) (nth 1 m2)))))))
3577 (defun gnus-methods-sloppily-equal (m1 m2)
3578 ;; Same method.
3579 (or
3580 (eq m1 m2)
3581 ;; Type and name are equal.
3582 (and
3583 (eq (car m1) (car m2))
3584 (equal (cadr m1) (cadr m2))
3585 (gnus-sloppily-equal-method-parameters m1 m2))))
3587 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3588 ;; Check parameters for sloppy equalness.
3589 (let ((p1 (copy-sequence (cddr m1)))
3590 (p2 (copy-sequence (cddr m2)))
3591 e1 e2)
3592 (block nil
3593 (while (setq e1 (pop p1))
3594 (unless (setq e2 (assq (car e1) p2))
3595 ;; The parameter doesn't exist in p2.
3596 (return nil))
3597 (setq p2 (delq e2 p2))
3598 (unless (equal e1 e2)
3599 (if (not (and (stringp (cadr e1))
3600 (stringp (cadr e2))))
3601 (return nil)
3602 ;; Special-case string parameter comparison so that we
3603 ;; can uniquify them.
3604 (let ((s1 (cadr e1))
3605 (s2 (cadr e2)))
3606 (when (string-match "/$" s1)
3607 (setq s1 (directory-file-name s1)))
3608 (when (string-match "/$" s2)
3609 (setq s2 (directory-file-name s2)))
3610 (unless (equal s1 s2)
3611 (return nil))))))
3612 ;; If p2 now is empty, they were equal.
3613 (null p2))))
3615 (defun gnus-server-equal (m1 m2)
3616 "Say whether two methods are equal."
3617 (let ((m1 (cond ((null m1) gnus-select-method)
3618 ((stringp m1) (gnus-server-to-method m1))
3619 (t m1)))
3620 (m2 (cond ((null m2) gnus-select-method)
3621 ((stringp m2) (gnus-server-to-method m2))
3622 (t m2))))
3623 (gnus-method-equal m1 m2)))
3625 (defun gnus-servers-using-backend (backend)
3626 "Return a list of known servers using BACKEND."
3627 (let ((opened gnus-opened-servers)
3628 out)
3629 (while opened
3630 (when (eq backend (caaar opened))
3631 (push (caar opened) out))
3632 (pop opened))
3633 out))
3635 (defun gnus-archive-server-wanted-p ()
3636 "Say whether the user wants to use the archive server."
3637 (cond
3638 ((or (not gnus-message-archive-method)
3639 (not gnus-message-archive-group))
3640 nil)
3641 ((and gnus-message-archive-method gnus-message-archive-group)
3642 t)
3643 (t
3644 (let ((active (cadr (assq 'nnfolder-active-file
3645 gnus-message-archive-method))))
3646 (and active
3647 (file-exists-p active))))))
3649 (defsubst gnus-method-to-server-name (method)
3650 (concat
3651 (format "%s" (car method))
3652 (when (and
3653 (or (assoc (format "%s" (car method))
3654 (gnus-methods-using 'address))
3655 (gnus-server-equal method gnus-message-archive-method))
3656 (nth 1 method)
3657 (not (string= (nth 1 method) "")))
3658 (concat "+" (nth 1 method)))))
3660 (defsubst gnus-method-to-full-server-name (method)
3661 (format "%s+%s" (car method) (nth 1 method)))
3663 (defun gnus-group-prefixed-name (group method &optional full)
3664 "Return the whole name from GROUP and METHOD.
3665 Call with full set to get the fully qualified group name (even if the
3666 server is native)."
3667 (when (stringp method)
3668 (setq method (gnus-server-to-method method)))
3669 (if (or (not method)
3670 (and (not full) (gnus-server-equal method "native"))
3671 ;;;!!! This might not be right. We'll see...
3672 ;(string-match ":" group)
3673 )
3674 group
3675 (concat (gnus-method-to-server-name method) ":" group)))
3677 (defun gnus-group-guess-prefixed-name (group)
3678 "Guess the whole name from GROUP and METHOD."
3679 (gnus-group-prefixed-name group (gnus-find-method-for-group
3680 group)))
3682 (defun gnus-group-full-name (group method)
3683 "Return the full name from GROUP and METHOD, even if the method is native."
3684 (gnus-group-prefixed-name group method t))
3686 (defun gnus-group-guess-full-name (group)
3687 "Guess the full name from GROUP, even if the method is native."
3688 (if (gnus-group-prefixed-p group)
3689 group
3690 (gnus-group-full-name group (gnus-find-method-for-group group))))
3692 (defun gnus-group-guess-full-name-from-command-method (group)
3693 "Guess the full name from GROUP, even if the method is native."
3694 (if (gnus-group-prefixed-p group)
3695 group
3696 (gnus-group-full-name group gnus-command-method)))
3698 (defun gnus-group-real-prefix (group)
3699 "Return the prefix of the current group name."
3700 (if (stringp group)
3701 (if (string-match "^[^:]+:" group)
3702 (substring group 0 (match-end 0))
3703 "")
3704 nil))
3706 (defun gnus-group-short-name (group)
3707 "Return the short group name."
3708 (let ((prefix (gnus-group-real-prefix group)))
3709 (if (< 0 (length prefix))
3710 (substring group (length prefix) nil)
3711 group)))
3713 (defun gnus-group-prefixed-p (group)
3714 "Return the prefix of the current group name."
3715 (< 0 (length (gnus-group-real-prefix group))))
3717 (declare-function gnus-group-decoded-name "gnus-group" (string))
3719 (defun gnus-summary-buffer-name (group)
3720 "Return the summary buffer name of GROUP."
3721 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3723 (defun gnus-group-method (group)
3724 "Return the server or method used for selecting GROUP.
3725 You should probably use `gnus-find-method-for-group' instead."
3726 (let ((prefix (gnus-group-real-prefix group)))
3727 (if (equal prefix "")
3728 gnus-select-method
3729 (let ((servers gnus-opened-servers)
3730 (server "")
3731 backend possible found)
3733 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3734 server (substring prefix (match-end 0) (1- (length prefix))))
3735 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3736 (while servers
3737 (when (eq (caaar servers) backend)
3738 (setq possible (caar servers))
3739 (when (equal (cadaar servers) server)
3740 (setq found (caar servers))))
3741 (pop servers))
3742 (or (car (rassoc found gnus-server-alist))
3743 found
3744 (car (rassoc possible gnus-server-alist))
3745 possible
3746 (list backend server))))))
3748 (defsubst gnus-native-method-p (method)
3749 "Return whether METHOD is the native select method."
3750 (gnus-method-equal method gnus-select-method))
3752 (defsubst gnus-secondary-method-p (method)
3753 "Return whether METHOD is a secondary select method."
3754 (let ((methods gnus-secondary-select-methods)
3755 (gmethod (inline (gnus-server-get-method nil method))))
3756 (while (and methods
3757 (not (gnus-method-equal
3758 (inline (gnus-server-get-method nil (car methods)))
3759 gmethod)))
3760 (setq methods (cdr methods)))
3761 methods))
3763 (defun gnus-method-simplify (method)
3764 "Return the shortest uniquely identifying string or method for METHOD."
3765 (cond ((stringp method)
3766 method)
3767 ((gnus-native-method-p method)
3768 nil)
3769 ((gnus-secondary-method-p method)
3770 (format "%s:%s" (nth 0 method) (nth 1 method)))
3771 (t
3772 method)))
3774 (defun gnus-groups-from-server (server)
3775 "Return a list of all groups that are fetched from SERVER."
3776 (let ((alist (cdr gnus-newsrc-alist))
3777 info groups)
3778 (while (setq info (pop alist))
3779 (when (gnus-server-equal (gnus-info-method info) server)
3780 (push (gnus-info-group info) groups)))
3781 (sort groups 'string<)))
3783 (defun gnus-group-foreign-p (group)
3784 "Say whether a group is foreign or not."
3785 (and (not (gnus-group-native-p group))
3786 (not (gnus-group-secondary-p group))))
3788 (defun gnus-group-native-p (group)
3789 "Say whether the group is native or not."
3790 (not (string-match ":" group)))
3792 (defun gnus-group-secondary-p (group)
3793 "Say whether the group is secondary or not."
3794 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3796 (defun gnus-parameters-get-parameter (group)
3797 "Return the group parameters for GROUP from `gnus-parameters'."
3798 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3799 case-fold-search
3800 gnus-parameters-case-fold-search))
3801 params-list)
3802 (dolist (elem gnus-parameters)
3803 (when (string-match (car elem) group)
3804 (setq params-list
3805 (nconc (gnus-expand-group-parameters
3806 (car elem) (cdr elem) group)
3807 params-list))))
3808 params-list))
3810 (defun gnus-expand-group-parameter (match value group)
3811 "Use MATCH to expand VALUE in GROUP."
3812 (let ((start (string-match match group)))
3813 (if start
3814 (let ((matched-string (substring group start (match-end 0))))
3815 ;; Build match groups
3816 (string-match match matched-string)
3817 (replace-match value nil nil matched-string))
3818 group)))
3820 (defun gnus-expand-group-parameters (match parameters group)
3821 "Go through PARAMETERS and expand them according to the match data."
3822 (let (new)
3823 (dolist (elem parameters)
3824 (if (and (stringp (cdr elem))
3826 (push (cons (car elem)
3827 (gnus-expand-group-parameter match (cdr elem) group))
3828 new)
3829 (push elem new)))
3830 new))
3832 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3833 "For GROUP, return the value of SYMBOL.
3835 You should call this in the `gnus-group-buffer' buffer.
3836 The function `gnus-group-find-parameter' will do that for you."
3837 ;; The speed trick: No cons'ing and quit early.
3838 (let* ((params (funcall gnus-group-get-parameter-function group))
3839 ;; Start easy, check the "real" group parameters.
3840 (simple-results
3841 (gnus-group-parameter-value params symbol allow-list t)))
3842 (if simple-results
3843 ;; Found results; return them.
3844 (car simple-results)
3845 ;; We didn't find it there, try `gnus-parameters'.
3846 (let ((result nil)
3847 (head nil)
3848 (tail gnus-parameters))
3849 ;; A good old-fashioned non-cl loop.
3850 (while tail
3851 (setq head (car tail)
3852 tail (cdr tail))
3853 ;; The car is regexp matching for matching the group name.
3854 (when (string-match (car head) group)
3855 ;; The cdr is the parameters.
3856 (setq result (gnus-group-parameter-value (cdr head)
3857 symbol allow-list))
3858 (when result
3859 ;; Expand if necessary.
3861 (setq result (gnus-expand-group-parameter (car head)
3862 result group))))))
3863 ;; Done.
3864 result))))
3866 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3867 "Return the group parameters for GROUP.
3868 If SYMBOL, return the value of that symbol in the group parameters.
3870 If you call this function inside a loop, consider using the faster
3871 `gnus-group-fast-parameter' instead."
3872 (with-current-buffer gnus-group-buffer
3873 (if symbol
3874 (gnus-group-fast-parameter group symbol allow-list)
3875 (nconc
3876 (copy-sequence
3877 (funcall gnus-group-get-parameter-function group))
3878 (gnus-parameters-get-parameter group)))))
3880 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3881 "Return the group parameters for GROUP.
3882 If SYMBOL, return the value of that symbol in the group parameters.
3883 If ALLOW-LIST, also allow list as a result.
3884 Most functions should use `gnus-group-find-parameter', which
3885 also examines the topic parameters."
3886 (let ((params (gnus-info-params (gnus-get-info group))))
3887 (if symbol
3888 (gnus-group-parameter-value params symbol allow-list)
3889 params)))
3891 (defun gnus-group-parameter-value (params symbol &optional
3892 allow-list present-p)
3893 "Return the value of SYMBOL in group PARAMS.
3894 If ALLOW-LIST, also allow list as a result."
3895 ;; We only wish to return group parameters (dotted lists) and
3896 ;; not local variables, which may have the same names.
3897 ;; But first we handle single elements...
3898 (or (car (memq symbol params))
3899 ;; Handle alist.
3900 (let (elem)
3901 (catch 'found
3902 (while (setq elem (pop params))
3903 (when (and (consp elem)
3904 (eq (car elem) symbol)
3905 (or allow-list
3906 (atom (cdr elem))))
3907 (throw 'found (if present-p (list (cdr elem))
3908 (cdr elem)))))))))
3910 (defun gnus-group-add-parameter (group param)
3911 "Add parameter PARAM to GROUP."
3912 (let ((info (gnus-get-info group)))
3913 (when info
3914 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3915 ;; Cons the new param to the old one and update.
3916 (gnus-group-set-info (cons param (gnus-info-params info))
3917 group 'params))))
3919 (defun gnus-group-set-parameter (group name value)
3920 "Set parameter NAME to VALUE in GROUP.
3921 GROUP can also be an INFO structure."
3922 (let ((info (if (listp group)
3923 group
3924 (gnus-get-info group))))
3925 (when info
3926 (gnus-group-remove-parameter group name)
3927 (let ((old-params (gnus-info-params info))
3928 (new-params (list (cons name value))))
3929 (while old-params
3930 (when (or (not (listp (car old-params)))
3931 (not (eq (caar old-params) name)))
3932 (setq new-params (append new-params (list (car old-params)))))
3933 (setq old-params (cdr old-params)))
3934 (if (listp group)
3935 (gnus-info-set-params info new-params t)
3936 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3938 (defun gnus-group-remove-parameter (group name)
3939 "Remove parameter NAME from GROUP.
3940 GROUP can also be an INFO structure."
3941 (let ((info (if (listp group)
3942 group
3943 (gnus-get-info group))))
3944 (when info
3945 (let ((params (gnus-info-params info)))
3946 (when params
3947 (setq params (delq name params))
3948 (while (assq name params)
3949 (gnus-alist-pull name params))
3950 (gnus-info-set-params info params))))))
3952 (defun gnus-group-add-score (group &optional score)
3953 "Add SCORE to the GROUP score.
3954 If SCORE is nil, add 1 to the score of GROUP."
3955 (let ((info (gnus-get-info group)))
3956 (when info
3957 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3959 (defun gnus-short-group-name (group &optional levels)
3960 "Collapse GROUP name LEVELS.
3961 Select methods are stripped and any remote host name is stripped down to
3962 just the host name."
3963 (let* ((name "")
3964 (foreign "")
3965 (depth 0)
3966 (skip 1)
3967 (levels (or levels
3968 gnus-group-uncollapsed-levels
3969 (progn
3971 (setq skip (match-end 0)
3972 depth (+ depth 1)))
3973 depth))))
3974 ;; Separate foreign select method from group name and collapse.
3975 ;; If method contains a server, collapse to non-domain server name,
3976 ;; otherwise collapse to select method.
3977 (let* ((colon (string-match ":" group))
3978 (server (and colon (substring group 0 colon)))
3979 (plus (and server (string-match "+" server))))
3980 (when server
3981 (if plus
3982 (setq foreign (substring server (+ 1 plus)
3984 group (substring group (+ 1 colon)))
3985 (setq foreign server
3986 group (substring group (+ 1 colon))))
3987 (setq foreign (concat foreign ":")))
3988 ;; Collapse group name leaving LEVELS uncollapsed elements
3989 (let* ((slist (split-string group "/"))
3990 (slen (length slist))
3992 (dlen (length dlist))
3993 glist
3994 glen
3995 gsep
3996 res)
3997 (if (> slen dlen)
3998 (setq glist slist
3999 glen slen
4000 gsep "/")
4001 (setq glist dlist
4002 glen dlen
4003 gsep "."))
4004 (setq levels (- glen levels))
4005 (dolist (g glist)
4006 (push (if (>= (decf levels) 0)
4007 (if (zerop (length g))
4008 ""
4009 (substring g 0 1))
4010 g)
4011 res))
4012 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4014 (defun gnus-narrow-to-body ()
4015 "Narrow to the body of an article."
4016 (narrow-to-region
4017 (progn
4018 (goto-char (point-min))
4020 (point-max)))
4021 (point-max)))
4023 \f
4024 ;;;
4025 ;;; Kill file handling.
4026 ;;;
4028 (defun gnus-apply-kill-file ()
4029 "Apply a kill file to the current newsgroup.
4030 Returns the number of articles marked as read."
4031 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4032 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4033 (gnus-apply-kill-file-internal)
4034 0))
4036 (defun gnus-kill-save-kill-buffer ()
4037 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4038 (when (get-file-buffer file)
4039 (with-current-buffer (get-file-buffer file)
4040 (when (buffer-modified-p)
4041 (save-buffer))
4042 (kill-buffer (current-buffer))))))
4044 (defcustom gnus-kill-file-name "KILL"
4045 "Suffix of the kill files."
4046 :group 'gnus-score-kill
4047 :group 'gnus-score-files
4048 :type 'string)
4050 (defun gnus-newsgroup-kill-file (newsgroup)
4051 "Return the name of a kill file name for NEWSGROUP.
4052 If NEWSGROUP is nil, return the global kill file name instead."
4053 (cond
4054 ;; The global KILL file is placed at top of the directory.
4055 ((or (null newsgroup)
4056 (string-equal newsgroup ""))
4057 (expand-file-name gnus-kill-file-name
4058 gnus-kill-files-directory))
4059 ;; Append ".KILL" to newsgroup name.
4060 ((gnus-use-long-file-name 'not-kill)
4061 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4062 "." gnus-kill-file-name)
4063 gnus-kill-files-directory))
4064 ;; Place "KILL" under the hierarchical directory.
4065 (t
4066 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4067 "/" gnus-kill-file-name)
4068 gnus-kill-files-directory))))
4070 ;;; Server things.
4072 (defun gnus-member-of-valid (symbol group)
4074 (memq symbol (assoc
4075 (symbol-name (car (gnus-find-method-for-group group)))
4076 gnus-valid-select-methods)))
4078 (defun gnus-method-option-p (method option)
4079 "Return non-nil if select METHOD has OPTION as a parameter."
4080 (when (stringp method)
4081 (setq method (gnus-server-to-method method)))
4082 (memq option (assoc (format "%s" (car method))
4083 gnus-valid-select-methods)))
4085 (defun gnus-similar-server-opened (method)
4086 "Return non-nil if we have a similar server opened.
4087 This is defined as a server with the same name, but different
4088 parameters."
4089 (let ((opened gnus-opened-servers)
4090 open)
4091 (while (and method opened)
4092 (setq open (car (pop opened)))
4093 ;; Type and name are the same...
4094 (when (and (equal (car method) (car open))
4095 (equal (cadr method) (cadr open))
4096 ;; ... but the rest of the parameters differ.
4097 (not (gnus-methods-sloppily-equal method open)))
4098 (setq method nil)))
4099 (not method)))
4101 (defun gnus-server-extend-method (group method)
4102 ;; This function "extends" a virtual server. If the server is
4103 ;; "hello", and the select method is ("hello" (my-var "something"))
4104 ;; in the group "alt.alt", this will result in a new virtual server
4105 ;; called "hello+alt.alt".
4106 (if (or (not (inline (gnus-similar-server-opened method)))
4107 (not (cddr method)))
4108 method
4109 (setq method
4110 `(,(car method) ,(concat (cadr method) "+" group)
4111 (,(intern (format "%s-address" (car method))) ,(cadr method))
4112 ,@(cddr method)))
4113 (push method gnus-extended-servers)
4114 method))
4116 (defun gnus-server-status (method)
4117 "Return the status of METHOD."
4118 (nth 1 (assoc method gnus-opened-servers)))
4120 (defun gnus-group-name-to-method (group)
4121 "Guess a select method based on GROUP."
4122 (if (string-match ":" group)
4123 (let ((server (substring group 0 (match-beginning 0))))
4125 (list (intern (substring server 0 (match-beginning 0)))
4126 (substring server (match-end 0)))
4127 (list (intern server) "")))
4128 gnus-select-method))
4130 (defun gnus-server-string (server)
4131 "Return a readable string that describes SERVER."
4132 (let* ((server (gnus-server-to-method server))
4133 (address (nth 1 server)))
4134 (if (and address
4135 (not (zerop (length address))))
4136 (format "%s using %s" address (car server))
4137 (format "%s" (car server)))))
4139 (defun gnus-same-method-different-name (method)
4140 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4141 (unless (assq slot (cddr method))
4142 (setq method
4143 (append method (list (list slot (nth 1 method)))))))
4144 (let ((methods gnus-extended-servers)
4145 open found)
4146 (while (and (not found)
4147 (setq open (pop methods)))
4148 (when (and (eq (car method) (car open))
4149 (gnus-sloppily-equal-method-parameters method open))
4150 (setq found open)))
4151 found))
4153 (defun gnus-find-method-for-group (group &optional info)
4154 "Find the select method that GROUP uses."
4155 (or gnus-override-method
4156 (and (not group)
4157 gnus-select-method)
4158 (and (not (gnus-group-entry group))
4159 ;; Killed or otherwise unknown group.
4160 (or
4161 ;; If we know a virtual server by that name, return its method.
4162 (gnus-server-to-method (gnus-group-server group))
4163 ;; Guess a new method as last resort.
4164 (gnus-group-name-to-method group)))
4165 (let ((info (or info (gnus-get-info group)))
4166 method)
4167 (if (or (not info)
4168 (not (setq method (gnus-info-method info)))
4169 (equal method "native"))
4170 gnus-select-method
4171 (setq method
4172 (cond ((stringp method)
4173 (inline (gnus-server-to-method method)))
4174 ((stringp (cadr method))
4175 (or
4176 (inline
4177 (gnus-same-method-different-name method))
4178 (inline (gnus-server-extend-method group method))))
4179 (t
4180 method)))
4181 (cond ((equal (cadr method) "")
4182 method)
4183 ((null (cadr method))
4184 (list (car method) ""))
4185 (t
4186 (gnus-server-add-address method)))))))
4188 (defun gnus-methods-using (feature)
4189 "Find all methods that have FEATURE."
4190 (let ((valids gnus-valid-select-methods)
4191 outs)
4192 (while valids
4193 (when (memq feature (car valids))
4194 (push (car valids) outs))
4195 (setq valids (cdr valids)))
4196 outs))
4198 (eval-and-compile
4199 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4201 (defun gnus-read-group (prompt &optional default)
4202 "Prompt the user for a group name.
4203 Disallow invalid group names."
4204 (let ((prefix "")
4205 group)
4206 (while (not group)
4207 (when (string-match
4208 gnus-invalid-group-regexp
4209 (setq group (read-string (concat prefix prompt)
4210 (cons (or default "") 0)
4211 'gnus-group-history)))
4212 (let ((match (match-string 0 group)))
4213 ;; Might be okay (e.g. for nnimap), so ask the user:
4215 (message-y-or-n-p
4216 "Proceed and create group anyway? " t
4219 Usually, it's dangerous to create a group with this name, because it's not
4220 supported by all back ends and servers. On IMAP servers it should work,
4221 though. If you are really sure, you can proceed anyway and create the group.
4223 You may customize the variable `gnus-invalid-group-regexp', which currently is
4227 group nil)))))
4228 group))
4230 (defun gnus-read-method (prompt)
4231 "Prompt the user for a method.
4232 Allow completion over sensible values."
4233 (let* ((open-servers
4234 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4235 gnus-opened-servers))
4236 (valid-methods
4237 (let (methods)
4238 (dolist (method gnus-valid-select-methods)
4239 (if (or (memq 'prompt-address method)
4240 (not (assoc (format "%s:" (car method)) open-servers)))
4241 (push method methods)))
4242 methods))
4243 (servers
4244 (append valid-methods
4245 open-servers
4246 gnus-predefined-server-alist
4247 gnus-server-alist))
4248 (method
4249 (gnus-completing-read
4250 prompt (mapcar 'car servers)
4251 t nil 'gnus-method-history)))
4252 (cond
4253 ((equal method "")
4254 (setq method gnus-select-method))
4255 ((assoc method gnus-valid-select-methods)
4256 (let ((address (if (memq 'prompt-address
4257 (assoc method gnus-valid-select-methods))
4258 (read-string "Address: ")
4259 "")))
4260 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4261 (list (intern method) address))))
4262 ((assoc method servers)
4263 method)
4264 (t
4265 (list (intern method) "")))))
4267 ;;; Agent functions
4269 (defun gnus-agent-method-p (method-or-server)
4270 "Say whether METHOD is covered by the agent."
4271 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4272 (let* ((method (if (stringp method-or-server)
4273 (gnus-server-to-method method-or-server)
4274 method-or-server))
4275 (server (gnus-method-to-server method t)))
4276 (setq gnus-agent-method-p-cache
4277 (cons method-or-server
4278 (member server gnus-agent-covered-methods)))))
4279 (cdr gnus-agent-method-p-cache))
4281 (defun gnus-online (method)
4282 (not
4283 (if gnus-plugged
4284 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4285 (gnus-agent-method-p method))))
4287 ;;; User-level commands.
4289 ;;;###autoload
4290 (defun gnus-slave-no-server (&optional arg)
4291 "Read network news as a slave, without connecting to the local server."
4292 (interactive "P")
4293 (gnus-no-server arg t))
4295 ;;;###autoload
4296 (defun gnus-no-server (&optional arg slave)
4297 "Read network news.
4298 If ARG is a positive number, Gnus will use that as the startup
4299 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4300 non-nil and not a positive number, Gnus will prompt the user for the
4301 name of an NNTP server to use.
4302 As opposed to `gnus', this command will not connect to the local
4303 server."
4304 (interactive "P")
4305 (gnus-no-server-1 arg slave))
4307 ;;;###autoload
4308 (defun gnus-slave (&optional arg)
4309 "Read news as a slave."
4310 (interactive "P")
4311 (gnus arg nil 'slave))
4313 ;;;###autoload
4314 (defun gnus-other-frame (&optional arg display)
4315 "Pop up a frame to read news.
4316 This will call one of the Gnus commands which is specified by the user
4317 option `gnus-other-frame-function' (default `gnus') with the argument
4318 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4319 optional second argument DISPLAY should be a standard display string
4321 omitted or the function `make-frame-on-display' is not available, the
4322 current display is used."
4323 (interactive "P")
4324 (if (fboundp 'make-frame-on-display)
4325 (unless display
4326 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4327 (setq display nil))
4328 (let ((alive (gnus-alive-p)))
4329 (unless (and alive
4330 (catch 'found
4331 (walk-windows
4332 (lambda (window)
4333 (when (and (or (not display)
4334 (equal display
4335 (gnus-frame-or-window-display-name
4336 window)))
4337 (with-current-buffer (window-buffer window)
4339 (symbol-name major-mode))))
4340 (gnus-select-frame-set-input-focus
4341 (setq gnus-other-frame-object (window-frame window)))
4342 (select-window window)
4343 (throw 'found t)))
4344 'ignore t)))
4345 (gnus-select-frame-set-input-focus
4346 (setq gnus-other-frame-object
4347 (if display
4348 (make-frame-on-display display gnus-other-frame-parameters)
4349 (make-frame gnus-other-frame-parameters))))
4350 (if alive
4351 (switch-to-buffer gnus-group-buffer)
4352 (funcall gnus-other-frame-function arg)
4353 (add-hook 'gnus-exit-gnus-hook
4354 '(lambda nil
4355 (when (and (frame-live-p gnus-other-frame-object)
4356 (cdr (frame-list)))
4357 (delete-frame gnus-other-frame-object))
4358 (setq gnus-other-frame-object nil)))))))
4360 ;;;###autoload
4361 (defun gnus (&optional arg dont-connect slave)
4362 "Read network news.
4363 If ARG is non-nil and a positive number, Gnus will use that as the
4364 startup level. If ARG is non-nil and not a positive number, Gnus will
4365 prompt the user for the name of an NNTP server to use."
4366 (interactive "P")
4367 ;; When using the development version of Gnus, load the gnus-load
4368 ;; file.
4369 (unless (string-match "^Gnus" gnus-version)
4370 (load "gnus-load" nil t))
4371 (unless (byte-code-function-p (symbol-function 'gnus))
4372 (message "You should byte-compile Gnus")
4373 (sit-for 2))
4374 (let ((gnus-action-message-log (list nil)))
4375 (gnus-1 arg dont-connect slave)
4376 (gnus-final-warning)))
4378 ;; Allow redefinition of Gnus functions.
4380 (gnus-ems-redefine)
4382 (provide 'gnus)
4384 ;;; gnus.el ends here