| blob | 3f5dc7a38f92196cde7f372cde6dbf25983836c5 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
5 ;; 2010 Free Software Foundation, Inc.
7 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; Keywords: news, mail
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;;; Code:
32 ;; For Emacs <22.2 and XEmacs.
41 ;; These are defined afterwards with gnus-define-group-parameter
55 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
60 "Starting your favorite newsreader."
64 "Dealing with formatting issues."
68 "Group character set issues."
74 "Cache interface."
79 "Article Registry."
83 "Server options at startup."
86 ;; These belong to gnus-group.el.
88 "Group buffers."
93 "Foreign groups."
98 "Automatic subscription of new groups."
102 "Group levels."
107 "Selecting a Group."
112 "Showing slices of the group list."
117 "Sorting the group buffer."
123 "Various group options."
127 ;; These belong to gnus-sum.el.
129 "Summary buffers."
134 "Leaving summary buffers."
139 "Marks used in summary buffers."
144 "Ordering articles according to replies."
149 "Formatting of the summary buffer."
154 "Choosing Articles."
159 "Summary movement commands."
164 "Show pictures of people, domains, and newsgroups."
168 "Mail group commands."
173 "Sorting the summary buffer."
178 "Highlighting and menus in the summary buffer."
184 "Various summary buffer options."
189 "Pick mode in the summary buffer."
195 "Tree display of threads in the summary buffer."
200 ;; Belongs to gnus-uu.el
202 "Viewing extracted files."
206 ;; Belongs to gnus-score.el
208 "Score and kill file handling."
212 "Kill files."
216 "Adaptive score files."
220 "Default values for score files."
224 "Expiring score rules."
228 "Decaying score rules."
232 "Score and kill file names."
237 "Various scoring and killing options."
240 ;; Other
242 "Options controlling the visual fluff."
247 "Offline support for Gnus."
251 "Files used by Gnus."
255 "Auto save file."
260 "Storing Gnus state."
264 "Options related to newsservers and other servers used by Gnus."
268 "Highlighting and menus in the server buffer."
273 "Composing replies and followups in Gnus."
277 "Meta variables controlling major portions of Gnus.
278 In general, modifying these variables does not take affect until Gnus
279 is restarted, and sometimes reloaded."
283 "Other Gnus options."
288 "Exiting Gnus."
293 "Frivolous Gnus extensions."
304 "If non-nil, the startup message will not be displayed.
305 This variable is used before `.gnus.el' is loaded, so it should
306 be set in `.emacs' instead."
335 0 5
344 gnus-mode-line-image-cache)
346 "This is %s, %s."
348 str)
350 line)))
355 ;;(defalias 'gnus-decode-rfc1522 'ignore)
356 )
358 ;; We define these group faces here to avoid the display
359 ;; update forced when creating new faces.
369 ()))
370 "Level 1 newsgroup face."
372 ;; backward-compatibility alias
384 ()))
385 "Level 1 empty newsgroup face."
387 ;; backward-compatibility alias
399 ()))
400 "Level 2 newsgroup face."
402 ;; backward-compatibility alias
414 ()))
415 "Level 2 empty newsgroup face."
417 ;; backward-compatibility alias
429 ()))
430 "Level 3 newsgroup face."
432 ;; backward-compatibility alias
439 ())
442 ())
444 ()))
445 "Level 3 empty newsgroup face."
447 ;; backward-compatibility alias
459 ()))
460 "Level 4 newsgroup face."
462 ;; backward-compatibility alias
469 ())
472 ())
474 ()))
475 "Level 4 empty newsgroup face."
477 ;; backward-compatibility alias
489 ()))
490 "Level 5 newsgroup face."
492 ;; backward-compatibility alias
499 ())
502 ())
504 ()))
505 "Level 5 empty newsgroup face."
507 ;; backward-compatibility alias
519 ()))
520 "Level 6 newsgroup face."
522 ;; backward-compatibility alias
529 ())
532 ())
534 ()))
535 "Level 6 empty newsgroup face."
537 ;; backward-compatibility alias
549 ()))
550 "Low level newsgroup face."
552 ;; backward-compatibility alias
564 ()))
565 "Low level empty newsgroup face."
567 ;; backward-compatibility alias
580 "Level 1 mailgroup face."
582 ;; backward-compatibility alias
595 "Level 1 empty mailgroup face."
597 ;; backward-compatibility alias
610 "Level 2 mailgroup face."
612 ;; backward-compatibility alias
625 "Level 2 empty mailgroup face."
627 ;; backward-compatibility alias
640 "Level 3 mailgroup face."
642 ;; backward-compatibility alias
654 ()))
655 "Level 3 empty mailgroup face."
657 ;; backward-compatibility alias
670 "Low level mailgroup face."
672 ;; backward-compatibility alias
685 "Low level empty mailgroup face."
687 ;; backward-compatibility alias
691 ;; Summary mode faces.
694 "Face used for selected articles."
696 ;; backward-compatibility alias
703 "Face used for cancelled articles."
705 ;; backward-compatibility alias
718 "Face used for high interest ticked articles."
720 ;; backward-compatibility alias
733 "Face used for low interest ticked articles."
735 ;; backward-compatibility alias
747 ()))
748 "Face used for normal interest ticked articles."
750 ;; backward-compatibility alias
763 "Face used for high interest ancient articles."
765 ;; backward-compatibility alias
778 "Face used for low interest ancient articles."
780 ;; backward-compatibility alias
792 ()))
793 "Face used for normal interest ancient articles."
795 ;; backward-compatibility alias
806 "Face used for high interest uncached articles."
808 ;; backward-compatibility alias
819 "Face used for low interest uncached articles."
821 ;; backward-compatibility alias
832 "Face used for normal interest uncached articles."
834 ;; backward-compatibility alias
841 "Face used for high interest unread articles."
843 ;; backward-compatibility alias
850 "Face used for low interest unread articles."
852 ;; backward-compatibility alias
858 ()))
859 "Face used for normal interest unread articles."
861 ;; backward-compatibility alias
876 "Face used for high interest read articles."
878 ;; backward-compatibility alias
893 "Face used for low interest read articles."
895 ;; backward-compatibility alias
907 ()))
908 "Face used for normal interest read articles."
910 ;; backward-compatibility alias
915 ;;;
916 ;;; Gnus buffers
917 ;;;
923 "Do the same as `get-buffer-create', but store the created buffer."
928 "Add the current buffer to the list of Gnus buffers."
932 "Kill BUFFER and remove from the list of Gnus buffers."
939 "Return a list of live Gnus buffers."
948 gnus-buffers)
950 ;;; Splash screen.
963 ()))
964 "Face for the splash screen."
966 ;; backward-compatibility alias
980 "Indent rigidly using only spaces and no tabs."
986 ;; We translate tabs into spaces -- not everybody uses
987 ;; an 8-character tab.
992 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1016 "*Color styles used for the Gnus logo."
1018 gnus-logo-color-alist))
1028 "Insert startup message in current buffer."
1029 ;; Insert the message.
1034 ;; Make sure the library defining `image-load-path' is
1035 ;; loaded (`find-image' is autoloaded) (and discard the
1036 ;; result). Else, we may get "defvar ignored because
1037 ;; image-load-path is let-bound" when calling `find-image'
1038 ;; below.
1048 :color-symbols
1054 ;; Account for the pbm's background.
1058 ;; Account for the xbm's background.
1069 t)))
1072 _ ___ _ _
1073 _ ___ __ ___ __ _ ___
1074 __ _ ___ __ ___
1075 _ ___ _
1076 _ _ __ _
1077 ___ __ _
1078 __ _
1079 _ _ _
1080 _ _ _
1081 _ _ _
1082 __ ___
1083 _ _ _ _
1084 _ _
1085 _ _
1086 _ _
1087 _
1088 __
1091 ;; And then hack it.
1100 ;; Fontify some.
1113 ;;; Do the rest.
1119 "Alist of group parameters.
1121 For example:
1123 (gnus-use-scoring nil)
1124 (gnus-summary-line-format
1126 (gcc-self . t)
1127 (display . all))
1130 (broken-reply-to . t)))"
1137 "If it is t, ignore case of group names specified in `gnus-parameters'.
1138 If it is nil, don't ignore case. If it is `default', which is for the
1139 backward compatibility, use the value of `case-fold-search'."
1150 "Define a group parameter PARAM.
1151 REST is a plist of following:
1152 :type One of `bool', `list' or nil.
1153 :function The name of the function.
1154 :function-document The documentation of the function.
1155 :parameter-type The type for customizing the parameter.
1156 :parameter-document The documentation for the parameter.
1157 :variable The name of the variable.
1158 :variable-document The documentation for the variable.
1159 :variable-group The group for customizing the variable.
1160 :variable-type The type for customizing the variable.
1161 :variable-default The default value of the variable."
1178 'progn
1180 ,variable-document
1186 gnus-group-parameters-more))
1189 ,parameter-type
1193 ,function-document
1195 val)
1198 t)
1203 (,variable
1205 elem value)
1213 ,function-document
1217 elem value)
1224 'value
1229 All other Gnus file and directory variables are initialized from this variable."
1235 "*Directory variable from which all other Gnus file variables are derived.
1237 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1238 This means that other directory variables that are initialized from
1239 this variable won't be set properly if you set this variable in `.gnus.el'.
1240 Set this variable in `.emacs' instead."
1245 "*Default directory for all Gnus buffers."
1248 directory))
1250 ;; Site dependent variables. These variables should be defined in
1251 ;; paths.el.
1254 "Specify a default NNTP server.
1255 This variable should be defined in paths.el, and should never be set
1256 by the user.
1257 If you want to change servers, you should use `gnus-select-method'.
1261 "A file with only the name of the nntp server in it."
1267 "Find default nntp server.
1268 Check the NNTPSERVER environment variable and the
1269 `gnus-nntpserver-file' file."
1277 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1278 ;; starting or even loading Gnus.
1279 ;;;###autoload(when (fboundp 'custom-autoload)
1280 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1286 gnus-default-nntp-server)
1288 "Default method for selecting a newsgroup.
1289 This variable should be a list, where the first element is how the
1290 news is to be fetched, the second is the address.
1293 NNTP, you could say:
1297 If you want to use your local spool, say:
1299 \(setq gnus-select-method (list 'nnspool (system-name)))
1301 If you use this variable, you must set `gnus-nntp-server' to nil.
1303 There is a lot more to know about select methods and virtual servers -
1304 see the manual for details."
1311 "*Method used for archiving messages you've sent.
1312 This should be a mail method.
1314 See also `gnus-update-message-archive-method'."
1318 gnus-select-method))
1323 The archive method is initially set according to the value of
1325 so that it may be used as a real method of the server which is named
1327 updated if the value of this variable is nil, even if you change the
1328 value of `gnus-message-archive-method' afterward. If you want the
1330 `gnus-message-archive-method', set this variable to a non-nil value."
1337 "*Name of the group in which to save the messages you've written.
1338 This can either be a string; a list of strings; or an alist
1339 of regexps/functions/forms to be evaluated to return a string (or a list
1340 of strings). The functions are called with the name of the current
1341 group (or nil) as a parameter.
1343 If you want to save your mail in one group and the news articles you
1344 write in another group, you could say something like:
1346 \(setq gnus-message-archive-group
1347 '((if (message-news-p)
1351 Normally the group names returned by this variable should be
1353 However, you may wish to store the message on some other server. In
1354 that case, just return a fully prefixed name of the group --
1362 function
1363 sexp
1364 string))
1367 "List of NNTP servers that the user can choose between interactively.
1368 To make Gnus query you for a server, you have to give `gnus' a
1369 non-numeric prefix - `C-u M-x gnus', in short."
1375 "The name of the host running the NNTP server."
1378 string))
1382 "A list of secondary methods that will be used for reading news.
1383 This is a list where each element is a complete select method (see
1384 `gnus-select-method').
1386 If, for instance, you want to read your mail with the nnml back end,
1387 you could set this variable:
1394 "Local domain name without a host name.
1395 The DOMAINNAME environment variable is used instead if it is defined.
1396 If the function `system-name' returns the full Internet name, there is
1397 no need to set this variable."
1400 string))
1404 "String with a description of what organization (if any) the user belongs to.
1407 ;; Customization variables
1410 "Preferred method for fetching an article by Message-ID.
1411 If you are reading news from the local spool (with nnspool), fetching
1412 articles by Message-ID is painfully slow. By setting this method to an
1413 nntp method, you might get acceptable results.
1415 The value of this variable must be a valid select method as discussed
1416 in the documentation of `gnus-select-method'.
1418 It can also be a list of select methods, as well as the special symbol
1419 `current', which means to use the current select method. If it is a
1420 list, Gnus will try all the methods in the list until it finds a match."
1426 gnus-select-method
1434 gnus-select-method))))
1437 "*Non-nil means that cross referenced articles will be marked as read.
1438 If nil, ignore cross references. If t, mark articles as read in
1439 subscribed newsgroups. If neither t nor nil, mark as read in all
1440 newsgroups."
1448 "*Process mark."
1454 "*The number of articles which indicates a large newsgroup.
1455 If the number of articles in a newsgroup is greater than this value,
1456 confirmation is required for selecting the newsgroup.
1457 If it is nil, no confirmation is required.
1459 Also see `gnus-large-ephemeral-newsgroup'."
1462 integer))
1465 "Non-nil means that the default name of a file to save articles in is the group name.
1466 If it's nil, the directory form of the group name is used instead.
1468 If this variable is a list, and the list contains the element
1469 `not-score', long file names will not be used for score files; if it
1470 contains the element `not-save', long file names will not be used for
1471 saving; and if it contains the element `not-kill', long file names
1472 will not be used for kill files.
1474 Note that the default for this variable varies according to what system
1475 type you're using. On `usg-unix-v' this variable defaults to nil while
1476 on all other systems it defaults to t."
1494 "*If non-nil, save group scoring info."
1500 "*If non-nil, allow undoing in Gnus group mode buffers."
1505 "*If non-nil, use some adaptive scoring scheme.
1506 If a list, then the values `word' and `line' are meaningful. The
1507 former will perform adaption on individual words in the subject
1508 header while `line' will perform adaption on several headers."
1514 "*If nil, Gnus will ignore the article cache.
1515 If `passive', it will allow entering (and reading) articles
1516 explicitly entered into the cache. If anything else, use the
1517 cache to the full extent of the law."
1525 "*If non-nil, display a thread tree buffer."
1530 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1531 If it is a number N, then Gnus will only keep the last N articles
1532 read. If it is neither nil nor a number, Gnus will keep all read
1533 articles. This is not a good idea."
1536 integer
1541 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1546 "*If non-nil, enable scoring."
1552 "*A hook called when preparing to exit from the summary buffer.
1553 It calls `gnus-summary-expire-articles' by default."
1558 "*Non-nil means that you are a Usenet novice.
1559 If non-nil, verbose messages may be displayed and confirmations may be
1560 required."
1565 "*Non-nil means that you will never be asked for confirmation about anything.
1566 That doesn't mean *anything* anything; particularly destructive
1567 commands will still require prompting."
1572 "*If non-nil, require your confirmation when catching up a group."
1577 "*If non-nil, require your confirmation when exiting Gnus."
1582 "*Function for extracting address components from a From header.
1583 Two pre-defined function exist: `gnus-extract-address-components',
1584 which is the default, quite fast, and too simplistic solution, and
1585 `mail-extract-address-components', which works much better, but is
1586 slower."
1593 "String used to separate shell commands."
1617 "*An alist of valid select methods.
1618 The first element of each list lists should be a string with the name
1619 of the select method. The other elements may be the category of
1620 this method (i. e., `post', `mail', `none' or whatever) or other
1621 properties that this method has (like being respoolable).
1622 If you implement a new select method, all you should have to change is
1623 this variable. I think."
1639 "Recomputes the select-method widget based on the value of
1640 `gnus-valid-select-methods'."
1642 "Widget for entering a select method."
1649 gnus-valid-select-methods)
1653 :inline t
1655 variable
1661 "List of buffers that should update their mode lines.
1662 The list may contain the symbols `group', `article', `tree' and
1663 `summary'. If the corresponding symbol is present, Gnus will keep
1664 that mode line updated with information that may be pertinent.
1665 If this variable is nil, screen refresh may be quicker."
1673 "*Max length of mode-line non-string contents.
1674 If this is nil, Gnus will take space as is needed, leaving the rest
1675 of the mode line intact."
1679 integer))
1681 ;; There should be special validation for this.
1686 to-address
1687 :function-document
1688 "Return GROUP's to-address."
1689 :variable-document
1690 "*Alist of group regexps and correspondent to-addresses."
1691 :variable-group gnus-group-parameter
1694 This will be used when doing followups and posts.
1696 This is primarily useful in mail groups that represent closed
1697 mailing lists--mailing lists where it's expected that everybody that
1698 writes to the mailing list is subscribed to it. Since using this
1699 parameter ensures that the mail only goes to the mailing list itself,
1700 it means that members won't receive two copies of your followups.
1702 Using `to-address' will actually work whether the group is foreign or
1703 not. Let's say there's a group on the server that is called
1704 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1705 articles from a mail-to-news gateway. Posting directly to this group
1706 is therefore impossible--you have to send mail to the mailing list
1707 address instead.
1709 The gnus-group-split mail splitting mechanism will behave as if this
1713 to-list
1714 :function-document
1715 "Return GROUP's to-list."
1716 :variable-document
1717 "*Alist of group regexps and correspondent to-lists."
1718 :variable-group gnus-group-parameter
1721 This address will be used when doing a `a' in the group.
1723 It is totally ignored when doing a followup--except that if it is
1724 present in a news group, you'll get mail group semantics when doing
1725 `f'.
1727 The gnus-group-split mail splitting mechanism will behave as if this
1731 subscribed
1732 :type bool
1733 :function-document
1734 "Return GROUP's subscription status."
1735 :variable-document
1736 "*Groups which are automatically considered subscribed."
1737 :variable-group gnus-group-parameter
1740 Gnus assumed that you are subscribed to the To/List address.
1742 When constructing a list of subscribed groups using
1743 `gnus-find-subscribed-addresses', Gnus includes the To address given
1747 auto-expire
1748 :type bool
1749 :function gnus-group-auto-expirable-p
1750 :function-document
1751 "Check whether GROUP is auto-expirable or not."
1752 :variable gnus-auto-expirable-newsgroups
1753 :variable-default nil
1754 :variable-document
1755 "*Groups in which to automatically mark read articles as expirable.
1756 If non-nil, this should be a regexp that should match all groups in
1757 which to perform auto-expiry. This only makes sense for mail groups."
1758 :variable-group nnmail-expire
1760 regexp)
1762 :parameter-document
1766 total-expire
1767 :type bool
1768 :function gnus-group-total-expirable-p
1769 :function-document
1770 "Check whether GROUP is total-expirable or not."
1771 :variable gnus-total-expirable-newsgroups
1772 :variable-default nil
1773 :variable-document
1774 "*Groups in which to perform expiry of all read articles.
1775 Use with extreme caution. All groups that match this regexp will be
1776 expiring - which means that all read articles will be deleted after
1777 \(say) one week. (This only goes for mail groups and the like, of
1778 course.)"
1779 :variable-group nnmail-expire
1781 regexp)
1783 :parameter-document
1784 "All read articles will be put through the expiry process
1786 This happens even if they are not marked as expirable.
1790 charset
1791 :function-document
1792 "Return the default charset of GROUP."
1793 :variable gnus-group-charset-alist
1794 :variable-default
1807 :variable-document
1808 "Alist of regexps (to match group names) and default charsets to be used when reading."
1809 :variable-group gnus-charset
1817 post-method
1818 :type list
1819 :function-document
1820 "Return a posting method for GROUP."
1821 :variable gnus-post-method-alist
1822 :variable-document
1823 "Alist of regexps (to match group names) and method to be used when
1824 posting an article."
1825 :variable-group gnus-group-foreign
1826 :parameter-type
1834 :parameter-document
1838 large-newsgroup-initial
1839 :type integer
1840 :function-document
1841 "Return GROUP's initial input of the number of articles."
1842 :variable-document
1843 "*Alist of group regexps and its initial input of the number of articles."
1844 :variable-group gnus-group-parameter
1850 This number will be prompted as the initial value of the number of
1851 articles to list when the group is a large newsgroup (see
1852 `gnus-large-newsgroup'). If it is nil, the default value is the
1855 ;; The Gnus registry's ignored groups
1857 registry-ignore
1858 :type list
1859 :function-document
1860 "Whether this group should be ignored by the registry."
1861 :variable gnus-registry-ignored-groups
1862 :variable-default nil
1863 :variable-document
1864 "*Groups in which the registry should be turned off."
1865 :variable-group gnus-registry
1872 :parameter-document
1875 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1877 "*Disable the group parameters for spam detection.
1878 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1885 "Spam group classification (requires spam.el).
1886 This group contains spam messages. On summary entry, unread messages
1887 will be marked as spam. On summary exit, the specified spam
1888 processors will be invoked on spam-marked messages, then those
1889 messages will be expired, so the spam processor will only see a
1893 "The ham value for the spam group parameter (requires spam.el).
1894 On summary exit, the specified ham processors will be invoked on
1895 ham-marked messages. Exercise caution, since the ham processor will
1896 see the same message more than once because there is no ham message
1900 spam-contents
1901 :type list
1902 :function-document
1903 "The spam type (spam, ham, or neither) of the group."
1904 :variable gnus-spam-newsgroup-contents
1905 :variable-default nil
1906 :variable-document
1907 "*Group classification (spam, ham, or neither). Only
1908 meaningful when spam.el is loaded. If non-nil, this should be a
1909 list of group name regexps associated with a classification for
1910 each one. In spam groups, new articles are marked as spam on
1911 summary entry. There is other behavior associated with ham and
1912 no classification when spam.el is loaded - see the manual."
1913 :variable-group spam
1927 :parameter-document
1928 "The spam classification (spam, ham, or neither) of this group.
1929 When a spam group is entered, all unread articles are marked as
1930 spam. There is other behavior associated with ham and no
1934 spam-resend-to
1935 :type list
1936 :function-document
1937 "The address to get spam resent (through spam-report-resend)."
1938 :variable gnus-spam-resend-to
1939 :variable-default nil
1940 :variable-document
1941 "The address to get spam resent (through spam-report-resend)."
1942 :variable-group spam
1946 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1947 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1948 :parameter-document
1952 ham-resend-to
1953 :type list
1954 :function-document
1955 "The address to get ham resent (through spam-report-resend)."
1956 :variable gnus-ham-resend-to
1957 :variable-default nil
1958 :variable-document
1959 "The address to get ham resent (through spam-report-resend)."
1960 :variable-group spam
1964 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1965 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1966 :parameter-document
1982 "OBSOLETE: The Gmane reporting summary exit spam processor.
1989 "OBSOLETE: The ifile summary exit ham processor.
1993 "OBSOLETE: The Bogofilter summary exit ham processor.
1997 "OBSOLETE: The spam-stat summary exit ham processor.
2001 "OBSOLETE: The whitelist summary exit ham processor.
2005 "OBSOLETE: The BBDB summary exit ham processor.
2009 "OBSOLETE: The ham copy exit ham processor.
2013 "OBSOLETE: The spamoracle summary exit ham processor.
2017 spam-process
2018 :type list
2019 :parameter-type
2022 :value nil
2059 :function-document
2060 "Which spam or ham processors will be applied when the summary is exited."
2061 :variable gnus-spam-process-newsgroups
2062 :variable-default nil
2063 :variable-document
2064 "*Groups in which to automatically process spam or ham articles with
2065 a backend on summary exit. If non-nil, this should be a list of group
2066 name regexps that should match all groups in which to do automatic
2067 spam processing, associated with the appropriate processor."
2068 :variable-group spam
2069 :variable-type
2110 :parameter-document
2114 spam-autodetect
2115 :type list
2116 :parameter-type
2118 :function-document
2119 "Should spam be autodetected (with spam-split) in this group?"
2120 :variable gnus-spam-autodetect
2121 :variable-default nil
2122 :variable-document
2123 "*Groups in which spam should be autodetected when they are entered.
2124 Only unseen articles will be examined, unless
2125 spam-autodetect-recheck-messages is set."
2126 :variable-group spam
2127 :variable-type
2132 boolean))
2133 :parameter-document
2134 "Spam autodetection.
2135 Only unseen articles will be examined, unless
2139 spam-autodetect-methods
2140 :type list
2141 :parameter-type
2164 :function-document
2165 "Methods to be used for autodetection in each group"
2166 :variable gnus-spam-autodetect-methods
2167 :variable-default nil
2168 :variable-document
2169 "*Methods for autodetecting spam per group.
2170 Requires the spam-autodetect parameter. Only unseen articles
2171 will be examined, unless spam-autodetect-recheck-messages is
2172 set."
2173 :variable-group spam
2174 :variable-type
2201 :parameter-document
2202 "Spam autodetection methods.
2203 Requires the spam-autodetect parameter. Only unseen articles
2204 will be examined, unless spam-autodetect-recheck-messages is
2208 spam-process-destination
2209 :type list
2210 :parameter-type
2216 :function-document
2217 "Where spam-processed articles will go at summary exit."
2218 :variable gnus-spam-process-destinations
2219 :variable-default nil
2220 :variable-document
2221 "*Groups in which to explicitly send spam-processed articles to
2222 another group, or expire them (the default). If non-nil, this should
2223 be a list of group name regexps that should match all groups in which
2224 to do spam-processed article moving, associated with the destination
2225 group or nil for explicit expiration. This only makes sense for
2226 mail groups."
2227 :variable-group spam
2228 :variable-type
2239 :parameter-document
2243 ham-process-destination
2244 :type list
2245 :parameter-type
2253 :function-document
2254 "Where ham articles will go at summary exit from a spam group."
2255 :variable gnus-ham-process-destinations
2256 :variable-default nil
2257 :variable-document
2258 "*Groups in which to explicitly send ham articles to
2259 another group, or do nothing (the default). If non-nil, this should
2260 be a list of group name regexps that should match all groups in which
2261 to do ham article moving, associated with the destination
2262 group or nil for explicit ignoring. This only makes sense for
2263 mail groups, and only works in spam groups."
2264 :variable-group spam
2265 :variable-type
2277 :parameter-document
2281 ham-marks
2292 :parameter-document
2293 "Marks considered ham (positively not spam). Such articles will be
2294 processed as ham (non-spam) on group exit. When nil, the global
2295 spam-ham-marks variable takes precedence."
2297 gnus-read-mark
2298 gnus-killed-mark
2299 gnus-kill-file-mark
2300 gnus-low-score-mark))))
2301 :variable-group spam
2302 :variable-document
2306 spam-marks
2315 :parameter-document
2316 "Marks considered spam.
2317 Such articles will be processed as spam on group exit. When nil, the global
2318 spam-spam-marks variable takes precedence."
2320 :variable-group spam
2321 :variable-document
2325 "Number of group name elements to leave alone when making a short group name."
2330 "*If non-nil, once you set a level, Gnus will use this level."
2334 ;; Hooks.
2337 "A hook run while Gnus is loaded."
2342 "A hook called to apply kill files to a group.
2343 This hook is intended to apply a kill file to the selected newsgroup.
2344 The function `gnus-apply-kill-file' is called by default.
2346 Since a general kill file is too heavy to use only for a few
2347 newsgroups, I recommend you to use a lighter hook function. For
2348 example, if you'd like to apply a kill file to articles which contains
2349 a string `rmgroup' in subject in newsgroup `control', you can use the
2350 following hook:
2352 (setq gnus-apply-kill-hook
2353 (list
2354 (lambda ()
2363 "Function run when a group level is changed.
2364 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2367 function))
2369 ;;; Face thingies.
2373 mouse-face
2374 summary-menu group-menu article-menu
2375 tree-highlight menu highlight
2376 browse-menu server-menu
2377 page-marker tree-menu binary-menu pick-menu)
2378 "*Enable visual features.
2379 If `visual' is disabled, there will be no menus and few faces. Most of
2380 the visual customization options below will be ignored. Gnus will use
2381 less space and be faster as a result.
2383 This variable can also be a list of visual elements to switch on. For
2384 instance, to switch off all visual things except menus, you can say:
2386 (setq gnus-visual '(menu))
2388 Valid elements include `summary-highlight', `group-highlight',
2389 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2390 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2391 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2411 ;; Byte-compiler warning.
2413 ;; Find out whether the gnus-visual TYPE is wanted.
2417 gnus-visual
2421 t))))
2431 "*Face used for group or summary buffer mouse highlighting.
2432 The line beneath the mouse pointer will be highlighted with this
2433 face."
2446 "Controls use of the agent cache while plugged.
2447 When set, Gnus will prefer using the locally stored content rather
2448 than re-fetching it from the server. You also need to enable
2449 `gnus-agent' for this to have any affect."
2455 "Default charset assumed to be used when viewing non-ASCII characters.
2456 This variable is overridden on a group-to-group basis by the
2457 `gnus-group-charset-alist' variable and is only used on groups not
2458 covered by that variable."
2462 ;; Fixme: Doc reference to agent.
2464 "Whether we want to use the Gnus agent or not.
2466 You may customize gnus-agent to disable its use. However, some
2467 back ends have started to use the agent as a client-side cache.
2468 Disabling the agent may result in noticeable loss of performance."
2474 "Function called by the command `gnus-other-frame'."
2482 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2483 This should be an alist for Emacs, or a plist for XEmacs."
2494 "Which information should be exposed in the User-Agent header.
2496 Can be a list of symbols or a string. Valid symbols are `gnus'
2497 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2498 addition to the Emacs version, you can add `codename' \(show
2499 \(S\)XEmacs codename\) or either `config' \(show system
2500 configuration\) or `type' \(show system type\). If you set it to
2501 a string, be sure to use a valid format, see RFC 2616."
2514 ;; Convert old (< 2005-01-10) symbol type values:
2533 \f
2534 ;;; Internal variables
2539 ; Reset each time gnus-agent-covered-methods is changed else
2540 ; gnus-agent-method-p may mis-report a methods status.
2541 )
2551 ;; The carpal mode has been removed, but define the variable for
2552 ;; backwards compatability.
2571 ;; Variable holding the user answers to all method prompts.
2574 ;; Variable holding the user answers to all mail method prompts.
2577 ;; Variable holding the user answers to all group prompts.
2585 "*The directory where cached articles will be stored."
2591 nnspool "cache"
2615 ;; Propagate flags to server, with the following exceptions:
2616 ;; `seen' is private to each gnus installation
2617 ;; `cache' is a internal gnus flag for each gnus installation
2618 ;; `download' is a agent flag private to each gnus installation
2619 ;; `unsend' are for nndraft groups only
2620 ;; `score' is not a proper mark
2621 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2624 "Marks that shouldn't be propagated to back ends.
2625 Typical marks are those that make no sense in a standalone back end,
2626 such as a mark that says whether an article is stored in the cache
2639 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2664 gnus-newsrc-last-checked-date
2665 gnus-newsrc-alist gnus-server-alist
2666 gnus-killed-list gnus-zombie-list
2667 gnus-topic-topology gnus-topic-alist
2668 gnus-format-specs)
2672 "Assoc list of read articles.
2676 "Assoc list of registry data.
2703 ;; Save window configuration.
2716 ;;; End of variables.
2718 ;; Define some autoload functions Gnus might use.
2721 ;; This little mapcar goes through the list below and marks the
2722 ;; symbols in question as autoloaded functions.
2742 message-send-and-exit message-yank-original)
2746 ;; This is only used in message.el, which has an autoload.
2748 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2750 ;; Next two only used in gnus-util.
2751 rmail-summary-exists rmail-select-summary)
2752 ;; Only used in gnus-util, which has an autoload.
2757 gnus-Folder-save-name gnus-folder-save-name)
2760 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2761 gnus-demon-add-disconnection gnus-demon-add-handler
2762 gnus-demon-remove-handler)
2764 gnus-demon-init gnus-demon-cancel)
2766 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2767 gnus-face-from-file)
2769 gnus-tree-open gnus-tree-close)
2771 gnus-server-server-name)
2774 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2775 gnus-article-hide-citation gnus-article-fill-cited-article
2776 gnus-article-hide-citation-in-followups
2777 gnus-article-fill-cited-long-lines)
2779 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2780 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2782 gnus-cache-possibly-remove-articles gnus-cache-request-article
2783 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2784 gnus-cache-enter-remove-article gnus-cached-article-p
2785 gnus-cache-open gnus-cache-close gnus-cache-update-article
2786 gnus-cache-articles-in-group)
2788 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2790 gnus-summary-increase-score gnus-summary-set-score
2791 gnus-summary-raise-thread gnus-summary-raise-same-subject
2792 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2793 gnus-summary-lower-thread gnus-summary-lower-same-subject
2794 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2795 gnus-summary-current-score gnus-score-delta-default
2796 gnus-score-flush-cache gnus-score-close
2797 gnus-possibly-score-headers gnus-score-followup-article
2798 gnus-score-followup-thread)
2801 gnus-current-score-file-nondirectory gnus-score-adaptive
2802 gnus-score-find-trace gnus-score-file-name)
2806 gnus-subscribe-topics)
2810 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2811 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2812 gnus-uu-mark-by-regexp gnus-uu-mark-all
2813 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2814 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2815 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2816 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2817 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2818 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2819 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2820 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2823 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2825 gnus-group-post-news gnus-group-mail gnus-group-news
2826 gnus-summary-post-news gnus-summary-news-other-window
2827 gnus-summary-followup gnus-summary-followup-with-original
2828 gnus-summary-cancel-article gnus-summary-supersede-article
2829 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2830 gnus-summary-mail-forward gnus-summary-mail-other-window
2831 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2832 gnus-summary-wide-reply gnus-summary-followup-to-mail
2833 gnus-summary-followup-to-mail-with-original gnus-bug
2834 gnus-summary-wide-reply-with-original
2835 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2836 gnus-summary-post-forward)
2841 gnus-list-of-unread-articles gnus-list-of-read-articles
2842 gnus-offer-save-summaries gnus-make-thread-indent-array
2843 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2844 gnus-summary-skip-intangible gnus-summary-article-number
2845 gnus-data-header gnus-data-find)
2847 gnus-group-list-groups gnus-group-first-unread-group
2848 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2849 gnus-group-setup-buffer gnus-group-get-new-news
2850 gnus-group-make-help-group gnus-group-update-group
2851 gnus-group-iterate gnus-group-group-name)
2853 gnus-backlog-remove-article)
2855 gnus-article-prepare gnus-article-set-window-start
2856 gnus-article-next-page gnus-article-prev-page
2857 gnus-request-article-this-buffer gnus-article-mode
2858 gnus-article-setup-buffer gnus-narrow-to-page
2859 gnus-article-delete-invisible-text gnus-treat-article)
2861 gnus-article-hide-headers gnus-article-hide-boring-headers
2862 gnus-article-treat-overstrike
2863 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2864 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2865 gnus-article-de-base64-unreadable
2866 gnus-article-decode-HZ
2867 gnus-article-wash-html
2868 gnus-article-unsplit-urls
2869 gnus-article-hide-pem gnus-article-hide-signature
2870 gnus-article-strip-leading-blank-lines gnus-article-date-local
2871 gnus-article-date-original gnus-article-date-lapsed
2872 ;;gnus-article-show-all-headers
2873 gnus-article-edit-mode gnus-article-edit-article
2874 gnus-article-edit-done gnus-article-decode-encoded-words
2875 gnus-start-date-timer gnus-stop-date-timer
2876 gnus-mime-view-all-parts)
2880 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2881 gnus-check-reasonable-setup)
2883 gnus-dup-enter-articles)
2889 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2890 gnus-async-halt-prefetch)
2892 gnus-agent-save-active gnus-agent-method-p
2893 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2894 gnus-summary-set-agent-mark gnus-agent-save-group-info
2895 gnus-agent-request-article gnus-agent-retrieve-headers)
2897 gnus-unplugged gnus-agentize gnus-agent-batch)
2899 gnus-summary-save-article-vm)
2904 gnus-group-split-update)
2907 ;;; gnus-sum.el thingies
2911 "*The format specification of the lines in the summary buffer.
2913 It works along the same lines as a normal formatting string,
2914 with some simple extensions.
2916 %N Article number, left padded with spaces (string)
2917 %S Subject (string)
2919 %n Name of the poster (string)
2920 %a Extracted name of the poster (string)
2921 %A Extracted address of the poster (string)
2922 %F Contents of the From: header (string)
2923 %f Contents of the From: or To: headers (string)
2924 %x Contents of the Xref: header (string)
2925 %D Date of the article (string)
2926 %d Date of the article (string) in DD-MMM format
2927 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2928 %M Message-id of the article (string)
2929 %r References of the article (string)
2930 %c Number of characters in the article (integer)
2931 %k Pretty-printed version of the above (string)
2933 %L Number of lines in the article (integer)
2934 %I Indentation based on thread level (a string of spaces)
2935 %B A complex trn-style thread tree (string)
2936 The variables `gnus-sum-thread-*' can be used for customization.
2937 %T A string with two possible values: 80 spaces if the article
2938 is on thread level two or larger and 0 spaces on level one
2943 %> Spaces of length thread-level (string)
2944 %< Spaces of length (- 20 thread-level) (string)
2945 %i Article score (number)
2946 %z Article zcore (character)
2947 %t Number of articles under the current thread (number).
2948 %e Whether the thread is empty or not (character).
2949 %V Total thread score (number).
2950 %P The line number (number).
2951 %O Download mark (character).
2952 %* If present, indicates desired cursor position
2953 (instead of after first colon).
2954 %u User defined specifier. The next character in the format string should
2955 be a letter. Gnus will call the function gnus-user-format-function-X,
2956 where X is the letter following %u. The function will be passed the
2957 current header as argument. The function should return a string, which
2958 will be inserted into the summary just like information from any other
2959 summary specifier.
2961 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2962 with care. For reasons of efficiency, Gnus will compute what column
2964 it is invalid to have these specs after a variable-length spec. Well,
2965 you might not be arrested, but your summary buffer will look strange,
2966 which is bad enough.
2968 The smart choice is to have these specs as far to the left as
2969 possible.
2971 This restriction may disappear in later versions of Gnus.
2973 General format specifiers can also be used.
2974 See Info node `(gnus)Formatting Variables'."
2979 ;;;
2980 ;;; Skeleton keymaps
2981 ;;;
2986 (while keys
2987 (define-key keymap (pop keys) 'undefined))))
2989 (defvar gnus-article-mode-map
2990 (let ((keymap (make-sparse-keymap)))
2991 (gnus-suppress-keymap keymap)
2992 keymap))
2993 (defvar gnus-summary-mode-map
2994 (let ((keymap (make-keymap)))
2995 (gnus-suppress-keymap keymap)
2996 keymap))
2997 (defvar gnus-group-mode-map
2998 (let ((keymap (make-keymap)))
2999 (gnus-suppress-keymap keymap)
3000 keymap))
3002 \f
3004 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3005 ;; If you want the cursor to go somewhere else, set these two
3006 ;; functions in some startup hook to whatever you want.
3007 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3008 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3010 ;;; Various macros and substs.
3012 (defun gnus-header-from (header)
3013 (mail-header-from header))
3015 (defmacro gnus-gethash (string hashtable)
3016 "Get hash value of STRING in HASHTABLE."
3017 `(symbol-value (intern-soft ,string ,hashtable)))
3019 (defmacro gnus-gethash-safe (string hashtable)
3020 "Get hash value of STRING in HASHTABLE.
3021 Return nil if not defined."
3022 `(let ((sym (intern-soft ,string ,hashtable)))
3023 (and (boundp sym) (symbol-value sym))))
3025 (defmacro gnus-sethash (string value hashtable)
3026 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3027 `(set (intern ,string ,hashtable) ,value))
3028 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3030 (defmacro gnus-group-unread (group)
3031 "Get the currently computed number of unread articles in GROUP."
3032 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3034 (defmacro gnus-group-entry (group)
3035 "Get the newsrc entry for GROUP."
3036 `(gnus-gethash ,group gnus-newsrc-hashtb))
3038 (defmacro gnus-active (group)
3039 "Get active info on GROUP."
3040 `(gnus-gethash ,group gnus-active-hashtb))
3042 (defmacro gnus-set-active (group active)
3043 "Set GROUP's active info."
3044 `(gnus-sethash ,group ,active gnus-active-hashtb))
3046 ;; Info access macros.
3048 (defmacro gnus-info-group (info)
3049 `(nth 0 ,info))
3050 (defmacro gnus-info-rank (info)
3051 `(nth 1 ,info))
3052 (defmacro gnus-info-read (info)
3053 `(nth 2 ,info))
3054 (defmacro gnus-info-marks (info)
3055 `(nth 3 ,info))
3056 (defmacro gnus-info-method (info)
3057 `(nth 4 ,info))
3058 (defmacro gnus-info-params (info)
3059 `(nth 5 ,info))
3061 (defmacro gnus-info-level (info)
3062 `(let ((rank (gnus-info-rank ,info)))
3063 (if (consp rank)
3064 (car rank)
3065 rank)))
3066 (defmacro gnus-info-score (info)
3067 `(let ((rank (gnus-info-rank ,info)))
3068 (or (and (consp rank) (cdr rank)) 0)))
3070 (defmacro gnus-info-set-group (info group)
3071 `(setcar ,info ,group))
3072 (defmacro gnus-info-set-rank (info rank)
3073 `(setcar (nthcdr 1 ,info) ,rank))
3074 (defmacro gnus-info-set-read (info read)
3075 `(setcar (nthcdr 2 ,info) ,read))
3076 (defmacro gnus-info-set-marks (info marks &optional extend)
3077 (if extend
3078 `(gnus-info-set-entry ,info ,marks 3)
3079 `(setcar (nthcdr 3 ,info) ,marks)))
3080 (defmacro gnus-info-set-method (info method &optional extend)
3081 (if extend
3082 `(gnus-info-set-entry ,info ,method 4)
3083 `(setcar (nthcdr 4 ,info) ,method)))
3084 (defmacro gnus-info-set-params (info params &optional extend)
3085 (if extend
3086 `(gnus-info-set-entry ,info ,params 5)
3087 `(setcar (nthcdr 5 ,info) ,params)))
3089 (defun gnus-info-set-entry (info entry number)
3090 ;; Extend the info until we have enough elements.
3091 (while (<= (length info) number)
3092 (nconc info (list nil)))
3093 ;; Set the entry.
3094 (setcar (nthcdr number info) entry))
3096 (defmacro gnus-info-set-level (info level)
3097 `(let ((rank (cdr ,info)))
3098 (if (consp (car rank))
3099 (setcar (car rank) ,level)
3100 (setcar rank ,level))))
3101 (defmacro gnus-info-set-score (info score)
3102 `(let ((rank (cdr ,info)))
3103 (if (consp (car rank))
3104 (setcdr (car rank) ,score)
3105 (setcar rank (cons (car rank) ,score)))))
3107 (defmacro gnus-get-info (group)
3108 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3110 ;;; Load the compatibility functions.
3112 (require 'gnus-ems)
3114 \f
3115 ;;;
3116 ;;; Shutdown
3117 ;;;
3119 (defvar gnus-shutdown-alist nil)
3121 (defun gnus-add-shutdown (function &rest symbols)
3122 "Run FUNCTION whenever one of SYMBOLS is shut down."
3123 (push (cons function symbols) gnus-shutdown-alist))
3125 (defun gnus-shutdown (symbol)
3126 "Shut down everything that waits for SYMBOL."
3127 (dolist (entry gnus-shutdown-alist)
3128 (when (memq symbol (cdr entry))
3129 (funcall (car entry)))))
3131 \f
3132 ;;;
3133 ;;; Gnus Utility Functions
3134 ;;;
3136 (defun gnus-find-subscribed-addresses ()
3137 "Return a regexp matching the addresses of all subscribed mail groups.
3138 It consists of the `to-address' or `to-list' parameter of all groups
3139 with a `subscribed' parameter."
3140 (let (group address addresses)
3141 (dolist (entry (cdr gnus-newsrc-alist))
3142 (setq group (car entry))
3143 (when (gnus-parameter-subscribed group)
3144 (setq address (mail-strip-quoted-names
3145 (or (gnus-group-fast-parameter group 'to-address)
3146 (gnus-group-fast-parameter group 'to-list))))
3147 (when address
3148 (add-to-list 'addresses address))))
3149 (when addresses
3152 (defmacro gnus-string-or (&rest strings)
3153 "Return the first element of STRINGS that is a non-blank string.
3154 STRINGS will be evaluated in normal `or' order."
3155 `(gnus-string-or-1 (list ,@strings)))
3157 (defun gnus-string-or-1 (strings)
3158 (let (string)
3159 (while strings
3160 (setq string (pop strings))
3162 (setq string nil)
3163 (setq strings nil)))
3164 string))
3166 (defun gnus-version (&optional arg)
3167 "Version number of this version of Gnus.
3168 If ARG, insert string at point."
3169 (interactive "P")
3170 (if arg
3171 (insert (message gnus-version))
3172 (message gnus-version)))
3174 (defun gnus-continuum-version (&optional version)
3175 "Return VERSION as a floating point number."
3176 (unless version
3177 (setq version gnus-version))
3180 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3181 (number (match-string 2 version))
3182 major minor least)
3183 (unless (string-match
3185 (error "Invalid version string: %s" version))
3186 (setq major (string-to-number (match-string 1 number))
3187 minor (string-to-number (match-string 2 number))
3188 least (if (match-beginning 3)
3189 (string-to-number (match-string 3 number))
3190 0))
3191 (string-to-number
3192 (if (zerop major)
3193 (format "%s00%02d%02d"
3194 (if (member alpha '("(ding)" "d"))
3195 "4.99"
3196 (+ 5 (* 0.02
3197 (abs
3198 (- (mm-char-int (aref (downcase alpha) 0))
3199 (mm-char-int ?t))))
3200 -0.01))
3201 minor least)
3202 (format "%d.%02d%02d" major minor least))))))
3204 (defun gnus-info-find-node (&optional nodename)
3205 "Find Info documentation of Gnus."
3206 (interactive)
3207 ;; Enlarge info window if needed.
3208 (let (gnus-info-buffer)
3209 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3210 (setq gnus-info-buffer (current-buffer))
3211 (gnus-configure-windows 'info)))
3213 ;;;
3214 ;;; gnus-interactive
3215 ;;;
3217 (defvar gnus-current-prefix-symbol nil
3218 "Current prefix symbol.")
3220 (defvar gnus-current-prefix-symbols nil
3221 "List of current prefix symbols.")
3223 (defun gnus-interactive (string &optional params)
3224 "Return a list that can be fed to `interactive'.
3225 See `interactive' for full documentation.
3227 Adds the following specs:
3229 y -- The current symbolic prefix.
3230 Y -- A list of the current symbolic prefix(es).
3231 A -- Article number.
3232 H -- Article header.
3233 g -- Group name."
3234 (let ((i 0)
3235 out c prompt)
3236 (while (< i (length string))
3238 (setq c (aref string i))
3239 (when (match-end 1)
3240 (setq prompt (match-string 1 string)))
3241 (setq i (match-end 0))
3242 ;; We basically emulate just about everything that
3243 ;; `interactive' does, but add the specs listed above.
3244 (push
3245 (cond
3246 ((= c ?a)
3247 (completing-read prompt obarray 'fboundp t))
3248 ((= c ?b)
3249 (read-buffer prompt (current-buffer) t))
3250 ((= c ?B)
3251 (read-buffer prompt (other-buffer (current-buffer))))
3252 ((= c ?c)
3253 (read-char))
3254 ((= c ?C)
3255 (completing-read prompt obarray 'commandp t))
3256 ((= c ?d)
3257 (point))
3258 ((= c ?D)
3259 (read-file-name prompt nil default-directory 'lambda))
3260 ((= c ?f)
3261 (read-file-name prompt nil nil 'lambda))
3262 ((= c ?F)
3263 (read-file-name prompt))
3264 ((= c ?k)
3265 (read-key-sequence prompt))
3266 ((= c ?K)
3267 (error "Not implemented spec"))
3268 ((= c ?e)
3269 (error "Not implemented spec"))
3270 ((= c ?m)
3271 (mark))
3272 ((= c ?N)
3273 (error "Not implemented spec"))
3274 ((= c ?n)
3275 (string-to-number (read-from-minibuffer prompt)))
3276 ((= c ?p)
3277 (prefix-numeric-value current-prefix-arg))
3278 ((= c ?P)
3279 current-prefix-arg)
3280 ((= c ?r)
3281 'gnus-prefix-nil)
3282 ((= c ?s)
3283 (read-string prompt))
3284 ((= c ?S)
3285 (intern (read-string prompt)))
3286 ((= c ?v)
3287 (read-variable prompt))
3288 ((= c ?x)
3289 (read-minibuffer prompt))
3290 ((= c ?x)
3291 (eval-minibuffer prompt))
3292 ;; And here the new specs come.
3293 ((= c ?y)
3294 gnus-current-prefix-symbol)
3295 ((= c ?Y)
3296 gnus-current-prefix-symbols)
3297 ((= c ?g)
3298 (gnus-group-group-name))
3299 ((= c ?A)
3300 (gnus-summary-skip-intangible)
3301 (or (get-text-property (point) 'gnus-number)
3302 (gnus-summary-last-subject)))
3303 ((= c ?H)
3304 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3305 (t
3306 (error "Non-implemented spec")))
3307 out)
3308 (cond
3309 ((= c ?r)
3310 (push (if (< (point) (mark)) (point) (mark)) out)
3311 (push (if (> (point) (mark)) (point) (mark)) out))))
3312 (setq out (delq 'gnus-prefix-nil out))
3313 (nreverse out)))
3315 (defun gnus-symbolic-argument (&optional arg)
3316 "Read a symbolic argument and a command, and then execute command."
3317 (interactive "P")
3318 (let* ((in-command (this-command-keys))
3319 (command in-command)
3320 gnus-current-prefix-symbols
3321 gnus-current-prefix-symbol
3322 syms)
3323 (while (equal in-command command)
3324 (message "%s-" (key-description (this-command-keys)))
3325 (push (intern (char-to-string (read-char))) syms)
3326 (setq command (read-key-sequence nil t)))
3327 (setq gnus-current-prefix-symbols (nreverse syms)
3328 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3329 (call-interactively (key-binding command t))))
3331 ;;; More various functions.
3333 (defsubst gnus-check-backend-function (func group)
3334 "Check whether GROUP supports function FUNC.
3335 GROUP can either be a string (a group name) or a select method."
3336 (ignore-errors
3337 (let ((method (if (stringp group)
3338 (car (gnus-find-method-for-group group))
3339 group)))
3340 (unless (featurep method)
3341 (require method))
3342 (fboundp (intern (format "%s-%s" method func))))))
3344 (defun gnus-group-read-only-p (&optional group)
3345 "Check whether GROUP supports editing or not.
3346 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3347 that that variable is buffer-local to the summary buffers."
3348 (let ((group (or group gnus-newsgroup-name)))
3349 (not (gnus-check-backend-function 'request-replace-article group))))
3351 (defun gnus-virtual-group-p (group)
3352 "Say whether GROUP is virtual or not."
3353 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3354 gnus-valid-select-methods)))
3356 (defun gnus-news-group-p (group &optional article)
3357 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3358 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3359 t) ;is news of course.
3360 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3361 nil) ;must be mail then.
3362 ((vectorp article) ;Has header info.
3363 (eq (gnus-request-type group (mail-header-id article)) 'news))
3364 ((null article) ;Hasn't header info
3365 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3366 ((< article 0) ;Virtual message
3367 nil) ;we don't know, guess mail.
3368 (t ;Has positive number
3369 (eq (gnus-request-type group article) 'news)))) ;use it.
3371 ;; Returns a list of writable groups.
3372 (defun gnus-writable-groups ()
3373 (let ((alist gnus-newsrc-alist)
3374 groups group)
3375 (while (setq group (car (pop alist)))
3376 (unless (gnus-group-read-only-p group)
3377 (push group groups)))
3378 (nreverse groups)))
3380 ;; Check whether to use long file names.
3381 (defun gnus-use-long-file-name (symbol)
3382 ;; The variable has to be set...
3383 (and gnus-use-long-file-name
3384 ;; If it isn't a list, then we return t.
3385 (or (not (listp gnus-use-long-file-name))
3386 ;; If it is a list, and the list contains `symbol', we
3387 ;; return nil.
3388 (not (memq symbol gnus-use-long-file-name)))))
3390 ;; Generate a unique new group name.
3391 (defun gnus-generate-new-group-name (leaf)
3392 (let ((name leaf)
3393 (num 0))
3394 (while (gnus-group-entry name)
3395 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3396 name))
3398 (defun gnus-ephemeral-group-p (group)
3399 "Say whether GROUP is ephemeral or not."
3400 (gnus-group-get-parameter group 'quit-config t))
3402 (defun gnus-group-quit-config (group)
3403 "Return the quit-config of GROUP."
3404 (gnus-group-get-parameter group 'quit-config t))
3406 (defun gnus-kill-ephemeral-group (group)
3407 "Remove ephemeral GROUP from relevant structures."
3408 (gnus-sethash group nil gnus-newsrc-hashtb))
3410 (defun gnus-simplify-mode-line ()
3411 "Make mode lines a bit simpler."
3412 (setq mode-line-modified (cdr gnus-mode-line-modified))
3413 (when (listp mode-line-format)
3414 (make-local-variable 'mode-line-format)
3415 (setq mode-line-format (copy-sequence mode-line-format))
3416 (when (equal (nth 3 mode-line-format) " ")
3417 (setcar (nthcdr 3 mode-line-format) " "))))
3419 ;;; Servers and groups.
3421 (defsubst gnus-server-add-address (method)
3422 (let ((method-name (symbol-name (car method))))
3423 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3424 (not (assq (intern (concat method-name "-address")) method))
3425 (memq 'physical-address (assq (car method)
3426 gnus-valid-select-methods)))
3427 (append method (list (list (intern (concat method-name "-address"))
3428 (nth 1 method))))
3429 method)))
3431 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3432 (catch 'server-name
3433 (setq method (or method gnus-select-method))
3435 ;; Perhaps it is already in the cache.
3436 (unless nocache
3437 (mapc (lambda (name-method)
3438 (if (equal (cdr name-method) method)
3439 (throw 'server-name (car name-method))))
3440 gnus-server-method-cache))
3442 (mapc
3443 (lambda (server-alist)
3444 (mapc (lambda (name-method)
3445 (when (gnus-methods-equal-p (cdr name-method) method)
3446 (unless (member name-method gnus-server-method-cache)
3447 (push name-method gnus-server-method-cache))
3448 (throw 'server-name (car name-method))))
3449 server-alist))
3450 (list gnus-server-alist
3451 gnus-predefined-server-alist))
3453 (let* ((name (if (member (cadr method) '(nil ""))
3454 (format "%s" (car method))
3455 (format "%s:%s" (car method) (cadr method))))
3456 (name-method (cons name method)))
3457 (when (and (not (member name-method gnus-server-method-cache))
3458 (not no-enter-cache)
3459 (not (assoc (car name-method) gnus-server-method-cache)))
3460 (push name-method gnus-server-method-cache))
3461 name)))
3463 (defsubst gnus-server-to-method (server)
3464 "Map virtual server names to select methods."
3465 (or (and server (listp server) server)
3466 (cdr (assoc server gnus-server-method-cache))
3467 (let ((result
3468 (or
3469 ;; Perhaps this is the native server?
3470 (and (equal server "native") gnus-select-method)
3471 ;; It should be in the server alist.
3472 (cdr (assoc server gnus-server-alist))
3473 ;; It could be in the predefined server alist.
3474 (cdr (assoc server gnus-predefined-server-alist))
3475 ;; If not, we look through all the opened server
3476 ;; to see whether we can find it there.
3477 (let ((opened gnus-opened-servers))
3478 (while (and opened
3479 (not (equal server (format "%s:%s" (caaar opened)
3480 (cadaar opened)))))
3481 (pop opened))
3482 (caar opened))
3483 ;; It could be a named method, search all servers
3484 (let ((servers gnus-secondary-select-methods))
3485 (while (and servers
3486 (not (equal server (format "%s:%s" (caar servers)
3487 (cadar servers)))))
3488 (pop servers))
3489 (car servers))
3490 ;; This could be some sort of foreign server that I
3491 ;; simply haven't opened (yet). Do a brute-force scan
3492 ;; of the entire gnus-newsrc-alist for the server name
3493 ;; of every method. As a side-effect, loads the
3494 ;; gnus-server-method-cache so this only happens once,
3495 ;; if at all.
3496 (let ((alist (cdr gnus-newsrc-alist))
3497 method match)
3498 (while alist
3499 (setq method (gnus-info-method (pop alist)))
3500 (when (and (not (stringp method))
3501 (equal server
3502 (gnus-method-to-server method nil t)))
3503 (setq match method
3504 alist nil)))
3505 match))))
3506 (when (and result
3507 (not (assoc server gnus-server-method-cache)))
3508 (push (cons server result) gnus-server-method-cache))
3509 result)))
3511 (defsubst gnus-server-get-method (group method)
3512 ;; Input either a server name, and extended server name, or a
3513 ;; select method, and return a select method.
3514 (cond ((stringp method)
3515 (gnus-server-to-method method))
3516 ((equal method gnus-select-method)
3517 gnus-select-method)
3518 ((and (stringp (car method))
3519 group)
3520 (gnus-server-extend-method group method))
3521 ((and method
3522 (not group)
3523 (equal (cadr method) ""))
3524 method)
3525 (t
3526 (gnus-server-add-address method))))
3528 (defmacro gnus-method-equal (ss1 ss2)
3529 "Say whether two servers are equal."
3530 `(let ((s1 ,ss1)
3531 (s2 ,ss2))
3532 (or (equal s1 s2)
3533 (and (= (length s1) (length s2))
3534 (progn
3535 (while (and s1 (member (car s1) s2))
3536 (setq s1 (cdr s1)))
3537 (null s1))))))
3539 (defun gnus-methods-equal-p (m1 m2)
3540 (let ((m1 (or m1 gnus-select-method))
3541 (m2 (or m2 gnus-select-method)))
3542 (or (equal m1 m2)
3543 (and (eq (car m1) (car m2))
3544 (or (not (memq 'address (assoc (symbol-name (car m1))
3545 gnus-valid-select-methods)))
3546 (equal (nth 1 m1) (nth 1 m2)))))))
3548 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3549 ;; Check parameters for sloppy equalness.
3550 (let ((p1 (copy-sequence (cddr m1)))
3551 (p2 (copy-sequence (cddr m2)))
3552 e1 e2)
3553 (block nil
3554 (while (setq e1 (pop p1))
3555 (unless (setq e2 (assq (car e1) p2))
3556 ;; The parameter doesn't exist in p2.
3557 (return nil))
3558 (setq p2 (delq e2 p2))
3559 (unless (equal e1 e2)
3560 (if (not (and (stringp (cadr e1))
3561 (stringp (cadr e2))))
3562 (return nil)
3563 ;; Special-case string parameter comparison so that we
3564 ;; can uniquify them.
3565 (let ((s1 (cadr e1))
3566 (s2 (cadr e2)))
3567 (when (string-match "/$" s1)
3568 (setq s1 (directory-file-name s1)))
3569 (when (string-match "/$" s2)
3570 (setq s2 (directory-file-name s2)))
3571 (unless (equal s1 s2)
3572 (return nil))))))
3573 ;; If p2 now is empty, they were equal.
3574 (null p2))))
3576 (defun gnus-methods-sloppily-equal (m1 m2)
3577 ;; Same method.
3578 (or
3579 (eq m1 m2)
3580 ;; Type and name are equal.
3581 (and
3582 (eq (car m1) (car m2))
3583 (equal (cadr m1) (cadr m2))
3584 (gnus-sloppily-equal-method-parameters m1 m2))))
3586 (defun gnus-server-equal (m1 m2)
3587 "Say whether two methods are equal."
3588 (let ((m1 (cond ((null m1) gnus-select-method)
3589 ((stringp m1) (gnus-server-to-method m1))
3590 (t m1)))
3591 (m2 (cond ((null m2) gnus-select-method)
3592 ((stringp m2) (gnus-server-to-method m2))
3593 (t m2))))
3594 (gnus-method-equal m1 m2)))
3596 (defun gnus-servers-using-backend (backend)
3597 "Return a list of known servers using BACKEND."
3598 (let ((opened gnus-opened-servers)
3599 out)
3600 (while opened
3601 (when (eq backend (caaar opened))
3602 (push (caar opened) out))
3603 (pop opened))
3604 out))
3606 (defun gnus-archive-server-wanted-p ()
3607 "Say whether the user wants to use the archive server."
3608 (cond
3609 ((or (not gnus-message-archive-method)
3610 (not gnus-message-archive-group))
3611 nil)
3612 ((and gnus-message-archive-method gnus-message-archive-group)
3613 t)
3614 (t
3615 (let ((active (cadr (assq 'nnfolder-active-file
3616 gnus-message-archive-method))))
3617 (and active
3618 (file-exists-p active))))))
3620 (defsubst gnus-method-to-server-name (method)
3621 (concat
3622 (format "%s" (car method))
3623 (when (and
3624 (or (assoc (format "%s" (car method))
3625 (gnus-methods-using 'address))
3626 (gnus-server-equal method gnus-message-archive-method))
3627 (nth 1 method)
3628 (not (string= (nth 1 method) "")))
3629 (concat "+" (nth 1 method)))))
3631 (defsubst gnus-method-to-full-server-name (method)
3632 (format "%s+%s" (car method) (nth 1 method)))
3634 (defun gnus-group-prefixed-name (group method &optional full)
3635 "Return the whole name from GROUP and METHOD.
3636 Call with full set to get the fully qualified group name (even if the
3637 server is native)."
3638 (when (stringp method)
3639 (setq method (gnus-server-to-method method)))
3640 (if (or (not method)
3641 (and (not full) (gnus-server-equal method "native"))
3642 ;;;!!! This might not be right. We'll see...
3643 ;(string-match ":" group)
3644 )
3645 group
3646 (concat (gnus-method-to-server-name method) ":" group)))
3648 (defun gnus-group-guess-prefixed-name (group)
3649 "Guess the whole name from GROUP and METHOD."
3650 (gnus-group-prefixed-name group (gnus-find-method-for-group
3651 group)))
3653 (defun gnus-group-full-name (group method)
3654 "Return the full name from GROUP and METHOD, even if the method is native."
3655 (gnus-group-prefixed-name group method t))
3657 (defun gnus-group-guess-full-name (group)
3658 "Guess the full name from GROUP, even if the method is native."
3659 (if (gnus-group-prefixed-p group)
3660 group
3661 (gnus-group-full-name group (gnus-find-method-for-group group))))
3663 (defun gnus-group-guess-full-name-from-command-method (group)
3664 "Guess the full name from GROUP, even if the method is native."
3665 (if (gnus-group-prefixed-p group)
3666 group
3667 (gnus-group-full-name group gnus-command-method)))
3669 (defun gnus-group-real-prefix (group)
3670 "Return the prefix of the current group name."
3671 (if (stringp group)
3672 (if (string-match "^[^:]+:" group)
3673 (substring group 0 (match-end 0))
3674 "")
3675 nil))
3677 (defun gnus-group-short-name (group)
3678 "Return the short group name."
3679 (let ((prefix (gnus-group-real-prefix group)))
3680 (if (< 0 (length prefix))
3681 (substring group (length prefix) nil)
3682 group)))
3684 (defun gnus-group-prefixed-p (group)
3685 "Return the prefix of the current group name."
3686 (< 0 (length (gnus-group-real-prefix group))))
3688 (declare-function gnus-group-decoded-name "gnus-group" (string))
3690 (defun gnus-summary-buffer-name (group)
3691 "Return the summary buffer name of GROUP."
3692 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3694 (defun gnus-group-method (group)
3695 "Return the server or method used for selecting GROUP.
3696 You should probably use `gnus-find-method-for-group' instead."
3697 (let ((prefix (gnus-group-real-prefix group)))
3698 (if (equal prefix "")
3699 gnus-select-method
3700 (let ((servers gnus-opened-servers)
3701 (server "")
3702 backend possible found)
3704 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3705 server (substring prefix (match-end 0) (1- (length prefix))))
3706 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3707 (while servers
3708 (when (eq (caaar servers) backend)
3709 (setq possible (caar servers))
3710 (when (equal (cadaar servers) server)
3711 (setq found (caar servers))))
3712 (pop servers))
3713 (or (car (rassoc found gnus-server-alist))
3714 found
3715 (car (rassoc possible gnus-server-alist))
3716 possible
3717 (list backend server))))))
3719 (defsubst gnus-native-method-p (method)
3720 "Return whether METHOD is the native select method."
3721 (gnus-method-equal method gnus-select-method))
3723 (defsubst gnus-secondary-method-p (method)
3724 "Return whether METHOD is a secondary select method."
3725 (let ((methods gnus-secondary-select-methods)
3726 (gmethod (inline (gnus-server-get-method nil method))))
3727 (while (and methods
3728 (not (gnus-method-equal
3729 (inline (gnus-server-get-method nil (car methods)))
3730 gmethod)))
3731 (setq methods (cdr methods)))
3732 methods))
3734 (defun gnus-method-simplify (method)
3735 "Return the shortest uniquely identifying string or method for METHOD."
3736 (cond ((stringp method)
3737 method)
3738 ((gnus-native-method-p method)
3739 nil)
3740 ((gnus-secondary-method-p method)
3741 (format "%s:%s" (nth 0 method) (nth 1 method)))
3742 (t
3743 method)))
3745 (defun gnus-groups-from-server (server)
3746 "Return a list of all groups that are fetched from SERVER."
3747 (let ((alist (cdr gnus-newsrc-alist))
3748 info groups)
3749 (while (setq info (pop alist))
3750 (when (gnus-server-equal (gnus-info-method info) server)
3751 (push (gnus-info-group info) groups)))
3752 (sort groups 'string<)))
3754 (defun gnus-group-foreign-p (group)
3755 "Say whether a group is foreign or not."
3756 (and (not (gnus-group-native-p group))
3757 (not (gnus-group-secondary-p group))))
3759 (defun gnus-group-native-p (group)
3760 "Say whether the group is native or not."
3761 (not (string-match ":" group)))
3763 (defun gnus-group-secondary-p (group)
3764 "Say whether the group is secondary or not."
3765 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3767 (defun gnus-parameters-get-parameter (group)
3768 "Return the group parameters for GROUP from `gnus-parameters'."
3769 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3770 case-fold-search
3771 gnus-parameters-case-fold-search))
3772 params-list)
3773 (dolist (elem gnus-parameters)
3774 (when (string-match (car elem) group)
3775 (setq params-list
3776 (nconc (gnus-expand-group-parameters
3777 (car elem) (cdr elem) group)
3778 params-list))))
3779 params-list))
3781 (defun gnus-expand-group-parameter (match value group)
3782 "Use MATCH to expand VALUE in GROUP."
3783 (let ((start (string-match match group)))
3784 (if start
3785 (let ((matched-string (substring group start (match-end 0))))
3786 ;; Build match groups
3787 (string-match match matched-string)
3788 (replace-match value nil nil matched-string))
3789 group)))
3791 (defun gnus-expand-group-parameters (match parameters group)
3792 "Go through PARAMETERS and expand them according to the match data."
3793 (let (new)
3794 (dolist (elem parameters)
3795 (if (and (stringp (cdr elem))
3797 (push (cons (car elem)
3798 (gnus-expand-group-parameter match (cdr elem) group))
3799 new)
3800 (push elem new)))
3801 new))
3803 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3804 "For GROUP, return the value of SYMBOL.
3806 You should call this in the `gnus-group-buffer' buffer.
3807 The function `gnus-group-find-parameter' will do that for you."
3808 ;; The speed trick: No cons'ing and quit early.
3809 (let* ((params (funcall gnus-group-get-parameter-function group))
3810 ;; Start easy, check the "real" group parameters.
3811 (simple-results
3812 (gnus-group-parameter-value params symbol allow-list t)))
3813 (if simple-results
3814 ;; Found results; return them.
3815 (car simple-results)
3816 ;; We didn't find it there, try `gnus-parameters'.
3817 (let ((result nil)
3818 (head nil)
3819 (tail gnus-parameters))
3820 ;; A good old-fashioned non-cl loop.
3821 (while tail
3822 (setq head (car tail)
3823 tail (cdr tail))
3824 ;; The car is regexp matching for matching the group name.
3825 (when (string-match (car head) group)
3826 ;; The cdr is the parameters.
3827 (setq result (gnus-group-parameter-value (cdr head)
3828 symbol allow-list))
3829 (when result
3830 ;; Expand if necessary.
3832 (setq result (gnus-expand-group-parameter (car head)
3833 result group))))))
3834 ;; Done.
3835 result))))
3837 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3838 "Return the group parameters for GROUP.
3839 If SYMBOL, return the value of that symbol in the group parameters.
3841 If you call this function inside a loop, consider using the faster
3842 `gnus-group-fast-parameter' instead."
3843 (with-current-buffer gnus-group-buffer
3844 (if symbol
3845 (gnus-group-fast-parameter group symbol allow-list)
3846 (nconc
3847 (copy-sequence
3848 (funcall gnus-group-get-parameter-function group))
3849 (gnus-parameters-get-parameter group)))))
3851 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3852 "Return the group parameters for GROUP.
3853 If SYMBOL, return the value of that symbol in the group parameters.
3854 If ALLOW-LIST, also allow list as a result.
3855 Most functions should use `gnus-group-find-parameter', which
3856 also examines the topic parameters."
3857 (let ((params (gnus-info-params (gnus-get-info group))))
3858 (if symbol
3859 (gnus-group-parameter-value params symbol allow-list)
3860 params)))
3862 (defun gnus-group-parameter-value (params symbol &optional
3863 allow-list present-p)
3864 "Return the value of SYMBOL in group PARAMS.
3865 If ALLOW-LIST, also allow list as a result."
3866 ;; We only wish to return group parameters (dotted lists) and
3867 ;; not local variables, which may have the same names.
3868 ;; But first we handle single elements...
3869 (or (car (memq symbol params))
3870 ;; Handle alist.
3871 (let (elem)
3872 (catch 'found
3873 (while (setq elem (pop params))
3874 (when (and (consp elem)
3875 (eq (car elem) symbol)
3876 (or allow-list
3877 (atom (cdr elem))))
3878 (throw 'found (if present-p (list (cdr elem))
3879 (cdr elem)))))))))
3881 (defun gnus-group-add-parameter (group param)
3882 "Add parameter PARAM to GROUP."
3883 (let ((info (gnus-get-info group)))
3884 (when info
3885 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3886 ;; Cons the new param to the old one and update.
3887 (gnus-group-set-info (cons param (gnus-info-params info))
3888 group 'params))))
3890 (defun gnus-group-set-parameter (group name value)
3891 "Set parameter NAME to VALUE in GROUP.
3892 GROUP can also be an INFO structure."
3893 (let ((info (if (listp group)
3894 group
3895 (gnus-get-info group))))
3896 (when info
3897 (gnus-group-remove-parameter group name)
3898 (let ((old-params (gnus-info-params info))
3899 (new-params (list (cons name value))))
3900 (while old-params
3901 (when (or (not (listp (car old-params)))
3902 (not (eq (caar old-params) name)))
3903 (setq new-params (append new-params (list (car old-params)))))
3904 (setq old-params (cdr old-params)))
3905 (if (listp group)
3906 (gnus-info-set-params info new-params t)
3907 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3909 (defun gnus-group-remove-parameter (group name)
3910 "Remove parameter NAME from GROUP.
3911 GROUP can also be an INFO structure."
3912 (let ((info (if (listp group)
3913 group
3914 (gnus-get-info group))))
3915 (when info
3916 (let ((params (gnus-info-params info)))
3917 (when params
3918 (setq params (delq name params))
3919 (while (assq name params)
3920 (gnus-alist-pull name params))
3921 (gnus-info-set-params info params))))))
3923 (defun gnus-group-add-score (group &optional score)
3924 "Add SCORE to the GROUP score.
3925 If SCORE is nil, add 1 to the score of GROUP."
3926 (let ((info (gnus-get-info group)))
3927 (when info
3928 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3930 (defun gnus-short-group-name (group &optional levels)
3931 "Collapse GROUP name LEVELS.
3932 Select methods are stripped and any remote host name is stripped down to
3933 just the host name."
3934 (let* ((name "")
3935 (foreign "")
3936 (depth 0)
3937 (skip 1)
3938 (levels (or levels
3939 gnus-group-uncollapsed-levels
3940 (progn
3942 (setq skip (match-end 0)
3943 depth (+ depth 1)))
3944 depth))))
3945 ;; Separate foreign select method from group name and collapse.
3946 ;; If method contains a server, collapse to non-domain server name,
3947 ;; otherwise collapse to select method.
3948 (let* ((colon (string-match ":" group))
3949 (server (and colon (substring group 0 colon)))
3950 (plus (and server (string-match "+" server))))
3951 (when server
3952 (if plus
3953 (setq foreign (substring server (+ 1 plus)
3955 group (substring group (+ 1 colon)))
3956 (setq foreign server
3957 group (substring group (+ 1 colon))))
3958 (setq foreign (concat foreign ":")))
3959 ;; Collapse group name leaving LEVELS uncollapsed elements
3960 (let* ((slist (split-string group "/"))
3961 (slen (length slist))
3963 (dlen (length dlist))
3964 glist
3965 glen
3966 gsep
3967 res)
3968 (if (> slen dlen)
3969 (setq glist slist
3970 glen slen
3971 gsep "/")
3972 (setq glist dlist
3973 glen dlen
3974 gsep "."))
3975 (setq levels (- glen levels))
3976 (dolist (g glist)
3977 (push (if (>= (decf levels) 0)
3978 (if (zerop (length g))
3979 ""
3980 (substring g 0 1))
3981 g)
3982 res))
3983 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3985 (defun gnus-narrow-to-body ()
3986 "Narrow to the body of an article."
3987 (narrow-to-region
3988 (progn
3989 (goto-char (point-min))
3991 (point-max)))
3992 (point-max)))
3994 \f
3995 ;;;
3996 ;;; Kill file handling.
3997 ;;;
3999 (defun gnus-apply-kill-file ()
4000 "Apply a kill file to the current newsgroup.
4001 Returns the number of articles marked as read."
4002 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4003 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4004 (gnus-apply-kill-file-internal)
4005 0))
4007 (defun gnus-kill-save-kill-buffer ()
4008 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4009 (when (get-file-buffer file)
4010 (with-current-buffer (get-file-buffer file)
4011 (when (buffer-modified-p)
4012 (save-buffer))
4013 (kill-buffer (current-buffer))))))
4015 (defcustom gnus-kill-file-name "KILL"
4016 "Suffix of the kill files."
4017 :group 'gnus-score-kill
4018 :group 'gnus-score-files
4019 :type 'string)
4021 (defun gnus-newsgroup-kill-file (newsgroup)
4022 "Return the name of a kill file name for NEWSGROUP.
4023 If NEWSGROUP is nil, return the global kill file name instead."
4024 (cond
4025 ;; The global KILL file is placed at top of the directory.
4026 ((or (null newsgroup)
4027 (string-equal newsgroup ""))
4028 (expand-file-name gnus-kill-file-name
4029 gnus-kill-files-directory))
4030 ;; Append ".KILL" to newsgroup name.
4031 ((gnus-use-long-file-name 'not-kill)
4032 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4033 "." gnus-kill-file-name)
4034 gnus-kill-files-directory))
4035 ;; Place "KILL" under the hierarchical directory.
4036 (t
4037 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4038 "/" gnus-kill-file-name)
4039 gnus-kill-files-directory))))
4041 ;;; Server things.
4043 (defun gnus-member-of-valid (symbol group)
4045 (memq symbol (assoc
4046 (symbol-name (car (gnus-find-method-for-group group)))
4047 gnus-valid-select-methods)))
4049 (defun gnus-method-option-p (method option)
4050 "Return non-nil if select METHOD has OPTION as a parameter."
4051 (when (stringp method)
4052 (setq method (gnus-server-to-method method)))
4053 (memq option (assoc (format "%s" (car method))
4054 gnus-valid-select-methods)))
4056 (defun gnus-similar-server-opened (method)
4057 "Return non-nil if we have a similar server opened.
4058 This is defined as a server with the same name, but different
4059 parameters."
4060 (let ((opened gnus-opened-servers)
4061 open)
4062 (while (and method opened)
4063 (setq open (car (pop opened)))
4064 ;; Type and name are the same...
4065 (when (and (equal (car method) (car open))
4066 (equal (cadr method) (cadr open))
4067 ;; ... but the rest of the parameters differ.
4068 (not (gnus-methods-sloppily-equal method open)))
4069 (setq method nil)))
4070 (not method)))
4072 (defun gnus-server-extend-method (group method)
4073 ;; This function "extends" a virtual server. If the server is
4074 ;; "hello", and the select method is ("hello" (my-var "something"))
4075 ;; in the group "alt.alt", this will result in a new virtual server
4076 ;; called "hello+alt.alt".
4077 (if (or (not (inline (gnus-similar-server-opened method)))
4078 (not (cddr method)))
4079 method
4080 (setq method
4081 `(,(car method) ,(concat (cadr method) "+" group)
4082 (,(intern (format "%s-address" (car method))) ,(cadr method))
4083 ,@(cddr method)))
4084 (push method gnus-extended-servers)
4085 method))
4087 (defun gnus-server-status (method)
4088 "Return the status of METHOD."
4089 (nth 1 (assoc method gnus-opened-servers)))
4091 (defun gnus-group-name-to-method (group)
4092 "Guess a select method based on GROUP."
4093 (if (string-match ":" group)
4094 (let ((server (substring group 0 (match-beginning 0))))
4096 (list (intern (substring server 0 (match-beginning 0)))
4097 (substring server (match-end 0)))
4098 (list (intern server) "")))
4099 gnus-select-method))
4101 (defun gnus-server-string (server)
4102 "Return a readable string that describes SERVER."
4103 (let* ((server (gnus-server-to-method server))
4104 (address (nth 1 server)))
4105 (if (and address
4106 (not (zerop (length address))))
4107 (format "%s using %s" address (car server))
4108 (format "%s" (car server)))))
4110 (defun gnus-same-method-different-name (method)
4111 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4112 (unless (assq slot (cddr method))
4113 (setq method
4114 (append method (list (list slot (nth 1 method)))))))
4115 (let ((methods gnus-extended-servers)
4116 open found)
4117 (while (and (not found)
4118 (setq open (pop methods)))
4119 (when (and (eq (car method) (car open))
4120 (gnus-sloppily-equal-method-parameters method open))
4121 (setq found open)))
4122 found))
4124 (defun gnus-find-method-for-group (group &optional info)
4125 "Find the select method that GROUP uses."
4126 (or gnus-override-method
4127 (and (not group)
4128 gnus-select-method)
4129 (and (not (gnus-group-entry group))
4130 ;; Killed or otherwise unknown group.
4131 (or
4132 ;; If we know a virtual server by that name, return its method.
4133 (gnus-server-to-method (gnus-group-server group))
4134 ;; Guess a new method as last resort.
4135 (gnus-group-name-to-method group)))
4136 (let ((info (or info (gnus-get-info group)))
4137 method)
4138 (if (or (not info)
4139 (not (setq method (gnus-info-method info)))
4140 (equal method "native"))
4141 gnus-select-method
4142 (setq method
4143 (cond ((stringp method)
4144 (inline (gnus-server-to-method method)))
4145 ((stringp (cadr method))
4146 (or
4147 (inline
4148 (gnus-same-method-different-name method))
4149 (inline (gnus-server-extend-method group method))))
4150 (t
4151 method)))
4152 (cond ((equal (cadr method) "")
4153 method)
4154 ((null (cadr method))
4155 (list (car method) ""))
4156 (t
4157 (gnus-server-add-address method)))))))
4159 (defun gnus-methods-using (feature)
4160 "Find all methods that have FEATURE."
4161 (let ((valids gnus-valid-select-methods)
4162 outs)
4163 (while valids
4164 (when (memq feature (car valids))
4165 (push (car valids) outs))
4166 (setq valids (cdr valids)))
4167 outs))
4169 (eval-and-compile
4170 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4172 (defun gnus-read-group (prompt &optional default)
4173 "Prompt the user for a group name.
4174 Disallow invalid group names."
4175 (let ((prefix "")
4176 group)
4177 (while (not group)
4178 (when (string-match
4179 gnus-invalid-group-regexp
4180 (setq group (read-string (concat prefix prompt)
4181 (cons (or default "") 0)
4182 'gnus-group-history)))
4183 (let ((match (match-string 0 group)))
4184 ;; Might be okay (e.g. for nnimap), so ask the user:
4186 (message-y-or-n-p
4187 "Proceed and create group anyway? " t
4190 Usually, it's dangerous to create a group with this name, because it's not
4191 supported by all back ends and servers. On IMAP servers it should work,
4192 though. If you are really sure, you can proceed anyway and create the group.
4194 You may customize the variable `gnus-invalid-group-regexp', which currently is
4198 group nil)))))
4199 group))
4201 (defun gnus-read-method (prompt)
4202 "Prompt the user for a method.
4203 Allow completion over sensible values."
4204 (let* ((open-servers
4205 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4206 gnus-opened-servers))
4207 (valid-methods
4208 (let (methods)
4209 (dolist (method gnus-valid-select-methods)
4210 (if (or (memq 'prompt-address method)
4211 (not (assoc (format "%s:" (car method)) open-servers)))
4212 (push method methods)))
4213 methods))
4214 (servers
4215 (append valid-methods
4216 open-servers
4217 gnus-predefined-server-alist
4218 gnus-server-alist))
4219 (method
4220 (gnus-completing-read
4221 prompt (mapcar 'car servers)
4222 t nil 'gnus-method-history)))
4223 (cond
4224 ((equal method "")
4225 (setq method gnus-select-method))
4226 ((assoc method gnus-valid-select-methods)
4227 (let ((address (if (memq 'prompt-address
4228 (assoc method gnus-valid-select-methods))
4229 (read-string "Address: ")
4230 "")))
4231 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4232 (list (intern method) address))))
4233 ((assoc method servers)
4234 method)
4235 (t
4236 (list (intern method) "")))))
4238 ;;; Agent functions
4240 (defun gnus-agent-method-p (method-or-server)
4241 "Say whether METHOD is covered by the agent."
4242 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4243 (let* ((method (if (stringp method-or-server)
4244 (gnus-server-to-method method-or-server)
4245 method-or-server))
4246 (server (gnus-method-to-server method t)))
4247 (setq gnus-agent-method-p-cache
4248 (cons method-or-server
4249 (member server gnus-agent-covered-methods)))))
4250 (cdr gnus-agent-method-p-cache))
4252 (defun gnus-online (method)
4253 (not
4254 (if gnus-plugged
4255 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4256 (gnus-agent-method-p method))))
4258 ;;; User-level commands.
4260 ;;;###autoload
4261 (defun gnus-slave-no-server (&optional arg)
4262 "Read network news as a slave, without connecting to the local server."
4263 (interactive "P")
4264 (gnus-no-server arg t))
4266 ;;;###autoload
4267 (defun gnus-no-server (&optional arg slave)
4268 "Read network news.
4269 If ARG is a positive number, Gnus will use that as the startup
4270 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4271 non-nil and not a positive number, Gnus will prompt the user for the
4272 name of an NNTP server to use.
4273 As opposed to `gnus', this command will not connect to the local
4274 server."
4275 (interactive "P")
4276 (gnus-no-server-1 arg slave))
4278 ;;;###autoload
4279 (defun gnus-slave (&optional arg)
4280 "Read news as a slave."
4281 (interactive "P")
4282 (gnus arg nil 'slave))
4284 ;;;###autoload
4285 (defun gnus-other-frame (&optional arg display)
4286 "Pop up a frame to read news.
4287 This will call one of the Gnus commands which is specified by the user
4288 option `gnus-other-frame-function' (default `gnus') with the argument
4289 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4290 optional second argument DISPLAY should be a standard display string
4292 omitted or the function `make-frame-on-display' is not available, the
4293 current display is used."
4294 (interactive "P")
4295 (if (fboundp 'make-frame-on-display)
4296 (unless display
4297 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4298 (setq display nil))
4299 (let ((alive (gnus-alive-p)))
4300 (unless (and alive
4301 (catch 'found
4302 (walk-windows
4303 (lambda (window)
4304 (when (and (or (not display)
4305 (equal display
4306 (gnus-frame-or-window-display-name
4307 window)))
4308 (with-current-buffer (window-buffer window)
4310 (symbol-name major-mode))))
4311 (gnus-select-frame-set-input-focus
4312 (setq gnus-other-frame-object (window-frame window)))
4313 (select-window window)
4314 (throw 'found t)))
4315 'ignore t)))
4316 (gnus-select-frame-set-input-focus
4317 (setq gnus-other-frame-object
4318 (if display
4319 (make-frame-on-display display gnus-other-frame-parameters)
4320 (make-frame gnus-other-frame-parameters))))
4321 (if alive
4322 (switch-to-buffer gnus-group-buffer)
4323 (funcall gnus-other-frame-function arg)
4324 (add-hook 'gnus-exit-gnus-hook
4325 '(lambda nil
4326 (when (and (frame-live-p gnus-other-frame-object)
4327 (cdr (frame-list)))
4328 (delete-frame gnus-other-frame-object))
4329 (setq gnus-other-frame-object nil)))))))
4331 ;;;###autoload
4332 (defun gnus (&optional arg dont-connect slave)
4333 "Read network news.
4334 If ARG is non-nil and a positive number, Gnus will use that as the
4335 startup level. If ARG is non-nil and not a positive number, Gnus will
4336 prompt the user for the name of an NNTP server to use."
4337 (interactive "P")
4338 ;; When using the development version of Gnus, load the gnus-load
4339 ;; file.
4340 (unless (string-match "^Gnus" gnus-version)
4341 (load "gnus-load" nil t))
4342 (unless (byte-code-function-p (symbol-function 'gnus))
4343 (message "You should byte-compile Gnus")
4344 (sit-for 2))
4345 (let ((gnus-action-message-log (list nil)))
4346 (gnus-1 arg dont-connect slave)
4347 (gnus-final-warning)))
4349 ;; Allow redefinition of Gnus functions.
4351 (gnus-ems-redefine)
4353 (provide 'gnus)
4355 ;;; gnus.el ends here