| blob | 6abe728cd86d8cd95edf83e6e33d3c5a87c6fd44 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987-1990, 1993-1998, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;;; Code:
31 ;; For Emacs <22.2 and XEmacs.
40 ;; These are defined afterwards with gnus-define-group-parameter
54 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
59 "Starting your favorite newsreader."
63 "Dealing with formatting issues."
67 "Group character set issues."
73 "Cache interface."
78 "Article Registry."
82 "Server options at startup."
85 ;; These belong to gnus-group.el.
87 "Group buffers."
92 "Foreign groups."
97 "Automatic subscription of new groups."
101 "Group levels."
106 "Selecting a Group."
111 "Showing slices of the group list."
116 "Sorting the group buffer."
122 "Various group options."
126 ;; These belong to gnus-sum.el.
128 "Summary buffers."
133 "Leaving summary buffers."
138 "Marks used in summary buffers."
143 "Ordering articles according to replies."
148 "Formatting of the summary buffer."
153 "Choosing Articles."
158 "Summary movement commands."
163 "Show pictures of people, domains, and newsgroups."
167 "Mail group commands."
172 "Sorting the summary buffer."
177 "Highlighting and menus in the summary buffer."
183 "Various summary buffer options."
188 "Pick mode in the summary buffer."
194 "Tree display of threads in the summary buffer."
199 ;; Belongs to gnus-uu.el
201 "Viewing extracted files."
205 ;; Belongs to gnus-score.el
207 "Score and kill file handling."
211 "Kill files."
215 "Adaptive score files."
219 "Default values for score files."
223 "Expiring score rules."
227 "Decaying score rules."
231 "Score and kill file names."
236 "Various scoring and killing options."
239 ;; Other
241 "Options controlling the visual fluff."
246 "Offline support for Gnus."
250 "Files used by Gnus."
254 "Auto save file."
259 "Storing Gnus state."
263 "Options related to newsservers and other servers used by Gnus."
267 "Highlighting and menus in the server buffer."
272 "Composing replies and followups in Gnus."
276 "Meta variables controlling major portions of Gnus.
277 In general, modifying these variables does not take effect until Gnus
278 is restarted, and sometimes reloaded."
282 "Other Gnus options."
287 "Exiting Gnus."
292 "Frivolous Gnus extensions."
303 "If non-nil, the startup message will not be displayed.
304 This variable is used before `.gnus.el' is loaded, so it should
305 be set in `.emacs' instead."
334 0 5
343 gnus-mode-line-image-cache)
345 "This is %s, %s."
347 str)
349 line)))
354 ;;(defalias 'gnus-decode-rfc1522 'ignore)
355 )
357 ;; We define these group faces here to avoid the display
358 ;; update forced when creating new faces.
368 ()))
369 "Level 1 newsgroup face."
371 ;; backward-compatibility alias
383 ()))
384 "Level 1 empty newsgroup face."
386 ;; backward-compatibility alias
398 ()))
399 "Level 2 newsgroup face."
401 ;; backward-compatibility alias
413 ()))
414 "Level 2 empty newsgroup face."
416 ;; backward-compatibility alias
428 ()))
429 "Level 3 newsgroup face."
431 ;; backward-compatibility alias
438 ())
441 ())
443 ()))
444 "Level 3 empty newsgroup face."
446 ;; backward-compatibility alias
458 ()))
459 "Level 4 newsgroup face."
461 ;; backward-compatibility alias
468 ())
471 ())
473 ()))
474 "Level 4 empty newsgroup face."
476 ;; backward-compatibility alias
488 ()))
489 "Level 5 newsgroup face."
491 ;; backward-compatibility alias
498 ())
501 ())
503 ()))
504 "Level 5 empty newsgroup face."
506 ;; backward-compatibility alias
518 ()))
519 "Level 6 newsgroup face."
521 ;; backward-compatibility alias
528 ())
531 ())
533 ()))
534 "Level 6 empty newsgroup face."
536 ;; backward-compatibility alias
548 ()))
549 "Low level newsgroup face."
551 ;; backward-compatibility alias
563 ()))
564 "Low level empty newsgroup face."
566 ;; backward-compatibility alias
579 "Level 1 mailgroup face."
581 ;; backward-compatibility alias
594 "Level 1 empty mailgroup face."
596 ;; backward-compatibility alias
609 "Level 2 mailgroup face."
611 ;; backward-compatibility alias
624 "Level 2 empty mailgroup face."
626 ;; backward-compatibility alias
639 "Level 3 mailgroup face."
641 ;; backward-compatibility alias
653 ()))
654 "Level 3 empty mailgroup face."
656 ;; backward-compatibility alias
669 "Low level mailgroup face."
671 ;; backward-compatibility alias
684 "Low level empty mailgroup face."
686 ;; backward-compatibility alias
690 ;; Summary mode faces.
693 "Face used for selected articles."
695 ;; backward-compatibility alias
702 "Face used for cancelled articles."
704 ;; backward-compatibility alias
717 "Face used for high interest ticked articles."
719 ;; backward-compatibility alias
732 "Face used for low interest ticked articles."
734 ;; backward-compatibility alias
746 ()))
747 "Face used for normal interest ticked articles."
749 ;; backward-compatibility alias
762 "Face used for high interest ancient articles."
764 ;; backward-compatibility alias
777 "Face used for low interest ancient articles."
779 ;; backward-compatibility alias
791 ()))
792 "Face used for normal interest ancient articles."
794 ;; backward-compatibility alias
805 "Face used for high interest uncached articles."
807 ;; backward-compatibility alias
818 "Face used for low interest uncached articles."
820 ;; backward-compatibility alias
831 "Face used for normal interest uncached articles."
833 ;; backward-compatibility alias
840 "Face used for high interest unread articles."
842 ;; backward-compatibility alias
849 "Face used for low interest unread articles."
851 ;; backward-compatibility alias
857 ()))
858 "Face used for normal interest unread articles."
860 ;; backward-compatibility alias
875 "Face used for high interest read articles."
877 ;; backward-compatibility alias
892 "Face used for low interest read articles."
894 ;; backward-compatibility alias
906 ()))
907 "Face used for normal interest read articles."
909 ;; backward-compatibility alias
914 ;;;
915 ;;; Gnus buffers
916 ;;;
922 "Do the same as `get-buffer-create', but store the created buffer."
927 "Add the current buffer to the list of Gnus buffers."
931 "Kill BUFFER and remove from the list of Gnus buffers."
938 "Return a list of live Gnus buffers."
947 gnus-buffers)
949 ;;; Splash screen.
962 ()))
963 "Face for the splash screen."
965 ;; backward-compatibility alias
979 "Indent rigidly using only spaces and no tabs."
985 ;; We translate tabs into spaces -- not everybody uses
986 ;; an 8-character tab.
991 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1015 "*Color styles used for the Gnus logo."
1017 gnus-logo-color-alist))
1027 "Insert startup message in current buffer."
1028 ;; Insert the message.
1033 ;; Make sure the library defining `image-load-path' is
1034 ;; loaded (`find-image' is autoloaded) (and discard the
1035 ;; result). Else, we may get "defvar ignored because
1036 ;; image-load-path is let-bound" when calling `find-image'
1037 ;; below.
1047 :color-symbols
1053 ;; Account for the pbm's background.
1057 ;; 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'.
1260 "A file with only the name of the nntp server in it."
1266 "Find default nntp server.
1267 Check the NNTPSERVER environment variable and the
1268 `gnus-nntpserver-file' file."
1276 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1277 ;; starting or even loading Gnus.
1278 ;;;###autoload(when (fboundp 'custom-autoload)
1279 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1285 gnus-default-nntp-server)
1287 "Default method for selecting a newsgroup.
1288 This variable should be a list, where the first element is how the
1289 news is to be fetched, the second is the address.
1292 NNTP, you could say:
1296 If you want to use your local spool, say:
1298 \(setq gnus-select-method (list 'nnspool (system-name)))
1300 If you use this variable, you must set `gnus-nntp-server' to nil.
1302 There is a lot more to know about select methods and virtual servers -
1303 see the manual for details."
1310 "*Method used for archiving messages you've sent.
1311 This should be a mail method.
1313 See also `gnus-update-message-archive-method'."
1317 gnus-select-method))
1322 The archive method is initially set according to the value of
1324 so that it may be used as a real method of the server which is named
1326 updated if the value of this variable is nil, even if you change the
1327 value of `gnus-message-archive-method' afterward. If you want the
1329 `gnus-message-archive-method', set this variable to a non-nil value."
1336 "*Name of the group in which to save the messages you've written.
1337 This can either be a string; a list of strings; or an alist
1338 of regexps/functions/forms to be evaluated to return a string (or a list
1339 of strings). The functions are called with the name of the current
1340 group (or nil) as a parameter.
1342 If you want to save your mail in one group and the news articles you
1343 write in another group, you could say something like:
1345 \(setq gnus-message-archive-group
1346 '((if (message-news-p)
1350 Normally the group names returned by this variable should be
1352 However, you may wish to store the message on some other server. In
1353 that case, just return a fully prefixed name of the group --
1361 function
1362 sexp
1363 string))
1366 "List of NNTP servers that the user can choose between interactively.
1367 To make Gnus query you for a server, you have to give `gnus' a
1368 non-numeric prefix - `C-u M-x gnus', in short."
1374 "The name of the host running the NNTP server."
1377 string))
1381 "A list of secondary methods that will be used for reading news.
1382 This is a list where each element is a complete select method (see
1383 `gnus-select-method').
1385 If, for instance, you want to read your mail with the nnml back end,
1386 you could set this variable:
1393 "Local domain name without a host name.
1394 The DOMAINNAME environment variable is used instead if it is defined.
1395 If the function `system-name' returns the full Internet name, there is
1396 no need to set this variable."
1399 string))
1402 ;; Customization variables
1405 "Preferred method for fetching an article by Message-ID.
1406 If you are reading news from the local spool (with nnspool), fetching
1407 articles by Message-ID is painfully slow. By setting this method to an
1408 nntp method, you might get acceptable results.
1410 The value of this variable must be a valid select method as discussed
1411 in the documentation of `gnus-select-method'.
1413 It can also be a list of select methods, as well as the special symbol
1414 `current', which means to use the current select method. If it is a
1415 list, Gnus will try all the methods in the list until it finds a match."
1421 gnus-select-method
1429 gnus-select-method))))
1432 "*Non-nil means that cross referenced articles will be marked as read.
1433 If nil, ignore cross references. If t, mark articles as read in
1434 subscribed newsgroups. If neither t nor nil, mark as read in all
1435 newsgroups."
1443 "*Process mark."
1449 "*The number of articles which indicates a large newsgroup.
1450 If the number of articles in a newsgroup is greater than this value,
1451 confirmation is required for selecting the newsgroup.
1452 If it is nil, no confirmation is required.
1454 Also see `gnus-large-ephemeral-newsgroup'."
1457 integer))
1460 "Non-nil means that the default name of a file to save articles in is the group name.
1461 If it's nil, the directory form of the group name is used instead.
1463 If this variable is a list, and the list contains the element
1464 `not-score', long file names will not be used for score files; if it
1465 contains the element `not-save', long file names will not be used for
1466 saving; and if it contains the element `not-kill', long file names
1467 will not be used for kill files.
1469 Note that the default for this variable varies according to what system
1470 type you're using. On `usg-unix-v' this variable defaults to nil while
1471 on all other systems it defaults to t."
1489 "*If non-nil, save group scoring info."
1495 "*If non-nil, allow undoing in Gnus group mode buffers."
1500 "*If non-nil, use some adaptive scoring scheme.
1501 If a list, then the values `word' and `line' are meaningful. The
1502 former will perform adaption on individual words in the subject
1503 header while `line' will perform adaption on several headers."
1509 "*If nil, Gnus will ignore the article cache.
1510 If `passive', it will allow entering (and reading) articles
1511 explicitly entered into the cache. If anything else, use the
1512 cache to the full extent of the law."
1520 "*If non-nil, display a thread tree buffer."
1525 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1526 If it is a number N, then Gnus will only keep the last N articles
1527 read. If it is neither nil nor a number, Gnus will keep all read
1528 articles. This is not a good idea."
1531 integer
1536 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1541 "*If non-nil, enable scoring."
1547 "*A hook called when preparing to exit from the summary buffer.
1548 It calls `gnus-summary-expire-articles' by default."
1553 "*Non-nil means that you are a Usenet novice.
1554 If non-nil, verbose messages may be displayed and confirmations may be
1555 required."
1560 "*Non-nil means that you will never be asked for confirmation about anything.
1561 That doesn't mean *anything* anything; particularly destructive
1562 commands will still require prompting."
1567 "*If non-nil, require your confirmation when catching up a group."
1572 "*If non-nil, require your confirmation when exiting Gnus."
1577 "*Function for extracting address components from a From header.
1578 Two pre-defined function exist: `gnus-extract-address-components',
1579 which is the default, quite fast, and too simplistic solution, and
1580 `mail-extract-address-components', which works much better, but is
1581 slower."
1588 "String used to separate shell commands."
1610 server-marks)
1613 "*An alist of valid select methods.
1614 The first element of each list lists should be a string with the name
1615 of the select method. The other elements may be the category of
1616 this method (i. e., `post', `mail', `none' or whatever) or other
1617 properties that this method has (like being respoolable).
1618 If you implement a new select method, all you should have to change is
1619 this variable. I think."
1635 "Recomputes the select-method widget based on the value of
1636 `gnus-valid-select-methods'."
1638 "Widget for entering a select method."
1645 gnus-valid-select-methods)
1649 :inline t
1651 variable
1657 "List of buffers that should update their mode lines.
1658 The list may contain the symbols `group', `article', `tree' and
1659 `summary'. If the corresponding symbol is present, Gnus will keep
1660 that mode line updated with information that may be pertinent.
1661 If this variable is nil, screen refresh may be quicker."
1669 "*Max length of mode-line non-string contents.
1670 If this is nil, Gnus will take space as is needed, leaving the rest
1671 of the mode line intact."
1675 integer))
1677 ;; There should be special validation for this.
1682 to-address
1683 :function-document
1684 "Return GROUP's to-address."
1685 :variable-document
1686 "*Alist of group regexps and correspondent to-addresses."
1687 :variable-group gnus-group-parameter
1690 This will be used when doing followups and posts.
1692 This is primarily useful in mail groups that represent closed
1693 mailing lists--mailing lists where it's expected that everybody that
1694 writes to the mailing list is subscribed to it. Since using this
1695 parameter ensures that the mail only goes to the mailing list itself,
1696 it means that members won't receive two copies of your followups.
1698 Using `to-address' will actually work whether the group is foreign or
1699 not. Let's say there's a group on the server that is called
1700 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1701 articles from a mail-to-news gateway. Posting directly to this group
1702 is therefore impossible--you have to send mail to the mailing list
1703 address instead.
1705 The gnus-group-split mail splitting mechanism will behave as if this
1709 to-list
1710 :function-document
1711 "Return GROUP's to-list."
1712 :variable-document
1713 "*Alist of group regexps and correspondent to-lists."
1714 :variable-group gnus-group-parameter
1717 This address will be used when doing a `a' in the group.
1719 It is totally ignored when doing a followup--except that if it is
1720 present in a news group, you'll get mail group semantics when doing
1721 `f'.
1723 The gnus-group-split mail splitting mechanism will behave as if this
1727 subscribed
1728 :type bool
1729 :function-document
1730 "Return GROUP's subscription status."
1731 :variable-document
1732 "*Groups which are automatically considered subscribed."
1733 :variable-group gnus-group-parameter
1736 Gnus assumed that you are subscribed to the To/List address.
1738 When constructing a list of subscribed groups using
1739 `gnus-find-subscribed-addresses', Gnus includes the To address given
1743 auto-expire
1744 :type bool
1745 :function gnus-group-auto-expirable-p
1746 :function-document
1747 "Check whether GROUP is auto-expirable or not."
1748 :variable gnus-auto-expirable-newsgroups
1749 :variable-default nil
1750 :variable-document
1751 "*Groups in which to automatically mark read articles as expirable.
1752 If non-nil, this should be a regexp that should match all groups in
1753 which to perform auto-expiry. This only makes sense for mail groups."
1754 :variable-group nnmail-expire
1756 regexp)
1758 :parameter-document
1762 total-expire
1763 :type bool
1764 :function gnus-group-total-expirable-p
1765 :function-document
1766 "Check whether GROUP is total-expirable or not."
1767 :variable gnus-total-expirable-newsgroups
1768 :variable-default nil
1769 :variable-document
1770 "*Groups in which to perform expiry of all read articles.
1771 Use with extreme caution. All groups that match this regexp will be
1772 expiring - which means that all read articles will be deleted after
1773 \(say) one week. (This only goes for mail groups and the like, of
1774 course.)"
1775 :variable-group nnmail-expire
1777 regexp)
1779 :parameter-document
1780 "All read articles will be put through the expiry process
1782 This happens even if they are not marked as expirable.
1786 charset
1787 :function-document
1788 "Return the default charset of GROUP."
1789 :variable gnus-group-charset-alist
1790 :variable-default
1803 :variable-document
1804 "Alist of regexps (to match group names) and default charsets to be used when reading."
1805 :variable-group gnus-charset
1813 post-method
1814 :type list
1815 :function-document
1816 "Return a posting method for GROUP."
1817 :variable gnus-post-method-alist
1818 :variable-document
1819 "Alist of regexps (to match group names) and method to be used when
1820 posting an article."
1821 :variable-group gnus-group-foreign
1822 :parameter-type
1830 :parameter-document
1834 large-newsgroup-initial
1835 :type integer
1836 :function-document
1837 "Return GROUP's initial input of the number of articles."
1838 :variable-document
1839 "*Alist of group regexps and its initial input of the number of articles."
1840 :variable-group gnus-group-parameter
1846 This number will be prompted as the initial value of the number of
1847 articles to list when the group is a large newsgroup (see
1848 `gnus-large-newsgroup'). If it is nil, the default value is the
1851 ;; The Gnus registry's ignored groups
1853 registry-ignore
1854 :type list
1855 :function-document
1856 "Whether this group should be ignored by the registry."
1857 :variable gnus-registry-ignored-groups
1858 :variable-default nil
1859 :variable-document
1860 "*Groups in which the registry should be turned off."
1861 :variable-group gnus-registry
1868 :parameter-document
1871 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1873 "*Disable the group parameters for spam detection.
1874 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1881 "Spam group classification (requires spam.el).
1882 This group contains spam messages. On summary entry, unread messages
1883 will be marked as spam. On summary exit, the specified spam
1884 processors will be invoked on spam-marked messages, then those
1885 messages will be expired, so the spam processor will only see a
1889 "The ham value for the spam group parameter (requires spam.el).
1890 On summary exit, the specified ham processors will be invoked on
1891 ham-marked messages. Exercise caution, since the ham processor will
1892 see the same message more than once because there is no ham message
1896 spam-contents
1897 :type list
1898 :function-document
1899 "The spam type (spam, ham, or neither) of the group."
1900 :variable gnus-spam-newsgroup-contents
1901 :variable-default nil
1902 :variable-document
1903 "*Group classification (spam, ham, or neither). Only
1904 meaningful when spam.el is loaded. If non-nil, this should be a
1905 list of group name regexps associated with a classification for
1906 each one. In spam groups, new articles are marked as spam on
1907 summary entry. There is other behavior associated with ham and
1908 no classification when spam.el is loaded - see the manual."
1909 :variable-group spam
1923 :parameter-document
1924 "The spam classification (spam, ham, or neither) of this group.
1925 When a spam group is entered, all unread articles are marked as
1926 spam. There is other behavior associated with ham and no
1930 spam-resend-to
1931 :type list
1932 :function-document
1933 "The address to get spam resent (through spam-report-resend)."
1934 :variable gnus-spam-resend-to
1935 :variable-default nil
1936 :variable-document
1937 "The address to get spam resent (through spam-report-resend)."
1938 :variable-group spam
1942 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1943 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1944 :parameter-document
1948 ham-resend-to
1949 :type list
1950 :function-document
1951 "The address to get ham resent (through spam-report-resend)."
1952 :variable gnus-ham-resend-to
1953 :variable-default nil
1954 :variable-document
1955 "The address to get ham resent (through spam-report-resend)."
1956 :variable-group spam
1960 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1961 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1962 :parameter-document
1978 "OBSOLETE: The Gmane reporting summary exit spam processor.
1985 "OBSOLETE: The ifile summary exit ham processor.
1989 "OBSOLETE: The Bogofilter summary exit ham processor.
1993 "OBSOLETE: The spam-stat summary exit ham processor.
1997 "OBSOLETE: The whitelist summary exit ham processor.
2001 "OBSOLETE: The BBDB summary exit ham processor.
2005 "OBSOLETE: The ham copy exit ham processor.
2009 "OBSOLETE: The spamoracle summary exit ham processor.
2013 spam-process
2014 :type list
2015 :parameter-type
2018 :value nil
2055 :function-document
2056 "Which spam or ham processors will be applied when the summary is exited."
2057 :variable gnus-spam-process-newsgroups
2058 :variable-default nil
2059 :variable-document
2060 "*Groups in which to automatically process spam or ham articles with
2061 a backend on summary exit. If non-nil, this should be a list of group
2062 name regexps that should match all groups in which to do automatic
2063 spam processing, associated with the appropriate processor."
2064 :variable-group spam
2065 :variable-type
2106 :parameter-document
2110 spam-autodetect
2111 :type list
2112 :parameter-type
2114 :function-document
2115 "Should spam be autodetected (with spam-split) in this group?"
2116 :variable gnus-spam-autodetect
2117 :variable-default nil
2118 :variable-document
2119 "*Groups in which spam should be autodetected when they are entered.
2120 Only unseen articles will be examined, unless
2121 spam-autodetect-recheck-messages is set."
2122 :variable-group spam
2123 :variable-type
2128 boolean))
2129 :parameter-document
2130 "Spam autodetection.
2131 Only unseen articles will be examined, unless
2135 spam-autodetect-methods
2136 :type list
2137 :parameter-type
2160 :function-document
2161 "Methods to be used for autodetection in each group"
2162 :variable gnus-spam-autodetect-methods
2163 :variable-default nil
2164 :variable-document
2165 "*Methods for autodetecting spam per group.
2166 Requires the spam-autodetect parameter. Only unseen articles
2167 will be examined, unless spam-autodetect-recheck-messages is
2168 set."
2169 :variable-group spam
2170 :variable-type
2197 :parameter-document
2198 "Spam autodetection methods.
2199 Requires the spam-autodetect parameter. Only unseen articles
2200 will be examined, unless spam-autodetect-recheck-messages is
2204 spam-process-destination
2205 :type list
2206 :parameter-type
2212 :function-document
2213 "Where spam-processed articles will go at summary exit."
2214 :variable gnus-spam-process-destinations
2215 :variable-default nil
2216 :variable-document
2217 "*Groups in which to explicitly send spam-processed articles to
2218 another group, or expire them (the default). If non-nil, this should
2219 be a list of group name regexps that should match all groups in which
2220 to do spam-processed article moving, associated with the destination
2221 group or nil for explicit expiration. This only makes sense for
2222 mail groups."
2223 :variable-group spam
2224 :variable-type
2235 :parameter-document
2239 ham-process-destination
2240 :type list
2241 :parameter-type
2249 :function-document
2250 "Where ham articles will go at summary exit from a spam group."
2251 :variable gnus-ham-process-destinations
2252 :variable-default nil
2253 :variable-document
2254 "*Groups in which to explicitly send ham articles to
2255 another group, or do nothing (the default). If non-nil, this should
2256 be a list of group name regexps that should match all groups in which
2257 to do ham article moving, associated with the destination
2258 group or nil for explicit ignoring. This only makes sense for
2259 mail groups, and only works in spam groups."
2260 :variable-group spam
2261 :variable-type
2273 :parameter-document
2277 ham-marks
2288 :parameter-document
2289 "Marks considered ham (positively not spam). Such articles will be
2290 processed as ham (non-spam) on group exit. When nil, the global
2291 spam-ham-marks variable takes precedence."
2293 gnus-read-mark
2294 gnus-killed-mark
2295 gnus-kill-file-mark
2296 gnus-low-score-mark))))
2297 :variable-group spam
2298 :variable-document
2302 spam-marks
2311 :parameter-document
2312 "Marks considered spam.
2313 Such articles will be processed as spam on group exit. When nil, the global
2314 spam-spam-marks variable takes precedence."
2316 :variable-group spam
2317 :variable-document
2321 "Number of group name elements to leave alone when making a short group name."
2326 "*If non-nil, once you set a level, Gnus will use this level."
2330 ;; Hooks.
2333 "A hook run while Gnus is loaded."
2338 "A hook called to apply kill files to a group.
2339 This hook is intended to apply a kill file to the selected newsgroup.
2340 The function `gnus-apply-kill-file' is called by default.
2342 Since a general kill file is too heavy to use only for a few
2343 newsgroups, I recommend you to use a lighter hook function. For
2344 example, if you'd like to apply a kill file to articles which contains
2345 a string `rmgroup' in subject in newsgroup `control', you can use the
2346 following hook:
2348 (setq gnus-apply-kill-hook
2349 (list
2350 (lambda ()
2359 "Function run when a group level is changed.
2360 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2363 function))
2365 ;;; Face thingies.
2369 mouse-face
2370 summary-menu group-menu article-menu
2371 tree-highlight menu highlight
2372 browse-menu server-menu
2373 page-marker tree-menu binary-menu pick-menu)
2374 "*Enable visual features.
2375 If `visual' is disabled, there will be no menus and few faces. Most of
2376 the visual customization options below will be ignored. Gnus will use
2377 less space and be faster as a result.
2379 This variable can also be a list of visual elements to switch on. For
2380 instance, to switch off all visual things except menus, you can say:
2382 (setq gnus-visual '(menu))
2384 Valid elements include `summary-highlight', `group-highlight',
2385 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2386 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2387 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2407 ;; Byte-compiler warning.
2409 ;; Find out whether the gnus-visual TYPE is wanted.
2413 gnus-visual
2417 t))))
2427 "*Face used for group or summary buffer mouse highlighting.
2428 The line beneath the mouse pointer will be highlighted with this
2429 face."
2442 "Controls use of the agent cache while plugged.
2443 When set, Gnus will prefer using the locally stored content rather
2444 than re-fetching it from the server. You also need to enable
2445 `gnus-agent' for this to have any affect."
2451 "Default charset assumed to be used when viewing non-ASCII characters.
2452 This variable is overridden on a group-to-group basis by the
2453 `gnus-group-charset-alist' variable and is only used on groups not
2454 covered by that variable."
2458 ;; Fixme: Doc reference to agent.
2460 "Whether we want to use the Gnus agent or not.
2462 You may customize gnus-agent to disable its use. However, some
2463 back ends have started to use the agent as a client-side cache.
2464 Disabling the agent may result in noticeable loss of performance."
2470 "Function called by the command `gnus-other-frame'."
2478 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2479 This should be an alist for Emacs, or a plist for XEmacs."
2490 "Which information should be exposed in the User-Agent header.
2492 Can be a list of symbols or a string. Valid symbols are `gnus'
2493 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2494 addition to the Emacs version, you can add `codename' \(show
2495 \(S\)XEmacs codename\) or either `config' \(show system
2496 configuration\) or `type' \(show system type\). If you set it to
2497 a string, be sure to use a valid format, see RFC 2616."
2510 ;; Convert old (< 2005-01-10) symbol type values:
2529 \f
2530 ;;; Internal variables
2535 ; Reset each time gnus-agent-covered-methods is changed else
2536 ; gnus-agent-method-p may mis-report a methods status.
2537 )
2547 ;; The carpal mode has been removed, but define the variable for
2548 ;; backwards compatibility.
2567 ;; Variable holding the user answers to all method prompts.
2570 ;; Variable holding the user answers to all mail method prompts.
2573 ;; Variable holding the user answers to all group prompts.
2581 "*The directory where cached articles will be stored."
2587 nnspool "cache"
2611 ;; Propagate flags to server, with the following exceptions:
2612 ;; `seen' is private to each gnus installation
2613 ;; `cache' is a internal gnus flag for each gnus installation
2614 ;; `download' is a agent flag private to each gnus installation
2615 ;; `unsend' are for nndraft groups only
2616 ;; `score' is not a proper mark
2617 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2620 "Marks that shouldn't be propagated to back ends.
2621 Typical marks are those that make no sense in a standalone back end,
2622 such as a mark that says whether an article is stored in the cache
2635 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2660 gnus-newsrc-last-checked-date
2661 gnus-newsrc-alist gnus-server-alist
2662 gnus-killed-list gnus-zombie-list
2663 gnus-topic-topology gnus-topic-alist
2664 gnus-format-specs)
2668 "Assoc list of read articles.
2672 "Assoc list of registry data.
2699 ;; Save window configuration.
2712 ;;; End of variables.
2714 ;; Define some autoload functions Gnus might use.
2717 ;; This little mapcar goes through the list below and marks the
2718 ;; symbols in question as autoloaded functions.
2738 message-send-and-exit message-yank-original)
2742 ;; This is only used in message.el, which has an autoload.
2744 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2746 ;; Next two only used in gnus-util.
2747 rmail-summary-exists rmail-select-summary)
2748 ;; Only used in gnus-util, which has an autoload.
2753 gnus-Folder-save-name gnus-folder-save-name)
2756 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2757 gnus-demon-add-disconnection gnus-demon-add-handler
2758 gnus-demon-remove-handler)
2760 gnus-demon-init gnus-demon-cancel)
2762 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2763 gnus-face-from-file)
2765 gnus-tree-open gnus-tree-close)
2767 gnus-server-server-name)
2770 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2771 gnus-article-hide-citation gnus-article-fill-cited-article
2772 gnus-article-hide-citation-in-followups
2773 gnus-article-fill-cited-long-lines)
2775 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2776 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2778 gnus-cache-possibly-remove-articles gnus-cache-request-article
2779 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2780 gnus-cache-enter-remove-article gnus-cached-article-p
2781 gnus-cache-open gnus-cache-close gnus-cache-update-article
2782 gnus-cache-articles-in-group)
2784 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2786 gnus-summary-increase-score gnus-summary-set-score
2787 gnus-summary-raise-thread gnus-summary-raise-same-subject
2788 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2789 gnus-summary-lower-thread gnus-summary-lower-same-subject
2790 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2791 gnus-summary-current-score gnus-score-delta-default
2792 gnus-score-flush-cache gnus-score-close
2793 gnus-possibly-score-headers gnus-score-followup-article
2794 gnus-score-followup-thread)
2797 gnus-current-score-file-nondirectory gnus-score-adaptive
2798 gnus-score-find-trace gnus-score-file-name)
2802 gnus-subscribe-topics)
2806 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2807 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2808 gnus-uu-mark-by-regexp gnus-uu-mark-all
2809 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2810 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2811 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2812 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2813 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2814 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2815 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2816 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2819 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2821 gnus-group-post-news gnus-group-mail gnus-group-news
2822 gnus-summary-post-news gnus-summary-news-other-window
2823 gnus-summary-followup gnus-summary-followup-with-original
2824 gnus-summary-cancel-article gnus-summary-supersede-article
2825 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2826 gnus-summary-mail-forward gnus-summary-mail-other-window
2827 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2828 gnus-summary-wide-reply gnus-summary-followup-to-mail
2829 gnus-summary-followup-to-mail-with-original gnus-bug
2830 gnus-summary-wide-reply-with-original
2831 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2832 gnus-summary-post-forward)
2837 gnus-list-of-unread-articles gnus-list-of-read-articles
2838 gnus-offer-save-summaries gnus-make-thread-indent-array
2839 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2840 gnus-summary-skip-intangible gnus-summary-article-number
2841 gnus-data-header gnus-data-find)
2843 gnus-group-list-groups gnus-group-first-unread-group
2844 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2845 gnus-group-setup-buffer gnus-group-get-new-news
2846 gnus-group-make-help-group gnus-group-update-group
2847 gnus-group-iterate gnus-group-group-name)
2849 gnus-backlog-remove-article)
2851 gnus-article-prepare gnus-article-set-window-start
2852 gnus-article-next-page gnus-article-prev-page
2853 gnus-request-article-this-buffer gnus-article-mode
2854 gnus-article-setup-buffer gnus-narrow-to-page
2855 gnus-article-delete-invisible-text gnus-treat-article)
2857 gnus-article-hide-headers gnus-article-hide-boring-headers
2858 gnus-article-treat-overstrike
2859 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2860 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2861 gnus-article-de-base64-unreadable
2862 gnus-article-decode-HZ
2863 gnus-article-wash-html
2864 gnus-article-unsplit-urls
2865 gnus-article-hide-pem gnus-article-hide-signature
2866 gnus-article-strip-leading-blank-lines gnus-article-date-local
2867 gnus-article-date-original gnus-article-date-lapsed
2868 ;;gnus-article-show-all-headers
2869 gnus-article-edit-mode gnus-article-edit-article
2870 gnus-article-edit-done gnus-article-decode-encoded-words
2871 gnus-start-date-timer gnus-stop-date-timer
2872 gnus-mime-view-all-parts)
2875 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2876 gnus-check-reasonable-setup)
2878 gnus-dup-enter-articles)
2884 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2885 gnus-async-halt-prefetch)
2887 gnus-agent-save-active gnus-agent-method-p
2888 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2889 gnus-summary-set-agent-mark gnus-agent-save-group-info
2890 gnus-agent-request-article gnus-agent-retrieve-headers)
2892 gnus-unplugged gnus-agentize gnus-agent-batch)
2894 gnus-summary-save-article-vm)
2899 gnus-group-split-update)
2902 ;;; gnus-sum.el thingies
2906 "*The format specification of the lines in the summary buffer.
2908 It works along the same lines as a normal formatting string,
2909 with some simple extensions.
2911 %N Article number, left padded with spaces (string)
2912 %S Subject (string)
2914 otherwise (string)
2915 %n Name of the poster (string)
2916 %a Extracted name of the poster (string)
2917 %A Extracted address of the poster (string)
2918 %F Contents of the From: header (string)
2919 %f Contents of the From: or To: headers (string)
2920 %x Contents of the Xref: header (string)
2921 %D Date of the article (string)
2922 %d Date of the article (string) in DD-MMM format
2923 %o Date of the article (string) in YYYYMMDD`T'HHMMSS
2924 format
2925 %M Message-id of the article (string)
2926 %r References of the article (string)
2927 %c Number of characters in the article (integer)
2928 %k Pretty-printed version of the above (string)
2930 %L Number of lines in the article (integer)
2931 %I Indentation based on thread level (a string of
2932 spaces)
2933 %B A complex trn-style thread tree (string)
2934 The variables `gnus-sum-thread-*' can be used for
2935 customization.
2936 %T A string with two possible values: 80 spaces if the
2937 article is on thread level two or larger and 0 spaces
2938 on level one
2940 otherwise (character)
2945 %> Spaces of length thread-level (string)
2946 %< Spaces of length (- 20 thread-level) (string)
2947 %i Article score (number)
2948 %z Article zcore (character)
2949 %t Number of articles under the current thread (number).
2950 %e Whether the thread is empty or not (character).
2951 %V Total thread score (number).
2952 %P The line number (number).
2953 %O Download mark (character).
2954 %* If present, indicates desired cursor position
2955 (instead of after first colon).
2956 %u User defined specifier. The next character in the
2957 format string should be a letter. Gnus will call the
2958 function gnus-user-format-function-X, where X is the
2959 letter following %u. The function will be passed the
2960 current header as argument. The function should
2961 return a string, which will be inserted into the
2962 summary just like information from any other summary
2963 specifier.
2964 &user-date; Age sensitive date format. Various date format is
2965 defined in `gnus-summary-user-date-format-alist'.
2968 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2969 with care. For reasons of efficiency, Gnus will compute what column
2971 it is invalid to have these specs after a variable-length spec. Well,
2972 you might not be arrested, but your summary buffer will look strange,
2973 which is bad enough.
2975 The smart choice is to have these specs as far to the left as
2976 possible.
2978 This restriction may disappear in later versions of Gnus.
2980 General format specifiers can also be used.
2981 See Info node `(gnus)Formatting Variables'."
2986 ;;;
2987 ;;; Skeleton keymaps
2988 ;;;
2993 (while keys
2994 (define-key keymap (pop keys) 'undefined))))
2996 (defvar gnus-article-mode-map
2997 (let ((keymap (make-sparse-keymap)))
2998 (gnus-suppress-keymap keymap)
2999 keymap))
3000 (defvar gnus-summary-mode-map
3001 (let ((keymap (make-keymap)))
3002 (gnus-suppress-keymap keymap)
3003 keymap))
3004 (defvar gnus-group-mode-map
3005 (let ((keymap (make-keymap)))
3006 (gnus-suppress-keymap keymap)
3007 keymap))
3009 \f
3011 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3012 ;; If you want the cursor to go somewhere else, set these two
3013 ;; functions in some startup hook to whatever you want.
3014 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3015 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3017 ;;; Various macros and substs.
3019 (defun gnus-header-from (header)
3020 (mail-header-from header))
3022 (defmacro gnus-gethash (string hashtable)
3023 "Get hash value of STRING in HASHTABLE."
3024 `(symbol-value (intern-soft ,string ,hashtable)))
3026 (defmacro gnus-gethash-safe (string hashtable)
3027 "Get hash value of STRING in HASHTABLE.
3028 Return nil if not defined."
3029 `(let ((sym (intern-soft ,string ,hashtable)))
3030 (and (boundp sym) (symbol-value sym))))
3032 (defmacro gnus-sethash (string value hashtable)
3033 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3034 `(set (intern ,string ,hashtable) ,value))
3035 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3037 (defmacro gnus-group-unread (group)
3038 "Get the currently computed number of unread articles in GROUP."
3039 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3041 (defmacro gnus-group-entry (group)
3042 "Get the newsrc entry for GROUP."
3043 `(gnus-gethash ,group gnus-newsrc-hashtb))
3045 (defmacro gnus-active (group)
3046 "Get active info on GROUP."
3047 `(gnus-gethash ,group gnus-active-hashtb))
3049 (defmacro gnus-set-active (group active)
3050 "Set GROUP's active info."
3051 `(gnus-sethash ,group ,active gnus-active-hashtb))
3053 ;; Info access macros.
3055 (defmacro gnus-info-group (info)
3056 `(nth 0 ,info))
3057 (defmacro gnus-info-rank (info)
3058 `(nth 1 ,info))
3059 (defmacro gnus-info-read (info)
3060 `(nth 2 ,info))
3061 (defmacro gnus-info-marks (info)
3062 `(nth 3 ,info))
3063 (defmacro gnus-info-method (info)
3064 `(nth 4 ,info))
3065 (defmacro gnus-info-params (info)
3066 `(nth 5 ,info))
3068 (defmacro gnus-info-level (info)
3069 `(let ((rank (gnus-info-rank ,info)))
3070 (if (consp rank)
3071 (car rank)
3072 rank)))
3073 (defmacro gnus-info-score (info)
3074 `(let ((rank (gnus-info-rank ,info)))
3075 (or (and (consp rank) (cdr rank)) 0)))
3077 (defmacro gnus-info-set-group (info group)
3078 `(setcar ,info ,group))
3079 (defmacro gnus-info-set-rank (info rank)
3080 `(setcar (nthcdr 1 ,info) ,rank))
3081 (defmacro gnus-info-set-read (info read)
3082 `(setcar (nthcdr 2 ,info) ,read))
3083 (defmacro gnus-info-set-marks (info marks &optional extend)
3084 (if extend
3085 `(gnus-info-set-entry ,info ,marks 3)
3086 `(setcar (nthcdr 3 ,info) ,marks)))
3087 (defmacro gnus-info-set-method (info method &optional extend)
3088 (if extend
3089 `(gnus-info-set-entry ,info ,method 4)
3090 `(setcar (nthcdr 4 ,info) ,method)))
3091 (defmacro gnus-info-set-params (info params &optional extend)
3092 (if extend
3093 `(gnus-info-set-entry ,info ,params 5)
3094 `(setcar (nthcdr 5 ,info) ,params)))
3096 (defun gnus-info-set-entry (info entry number)
3097 ;; Extend the info until we have enough elements.
3098 (while (<= (length info) number)
3099 (nconc info (list nil)))
3100 ;; Set the entry.
3101 (setcar (nthcdr number info) entry))
3103 (defmacro gnus-info-set-level (info level)
3104 `(let ((rank (cdr ,info)))
3105 (if (consp (car rank))
3106 (setcar (car rank) ,level)
3107 (setcar rank ,level))))
3108 (defmacro gnus-info-set-score (info score)
3109 `(let ((rank (cdr ,info)))
3110 (if (consp (car rank))
3111 (setcdr (car rank) ,score)
3112 (setcar rank (cons (car rank) ,score)))))
3114 (defmacro gnus-get-info (group)
3115 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3117 (defun gnus-set-info (group info)
3118 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3119 info))
3121 ;;; Load the compatibility functions.
3123 (require 'gnus-ems)
3125 \f
3126 ;;;
3127 ;;; Shutdown
3128 ;;;
3130 (defvar gnus-shutdown-alist nil)
3132 (defun gnus-add-shutdown (function &rest symbols)
3133 "Run FUNCTION whenever one of SYMBOLS is shut down."
3134 (push (cons function symbols) gnus-shutdown-alist))
3136 (defun gnus-shutdown (symbol)
3137 "Shut down everything that waits for SYMBOL."
3138 (dolist (entry gnus-shutdown-alist)
3139 (when (memq symbol (cdr entry))
3140 (funcall (car entry)))))
3142 \f
3143 ;;;
3144 ;;; Gnus Utility Functions
3145 ;;;
3147 (defun gnus-find-subscribed-addresses ()
3148 "Return a regexp matching the addresses of all subscribed mail groups.
3149 It consists of the `to-address' or `to-list' parameter of all groups
3150 with a `subscribed' parameter."
3151 (let (group address addresses)
3152 (dolist (entry (cdr gnus-newsrc-alist))
3153 (setq group (car entry))
3154 (when (gnus-parameter-subscribed group)
3155 (setq address (mail-strip-quoted-names
3156 (or (gnus-group-fast-parameter group 'to-address)
3157 (gnus-group-fast-parameter group 'to-list))))
3158 (when address
3159 (add-to-list 'addresses address))))
3160 (when addresses
3163 (defmacro gnus-string-or (&rest strings)
3164 "Return the first element of STRINGS that is a non-blank string.
3165 STRINGS will be evaluated in normal `or' order."
3166 `(gnus-string-or-1 (list ,@strings)))
3168 (defun gnus-string-or-1 (strings)
3169 (let (string)
3170 (while strings
3171 (setq string (pop strings))
3173 (setq string nil)
3174 (setq strings nil)))
3175 string))
3177 (defun gnus-version (&optional arg)
3178 "Version number of this version of Gnus.
3179 If ARG, insert string at point."
3180 (interactive "P")
3181 (if arg
3182 (insert (message gnus-version))
3183 (message gnus-version)))
3185 (defun gnus-continuum-version (&optional version)
3186 "Return VERSION as a floating point number."
3187 (unless version
3188 (setq version gnus-version))
3191 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3192 (number (match-string 2 version))
3193 major minor least)
3194 (unless (string-match
3196 (error "Invalid version string: %s" version))
3197 (setq major (string-to-number (match-string 1 number))
3198 minor (string-to-number (match-string 2 number))
3199 least (if (match-beginning 3)
3200 (string-to-number (match-string 3 number))
3201 0))
3202 (string-to-number
3203 (if (zerop major)
3204 (format "%s00%02d%02d"
3205 (if (member alpha '("(ding)" "d"))
3206 "4.99"
3207 (+ 5 (* 0.02
3208 (abs
3209 (- (mm-char-int (aref (downcase alpha) 0))
3210 (mm-char-int ?t))))
3211 -0.01))
3212 minor least)
3213 (format "%d.%02d%02d" major minor least))))))
3215 (defun gnus-info-find-node (&optional nodename)
3216 "Find Info documentation of Gnus."
3217 (interactive)
3218 ;; Enlarge info window if needed.
3219 (let (gnus-info-buffer)
3220 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3221 (setq gnus-info-buffer (current-buffer))
3222 (gnus-configure-windows 'info)))
3224 ;;;
3225 ;;; gnus-interactive
3226 ;;;
3228 (defvar gnus-current-prefix-symbol nil
3229 "Current prefix symbol.")
3231 (defvar gnus-current-prefix-symbols nil
3232 "List of current prefix symbols.")
3234 (defun gnus-interactive (string &optional params)
3235 "Return a list that can be fed to `interactive'.
3236 See `interactive' for full documentation.
3238 Adds the following specs:
3240 y -- The current symbolic prefix.
3241 Y -- A list of the current symbolic prefix(es).
3242 A -- Article number.
3243 H -- Article header.
3244 g -- Group name."
3245 (let ((i 0)
3246 out c prompt)
3247 (while (< i (length string))
3249 (setq c (aref string i))
3250 (when (match-end 1)
3251 (setq prompt (match-string 1 string)))
3252 (setq i (match-end 0))
3253 ;; We basically emulate just about everything that
3254 ;; `interactive' does, but add the specs listed above.
3255 (push
3256 (cond
3257 ((= c ?a)
3258 (completing-read prompt obarray 'fboundp t))
3259 ((= c ?b)
3260 (read-buffer prompt (current-buffer) t))
3261 ((= c ?B)
3262 (read-buffer prompt (other-buffer (current-buffer))))
3263 ((= c ?c)
3264 (read-char))
3265 ((= c ?C)
3266 (completing-read prompt obarray 'commandp t))
3267 ((= c ?d)
3268 (point))
3269 ((= c ?D)
3270 (read-directory-name prompt nil default-directory 'lambda))
3271 ((= c ?f)
3272 (read-file-name prompt nil nil 'lambda))
3273 ((= c ?F)
3274 (read-file-name prompt))
3275 ((= c ?k)
3276 (read-key-sequence prompt))
3277 ((= c ?K)
3278 (error "Not implemented spec"))
3279 ((= c ?e)
3280 (error "Not implemented spec"))
3281 ((= c ?m)
3282 (mark))
3283 ((= c ?N)
3284 (error "Not implemented spec"))
3285 ((= c ?n)
3286 (string-to-number (read-from-minibuffer prompt)))
3287 ((= c ?p)
3288 (prefix-numeric-value current-prefix-arg))
3289 ((= c ?P)
3290 current-prefix-arg)
3291 ((= c ?r)
3292 'gnus-prefix-nil)
3293 ((= c ?s)
3294 (read-string prompt))
3295 ((= c ?S)
3296 (intern (read-string prompt)))
3297 ((= c ?v)
3298 (read-variable prompt))
3299 ((= c ?x)
3300 (read-minibuffer prompt))
3301 ((= c ?x)
3302 (eval-minibuffer prompt))
3303 ;; And here the new specs come.
3304 ((= c ?y)
3305 gnus-current-prefix-symbol)
3306 ((= c ?Y)
3307 gnus-current-prefix-symbols)
3308 ((= c ?g)
3309 (gnus-group-group-name))
3310 ((= c ?A)
3311 (gnus-summary-skip-intangible)
3312 (or (get-text-property (point) 'gnus-number)
3313 (gnus-summary-last-subject)))
3314 ((= c ?H)
3315 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3316 (t
3317 (error "Non-implemented spec")))
3318 out)
3319 (cond
3320 ((= c ?r)
3321 (push (if (< (point) (mark)) (point) (mark)) out)
3322 (push (if (> (point) (mark)) (point) (mark)) out))))
3323 (setq out (delq 'gnus-prefix-nil out))
3324 (nreverse out)))
3326 (defun gnus-symbolic-argument (&optional arg)
3327 "Read a symbolic argument and a command, and then execute command."
3328 (interactive "P")
3329 (let* ((in-command (this-command-keys))
3330 (command in-command)
3331 gnus-current-prefix-symbols
3332 gnus-current-prefix-symbol
3333 syms)
3334 (while (equal in-command command)
3335 (message "%s-" (key-description (this-command-keys)))
3336 (push (intern (char-to-string (read-char))) syms)
3337 (setq command (read-key-sequence nil t)))
3338 (setq gnus-current-prefix-symbols (nreverse syms)
3339 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3340 (call-interactively (key-binding command t))))
3342 ;;; More various functions.
3344 (defsubst gnus-check-backend-function (func group)
3345 "Check whether GROUP supports function FUNC.
3346 GROUP can either be a string (a group name) or a select method."
3347 (ignore-errors
3348 (let ((method (if (stringp group)
3349 (car (gnus-find-method-for-group group))
3350 group)))
3351 (unless (featurep method)
3352 (require method))
3353 (fboundp (intern (format "%s-%s" method func))))))
3355 (defun gnus-group-read-only-p (&optional group)
3356 "Check whether GROUP supports editing or not.
3357 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3358 that that variable is buffer-local to the summary buffers."
3359 (let ((group (or group gnus-newsgroup-name)))
3360 (not (gnus-check-backend-function 'request-replace-article group))))
3362 (defun gnus-virtual-group-p (group)
3363 "Say whether GROUP is virtual or not."
3364 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3365 gnus-valid-select-methods)))
3367 (defun gnus-news-group-p (group &optional article)
3368 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3369 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3370 t) ;is news of course.
3371 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3372 nil) ;must be mail then.
3373 ((vectorp article) ;Has header info.
3374 (eq (gnus-request-type group (mail-header-id article)) 'news))
3375 ((null article) ;Hasn't header info
3376 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3377 ((< article 0) ;Virtual message
3378 nil) ;we don't know, guess mail.
3379 (t ;Has positive number
3380 (eq (gnus-request-type group article) 'news)))) ;use it.
3382 ;; Returns a list of writable groups.
3383 (defun gnus-writable-groups ()
3384 (let ((alist gnus-newsrc-alist)
3385 groups group)
3386 (while (setq group (car (pop alist)))
3387 (unless (gnus-group-read-only-p group)
3388 (push group groups)))
3389 (nreverse groups)))
3391 ;; Check whether to use long file names.
3392 (defun gnus-use-long-file-name (symbol)
3393 ;; The variable has to be set...
3394 (and gnus-use-long-file-name
3395 ;; If it isn't a list, then we return t.
3396 (or (not (listp gnus-use-long-file-name))
3397 ;; If it is a list, and the list contains `symbol', we
3398 ;; return nil.
3399 (not (memq symbol gnus-use-long-file-name)))))
3401 ;; Generate a unique new group name.
3402 (defun gnus-generate-new-group-name (leaf)
3403 (let ((name leaf)
3404 (num 0))
3405 (while (gnus-group-entry name)
3406 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3407 name))
3409 (defun gnus-ephemeral-group-p (group)
3410 "Say whether GROUP is ephemeral or not."
3411 (gnus-group-get-parameter group 'quit-config t))
3413 (defun gnus-group-quit-config (group)
3414 "Return the quit-config of GROUP."
3415 (gnus-group-get-parameter group 'quit-config t))
3417 (defun gnus-kill-ephemeral-group (group)
3418 "Remove ephemeral GROUP from relevant structures."
3419 (gnus-sethash group nil gnus-newsrc-hashtb))
3421 (defun gnus-simplify-mode-line ()
3422 "Make mode lines a bit simpler."
3423 (setq mode-line-modified (cdr gnus-mode-line-modified))
3424 (when (listp mode-line-format)
3425 (make-local-variable 'mode-line-format)
3426 (setq mode-line-format (copy-sequence mode-line-format))
3427 (when (equal (nth 3 mode-line-format) " ")
3428 (setcar (nthcdr 3 mode-line-format) " "))))
3430 ;;; Servers and groups.
3432 (defsubst gnus-server-add-address (method)
3433 (let ((method-name (symbol-name (car method))))
3434 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3435 (not (assq (intern (concat method-name "-address")) method))
3436 (memq 'physical-address (assq (car method)
3437 gnus-valid-select-methods)))
3438 (append method (list (list (intern (concat method-name "-address"))
3439 (nth 1 method))))
3440 method)))
3442 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3443 (catch 'server-name
3444 (setq method (or method gnus-select-method))
3446 ;; Perhaps it is already in the cache.
3447 (unless nocache
3448 (mapc (lambda (name-method)
3449 (if (equal (cdr name-method) method)
3450 (throw 'server-name (car name-method))))
3451 gnus-server-method-cache))
3453 (mapc
3454 (lambda (server-alist)
3455 (mapc (lambda (name-method)
3456 (when (gnus-methods-equal-p (cdr name-method) method)
3457 (unless (member name-method gnus-server-method-cache)
3458 (push name-method gnus-server-method-cache))
3459 (throw 'server-name (car name-method))))
3460 server-alist))
3461 (list gnus-server-alist
3462 gnus-predefined-server-alist))
3464 (let* ((name (if (member (cadr method) '(nil ""))
3465 (format "%s" (car method))
3466 (format "%s:%s" (car method) (cadr method))))
3467 (name-method (cons name method)))
3468 (when (and (not (member name-method gnus-server-method-cache))
3469 (not no-enter-cache)
3470 (not (assoc (car name-method) gnus-server-method-cache)))
3471 (push name-method gnus-server-method-cache))
3472 name)))
3474 (defsubst gnus-server-to-method (server)
3475 "Map virtual server names to select methods."
3476 (or (and server (listp server) server)
3477 (cdr (assoc server gnus-server-method-cache))
3478 (let ((result
3479 (or
3480 ;; Perhaps this is the native server?
3481 (and (equal server "native") gnus-select-method)
3482 ;; It should be in the server alist.
3483 (cdr (assoc server gnus-server-alist))
3484 ;; It could be in the predefined server alist.
3485 (cdr (assoc server gnus-predefined-server-alist))
3486 ;; If not, we look through all the opened server
3487 ;; to see whether we can find it there.
3488 (let ((opened gnus-opened-servers))
3489 (while (and opened
3490 (not (equal server (format "%s:%s" (caaar opened)
3491 (cadaar opened)))))
3492 (pop opened))
3493 (caar opened))
3494 ;; It could be a named method, search all servers
3495 (let ((servers gnus-secondary-select-methods))
3496 (while (and servers
3497 (not (equal server (format "%s:%s" (caar servers)
3498 (cadar servers)))))
3499 (pop servers))
3500 (car servers))
3501 ;; This could be some sort of foreign server that I
3502 ;; simply haven't opened (yet). Do a brute-force scan
3503 ;; of the entire gnus-newsrc-alist for the server name
3504 ;; of every method. As a side-effect, loads the
3505 ;; gnus-server-method-cache so this only happens once,
3506 ;; if at all.
3507 (let ((alist (cdr gnus-newsrc-alist))
3508 method match)
3509 (while alist
3510 (setq method (gnus-info-method (pop alist)))
3511 (when (and (not (stringp method))
3512 (equal server
3513 (gnus-method-to-server method nil t)))
3514 (setq match method
3515 alist nil)))
3516 match))))
3517 (when (and result
3518 (not (assoc server gnus-server-method-cache)))
3519 (push (cons server result) gnus-server-method-cache))
3520 result)))
3522 (defsubst gnus-server-get-method (group method)
3523 ;; Input either a server name, and extended server name, or a
3524 ;; select method, and return a select method.
3525 (cond ((stringp method)
3526 (gnus-server-to-method method))
3527 ((equal method gnus-select-method)
3528 gnus-select-method)
3529 ((and (stringp (car method))
3530 group)
3531 (gnus-server-extend-method group method))
3532 ((and method
3533 (not group)
3534 (equal (cadr method) ""))
3535 method)
3536 (t
3537 (gnus-server-add-address method))))
3539 (defmacro gnus-method-equal (ss1 ss2)
3540 "Say whether two servers are equal."
3541 `(let ((s1 ,ss1)
3542 (s2 ,ss2))
3543 (or (equal s1 s2)
3544 (and (= (length s1) (length s2))
3545 (progn
3546 (while (and s1 (member (car s1) s2))
3547 (setq s1 (cdr s1)))
3548 (null s1))))))
3550 (defun gnus-methods-equal-p (m1 m2)
3551 (let ((m1 (or m1 gnus-select-method))
3552 (m2 (or m2 gnus-select-method)))
3553 (or (equal m1 m2)
3554 (and (eq (car m1) (car m2))
3555 (or (not (memq 'address (assoc (symbol-name (car m1))
3556 gnus-valid-select-methods)))
3557 (equal (nth 1 m1) (nth 1 m2)))))))
3559 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3560 ;; Check parameters for sloppy equalness.
3561 (let ((p1 (copy-sequence (cddr m1)))
3562 (p2 (copy-sequence (cddr m2)))
3563 e1 e2)
3564 (block nil
3565 (while (setq e1 (pop p1))
3566 (unless (setq e2 (assq (car e1) p2))
3567 ;; The parameter doesn't exist in p2.
3568 (return nil))
3569 (setq p2 (delq e2 p2))
3570 (unless (equal e1 e2)
3571 (if (not (and (stringp (cadr e1))
3572 (stringp (cadr e2))))
3573 (return nil)
3574 ;; Special-case string parameter comparison so that we
3575 ;; can uniquify them.
3576 (let ((s1 (cadr e1))
3577 (s2 (cadr e2)))
3578 (when (string-match "/$" s1)
3579 (setq s1 (directory-file-name s1)))
3580 (when (string-match "/$" s2)
3581 (setq s2 (directory-file-name s2)))
3582 (unless (equal s1 s2)
3583 (return nil))))))
3584 ;; If p2 now is empty, they were equal.
3585 (null p2))))
3587 (defun gnus-methods-sloppily-equal (m1 m2)
3588 ;; Same method.
3589 (or
3590 (eq m1 m2)
3591 ;; Type and name are equal.
3592 (and
3593 (eq (car m1) (car m2))
3594 (equal (cadr m1) (cadr m2))
3595 (gnus-sloppily-equal-method-parameters m1 m2))))
3597 (defun gnus-server-equal (m1 m2)
3598 "Say whether two methods are equal."
3599 (let ((m1 (cond ((null m1) gnus-select-method)
3600 ((stringp m1) (gnus-server-to-method m1))
3601 (t m1)))
3602 (m2 (cond ((null m2) gnus-select-method)
3603 ((stringp m2) (gnus-server-to-method m2))
3604 (t m2))))
3605 (gnus-method-equal m1 m2)))
3607 (defun gnus-servers-using-backend (backend)
3608 "Return a list of known servers using BACKEND."
3609 (let ((opened gnus-opened-servers)
3610 out)
3611 (while opened
3612 (when (eq backend (caaar opened))
3613 (push (caar opened) out))
3614 (pop opened))
3615 out))
3617 (defun gnus-archive-server-wanted-p ()
3618 "Say whether the user wants to use the archive server."
3619 (cond
3620 ((or (not gnus-message-archive-method)
3621 (not gnus-message-archive-group))
3622 nil)
3623 ((and gnus-message-archive-method gnus-message-archive-group)
3624 t)
3625 (t
3626 (let ((active (cadr (assq 'nnfolder-active-file
3627 gnus-message-archive-method))))
3628 (and active
3629 (file-exists-p active))))))
3631 (defsubst gnus-method-to-server-name (method)
3632 (concat
3633 (format "%s" (car method))
3634 (when (and
3635 (or (assoc (format "%s" (car method))
3636 (gnus-methods-using 'address))
3637 (gnus-server-equal method gnus-message-archive-method))
3638 (nth 1 method)
3639 (not (string= (nth 1 method) "")))
3640 (concat "+" (nth 1 method)))))
3642 (defsubst gnus-method-to-full-server-name (method)
3643 (format "%s+%s" (car method) (nth 1 method)))
3645 (defun gnus-group-prefixed-name (group method &optional full)
3646 "Return the whole name from GROUP and METHOD.
3647 Call with full set to get the fully qualified group name (even if the
3648 server is native)."
3649 (when (stringp method)
3650 (setq method (gnus-server-to-method method)))
3651 (if (or (not method)
3652 (and (not full) (gnus-server-equal method "native"))
3653 ;;;!!! This might not be right. We'll see...
3654 ;(string-match ":" group)
3655 )
3656 group
3657 (concat (gnus-method-to-server-name method) ":" group)))
3659 (defun gnus-group-guess-prefixed-name (group)
3660 "Guess the whole name from GROUP and METHOD."
3661 (gnus-group-prefixed-name group (gnus-find-method-for-group
3662 group)))
3664 (defun gnus-group-full-name (group method)
3665 "Return the full name from GROUP and METHOD, even if the method is native."
3666 (gnus-group-prefixed-name group method t))
3668 (defun gnus-group-guess-full-name (group)
3669 "Guess the full name from GROUP, even if the method is native."
3670 (if (gnus-group-prefixed-p group)
3671 group
3672 (gnus-group-full-name group (gnus-find-method-for-group group))))
3674 (defun gnus-group-guess-full-name-from-command-method (group)
3675 "Guess the full name from GROUP, even if the method is native."
3676 (if (gnus-group-prefixed-p group)
3677 group
3678 (gnus-group-full-name group gnus-command-method)))
3680 (defun gnus-group-real-prefix (group)
3681 "Return the prefix of the current group name."
3682 (if (stringp group)
3683 (if (string-match "^[^:]+:" group)
3684 (substring group 0 (match-end 0))
3685 "")
3686 nil))
3688 (defun gnus-group-short-name (group)
3689 "Return the short group name."
3690 (let ((prefix (gnus-group-real-prefix group)))
3691 (if (< 0 (length prefix))
3692 (substring group (length prefix) nil)
3693 group)))
3695 (defun gnus-group-prefixed-p (group)
3696 "Return the prefix of the current group name."
3697 (< 0 (length (gnus-group-real-prefix group))))
3699 (declare-function gnus-group-decoded-name "gnus-group" (string))
3701 (defun gnus-summary-buffer-name (group)
3702 "Return the summary buffer name of GROUP."
3703 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3705 (defun gnus-group-method (group)
3706 "Return the server or method used for selecting GROUP.
3707 You should probably use `gnus-find-method-for-group' instead."
3708 (let ((prefix (gnus-group-real-prefix group)))
3709 (if (equal prefix "")
3710 gnus-select-method
3711 (let ((servers gnus-opened-servers)
3712 (server "")
3713 backend possible found)
3715 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3716 server (substring prefix (match-end 0) (1- (length prefix))))
3717 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3718 (while servers
3719 (when (eq (caaar servers) backend)
3720 (setq possible (caar servers))
3721 (when (equal (cadaar servers) server)
3722 (setq found (caar servers))))
3723 (pop servers))
3724 (or (car (rassoc found gnus-server-alist))
3725 found
3726 (car (rassoc possible gnus-server-alist))
3727 possible
3728 (list backend server))))))
3730 (defsubst gnus-native-method-p (method)
3731 "Return whether METHOD is the native select method."
3732 (gnus-method-equal method gnus-select-method))
3734 (defsubst gnus-secondary-method-p (method)
3735 "Return whether METHOD is a secondary select method."
3736 (let ((methods gnus-secondary-select-methods)
3737 (gmethod (inline (gnus-server-get-method nil method))))
3738 (while (and methods
3739 (not (gnus-method-equal
3740 (inline (gnus-server-get-method nil (car methods)))
3741 gmethod)))
3742 (setq methods (cdr methods)))
3743 methods))
3745 (defun gnus-method-simplify (method)
3746 "Return the shortest uniquely identifying string or method for METHOD."
3747 (cond ((stringp method)
3748 method)
3749 ((gnus-native-method-p method)
3750 nil)
3751 ((gnus-secondary-method-p method)
3752 (format "%s:%s" (nth 0 method) (nth 1 method)))
3753 (t
3754 method)))
3756 (defun gnus-groups-from-server (server)
3757 "Return a list of all groups that are fetched from SERVER."
3758 (let ((alist (cdr gnus-newsrc-alist))
3759 info groups)
3760 (while (setq info (pop alist))
3761 (when (gnus-server-equal (gnus-info-method info) server)
3762 (push (gnus-info-group info) groups)))
3763 (sort groups 'string<)))
3765 (defun gnus-group-foreign-p (group)
3766 "Say whether a group is foreign or not."
3767 (and (not (gnus-group-native-p group))
3768 (not (gnus-group-secondary-p group))))
3770 (defun gnus-group-native-p (group)
3771 "Say whether the group is native or not."
3772 (not (string-match ":" group)))
3774 (defun gnus-group-secondary-p (group)
3775 "Say whether the group is secondary or not."
3776 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3778 (defun gnus-parameters-get-parameter (group)
3779 "Return the group parameters for GROUP from `gnus-parameters'."
3780 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3781 case-fold-search
3782 gnus-parameters-case-fold-search))
3783 params-list)
3784 (dolist (elem gnus-parameters)
3785 (when (string-match (car elem) group)
3786 (setq params-list
3787 (nconc (gnus-expand-group-parameters
3788 (car elem) (cdr elem) group)
3789 params-list))))
3790 params-list))
3792 (defun gnus-expand-group-parameter (match value group)
3793 "Use MATCH to expand VALUE in GROUP."
3794 (let ((start (string-match match group)))
3795 (if start
3796 (let ((matched-string (substring group start (match-end 0))))
3797 ;; Build match groups
3798 (string-match match matched-string)
3799 (replace-match value nil nil matched-string))
3800 group)))
3802 (defun gnus-expand-group-parameters (match parameters group)
3803 "Go through PARAMETERS and expand them according to the match data."
3804 (let (new)
3805 (dolist (elem parameters)
3806 (if (and (stringp (cdr elem))
3808 (push (cons (car elem)
3809 (gnus-expand-group-parameter match (cdr elem) group))
3810 new)
3811 (push elem new)))
3812 new))
3814 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3815 "For GROUP, return the value of SYMBOL.
3817 You should call this in the `gnus-group-buffer' buffer.
3818 The function `gnus-group-find-parameter' will do that for you."
3819 ;; The speed trick: No cons'ing and quit early.
3820 (let* ((params (funcall gnus-group-get-parameter-function group))
3821 ;; Start easy, check the "real" group parameters.
3822 (simple-results
3823 (gnus-group-parameter-value params symbol allow-list t)))
3824 (if simple-results
3825 ;; Found results; return them.
3826 (car simple-results)
3827 ;; We didn't find it there, try `gnus-parameters'.
3828 (let ((result nil)
3829 (head nil)
3830 (tail gnus-parameters))
3831 ;; A good old-fashioned non-cl loop.
3832 (while tail
3833 (setq head (car tail)
3834 tail (cdr tail))
3835 ;; The car is regexp matching for matching the group name.
3836 (when (string-match (car head) group)
3837 ;; The cdr is the parameters.
3838 (setq result (gnus-group-parameter-value (cdr head)
3839 symbol allow-list))
3840 (when result
3841 ;; Expand if necessary.
3843 (setq result (gnus-expand-group-parameter (car head)
3844 result group))))))
3845 ;; Done.
3846 result))))
3848 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3849 "Return the group parameters for GROUP.
3850 If SYMBOL, return the value of that symbol in the group parameters.
3852 If you call this function inside a loop, consider using the faster
3853 `gnus-group-fast-parameter' instead."
3854 (with-current-buffer gnus-group-buffer
3855 (if symbol
3856 (gnus-group-fast-parameter group symbol allow-list)
3857 (nconc
3858 (copy-sequence
3859 (funcall gnus-group-get-parameter-function group))
3860 (gnus-parameters-get-parameter group)))))
3862 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3863 "Return the group parameters for GROUP.
3864 If SYMBOL, return the value of that symbol in the group parameters.
3865 If ALLOW-LIST, also allow list as a result.
3866 Most functions should use `gnus-group-find-parameter', which
3867 also examines the topic parameters."
3868 (let ((params (gnus-info-params (gnus-get-info group))))
3869 (if symbol
3870 (gnus-group-parameter-value params symbol allow-list)
3871 params)))
3873 (defun gnus-group-parameter-value (params symbol &optional
3874 allow-list present-p)
3875 "Return the value of SYMBOL in group PARAMS.
3876 If ALLOW-LIST, also allow list as a result."
3877 ;; We only wish to return group parameters (dotted lists) and
3878 ;; not local variables, which may have the same names.
3879 ;; But first we handle single elements...
3880 (or (car (memq symbol params))
3881 ;; Handle alist.
3882 (let (elem)
3883 (catch 'found
3884 (while (setq elem (pop params))
3885 (when (and (consp elem)
3886 (eq (car elem) symbol)
3887 (or allow-list
3888 (atom (cdr elem))))
3889 (throw 'found (if present-p (list (cdr elem))
3890 (cdr elem)))))))))
3892 (defun gnus-group-add-parameter (group param)
3893 "Add parameter PARAM to GROUP."
3894 (let ((info (gnus-get-info group)))
3895 (when info
3896 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3897 ;; Cons the new param to the old one and update.
3898 (gnus-group-set-info (cons param (gnus-info-params info))
3899 group 'params))))
3901 (defun gnus-group-set-parameter (group name value)
3902 "Set parameter NAME to VALUE in GROUP.
3903 GROUP can also be an INFO structure."
3904 (let ((info (if (listp group)
3905 group
3906 (gnus-get-info group))))
3907 (when info
3908 (gnus-group-remove-parameter group name)
3909 (let ((old-params (gnus-info-params info))
3910 (new-params (list (cons name value))))
3911 (while old-params
3912 (when (or (not (listp (car old-params)))
3913 (not (eq (caar old-params) name)))
3914 (setq new-params (append new-params (list (car old-params)))))
3915 (setq old-params (cdr old-params)))
3916 (if (listp group)
3917 (gnus-info-set-params info new-params t)
3918 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3920 (defun gnus-group-remove-parameter (group name)
3921 "Remove parameter NAME from GROUP.
3922 GROUP can also be an INFO structure."
3923 (let ((info (if (listp group)
3924 group
3925 (gnus-get-info group))))
3926 (when info
3927 (let ((params (gnus-info-params info)))
3928 (when params
3929 (setq params (delq name params))
3930 (while (assq name params)
3931 (gnus-alist-pull name params))
3932 (gnus-info-set-params info params))))))
3934 (defun gnus-group-add-score (group &optional score)
3935 "Add SCORE to the GROUP score.
3936 If SCORE is nil, add 1 to the score of GROUP."
3937 (let ((info (gnus-get-info group)))
3938 (when info
3939 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3941 (defun gnus-short-group-name (group &optional levels)
3942 "Collapse GROUP name LEVELS.
3943 Select methods are stripped and any remote host name is stripped down to
3944 just the host name."
3945 (let* ((name "")
3946 (foreign "")
3947 (depth 0)
3948 (skip 1)
3949 (levels (or levels
3950 gnus-group-uncollapsed-levels
3951 (progn
3953 (setq skip (match-end 0)
3954 depth (+ depth 1)))
3955 depth))))
3956 ;; Separate foreign select method from group name and collapse.
3957 ;; If method contains a server, collapse to non-domain server name,
3958 ;; otherwise collapse to select method.
3959 (let* ((colon (string-match ":" group))
3960 (server (and colon (substring group 0 colon)))
3961 (plus (and server (string-match "+" server))))
3962 (when server
3963 (if plus
3964 (setq foreign (substring server (+ 1 plus)
3966 group (substring group (+ 1 colon)))
3967 (setq foreign server
3968 group (substring group (+ 1 colon))))
3969 (setq foreign (concat foreign ":")))
3970 ;; Collapse group name leaving LEVELS uncollapsed elements
3971 (let* ((slist (split-string group "/"))
3972 (slen (length slist))
3974 (dlen (length dlist))
3975 glist
3976 glen
3977 gsep
3978 res)
3979 (if (> slen dlen)
3980 (setq glist slist
3981 glen slen
3982 gsep "/")
3983 (setq glist dlist
3984 glen dlen
3985 gsep "."))
3986 (setq levels (- glen levels))
3987 (dolist (g glist)
3988 (push (if (>= (decf levels) 0)
3989 (if (zerop (length g))
3990 ""
3991 (substring g 0 1))
3992 g)
3993 res))
3994 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3996 (defun gnus-narrow-to-body ()
3997 "Narrow to the body of an article."
3998 (narrow-to-region
3999 (progn
4000 (goto-char (point-min))
4002 (point-max)))
4003 (point-max)))
4005 \f
4006 ;;;
4007 ;;; Kill file handling.
4008 ;;;
4010 (defun gnus-apply-kill-file ()
4011 "Apply a kill file to the current newsgroup.
4012 Returns the number of articles marked as read."
4013 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4014 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4015 (gnus-apply-kill-file-internal)
4016 0))
4018 (defun gnus-kill-save-kill-buffer ()
4019 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4020 (when (get-file-buffer file)
4021 (with-current-buffer (get-file-buffer file)
4022 (when (buffer-modified-p)
4023 (save-buffer))
4024 (kill-buffer (current-buffer))))))
4026 (defcustom gnus-kill-file-name "KILL"
4027 "Suffix of the kill files."
4028 :group 'gnus-score-kill
4029 :group 'gnus-score-files
4030 :type 'string)
4032 (defun gnus-newsgroup-kill-file (newsgroup)
4033 "Return the name of a kill file name for NEWSGROUP.
4034 If NEWSGROUP is nil, return the global kill file name instead."
4035 (cond
4036 ;; The global KILL file is placed at top of the directory.
4037 ((or (null newsgroup)
4038 (string-equal newsgroup ""))
4039 (expand-file-name gnus-kill-file-name
4040 gnus-kill-files-directory))
4041 ;; Append ".KILL" to newsgroup name.
4042 ((gnus-use-long-file-name 'not-kill)
4043 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4044 "." gnus-kill-file-name)
4045 gnus-kill-files-directory))
4046 ;; Place "KILL" under the hierarchical directory.
4047 (t
4048 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4049 "/" gnus-kill-file-name)
4050 gnus-kill-files-directory))))
4052 ;;; Server things.
4054 (defun gnus-member-of-valid (symbol group)
4056 (memq symbol (assoc
4057 (symbol-name (car (gnus-find-method-for-group group)))
4058 gnus-valid-select-methods)))
4060 (defun gnus-method-option-p (method option)
4061 "Return non-nil if select METHOD has OPTION as a parameter."
4062 (when (stringp method)
4063 (setq method (gnus-server-to-method method)))
4064 (memq option (assoc (format "%s" (car method))
4065 gnus-valid-select-methods)))
4067 (defun gnus-similar-server-opened (method)
4068 "Return non-nil if we have a similar server opened.
4069 This is defined as a server with the same name, but different
4070 parameters."
4071 (let ((opened gnus-opened-servers)
4072 open)
4073 (while (and method opened)
4074 (setq open (car (pop opened)))
4075 ;; Type and name are the same...
4076 (when (and (equal (car method) (car open))
4077 (equal (cadr method) (cadr open))
4078 ;; ... but the rest of the parameters differ.
4079 (not (gnus-methods-sloppily-equal method open)))
4080 (setq method nil)))
4081 (not method)))
4083 (defun gnus-server-extend-method (group method)
4084 ;; This function "extends" a virtual server. If the server is
4085 ;; "hello", and the select method is ("hello" (my-var "something"))
4086 ;; in the group "alt.alt", this will result in a new virtual server
4087 ;; called "hello+alt.alt".
4088 (if (or (not (inline (gnus-similar-server-opened method)))
4089 (not (cddr method)))
4090 method
4091 (setq method
4092 `(,(car method) ,(concat (cadr method) "+" group)
4093 (,(intern (format "%s-address" (car method))) ,(cadr method))
4094 ,@(cddr method)))
4095 (push method gnus-extended-servers)
4096 method))
4098 (defun gnus-server-status (method)
4099 "Return the status of METHOD."
4100 (nth 1 (assoc method gnus-opened-servers)))
4102 (defun gnus-group-name-to-method (group)
4103 "Guess a select method based on GROUP."
4104 (if (string-match ":" group)
4105 (let ((server (substring group 0 (match-beginning 0))))
4107 (list (intern (substring server 0 (match-beginning 0)))
4108 (substring server (match-end 0)))
4109 (list (intern server) "")))
4110 gnus-select-method))
4112 (defun gnus-server-string (server)
4113 "Return a readable string that describes SERVER."
4114 (let* ((server (gnus-server-to-method server))
4115 (address (nth 1 server)))
4116 (if (and address
4117 (not (zerop (length address))))
4118 (format "%s using %s" address (car server))
4119 (format "%s" (car server)))))
4121 (defun gnus-same-method-different-name (method)
4122 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4123 (unless (assq slot (cddr method))
4124 (setq method
4125 (append method (list (list slot (nth 1 method)))))))
4126 (let ((methods gnus-extended-servers)
4127 open found)
4128 (while (and (not found)
4129 (setq open (pop methods)))
4130 (when (and (eq (car method) (car open))
4131 (gnus-sloppily-equal-method-parameters method open))
4132 (setq found open)))
4133 found))
4135 (defun gnus-find-method-for-group (group &optional info)
4136 "Find the select method that GROUP uses."
4137 (or gnus-override-method
4138 (and (not group)
4139 gnus-select-method)
4140 (and (not (gnus-group-entry group))
4141 ;; Killed or otherwise unknown group.
4142 (or
4143 ;; If we know a virtual server by that name, return its method.
4144 (gnus-server-to-method (gnus-group-server group))
4145 ;; Guess a new method as last resort.
4146 (gnus-group-name-to-method group)))
4147 (let ((info (or info (gnus-get-info group)))
4148 method)
4149 (if (or (not info)
4150 (not (setq method (gnus-info-method info)))
4151 (equal method "native"))
4152 gnus-select-method
4153 (setq method
4154 (cond ((stringp method)
4155 (inline (gnus-server-to-method method)))
4156 ((stringp (cadr method))
4157 (or
4158 (inline
4159 (gnus-same-method-different-name method))
4160 (inline (gnus-server-extend-method group method))))
4161 (t
4162 method)))
4163 (cond ((equal (cadr method) "")
4164 method)
4165 ((null (cadr method))
4166 (list (car method) ""))
4167 (t
4168 (gnus-server-add-address method)))))))
4170 (defun gnus-methods-using (feature)
4171 "Find all methods that have FEATURE."
4172 (let ((valids gnus-valid-select-methods)
4173 outs)
4174 (while valids
4175 (when (memq feature (car valids))
4176 (push (car valids) outs))
4177 (setq valids (cdr valids)))
4178 outs))
4180 (eval-and-compile
4181 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4183 (defun gnus-read-group (prompt &optional default)
4184 "Prompt the user for a group name.
4185 Disallow invalid group names."
4186 (let ((prefix "")
4187 group)
4188 (while (not group)
4189 (when (string-match
4190 gnus-invalid-group-regexp
4191 (setq group (read-string (concat prefix prompt)
4192 (cons (or default "") 0)
4193 'gnus-group-history)))
4194 (let ((match (match-string 0 group)))
4195 ;; Might be okay (e.g. for nnimap), so ask the user:
4197 (message-y-or-n-p
4198 "Proceed and create group anyway? " t
4201 Usually, it's dangerous to create a group with this name, because it's not
4202 supported by all back ends and servers. On IMAP servers it should work,
4203 though. If you are really sure, you can proceed anyway and create the group.
4205 You may customize the variable `gnus-invalid-group-regexp', which currently is
4209 group nil)))))
4210 group))
4212 (defun gnus-read-method (prompt)
4213 "Prompt the user for a method.
4214 Allow completion over sensible values."
4215 (let* ((open-servers
4216 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4217 gnus-opened-servers))
4218 (valid-methods
4219 (let (methods)
4220 (dolist (method gnus-valid-select-methods)
4221 (if (or (memq 'prompt-address method)
4222 (not (assoc (format "%s:" (car method)) open-servers)))
4223 (push method methods)))
4224 methods))
4225 (servers
4226 (append valid-methods
4227 open-servers
4228 gnus-predefined-server-alist
4229 gnus-server-alist))
4230 (method
4231 (gnus-completing-read
4232 prompt (mapcar 'car servers)
4233 t nil 'gnus-method-history)))
4234 (cond
4235 ((equal method "")
4236 (setq method gnus-select-method))
4237 ((assoc method gnus-valid-select-methods)
4238 (let ((address (if (memq 'prompt-address
4239 (assoc method gnus-valid-select-methods))
4240 (read-string "Address: ")
4241 "")))
4242 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4243 (list (intern method) address))))
4244 ((assoc method servers)
4245 method)
4246 (t
4247 (list (intern method) "")))))
4249 ;;; Agent functions
4251 (defun gnus-agent-method-p (method-or-server)
4252 "Say whether METHOD is covered by the agent."
4253 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4254 (let* ((method (if (stringp method-or-server)
4255 (gnus-server-to-method method-or-server)
4256 method-or-server))
4257 (server (gnus-method-to-server method t)))
4258 (setq gnus-agent-method-p-cache
4259 (cons method-or-server
4260 (member server gnus-agent-covered-methods)))))
4261 (cdr gnus-agent-method-p-cache))
4263 (defun gnus-online (method)
4264 (not
4265 (if gnus-plugged
4266 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4267 (gnus-agent-method-p method))))
4269 ;;; User-level commands.
4271 ;;;###autoload
4272 (defun gnus-slave-no-server (&optional arg)
4273 "Read network news as a slave, without connecting to the local server."
4274 (interactive "P")
4275 (gnus-no-server arg t))
4277 ;;;###autoload
4278 (defun gnus-no-server (&optional arg slave)
4279 "Read network news.
4280 If ARG is a positive number, Gnus will use that as the startup
4281 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4282 non-nil and not a positive number, Gnus will prompt the user for the
4283 name of an NNTP server to use.
4284 As opposed to `gnus', this command will not connect to the local
4285 server."
4286 (interactive "P")
4287 (gnus-no-server-1 arg slave))
4289 ;;;###autoload
4290 (defun gnus-slave (&optional arg)
4291 "Read news as a slave."
4292 (interactive "P")
4293 (gnus arg nil 'slave))
4295 ;;;###autoload
4296 (defun gnus-other-frame (&optional arg display)
4297 "Pop up a frame to read news.
4298 This will call one of the Gnus commands which is specified by the user
4299 option `gnus-other-frame-function' (default `gnus') with the argument
4300 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4301 optional second argument DISPLAY should be a standard display string
4303 omitted or the function `make-frame-on-display' is not available, the
4304 current display is used."
4305 (interactive "P")
4306 (if (fboundp 'make-frame-on-display)
4307 (unless display
4308 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4309 (setq display nil))
4310 (let ((alive (gnus-alive-p)))
4311 (unless (and alive
4312 (catch 'found
4313 (walk-windows
4314 (lambda (window)
4315 (when (and (or (not display)
4316 (equal display
4317 (gnus-frame-or-window-display-name
4318 window)))
4319 (with-current-buffer (window-buffer window)
4321 (symbol-name major-mode))))
4322 (gnus-select-frame-set-input-focus
4323 (setq gnus-other-frame-object (window-frame window)))
4324 (select-window window)
4325 (throw 'found t)))
4326 'ignore t)))
4327 (gnus-select-frame-set-input-focus
4328 (setq gnus-other-frame-object
4329 (if display
4330 (make-frame-on-display display gnus-other-frame-parameters)
4331 (make-frame gnus-other-frame-parameters))))
4332 (if alive
4333 (switch-to-buffer gnus-group-buffer)
4334 (funcall gnus-other-frame-function arg)
4335 (add-hook 'gnus-exit-gnus-hook
4336 '(lambda nil
4337 (when (and (frame-live-p gnus-other-frame-object)
4338 (cdr (frame-list)))
4339 (delete-frame gnus-other-frame-object))
4340 (setq gnus-other-frame-object nil)))))))
4342 ;;;###autoload
4343 (defun gnus (&optional arg dont-connect slave)
4344 "Read network news.
4345 If ARG is non-nil and a positive number, Gnus will use that as the
4346 startup level. If ARG is non-nil and not a positive number, Gnus will
4347 prompt the user for the name of an NNTP server to use."
4348 (interactive "P")
4349 ;; When using the development version of Gnus, load the gnus-load
4350 ;; file.
4351 (unless (string-match "^Gnus" gnus-version)
4352 (load "gnus-load" nil t))
4353 (unless (byte-code-function-p (symbol-function 'gnus))
4354 (message "You should byte-compile Gnus")
4355 (sit-for 2))
4356 (let ((gnus-action-message-log (list nil)))
4357 (gnus-1 arg dont-connect slave)
4358 (gnus-final-warning)))
4360 ;; Allow redefinition of Gnus functions.
4362 (gnus-ems-redefine)
4364 (provide 'gnus)
4366 ;;; gnus.el ends here