| blob | 90b616a9d93e254f5c2a9e53c7dac5c99cf574e0 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; Keywords: news, mail
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;;; Code:
32 ;; For Emacs <22.2 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 loaded
1035 ;; (`find-image' is autoloaded) (and discard the result). Else, we may
1036 ;; get "defvar ignored because image-load-path is let-bound" when calling
1037 ;; `find-image' below.
1047 :color-symbols
1053 ;; Account for the pbm's background.
1057 ;; Account for the xbm's background.
1067 t)))
1070 _ ___ _ _
1071 _ ___ __ ___ __ _ ___
1072 __ _ ___ __ ___
1073 _ ___ _
1074 _ _ __ _
1075 ___ __ _
1076 __ _
1077 _ _ _
1078 _ _ _
1079 _ _ _
1080 __ ___
1081 _ _ _ _
1082 _ _
1083 _ _
1084 _ _
1085 _
1086 __
1089 ;; And then hack it.
1098 ;; Fontify some.
1111 ;;; Do the rest.
1117 "Alist of group parameters.
1119 For example:
1121 (gnus-use-scoring nil)
1122 (gnus-summary-line-format
1124 (gcc-self . t)
1125 (display . all))
1128 (broken-reply-to . t)))"
1135 "If it is t, ignore case of group names specified in `gnus-parameters'.
1136 If it is nil, don't ignore case. If it is `default', which is for the
1137 backward compatibility, use the value of `case-fold-search'."
1148 "Define a group parameter PARAM.
1149 REST is a plist of following:
1150 :type One of `bool', `list' or nil.
1151 :function The name of the function.
1152 :function-document The documentation of the function.
1153 :parameter-type The type for customizing the parameter.
1154 :parameter-document The documentation for the parameter.
1155 :variable The name of the variable.
1156 :variable-document The documentation for the variable.
1157 :variable-group The group for customizing the variable.
1158 :variable-type The type for customizing the variable.
1159 :variable-default The default value of the variable."
1176 'progn
1178 ,variable-document
1184 gnus-group-parameters-more))
1187 ,parameter-type
1191 ,function-document
1193 val)
1196 t)
1201 (,variable
1203 elem value)
1211 ,function-document
1215 elem value)
1222 'value
1227 All other Gnus file and directory variables are initialized from this variable."
1233 "*Directory variable from which all other Gnus file variables are derived.
1235 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1236 This means that other directory variables that are initialized from
1237 this variable won't be set properly if you set this variable in `.gnus.el'.
1238 Set this variable in `.emacs' instead."
1243 "*Default directory for all Gnus buffers."
1246 directory))
1248 ;; Site dependent variables. These variables should be defined in
1249 ;; paths.el.
1252 "Specify a default NNTP server.
1253 This variable should be defined in paths.el, and should never be set
1254 by the user.
1255 If you want to change servers, you should use `gnus-select-method'.
1259 "A file with only the name of the nntp server in it."
1265 "Find default nntp server.
1266 Check the NNTPSERVER environment variable and the
1267 `gnus-nntpserver-file' file."
1275 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1276 ;; starting or even loading Gnus.
1277 ;;;###autoload(when (fboundp 'custom-autoload)
1278 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1284 gnus-default-nntp-server)
1286 "Default method for selecting a newsgroup.
1287 This variable should be a list, where the first element is how the
1288 news is to be fetched, the second is the address.
1291 NNTP, you could say:
1295 If you want to use your local spool, say:
1297 \(setq gnus-select-method (list 'nnspool (system-name)))
1299 If you use this variable, you must set `gnus-nntp-server' to nil.
1301 There is a lot more to know about select methods and virtual servers -
1302 see the manual for details."
1309 "*Method used for archiving messages you've sent.
1310 This should be a mail method.
1312 See also `gnus-update-message-archive-method'."
1316 gnus-select-method))
1321 The archive method is initially set according to the value of
1323 so that it may be used as a real method of the server which is named
1325 updated if the value of this variable is nil, even if you change the
1326 value of `gnus-message-archive-method' afterward. If you want the
1328 `gnus-message-archive-method', set this variable to a non-nil value."
1335 "*Name of the group in which to save the messages you've written.
1336 This can either be a string; a list of strings; or an alist
1337 of regexps/functions/forms to be evaluated to return a string (or a list
1338 of strings). The functions are called with the name of the current
1339 group (or nil) as a parameter.
1341 If you want to save your mail in one group and the news articles you
1342 write in another group, you could say something like:
1344 \(setq gnus-message-archive-group
1345 '((if (message-news-p)
1349 Normally the group names returned by this variable should be
1351 However, you may wish to store the message on some other server. In
1352 that case, just return a fully prefixed name of the group --
1360 function
1361 sexp
1362 string))
1365 "List of NNTP servers that the user can choose between interactively.
1366 To make Gnus query you for a server, you have to give `gnus' a
1367 non-numeric prefix - `C-u M-x gnus', in short."
1373 "The name of the host running the NNTP server."
1376 string))
1380 "A list of secondary methods that will be used for reading news.
1381 This is a list where each element is a complete select method (see
1382 `gnus-select-method').
1384 If, for instance, you want to read your mail with the nnml back end,
1385 you could set this variable:
1392 "Local domain name without a host name.
1393 The DOMAINNAME environment variable is used instead if it is defined.
1394 If the function `system-name' returns the full Internet name, there is
1395 no need to set this variable."
1398 string))
1402 "String with a description of what organization (if any) the user belongs to.
1405 ;; Customization variables
1408 "Preferred method for fetching an article by Message-ID.
1409 If you are reading news from the local spool (with nnspool), fetching
1410 articles by Message-ID is painfully slow. By setting this method to an
1411 nntp method, you might get acceptable results.
1413 The value of this variable must be a valid select method as discussed
1414 in the documentation of `gnus-select-method'.
1416 It can also be a list of select methods, as well as the special symbol
1417 `current', which means to use the current select method. If it is a
1418 list, Gnus will try all the methods in the list until it finds a match."
1424 gnus-select-method
1432 gnus-select-method))))
1435 "*Non-nil means that cross referenced articles will be marked as read.
1436 If nil, ignore cross references. If t, mark articles as read in
1437 subscribed newsgroups. If neither t nor nil, mark as read in all
1438 newsgroups."
1446 "*Process mark."
1452 "*The number of articles which indicates a large newsgroup.
1453 If the number of articles in a newsgroup is greater than this value,
1454 confirmation is required for selecting the newsgroup.
1455 If it is nil, no confirmation is required.
1457 Also see `gnus-large-ephemeral-newsgroup'."
1460 integer))
1463 "Non-nil means that the default name of a file to save articles in is the group name.
1464 If it's nil, the directory form of the group name is used instead.
1466 If this variable is a list, and the list contains the element
1467 `not-score', long file names will not be used for score files; if it
1468 contains the element `not-save', long file names will not be used for
1469 saving; and if it contains the element `not-kill', long file names
1470 will not be used for kill files.
1472 Note that the default for this variable varies according to what system
1473 type you're using. On `usg-unix-v' this variable defaults to nil while
1474 on all other systems it defaults to t."
1492 "*If non-nil, save group scoring info."
1498 "*If non-nil, allow undoing in Gnus group mode buffers."
1503 "*If non-nil, use some adaptive scoring scheme.
1504 If a list, then the values `word' and `line' are meaningful. The
1505 former will perform adaption on individual words in the subject
1506 header while `line' will perform adaption on several headers."
1512 "*If nil, Gnus will ignore the article cache.
1513 If `passive', it will allow entering (and reading) articles
1514 explicitly entered into the cache. If anything else, use the
1515 cache to the full extent of the law."
1523 "*If non-nil, display a thread tree buffer."
1528 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1529 If it is a number N, then Gnus will only keep the last N articles
1530 read. If it is neither nil nor a number, Gnus will keep all read
1531 articles. This is not a good idea."
1534 integer
1539 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1544 "*If non-nil, enable scoring."
1550 "*A hook called when preparing to exit from the summary buffer.
1551 It calls `gnus-summary-expire-articles' by default."
1556 "*Non-nil means that you are a Usenet novice.
1557 If non-nil, verbose messages may be displayed and confirmations may be
1558 required."
1563 "*Non-nil means that you will never be asked for confirmation about anything.
1564 That doesn't mean *anything* anything; particularly destructive
1565 commands will still require prompting."
1570 "*If non-nil, require your confirmation when catching up a group."
1575 "*If non-nil, require your confirmation when exiting Gnus."
1580 "*Function for extracting address components from a From header.
1581 Two pre-defined function exist: `gnus-extract-address-components',
1582 which is the default, quite fast, and too simplistic solution, and
1583 `mail-extract-address-components', which works much better, but is
1584 slower."
1591 "String used to separate shell commands."
1615 "*An alist of valid select methods.
1616 The first element of each list lists should be a string with the name
1617 of the select method. The other elements may be the category of
1618 this method (i. e., `post', `mail', `none' or whatever) or other
1619 properties that this method has (like being respoolable).
1620 If you implement a new select method, all you should have to change is
1621 this variable. I think."
1637 "Recomputes the select-method widget based on the value of
1638 `gnus-valid-select-methods'."
1640 "Widget for entering a select method."
1647 gnus-valid-select-methods)
1651 :inline t
1653 variable
1659 "List of buffers that should update their mode lines.
1660 The list may contain the symbols `group', `article', `tree' and
1661 `summary'. If the corresponding symbol is present, Gnus will keep
1662 that mode line updated with information that may be pertinent.
1663 If this variable is nil, screen refresh may be quicker."
1671 "*Max length of mode-line non-string contents.
1672 If this is nil, Gnus will take space as is needed, leaving the rest
1673 of the mode line intact."
1677 integer))
1679 ;; There should be special validation for this.
1684 to-address
1685 :function-document
1686 "Return GROUP's to-address."
1687 :variable-document
1688 "*Alist of group regexps and correspondent to-addresses."
1689 :variable-group gnus-group-parameter
1692 This will be used when doing followups and posts.
1694 This is primarily useful in mail groups that represent closed
1695 mailing lists--mailing lists where it's expected that everybody that
1696 writes to the mailing list is subscribed to it. Since using this
1697 parameter ensures that the mail only goes to the mailing list itself,
1698 it means that members won't receive two copies of your followups.
1700 Using `to-address' will actually work whether the group is foreign or
1701 not. Let's say there's a group on the server that is called
1702 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1703 articles from a mail-to-news gateway. Posting directly to this group
1704 is therefore impossible--you have to send mail to the mailing list
1705 address instead.
1707 The gnus-group-split mail splitting mechanism will behave as if this
1711 to-list
1712 :function-document
1713 "Return GROUP's to-list."
1714 :variable-document
1715 "*Alist of group regexps and correspondent to-lists."
1716 :variable-group gnus-group-parameter
1719 This address will be used when doing a `a' in the group.
1721 It is totally ignored when doing a followup--except that if it is
1722 present in a news group, you'll get mail group semantics when doing
1723 `f'.
1725 The gnus-group-split mail splitting mechanism will behave as if this
1729 subscribed
1730 :type bool
1731 :function-document
1732 "Return GROUP's subscription status."
1733 :variable-document
1734 "*Groups which are automatically considered subscribed."
1735 :variable-group gnus-group-parameter
1738 Gnus assumed that you are subscribed to the To/List address.
1740 When constructing a list of subscribed groups using
1741 `gnus-find-subscribed-addresses', Gnus includes the To address given
1745 auto-expire
1746 :type bool
1747 :function gnus-group-auto-expirable-p
1748 :function-document
1749 "Check whether GROUP is auto-expirable or not."
1750 :variable gnus-auto-expirable-newsgroups
1751 :variable-default nil
1752 :variable-document
1753 "*Groups in which to automatically mark read articles as expirable.
1754 If non-nil, this should be a regexp that should match all groups in
1755 which to perform auto-expiry. This only makes sense for mail groups."
1756 :variable-group nnmail-expire
1758 regexp)
1760 :parameter-document
1764 total-expire
1765 :type bool
1766 :function gnus-group-total-expirable-p
1767 :function-document
1768 "Check whether GROUP is total-expirable or not."
1769 :variable gnus-total-expirable-newsgroups
1770 :variable-default nil
1771 :variable-document
1772 "*Groups in which to perform expiry of all read articles.
1773 Use with extreme caution. All groups that match this regexp will be
1774 expiring - which means that all read articles will be deleted after
1775 \(say) one week. (This only goes for mail groups and the like, of
1776 course.)"
1777 :variable-group nnmail-expire
1779 regexp)
1781 :parameter-document
1782 "All read articles will be put through the expiry process
1784 This happens even if they are not marked as expirable.
1788 charset
1789 :function-document
1790 "Return the default charset of GROUP."
1791 :variable gnus-group-charset-alist
1792 :variable-default
1805 :variable-document
1806 "Alist of regexps (to match group names) and default charsets to be used when reading."
1807 :variable-group gnus-charset
1815 post-method
1816 :type list
1817 :function-document
1818 "Return a posting method for GROUP."
1819 :variable gnus-post-method-alist
1820 :variable-document
1821 "Alist of regexps (to match group names) and method to be used when
1822 posting an article."
1823 :variable-group gnus-group-foreign
1824 :parameter-type
1832 :parameter-document
1836 large-newsgroup-initial
1837 :type integer
1838 :function-document
1839 "Return GROUP's initial input of the number of articles."
1840 :variable-document
1841 "*Alist of group regexps and its initial input of the number of articles."
1842 :variable-group gnus-group-parameter
1848 This number will be prompted as the initial value of the number of
1849 articles to list when the group is a large newsgroup (see
1850 `gnus-large-newsgroup'). If it is nil, the default value is the
1853 ;; The Gnus registry's ignored groups
1855 registry-ignore
1856 :type list
1857 :function-document
1858 "Whether this group should be ignored by the registry."
1859 :variable gnus-registry-ignored-groups
1860 :variable-default nil
1861 :variable-document
1862 "*Groups in which the registry should be turned off."
1863 :variable-group gnus-registry
1870 :parameter-document
1873 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1875 "*Disable the group parameters for spam detection.
1876 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1883 "Spam group classification (requires spam.el).
1884 This group contains spam messages. On summary entry, unread messages
1885 will be marked as spam. On summary exit, the specified spam
1886 processors will be invoked on spam-marked messages, then those
1887 messages will be expired, so the spam processor will only see a
1891 "The ham value for the spam group parameter (requires spam.el).
1892 On summary exit, the specified ham processors will be invoked on
1893 ham-marked messages. Exercise caution, since the ham processor will
1894 see the same message more than once because there is no ham message
1898 spam-contents
1899 :type list
1900 :function-document
1901 "The spam type (spam, ham, or neither) of the group."
1902 :variable gnus-spam-newsgroup-contents
1903 :variable-default nil
1904 :variable-document
1905 "*Group classification (spam, ham, or neither). Only
1906 meaningful when spam.el is loaded. If non-nil, this should be a
1907 list of group name regexps associated with a classification for
1908 each one. In spam groups, new articles are marked as spam on
1909 summary entry. There is other behavior associated with ham and
1910 no classification when spam.el is loaded - see the manual."
1911 :variable-group spam
1925 :parameter-document
1926 "The spam classification (spam, ham, or neither) of this group.
1927 When a spam group is entered, all unread articles are marked as
1928 spam. There is other behavior associated with ham and no
1932 spam-resend-to
1933 :type list
1934 :function-document
1935 "The address to get spam resent (through spam-report-resend)."
1936 :variable gnus-spam-resend-to
1937 :variable-default nil
1938 :variable-document
1939 "The address to get spam resent (through spam-report-resend)."
1940 :variable-group spam
1944 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1945 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1946 :parameter-document
1950 ham-resend-to
1951 :type list
1952 :function-document
1953 "The address to get ham resent (through spam-report-resend)."
1954 :variable gnus-ham-resend-to
1955 :variable-default nil
1956 :variable-document
1957 "The address to get ham resent (through spam-report-resend)."
1958 :variable-group spam
1962 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1963 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1964 :parameter-document
1980 "OBSOLETE: The Gmane reporting summary exit spam processor.
1987 "OBSOLETE: The ifile summary exit ham processor.
1991 "OBSOLETE: The Bogofilter summary exit ham processor.
1995 "OBSOLETE: The spam-stat summary exit ham processor.
1999 "OBSOLETE: The whitelist summary exit ham processor.
2003 "OBSOLETE: The BBDB summary exit ham processor.
2007 "OBSOLETE: The ham copy exit ham processor.
2011 "OBSOLETE: The spamoracle summary exit ham processor.
2015 spam-process
2016 :type list
2017 :parameter-type
2020 :value nil
2057 :function-document
2058 "Which spam or ham processors will be applied when the summary is exited."
2059 :variable gnus-spam-process-newsgroups
2060 :variable-default nil
2061 :variable-document
2062 "*Groups in which to automatically process spam or ham articles with
2063 a backend on summary exit. If non-nil, this should be a list of group
2064 name regexps that should match all groups in which to do automatic
2065 spam processing, associated with the appropriate processor."
2066 :variable-group spam
2067 :variable-type
2108 :parameter-document
2112 spam-autodetect
2113 :type list
2114 :parameter-type
2116 :function-document
2117 "Should spam be autodetected (with spam-split) in this group?"
2118 :variable gnus-spam-autodetect
2119 :variable-default nil
2120 :variable-document
2121 "*Groups in which spam should be autodetected when they are entered.
2122 Only unseen articles will be examined, unless
2123 spam-autodetect-recheck-messages is set."
2124 :variable-group spam
2125 :variable-type
2130 boolean))
2131 :parameter-document
2132 "Spam autodetection.
2133 Only unseen articles will be examined, unless
2137 spam-autodetect-methods
2138 :type list
2139 :parameter-type
2162 :function-document
2163 "Methods to be used for autodetection in each group"
2164 :variable gnus-spam-autodetect-methods
2165 :variable-default nil
2166 :variable-document
2167 "*Methods for autodetecting spam per group.
2168 Requires the spam-autodetect parameter. Only unseen articles
2169 will be examined, unless spam-autodetect-recheck-messages is
2170 set."
2171 :variable-group spam
2172 :variable-type
2199 :parameter-document
2200 "Spam autodetection methods.
2201 Requires the spam-autodetect parameter. Only unseen articles
2202 will be examined, unless spam-autodetect-recheck-messages is
2206 spam-process-destination
2207 :type list
2208 :parameter-type
2214 :function-document
2215 "Where spam-processed articles will go at summary exit."
2216 :variable gnus-spam-process-destinations
2217 :variable-default nil
2218 :variable-document
2219 "*Groups in which to explicitly send spam-processed articles to
2220 another group, or expire them (the default). If non-nil, this should
2221 be a list of group name regexps that should match all groups in which
2222 to do spam-processed article moving, associated with the destination
2223 group or nil for explicit expiration. This only makes sense for
2224 mail groups."
2225 :variable-group spam
2226 :variable-type
2237 :parameter-document
2241 ham-process-destination
2242 :type list
2243 :parameter-type
2251 :function-document
2252 "Where ham articles will go at summary exit from a spam group."
2253 :variable gnus-ham-process-destinations
2254 :variable-default nil
2255 :variable-document
2256 "*Groups in which to explicitly send ham articles to
2257 another group, or do nothing (the default). If non-nil, this should
2258 be a list of group name regexps that should match all groups in which
2259 to do ham article moving, associated with the destination
2260 group or nil for explicit ignoring. This only makes sense for
2261 mail groups, and only works in spam groups."
2262 :variable-group spam
2263 :variable-type
2275 :parameter-document
2279 ham-marks
2290 :parameter-document
2291 "Marks considered ham (positively not spam). Such articles will be
2292 processed as ham (non-spam) on group exit. When nil, the global
2293 spam-ham-marks variable takes precedence."
2295 gnus-read-mark
2296 gnus-killed-mark
2297 gnus-kill-file-mark
2298 gnus-low-score-mark))))
2299 :variable-group spam
2300 :variable-document
2304 spam-marks
2313 :parameter-document
2314 "Marks considered spam.
2315 Such articles will be processed as spam on group exit. When nil, the global
2316 spam-spam-marks variable takes precedence."
2318 :variable-group spam
2319 :variable-document
2323 "Number of group name elements to leave alone when making a short group name."
2328 "*If non-nil, once you set a level, Gnus will use this level."
2332 ;; Hooks.
2335 "A hook run while Gnus is loaded."
2340 "A hook called to apply kill files to a group.
2341 This hook is intended to apply a kill file to the selected newsgroup.
2342 The function `gnus-apply-kill-file' is called by default.
2344 Since a general kill file is too heavy to use only for a few
2345 newsgroups, I recommend you to use a lighter hook function. For
2346 example, if you'd like to apply a kill file to articles which contains
2347 a string `rmgroup' in subject in newsgroup `control', you can use the
2348 following hook:
2350 (setq gnus-apply-kill-hook
2351 (list
2352 (lambda ()
2361 "Function run when a group level is changed.
2362 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2365 function))
2367 ;;; Face thingies.
2371 mouse-face
2372 summary-menu group-menu article-menu
2373 tree-highlight menu highlight
2374 browse-menu server-menu
2375 page-marker tree-menu binary-menu pick-menu)
2376 "*Enable visual features.
2377 If `visual' is disabled, there will be no menus and few faces. Most of
2378 the visual customization options below will be ignored. Gnus will use
2379 less space and be faster as a result.
2381 This variable can also be a list of visual elements to switch on. For
2382 instance, to switch off all visual things except menus, you can say:
2384 (setq gnus-visual '(menu))
2386 Valid elements include `summary-highlight', `group-highlight',
2387 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2388 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2389 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2409 ;; Byte-compiler warning.
2411 ;; Find out whether the gnus-visual TYPE is wanted.
2415 gnus-visual
2419 t))))
2429 "*Face used for group or summary buffer mouse highlighting.
2430 The line beneath the mouse pointer will be highlighted with this
2431 face."
2444 "Controls use of the agent cache while plugged.
2445 When set, Gnus will prefer using the locally stored content rather
2446 than re-fetching it from the server. You also need to enable
2447 `gnus-agent' for this to have any affect."
2453 "Default charset assumed to be used when viewing non-ASCII characters.
2454 This variable is overridden on a group-to-group basis by the
2455 `gnus-group-charset-alist' variable and is only used on groups not
2456 covered by that variable."
2460 ;; Fixme: Doc reference to agent.
2462 "Whether we want to use the Gnus agent or not.
2464 You may customize gnus-agent to disable its use. However, some
2465 back ends have started to use the agent as a client-side cache.
2466 Disabling the agent may result in noticeable loss of performance."
2472 "Function called by the command `gnus-other-frame'."
2480 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2481 This should be an alist for Emacs, or a plist for XEmacs."
2492 "Which information should be exposed in the User-Agent header.
2494 Can be a list of symbols or a string. Valid symbols are `gnus'
2495 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2496 addition to the Emacs version, you can add `codename' \(show
2497 \(S\)XEmacs codename\) or either `config' \(show system
2498 configuration\) or `type' \(show system type\). If you set it to
2499 a string, be sure to use a valid format, see RFC 2616."
2512 ;; Convert old (< 2005-01-10) symbol type values:
2531 \f
2532 ;;; Internal variables
2537 ; Reset each time gnus-agent-covered-methods is changed else
2538 ; gnus-agent-method-p may mis-report a methods status.
2539 )
2549 ;; The carpal mode has been removed, but define the variable for
2550 ;; backwards compatability.
2569 ;; Variable holding the user answers to all method prompts.
2572 ;; Variable holding the user answers to all mail method prompts.
2575 ;; Variable holding the user answers to all group prompts.
2583 "*The directory where cached articles will be stored."
2589 nnspool "cache"
2613 ;; Propagate flags to server, with the following exceptions:
2614 ;; `seen' is private to each gnus installation
2615 ;; `cache' is a internal gnus flag for each gnus installation
2616 ;; `download' is a agent flag private to each gnus installation
2617 ;; `unsend' are for nndraft groups only
2618 ;; `score' is not a proper mark
2619 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2622 "Marks that shouldn't be propagated to back ends.
2623 Typical marks are those that make no sense in a standalone back end,
2624 such as a mark that says whether an article is stored in the cache
2637 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2662 gnus-newsrc-last-checked-date
2663 gnus-newsrc-alist gnus-server-alist
2664 gnus-killed-list gnus-zombie-list
2665 gnus-topic-topology gnus-topic-alist
2666 gnus-format-specs)
2670 "Assoc list of read articles.
2674 "Assoc list of registry data.
2701 ;; Save window configuration.
2714 ;;; End of variables.
2716 ;; Define some autoload functions Gnus might use.
2719 ;; This little mapcar goes through the list below and marks the
2720 ;; symbols in question as autoloaded functions.
2740 message-send-and-exit message-yank-original)
2744 ;; This is only used in message.el, which has an autoload.
2746 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2748 ;; Next two only used in gnus-util.
2749 rmail-summary-exists rmail-select-summary)
2750 ;; Only used in gnus-util, which has an autoload.
2755 gnus-Folder-save-name gnus-folder-save-name)
2758 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2759 gnus-demon-add-disconnection gnus-demon-add-handler
2760 gnus-demon-remove-handler)
2762 gnus-demon-init gnus-demon-cancel)
2764 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2765 gnus-face-from-file)
2767 gnus-tree-open gnus-tree-close)
2769 gnus-server-server-name)
2772 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2773 gnus-article-hide-citation gnus-article-fill-cited-article
2774 gnus-article-hide-citation-in-followups)
2776 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2777 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2779 gnus-cache-possibly-remove-articles gnus-cache-request-article
2780 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2781 gnus-cache-enter-remove-article gnus-cached-article-p
2782 gnus-cache-open gnus-cache-close gnus-cache-update-article
2783 gnus-cache-articles-in-group)
2785 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2787 gnus-summary-increase-score gnus-summary-set-score
2788 gnus-summary-raise-thread gnus-summary-raise-same-subject
2789 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2790 gnus-summary-lower-thread gnus-summary-lower-same-subject
2791 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2792 gnus-summary-current-score gnus-score-delta-default
2793 gnus-score-flush-cache gnus-score-close
2794 gnus-possibly-score-headers gnus-score-followup-article
2795 gnus-score-followup-thread)
2798 gnus-current-score-file-nondirectory gnus-score-adaptive
2799 gnus-score-find-trace gnus-score-file-name)
2803 gnus-subscribe-topics)
2807 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2808 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2809 gnus-uu-mark-by-regexp gnus-uu-mark-all
2810 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2811 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2812 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2813 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2814 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2815 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2816 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2817 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2820 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2822 gnus-group-post-news gnus-group-mail gnus-group-news
2823 gnus-summary-post-news gnus-summary-news-other-window
2824 gnus-summary-followup gnus-summary-followup-with-original
2825 gnus-summary-cancel-article gnus-summary-supersede-article
2826 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2827 gnus-summary-mail-forward gnus-summary-mail-other-window
2828 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2829 gnus-summary-wide-reply gnus-summary-followup-to-mail
2830 gnus-summary-followup-to-mail-with-original gnus-bug
2831 gnus-summary-wide-reply-with-original
2832 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2833 gnus-summary-post-forward)
2838 gnus-list-of-unread-articles gnus-list-of-read-articles
2839 gnus-offer-save-summaries gnus-make-thread-indent-array
2840 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2841 gnus-summary-skip-intangible gnus-summary-article-number
2842 gnus-data-header gnus-data-find)
2844 gnus-group-list-groups gnus-group-first-unread-group
2845 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2846 gnus-group-setup-buffer gnus-group-get-new-news
2847 gnus-group-make-help-group gnus-group-update-group
2848 gnus-group-iterate gnus-group-group-name)
2850 gnus-backlog-remove-article)
2852 gnus-article-prepare gnus-article-set-window-start
2853 gnus-article-next-page gnus-article-prev-page
2854 gnus-request-article-this-buffer gnus-article-mode
2855 gnus-article-setup-buffer gnus-narrow-to-page
2856 gnus-article-delete-invisible-text gnus-treat-article)
2858 gnus-article-hide-headers gnus-article-hide-boring-headers
2859 gnus-article-treat-overstrike
2860 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2861 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2862 gnus-article-de-base64-unreadable
2863 gnus-article-decode-HZ
2864 gnus-article-wash-html
2865 gnus-article-unsplit-urls
2866 gnus-article-hide-pem gnus-article-hide-signature
2867 gnus-article-strip-leading-blank-lines gnus-article-date-local
2868 gnus-article-date-original gnus-article-date-lapsed
2869 ;;gnus-article-show-all-headers
2870 gnus-article-edit-mode gnus-article-edit-article
2871 gnus-article-edit-done gnus-article-decode-encoded-words
2872 gnus-start-date-timer gnus-stop-date-timer
2873 gnus-mime-view-all-parts)
2877 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2878 gnus-check-reasonable-setup)
2880 gnus-dup-enter-articles)
2886 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2887 gnus-async-halt-prefetch)
2889 gnus-agent-save-active gnus-agent-method-p
2890 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2891 gnus-summary-set-agent-mark gnus-agent-save-group-info
2892 gnus-agent-request-article gnus-agent-retrieve-headers)
2894 gnus-unplugged gnus-agentize gnus-agent-batch)
2896 gnus-summary-save-article-vm)
2901 gnus-group-split-update)
2904 ;;; gnus-sum.el thingies
2908 "*The format specification of the lines in the summary buffer.
2910 It works along the same lines as a normal formatting string,
2911 with some simple extensions.
2913 %N Article number, left padded with spaces (string)
2914 %S Subject (string)
2916 %n Name of the poster (string)
2917 %a Extracted name of the poster (string)
2918 %A Extracted address of the poster (string)
2919 %F Contents of the From: header (string)
2920 %f Contents of the From: or To: headers (string)
2921 %x Contents of the Xref: header (string)
2922 %D Date of the article (string)
2923 %d Date of the article (string) in DD-MMM format
2924 %o Date of the article (string) in YYYYMMDD`T'HHMMSS 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 spaces)
2932 %B A complex trn-style thread tree (string)
2933 The variables `gnus-sum-thread-*' can be used for customization.
2934 %T A string with two possible values: 80 spaces if the article
2935 is on thread level two or larger and 0 spaces on level one
2940 %> Spaces of length thread-level (string)
2941 %< Spaces of length (- 20 thread-level) (string)
2942 %i Article score (number)
2943 %z Article zcore (character)
2944 %t Number of articles under the current thread (number).
2945 %e Whether the thread is empty or not (character).
2946 %V Total thread score (number).
2947 %P The line number (number).
2948 %O Download mark (character).
2949 %* If present, indicates desired cursor position
2950 (instead of after first colon).
2951 %u User defined specifier. The next character in the format string should
2952 be a letter. Gnus will call the function gnus-user-format-function-X,
2953 where X is the letter following %u. The function will be passed the
2954 current header as argument. The function should return a string, which
2955 will be inserted into the summary just like information from any other
2956 summary specifier.
2958 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2959 with care. For reasons of efficiency, Gnus will compute what column
2961 it is invalid to have these specs after a variable-length spec. Well,
2962 you might not be arrested, but your summary buffer will look strange,
2963 which is bad enough.
2965 The smart choice is to have these specs as far to the left as
2966 possible.
2968 This restriction may disappear in later versions of Gnus.
2970 General format specifiers can also be used.
2971 See Info node `(gnus)Formatting Variables'."
2976 ;;;
2977 ;;; Skeleton keymaps
2978 ;;;
2983 (while keys
2984 (define-key keymap (pop keys) 'undefined))))
2986 (defvar gnus-article-mode-map
2987 (let ((keymap (make-sparse-keymap)))
2988 (gnus-suppress-keymap keymap)
2989 keymap))
2990 (defvar gnus-summary-mode-map
2991 (let ((keymap (make-keymap)))
2992 (gnus-suppress-keymap keymap)
2993 keymap))
2994 (defvar gnus-group-mode-map
2995 (let ((keymap (make-keymap)))
2996 (gnus-suppress-keymap keymap)
2997 keymap))
2999 \f
3001 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3002 ;; If you want the cursor to go somewhere else, set these two
3003 ;; functions in some startup hook to whatever you want.
3004 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3005 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3007 ;;; Various macros and substs.
3009 (defun gnus-header-from (header)
3010 (mail-header-from header))
3012 (defmacro gnus-gethash (string hashtable)
3013 "Get hash value of STRING in HASHTABLE."
3014 `(symbol-value (intern-soft ,string ,hashtable)))
3016 (defmacro gnus-gethash-safe (string hashtable)
3017 "Get hash value of STRING in HASHTABLE.
3018 Return nil if not defined."
3019 `(let ((sym (intern-soft ,string ,hashtable)))
3020 (and (boundp sym) (symbol-value sym))))
3022 (defmacro gnus-sethash (string value hashtable)
3023 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3024 `(set (intern ,string ,hashtable) ,value))
3025 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3027 (defmacro gnus-group-unread (group)
3028 "Get the currently computed number of unread articles in GROUP."
3029 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3031 (defmacro gnus-group-entry (group)
3032 "Get the newsrc entry for GROUP."
3033 `(gnus-gethash ,group gnus-newsrc-hashtb))
3035 (defmacro gnus-active (group)
3036 "Get active info on GROUP."
3037 `(gnus-gethash ,group gnus-active-hashtb))
3039 (defmacro gnus-set-active (group active)
3040 "Set GROUP's active info."
3041 `(gnus-sethash ,group ,active gnus-active-hashtb))
3043 ;; Info access macros.
3045 (defmacro gnus-info-group (info)
3046 `(nth 0 ,info))
3047 (defmacro gnus-info-rank (info)
3048 `(nth 1 ,info))
3049 (defmacro gnus-info-read (info)
3050 `(nth 2 ,info))
3051 (defmacro gnus-info-marks (info)
3052 `(nth 3 ,info))
3053 (defmacro gnus-info-method (info)
3054 `(nth 4 ,info))
3055 (defmacro gnus-info-params (info)
3056 `(nth 5 ,info))
3058 (defmacro gnus-info-level (info)
3059 `(let ((rank (gnus-info-rank ,info)))
3060 (if (consp rank)
3061 (car rank)
3062 rank)))
3063 (defmacro gnus-info-score (info)
3064 `(let ((rank (gnus-info-rank ,info)))
3065 (or (and (consp rank) (cdr rank)) 0)))
3067 (defmacro gnus-info-set-group (info group)
3068 `(setcar ,info ,group))
3069 (defmacro gnus-info-set-rank (info rank)
3070 `(setcar (nthcdr 1 ,info) ,rank))
3071 (defmacro gnus-info-set-read (info read)
3072 `(setcar (nthcdr 2 ,info) ,read))
3073 (defmacro gnus-info-set-marks (info marks &optional extend)
3074 (if extend
3075 `(gnus-info-set-entry ,info ,marks 3)
3076 `(setcar (nthcdr 3 ,info) ,marks)))
3077 (defmacro gnus-info-set-method (info method &optional extend)
3078 (if extend
3079 `(gnus-info-set-entry ,info ,method 4)
3080 `(setcar (nthcdr 4 ,info) ,method)))
3081 (defmacro gnus-info-set-params (info params &optional extend)
3082 (if extend
3083 `(gnus-info-set-entry ,info ,params 5)
3084 `(setcar (nthcdr 5 ,info) ,params)))
3086 (defun gnus-info-set-entry (info entry number)
3087 ;; Extend the info until we have enough elements.
3088 (while (<= (length info) number)
3089 (nconc info (list nil)))
3090 ;; Set the entry.
3091 (setcar (nthcdr number info) entry))
3093 (defmacro gnus-info-set-level (info level)
3094 `(let ((rank (cdr ,info)))
3095 (if (consp (car rank))
3096 (setcar (car rank) ,level)
3097 (setcar rank ,level))))
3098 (defmacro gnus-info-set-score (info score)
3099 `(let ((rank (cdr ,info)))
3100 (if (consp (car rank))
3101 (setcdr (car rank) ,score)
3102 (setcar rank (cons (car rank) ,score)))))
3104 (defmacro gnus-get-info (group)
3105 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3107 ;;; Load the compatibility functions.
3109 (require 'gnus-ems)
3111 \f
3112 ;;;
3113 ;;; Shutdown
3114 ;;;
3116 (defvar gnus-shutdown-alist nil)
3118 (defun gnus-add-shutdown (function &rest symbols)
3119 "Run FUNCTION whenever one of SYMBOLS is shut down."
3120 (push (cons function symbols) gnus-shutdown-alist))
3122 (defun gnus-shutdown (symbol)
3123 "Shut down everything that waits for SYMBOL."
3124 (dolist (entry gnus-shutdown-alist)
3125 (when (memq symbol (cdr entry))
3126 (funcall (car entry)))))
3128 \f
3129 ;;;
3130 ;;; Gnus Utility Functions
3131 ;;;
3133 (defun gnus-find-subscribed-addresses ()
3134 "Return a regexp matching the addresses of all subscribed mail groups.
3135 It consists of the `to-address' or `to-list' parameter of all groups
3136 with a `subscribed' parameter."
3137 (let (group address addresses)
3138 (dolist (entry (cdr gnus-newsrc-alist))
3139 (setq group (car entry))
3140 (when (gnus-parameter-subscribed group)
3141 (setq address (mail-strip-quoted-names
3142 (or (gnus-group-fast-parameter group 'to-address)
3143 (gnus-group-fast-parameter group 'to-list))))
3144 (when address
3145 (add-to-list 'addresses address))))
3146 (when addresses
3149 (defmacro gnus-string-or (&rest strings)
3150 "Return the first element of STRINGS that is a non-blank string.
3151 STRINGS will be evaluated in normal `or' order."
3152 `(gnus-string-or-1 (list ,@strings)))
3154 (defun gnus-string-or-1 (strings)
3155 (let (string)
3156 (while strings
3157 (setq string (pop strings))
3159 (setq string nil)
3160 (setq strings nil)))
3161 string))
3163 (defun gnus-version (&optional arg)
3164 "Version number of this version of Gnus.
3165 If ARG, insert string at point."
3166 (interactive "P")
3167 (if arg
3168 (insert (message gnus-version))
3169 (message gnus-version)))
3171 (defun gnus-continuum-version (&optional version)
3172 "Return VERSION as a floating point number."
3173 (unless version
3174 (setq version gnus-version))
3177 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3178 (number (match-string 2 version))
3179 major minor least)
3180 (unless (string-match
3182 (error "Invalid version string: %s" version))
3183 (setq major (string-to-number (match-string 1 number))
3184 minor (string-to-number (match-string 2 number))
3185 least (if (match-beginning 3)
3186 (string-to-number (match-string 3 number))
3187 0))
3188 (string-to-number
3189 (if (zerop major)
3190 (format "%s00%02d%02d"
3191 (if (member alpha '("(ding)" "d"))
3192 "4.99"
3193 (+ 5 (* 0.02
3194 (abs
3195 (- (mm-char-int (aref (downcase alpha) 0))
3196 (mm-char-int ?t))))
3197 -0.01))
3198 minor least)
3199 (format "%d.%02d%02d" major minor least))))))
3201 (defun gnus-info-find-node (&optional nodename)
3202 "Find Info documentation of Gnus."
3203 (interactive)
3204 ;; Enlarge info window if needed.
3205 (let (gnus-info-buffer)
3206 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3207 (setq gnus-info-buffer (current-buffer))
3208 (gnus-configure-windows 'info)))
3210 ;;;
3211 ;;; gnus-interactive
3212 ;;;
3214 (defvar gnus-current-prefix-symbol nil
3215 "Current prefix symbol.")
3217 (defvar gnus-current-prefix-symbols nil
3218 "List of current prefix symbols.")
3220 (defun gnus-interactive (string &optional params)
3221 "Return a list that can be fed to `interactive'.
3222 See `interactive' for full documentation.
3224 Adds the following specs:
3226 y -- The current symbolic prefix.
3227 Y -- A list of the current symbolic prefix(es).
3228 A -- Article number.
3229 H -- Article header.
3230 g -- Group name."
3231 (let ((i 0)
3232 out c prompt)
3233 (while (< i (length string))
3235 (setq c (aref string i))
3236 (when (match-end 1)
3237 (setq prompt (match-string 1 string)))
3238 (setq i (match-end 0))
3239 ;; We basically emulate just about everything that
3240 ;; `interactive' does, but add the specs listed above.
3241 (push
3242 (cond
3243 ((= c ?a)
3244 (completing-read prompt obarray 'fboundp t))
3245 ((= c ?b)
3246 (read-buffer prompt (current-buffer) t))
3247 ((= c ?B)
3248 (read-buffer prompt (other-buffer (current-buffer))))
3249 ((= c ?c)
3250 (read-char))
3251 ((= c ?C)
3252 (completing-read prompt obarray 'commandp t))
3253 ((= c ?d)
3254 (point))
3255 ((= c ?D)
3256 (read-file-name prompt nil default-directory 'lambda))
3257 ((= c ?f)
3258 (read-file-name prompt nil nil 'lambda))
3259 ((= c ?F)
3260 (read-file-name prompt))
3261 ((= c ?k)
3262 (read-key-sequence prompt))
3263 ((= c ?K)
3264 (error "Not implemented spec"))
3265 ((= c ?e)
3266 (error "Not implemented spec"))
3267 ((= c ?m)
3268 (mark))
3269 ((= c ?N)
3270 (error "Not implemented spec"))
3271 ((= c ?n)
3272 (string-to-number (read-from-minibuffer prompt)))
3273 ((= c ?p)
3274 (prefix-numeric-value current-prefix-arg))
3275 ((= c ?P)
3276 current-prefix-arg)
3277 ((= c ?r)
3278 'gnus-prefix-nil)
3279 ((= c ?s)
3280 (read-string prompt))
3281 ((= c ?S)
3282 (intern (read-string prompt)))
3283 ((= c ?v)
3284 (read-variable prompt))
3285 ((= c ?x)
3286 (read-minibuffer prompt))
3287 ((= c ?x)
3288 (eval-minibuffer prompt))
3289 ;; And here the new specs come.
3290 ((= c ?y)
3291 gnus-current-prefix-symbol)
3292 ((= c ?Y)
3293 gnus-current-prefix-symbols)
3294 ((= c ?g)
3295 (gnus-group-group-name))
3296 ((= c ?A)
3297 (gnus-summary-skip-intangible)
3298 (or (get-text-property (point) 'gnus-number)
3299 (gnus-summary-last-subject)))
3300 ((= c ?H)
3301 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3302 (t
3303 (error "Non-implemented spec")))
3304 out)
3305 (cond
3306 ((= c ?r)
3307 (push (if (< (point) (mark)) (point) (mark)) out)
3308 (push (if (> (point) (mark)) (point) (mark)) out))))
3309 (setq out (delq 'gnus-prefix-nil out))
3310 (nreverse out)))
3312 (defun gnus-symbolic-argument (&optional arg)
3313 "Read a symbolic argument and a command, and then execute command."
3314 (interactive "P")
3315 (let* ((in-command (this-command-keys))
3316 (command in-command)
3317 gnus-current-prefix-symbols
3318 gnus-current-prefix-symbol
3319 syms)
3320 (while (equal in-command command)
3321 (message "%s-" (key-description (this-command-keys)))
3322 (push (intern (char-to-string (read-char))) syms)
3323 (setq command (read-key-sequence nil t)))
3324 (setq gnus-current-prefix-symbols (nreverse syms)
3325 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3326 (call-interactively (key-binding command t))))
3328 ;;; More various functions.
3330 (defsubst gnus-check-backend-function (func group)
3331 "Check whether GROUP supports function FUNC.
3332 GROUP can either be a string (a group name) or a select method."
3333 (ignore-errors
3334 (let ((method (if (stringp group)
3335 (car (gnus-find-method-for-group group))
3336 group)))
3337 (unless (featurep method)
3338 (require method))
3339 (fboundp (intern (format "%s-%s" method func))))))
3341 (defun gnus-group-read-only-p (&optional group)
3342 "Check whether GROUP supports editing or not.
3343 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3344 that that variable is buffer-local to the summary buffers."
3345 (let ((group (or group gnus-newsgroup-name)))
3346 (not (gnus-check-backend-function 'request-replace-article group))))
3348 (defun gnus-virtual-group-p (group)
3349 "Say whether GROUP is virtual or not."
3350 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3351 gnus-valid-select-methods)))
3353 (defun gnus-news-group-p (group &optional article)
3354 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3355 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3356 t) ;is news of course.
3357 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3358 nil) ;must be mail then.
3359 ((vectorp article) ;Has header info.
3360 (eq (gnus-request-type group (mail-header-id article)) 'news))
3361 ((null article) ;Hasn't header info
3362 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3363 ((< article 0) ;Virtual message
3364 nil) ;we don't know, guess mail.
3365 (t ;Has positive number
3366 (eq (gnus-request-type group article) 'news)))) ;use it.
3368 ;; Returns a list of writable groups.
3369 (defun gnus-writable-groups ()
3370 (let ((alist gnus-newsrc-alist)
3371 groups group)
3372 (while (setq group (car (pop alist)))
3373 (unless (gnus-group-read-only-p group)
3374 (push group groups)))
3375 (nreverse groups)))
3377 ;; Check whether to use long file names.
3378 (defun gnus-use-long-file-name (symbol)
3379 ;; The variable has to be set...
3380 (and gnus-use-long-file-name
3381 ;; If it isn't a list, then we return t.
3382 (or (not (listp gnus-use-long-file-name))
3383 ;; If it is a list, and the list contains `symbol', we
3384 ;; return nil.
3385 (not (memq symbol gnus-use-long-file-name)))))
3387 ;; Generate a unique new group name.
3388 (defun gnus-generate-new-group-name (leaf)
3389 (let ((name leaf)
3390 (num 0))
3391 (while (gnus-group-entry name)
3392 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3393 name))
3395 (defun gnus-ephemeral-group-p (group)
3396 "Say whether GROUP is ephemeral or not."
3397 (gnus-group-get-parameter group 'quit-config t))
3399 (defun gnus-group-quit-config (group)
3400 "Return the quit-config of GROUP."
3401 (gnus-group-get-parameter group 'quit-config t))
3403 (defun gnus-kill-ephemeral-group (group)
3404 "Remove ephemeral GROUP from relevant structures."
3405 (gnus-sethash group nil gnus-newsrc-hashtb))
3407 (defun gnus-simplify-mode-line ()
3408 "Make mode lines a bit simpler."
3409 (setq mode-line-modified (cdr gnus-mode-line-modified))
3410 (when (listp mode-line-format)
3411 (make-local-variable 'mode-line-format)
3412 (setq mode-line-format (copy-sequence mode-line-format))
3413 (when (equal (nth 3 mode-line-format) " ")
3414 (setcar (nthcdr 3 mode-line-format) " "))))
3416 ;;; Servers and groups.
3418 (defsubst gnus-server-add-address (method)
3419 (let ((method-name (symbol-name (car method))))
3420 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3421 (not (assq (intern (concat method-name "-address")) method))
3422 (memq 'physical-address (assq (car method)
3423 gnus-valid-select-methods)))
3424 (append method (list (list (intern (concat method-name "-address"))
3425 (nth 1 method))))
3426 method)))
3428 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3429 (catch 'server-name
3430 (setq method (or method gnus-select-method))
3432 ;; Perhaps it is already in the cache.
3433 (unless nocache
3434 (mapc (lambda (name-method)
3435 (if (equal (cdr name-method) method)
3436 (throw 'server-name (car name-method))))
3437 gnus-server-method-cache))
3439 (mapc
3440 (lambda (server-alist)
3441 (mapc (lambda (name-method)
3442 (when (gnus-methods-equal-p (cdr name-method) method)
3443 (unless (member name-method gnus-server-method-cache)
3444 (push name-method gnus-server-method-cache))
3445 (throw 'server-name (car name-method))))
3446 server-alist))
3447 (list gnus-server-alist
3448 gnus-predefined-server-alist))
3450 (let* ((name (if (member (cadr method) '(nil ""))
3451 (format "%s" (car method))
3452 (format "%s:%s" (car method) (cadr method))))
3453 (name-method (cons name method)))
3454 (when (and (not (member name-method gnus-server-method-cache))
3455 (not no-enter-cache)
3456 (not (assoc (car name-method) gnus-server-method-cache)))
3457 (push name-method gnus-server-method-cache))
3458 name)))
3460 (defsubst gnus-server-to-method (server)
3461 "Map virtual server names to select methods."
3462 (or (and server (listp server) server)
3463 (cdr (assoc server gnus-server-method-cache))
3464 (let ((result
3465 (or
3466 ;; Perhaps this is the native server?
3467 (and (equal server "native") gnus-select-method)
3468 ;; It should be in the server alist.
3469 (cdr (assoc server gnus-server-alist))
3470 ;; It could be in the predefined server alist.
3471 (cdr (assoc server gnus-predefined-server-alist))
3472 ;; If not, we look through all the opened server
3473 ;; to see whether we can find it there.
3474 (let ((opened gnus-opened-servers))
3475 (while (and opened
3476 (not (equal server (format "%s:%s" (caaar opened)
3477 (cadaar opened)))))
3478 (pop opened))
3479 (caar opened))
3480 ;; It could be a named method, search all servers
3481 (let ((servers gnus-secondary-select-methods))
3482 (while (and servers
3483 (not (equal server (format "%s:%s" (caar servers)
3484 (cadar servers)))))
3485 (pop servers))
3486 (car servers))
3487 ;; This could be some sort of foreign server that I
3488 ;; simply haven't opened (yet). Do a brute-force scan
3489 ;; of the entire gnus-newsrc-alist for the server name
3490 ;; of every method. As a side-effect, loads the
3491 ;; gnus-server-method-cache so this only happens once,
3492 ;; if at all.
3493 (let ((alist (cdr gnus-newsrc-alist))
3494 method match)
3495 (while alist
3496 (setq method (gnus-info-method (pop alist)))
3497 (when (and (not (stringp method))
3498 (equal server
3499 (gnus-method-to-server method nil t)))
3500 (setq match method
3501 alist nil)))
3502 match))))
3503 (when (and result
3504 (not (assoc server gnus-server-method-cache)))
3505 (push (cons server result) gnus-server-method-cache))
3506 result)))
3508 (defsubst gnus-server-get-method (group method)
3509 ;; Input either a server name, and extended server name, or a
3510 ;; select method, and return a select method.
3511 (cond ((stringp method)
3512 (gnus-server-to-method method))
3513 ((equal method gnus-select-method)
3514 gnus-select-method)
3515 ((and (stringp (car method))
3516 group)
3517 (gnus-server-extend-method group method))
3518 ((and method
3519 (not group)
3520 (equal (cadr method) ""))
3521 method)
3522 (t
3523 (gnus-server-add-address method))))
3525 (defmacro gnus-method-equal (ss1 ss2)
3526 "Say whether two servers are equal."
3527 `(let ((s1 ,ss1)
3528 (s2 ,ss2))
3529 (or (equal s1 s2)
3530 (and (= (length s1) (length s2))
3531 (progn
3532 (while (and s1 (member (car s1) s2))
3533 (setq s1 (cdr s1)))
3534 (null s1))))))
3536 (defun gnus-methods-equal-p (m1 m2)
3537 (let ((m1 (or m1 gnus-select-method))
3538 (m2 (or m2 gnus-select-method)))
3539 (or (equal m1 m2)
3540 (and (eq (car m1) (car m2))
3541 (or (not (memq 'address (assoc (symbol-name (car m1))
3542 gnus-valid-select-methods)))
3543 (equal (nth 1 m1) (nth 1 m2)))))))
3545 (defun gnus-methods-sloppily-equal (m1 m2)
3546 ;; Same method.
3547 (or
3548 (eq m1 m2)
3549 ;; Type and name are equal.
3550 (and
3551 (eq (car m1) (car m2))
3552 (equal (cadr m1) (cadr m2))
3553 (gnus-sloppily-equal-method-parameters m1 m2))))
3555 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3556 ;; Check parameters for sloppy equalness.
3557 (let ((p1 (copy-sequence (cddr m1)))
3558 (p2 (copy-sequence (cddr m2)))
3559 e1 e2)
3560 (block nil
3561 (while (setq e1 (pop p1))
3562 (unless (setq e2 (assq (car e1) p2))
3563 ;; The parameter doesn't exist in p2.
3564 (return nil))
3565 (setq p2 (delq e2 p2))
3566 (unless (equal e1 e2)
3567 (if (not (and (stringp (cadr e1))
3568 (stringp (cadr e2))))
3569 (return nil)
3570 ;; Special-case string parameter comparison so that we
3571 ;; can uniquify them.
3572 (let ((s1 (cadr e1))
3573 (s2 (cadr e2)))
3574 (when (string-match "/$" s1)
3575 (setq s1 (directory-file-name s1)))
3576 (when (string-match "/$" s2)
3577 (setq s2 (directory-file-name s2)))
3578 (unless (equal s1 s2)
3579 (return nil))))))
3580 ;; If p2 now is empty, they were equal.
3581 (null p2))))
3583 (defun gnus-server-equal (m1 m2)
3584 "Say whether two methods are equal."
3585 (let ((m1 (cond ((null m1) gnus-select-method)
3586 ((stringp m1) (gnus-server-to-method m1))
3587 (t m1)))
3588 (m2 (cond ((null m2) gnus-select-method)
3589 ((stringp m2) (gnus-server-to-method m2))
3590 (t m2))))
3591 (gnus-method-equal m1 m2)))
3593 (defun gnus-servers-using-backend (backend)
3594 "Return a list of known servers using BACKEND."
3595 (let ((opened gnus-opened-servers)
3596 out)
3597 (while opened
3598 (when (eq backend (caaar opened))
3599 (push (caar opened) out))
3600 (pop opened))
3601 out))
3603 (defun gnus-archive-server-wanted-p ()
3604 "Say whether the user wants to use the archive server."
3605 (cond
3606 ((or (not gnus-message-archive-method)
3607 (not gnus-message-archive-group))
3608 nil)
3609 ((and gnus-message-archive-method gnus-message-archive-group)
3610 t)
3611 (t
3612 (let ((active (cadr (assq 'nnfolder-active-file
3613 gnus-message-archive-method))))
3614 (and active
3615 (file-exists-p active))))))
3617 (defsubst gnus-method-to-server-name (method)
3618 (concat
3619 (format "%s" (car method))
3620 (when (and
3621 (or (assoc (format "%s" (car method))
3622 (gnus-methods-using 'address))
3623 (gnus-server-equal method gnus-message-archive-method))
3624 (nth 1 method)
3625 (not (string= (nth 1 method) "")))
3626 (concat "+" (nth 1 method)))))
3628 (defsubst gnus-method-to-full-server-name (method)
3629 (format "%s+%s" (car method) (nth 1 method)))
3631 (defun gnus-group-prefixed-name (group method &optional full)
3632 "Return the whole name from GROUP and METHOD.
3633 Call with full set to get the fully qualified group name (even if the
3634 server is native)."
3635 (when (stringp method)
3636 (setq method (gnus-server-to-method method)))
3637 (if (or (not method)
3638 (and (not full) (gnus-server-equal method "native"))
3639 ;;;!!! This might not be right. We'll see...
3640 ;(string-match ":" group)
3641 )
3642 group
3643 (concat (gnus-method-to-server-name method) ":" group)))
3645 (defun gnus-group-guess-prefixed-name (group)
3646 "Guess the whole name from GROUP and METHOD."
3647 (gnus-group-prefixed-name group (gnus-find-method-for-group
3648 group)))
3650 (defun gnus-group-full-name (group method)
3651 "Return the full name from GROUP and METHOD, even if the method is native."
3652 (gnus-group-prefixed-name group method t))
3654 (defun gnus-group-guess-full-name (group)
3655 "Guess the full name from GROUP, even if the method is native."
3656 (if (gnus-group-prefixed-p group)
3657 group
3658 (gnus-group-full-name group (gnus-find-method-for-group group))))
3660 (defun gnus-group-guess-full-name-from-command-method (group)
3661 "Guess the full name from GROUP, even if the method is native."
3662 (if (gnus-group-prefixed-p group)
3663 group
3664 (gnus-group-full-name group gnus-command-method)))
3666 (defun gnus-group-real-prefix (group)
3667 "Return the prefix of the current group name."
3668 (if (stringp group)
3669 (if (string-match "^[^:]+:" group)
3670 (substring group 0 (match-end 0))
3671 "")
3672 nil))
3674 (defun gnus-group-short-name (group)
3675 "Return the short group name."
3676 (let ((prefix (gnus-group-real-prefix group)))
3677 (if (< 0 (length prefix))
3678 (substring group (length prefix) nil)
3679 group)))
3681 (defun gnus-group-prefixed-p (group)
3682 "Return the prefix of the current group name."
3683 (< 0 (length (gnus-group-real-prefix group))))
3685 (declare-function gnus-group-decoded-name "gnus-group" (string))
3687 (defun gnus-summary-buffer-name (group)
3688 "Return the summary buffer name of GROUP."
3689 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3691 (defun gnus-group-method (group)
3692 "Return the server or method used for selecting GROUP.
3693 You should probably use `gnus-find-method-for-group' instead."
3694 (let ((prefix (gnus-group-real-prefix group)))
3695 (if (equal prefix "")
3696 gnus-select-method
3697 (let ((servers gnus-opened-servers)
3698 (server "")
3699 backend possible found)
3701 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3702 server (substring prefix (match-end 0) (1- (length prefix))))
3703 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3704 (while servers
3705 (when (eq (caaar servers) backend)
3706 (setq possible (caar servers))
3707 (when (equal (cadaar servers) server)
3708 (setq found (caar servers))))
3709 (pop servers))
3710 (or (car (rassoc found gnus-server-alist))
3711 found
3712 (car (rassoc possible gnus-server-alist))
3713 possible
3714 (list backend server))))))
3716 (defsubst gnus-native-method-p (method)
3717 "Return whether METHOD is the native select method."
3718 (gnus-method-equal method gnus-select-method))
3720 (defsubst gnus-secondary-method-p (method)
3721 "Return whether METHOD is a secondary select method."
3722 (let ((methods gnus-secondary-select-methods)
3723 (gmethod (inline (gnus-server-get-method nil method))))
3724 (while (and methods
3725 (not (gnus-method-equal
3726 (inline (gnus-server-get-method nil (car methods)))
3727 gmethod)))
3728 (setq methods (cdr methods)))
3729 methods))
3731 (defun gnus-method-simplify (method)
3732 "Return the shortest uniquely identifying string or method for METHOD."
3733 (cond ((stringp method)
3734 method)
3735 ((gnus-native-method-p method)
3736 nil)
3737 ((gnus-secondary-method-p method)
3738 (format "%s:%s" (nth 0 method) (nth 1 method)))
3739 (t
3740 method)))
3742 (defun gnus-groups-from-server (server)
3743 "Return a list of all groups that are fetched from SERVER."
3744 (let ((alist (cdr gnus-newsrc-alist))
3745 info groups)
3746 (while (setq info (pop alist))
3747 (when (gnus-server-equal (gnus-info-method info) server)
3748 (push (gnus-info-group info) groups)))
3749 (sort groups 'string<)))
3751 (defun gnus-group-foreign-p (group)
3752 "Say whether a group is foreign or not."
3753 (and (not (gnus-group-native-p group))
3754 (not (gnus-group-secondary-p group))))
3756 (defun gnus-group-native-p (group)
3757 "Say whether the group is native or not."
3758 (not (string-match ":" group)))
3760 (defun gnus-group-secondary-p (group)
3761 "Say whether the group is secondary or not."
3762 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3764 (defun gnus-parameters-get-parameter (group)
3765 "Return the group parameters for GROUP from `gnus-parameters'."
3766 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3767 case-fold-search
3768 gnus-parameters-case-fold-search))
3769 params-list)
3770 (dolist (elem gnus-parameters)
3771 (when (string-match (car elem) group)
3772 (setq params-list
3773 (nconc (gnus-expand-group-parameters
3774 (car elem) (cdr elem) group)
3775 params-list))))
3776 params-list))
3778 (defun gnus-expand-group-parameter (match value group)
3779 "Use MATCH to expand VALUE in GROUP."
3780 (let ((start (string-match match group)))
3781 (if start
3782 (let ((matched-string (substring group start (match-end 0))))
3783 ;; Build match groups
3784 (string-match match matched-string)
3785 (replace-match value nil nil matched-string))
3786 group)))
3788 (defun gnus-expand-group-parameters (match parameters group)
3789 "Go through PARAMETERS and expand them according to the match data."
3790 (let (new)
3791 (dolist (elem parameters)
3792 (if (and (stringp (cdr elem))
3794 (push (cons (car elem)
3795 (gnus-expand-group-parameter match (cdr elem) group))
3796 new)
3797 (push elem new)))
3798 new))
3800 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3801 "For GROUP, return the value of SYMBOL.
3803 You should call this in the `gnus-group-buffer' buffer.
3804 The function `gnus-group-find-parameter' will do that for you."
3805 ;; The speed trick: No cons'ing and quit early.
3806 (let* ((params (funcall gnus-group-get-parameter-function group))
3807 ;; Start easy, check the "real" group parameters.
3808 (simple-results
3809 (gnus-group-parameter-value params symbol allow-list t)))
3810 (if simple-results
3811 ;; Found results; return them.
3812 (car simple-results)
3813 ;; We didn't find it there, try `gnus-parameters'.
3814 (let ((result nil)
3815 (head nil)
3816 (tail gnus-parameters))
3817 ;; A good old-fashioned non-cl loop.
3818 (while tail
3819 (setq head (car tail)
3820 tail (cdr tail))
3821 ;; The car is regexp matching for matching the group name.
3822 (when (string-match (car head) group)
3823 ;; The cdr is the parameters.
3824 (setq result (gnus-group-parameter-value (cdr head)
3825 symbol allow-list))
3826 (when result
3827 ;; Expand if necessary.
3829 (setq result (gnus-expand-group-parameter (car head)
3830 result group))))))
3831 ;; Done.
3832 result))))
3834 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3835 "Return the group parameters for GROUP.
3836 If SYMBOL, return the value of that symbol in the group parameters.
3838 If you call this function inside a loop, consider using the faster
3839 `gnus-group-fast-parameter' instead."
3840 (with-current-buffer gnus-group-buffer
3841 (if symbol
3842 (gnus-group-fast-parameter group symbol allow-list)
3843 (nconc
3844 (copy-sequence
3845 (funcall gnus-group-get-parameter-function group))
3846 (gnus-parameters-get-parameter group)))))
3848 (defun gnus-group-get-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.
3851 If ALLOW-LIST, also allow list as a result.
3852 Most functions should use `gnus-group-find-parameter', which
3853 also examines the topic parameters."
3854 (let ((params (gnus-info-params (gnus-get-info group))))
3855 (if symbol
3856 (gnus-group-parameter-value params symbol allow-list)
3857 params)))
3859 (defun gnus-group-parameter-value (params symbol &optional
3860 allow-list present-p)
3861 "Return the value of SYMBOL in group PARAMS.
3862 If ALLOW-LIST, also allow list as a result."
3863 ;; We only wish to return group parameters (dotted lists) and
3864 ;; not local variables, which may have the same names.
3865 ;; But first we handle single elements...
3866 (or (car (memq symbol params))
3867 ;; Handle alist.
3868 (let (elem)
3869 (catch 'found
3870 (while (setq elem (pop params))
3871 (when (and (consp elem)
3872 (eq (car elem) symbol)
3873 (or allow-list
3874 (atom (cdr elem))))
3875 (throw 'found (if present-p (list (cdr elem))
3876 (cdr elem)))))))))
3878 (defun gnus-group-add-parameter (group param)
3879 "Add parameter PARAM to GROUP."
3880 (let ((info (gnus-get-info group)))
3881 (when info
3882 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3883 ;; Cons the new param to the old one and update.
3884 (gnus-group-set-info (cons param (gnus-info-params info))
3885 group 'params))))
3887 (defun gnus-group-set-parameter (group name value)
3888 "Set parameter NAME to VALUE in GROUP.
3889 GROUP can also be an INFO structure."
3890 (let ((info (if (listp group)
3891 group
3892 (gnus-get-info group))))
3893 (when info
3894 (gnus-group-remove-parameter group name)
3895 (let ((old-params (gnus-info-params info))
3896 (new-params (list (cons name value))))
3897 (while old-params
3898 (when (or (not (listp (car old-params)))
3899 (not (eq (caar old-params) name)))
3900 (setq new-params (append new-params (list (car old-params)))))
3901 (setq old-params (cdr old-params)))
3902 (if (listp group)
3903 (gnus-info-set-params info new-params t)
3904 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3906 (defun gnus-group-remove-parameter (group name)
3907 "Remove parameter NAME from GROUP.
3908 GROUP can also be an INFO structure."
3909 (let ((info (if (listp group)
3910 group
3911 (gnus-get-info group))))
3912 (when info
3913 (let ((params (gnus-info-params info)))
3914 (when params
3915 (setq params (delq name params))
3916 (while (assq name params)
3917 (gnus-alist-pull name params))
3918 (gnus-info-set-params info params))))))
3920 (defun gnus-group-add-score (group &optional score)
3921 "Add SCORE to the GROUP score.
3922 If SCORE is nil, add 1 to the score of GROUP."
3923 (let ((info (gnus-get-info group)))
3924 (when info
3925 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3927 (defun gnus-short-group-name (group &optional levels)
3928 "Collapse GROUP name LEVELS.
3929 Select methods are stripped and any remote host name is stripped down to
3930 just the host name."
3931 (let* ((name "")
3932 (foreign "")
3933 (depth 0)
3934 (skip 1)
3935 (levels (or levels
3936 gnus-group-uncollapsed-levels
3937 (progn
3939 (setq skip (match-end 0)
3940 depth (+ depth 1)))
3941 depth))))
3942 ;; Separate foreign select method from group name and collapse.
3943 ;; If method contains a server, collapse to non-domain server name,
3944 ;; otherwise collapse to select method.
3945 (let* ((colon (string-match ":" group))
3946 (server (and colon (substring group 0 colon)))
3947 (plus (and server (string-match "+" server))))
3948 (when server
3949 (if plus
3950 (setq foreign (substring server (+ 1 plus)
3952 group (substring group (+ 1 colon)))
3953 (setq foreign server
3954 group (substring group (+ 1 colon))))
3955 (setq foreign (concat foreign ":")))
3956 ;; Collapse group name leaving LEVELS uncollapsed elements
3957 (let* ((slist (split-string group "/"))
3958 (slen (length slist))
3960 (dlen (length dlist))
3961 glist
3962 glen
3963 gsep
3964 res)
3965 (if (> slen dlen)
3966 (setq glist slist
3967 glen slen
3968 gsep "/")
3969 (setq glist dlist
3970 glen dlen
3971 gsep "."))
3972 (setq levels (- glen levels))
3973 (dolist (g glist)
3974 (push (if (>= (decf levels) 0)
3975 (if (zerop (length g))
3976 ""
3977 (substring g 0 1))
3978 g)
3979 res))
3980 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3982 (defun gnus-narrow-to-body ()
3983 "Narrow to the body of an article."
3984 (narrow-to-region
3985 (progn
3986 (goto-char (point-min))
3988 (point-max)))
3989 (point-max)))
3991 \f
3992 ;;;
3993 ;;; Kill file handling.
3994 ;;;
3996 (defun gnus-apply-kill-file ()
3997 "Apply a kill file to the current newsgroup.
3998 Returns the number of articles marked as read."
3999 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4000 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4001 (gnus-apply-kill-file-internal)
4002 0))
4004 (defun gnus-kill-save-kill-buffer ()
4005 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4006 (when (get-file-buffer file)
4007 (with-current-buffer (get-file-buffer file)
4008 (when (buffer-modified-p)
4009 (save-buffer))
4010 (kill-buffer (current-buffer))))))
4012 (defcustom gnus-kill-file-name "KILL"
4013 "Suffix of the kill files."
4014 :group 'gnus-score-kill
4015 :group 'gnus-score-files
4016 :type 'string)
4018 (defun gnus-newsgroup-kill-file (newsgroup)
4019 "Return the name of a kill file name for NEWSGROUP.
4020 If NEWSGROUP is nil, return the global kill file name instead."
4021 (cond
4022 ;; The global KILL file is placed at top of the directory.
4023 ((or (null newsgroup)
4024 (string-equal newsgroup ""))
4025 (expand-file-name gnus-kill-file-name
4026 gnus-kill-files-directory))
4027 ;; Append ".KILL" to newsgroup name.
4028 ((gnus-use-long-file-name 'not-kill)
4029 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4030 "." gnus-kill-file-name)
4031 gnus-kill-files-directory))
4032 ;; Place "KILL" under the hierarchical directory.
4033 (t
4034 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4035 "/" gnus-kill-file-name)
4036 gnus-kill-files-directory))))
4038 ;;; Server things.
4040 (defun gnus-member-of-valid (symbol group)
4042 (memq symbol (assoc
4043 (symbol-name (car (gnus-find-method-for-group group)))
4044 gnus-valid-select-methods)))
4046 (defun gnus-method-option-p (method option)
4047 "Return non-nil if select METHOD has OPTION as a parameter."
4048 (when (stringp method)
4049 (setq method (gnus-server-to-method method)))
4050 (memq option (assoc (format "%s" (car method))
4051 gnus-valid-select-methods)))
4053 (defun gnus-similar-server-opened (method)
4054 "Return non-nil if we have a similar server opened.
4055 This is defined as a server with the same name, but different
4056 parameters."
4057 (let ((opened gnus-opened-servers)
4058 open)
4059 (while (and method opened)
4060 (setq open (car (pop opened)))
4061 ;; Type and name are the same...
4062 (when (and (equal (car method) (car open))
4063 (equal (cadr method) (cadr open))
4064 ;; ... but the rest of the parameters differ.
4065 (not (gnus-methods-sloppily-equal method open)))
4066 (setq method nil)))
4067 (not method)))
4069 (defun gnus-server-extend-method (group method)
4070 ;; This function "extends" a virtual server. If the server is
4071 ;; "hello", and the select method is ("hello" (my-var "something"))
4072 ;; in the group "alt.alt", this will result in a new virtual server
4073 ;; called "hello+alt.alt".
4074 (if (or (not (inline (gnus-similar-server-opened method)))
4075 (not (cddr method)))
4076 method
4077 (setq method
4078 `(,(car method) ,(concat (cadr method) "+" group)
4079 (,(intern (format "%s-address" (car method))) ,(cadr method))
4080 ,@(cddr method)))
4081 (push method gnus-extended-servers)
4082 method))
4084 (defun gnus-server-status (method)
4085 "Return the status of METHOD."
4086 (nth 1 (assoc method gnus-opened-servers)))
4088 (defun gnus-group-name-to-method (group)
4089 "Guess a select method based on GROUP."
4090 (if (string-match ":" group)
4091 (let ((server (substring group 0 (match-beginning 0))))
4093 (list (intern (substring server 0 (match-beginning 0)))
4094 (substring server (match-end 0)))
4095 (list (intern server) "")))
4096 gnus-select-method))
4098 (defun gnus-server-string (server)
4099 "Return a readable string that describes SERVER."
4100 (let* ((server (gnus-server-to-method server))
4101 (address (nth 1 server)))
4102 (if (and address
4103 (not (zerop (length address))))
4104 (format "%s using %s" address (car server))
4105 (format "%s" (car server)))))
4107 (defun gnus-same-method-different-name (method)
4108 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4109 (unless (assq slot (cddr method))
4110 (setq method
4111 (append method (list (list slot (nth 1 method)))))))
4112 (let ((methods gnus-extended-servers)
4113 open found)
4114 (while (and (not found)
4115 (setq open (pop methods)))
4116 (when (and (eq (car method) (car open))
4117 (gnus-sloppily-equal-method-parameters method open))
4118 (setq found open)))
4119 found))
4121 (defun gnus-find-method-for-group (group &optional info)
4122 "Find the select method that GROUP uses."
4123 (or gnus-override-method
4124 (and (not group)
4125 gnus-select-method)
4126 (and (not (gnus-group-entry group))
4127 ;; Killed or otherwise unknown group.
4128 (or
4129 ;; If we know a virtual server by that name, return its method.
4130 (gnus-server-to-method (gnus-group-server group))
4131 ;; Guess a new method as last resort.
4132 (gnus-group-name-to-method group)))
4133 (let ((info (or info (gnus-get-info group)))
4134 method)
4135 (if (or (not info)
4136 (not (setq method (gnus-info-method info)))
4137 (equal method "native"))
4138 gnus-select-method
4139 (setq method
4140 (cond ((stringp method)
4141 (inline (gnus-server-to-method method)))
4142 ((stringp (cadr method))
4143 (or
4144 (inline
4145 (gnus-same-method-different-name method))
4146 (inline (gnus-server-extend-method group method))))
4147 (t
4148 method)))
4149 (cond ((equal (cadr method) "")
4150 method)
4151 ((null (cadr method))
4152 (list (car method) ""))
4153 (t
4154 (gnus-server-add-address method)))))))
4156 (defun gnus-methods-using (feature)
4157 "Find all methods that have FEATURE."
4158 (let ((valids gnus-valid-select-methods)
4159 outs)
4160 (while valids
4161 (when (memq feature (car valids))
4162 (push (car valids) outs))
4163 (setq valids (cdr valids)))
4164 outs))
4166 (eval-and-compile
4167 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4169 (defun gnus-read-group (prompt &optional default)
4170 "Prompt the user for a group name.
4171 Disallow invalid group names."
4172 (let ((prefix "")
4173 group)
4174 (while (not group)
4175 (when (string-match
4176 gnus-invalid-group-regexp
4177 (setq group (read-string (concat prefix prompt)
4178 (cons (or default "") 0)
4179 'gnus-group-history)))
4180 (let ((match (match-string 0 group)))
4181 ;; Might be okay (e.g. for nnimap), so ask the user:
4183 (message-y-or-n-p
4184 "Proceed and create group anyway? " t
4187 Usually, it's dangerous to create a group with this name, because it's not
4188 supported by all back ends and servers. On IMAP servers it should work,
4189 though. If you are really sure, you can proceed anyway and create the group.
4191 You may customize the variable `gnus-invalid-group-regexp', which currently is
4195 group nil)))))
4196 group))
4198 (defun gnus-read-method (prompt)
4199 "Prompt the user for a method.
4200 Allow completion over sensible values."
4201 (let* ((open-servers
4202 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4203 gnus-opened-servers))
4204 (valid-methods
4205 (let (methods)
4206 (dolist (method gnus-valid-select-methods)
4207 (if (or (memq 'prompt-address method)
4208 (not (assoc (format "%s:" (car method)) open-servers)))
4209 (push method methods)))
4210 methods))
4211 (servers
4212 (append valid-methods
4213 open-servers
4214 gnus-predefined-server-alist
4215 gnus-server-alist))
4216 (method
4217 (gnus-completing-read
4218 prompt (mapcar 'car servers)
4219 t nil 'gnus-method-history)))
4220 (cond
4221 ((equal method "")
4222 (setq method gnus-select-method))
4223 ((assoc method gnus-valid-select-methods)
4224 (let ((address (if (memq 'prompt-address
4225 (assoc method gnus-valid-select-methods))
4226 (read-string "Address: ")
4227 "")))
4228 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4229 (list (intern method) address))))
4230 ((assoc method servers)
4231 method)
4232 (t
4233 (list (intern method) "")))))
4235 ;;; Agent functions
4237 (defun gnus-agent-method-p (method-or-server)
4238 "Say whether METHOD is covered by the agent."
4239 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4240 (let* ((method (if (stringp method-or-server)
4241 (gnus-server-to-method method-or-server)
4242 method-or-server))
4243 (server (gnus-method-to-server method t)))
4244 (setq gnus-agent-method-p-cache
4245 (cons method-or-server
4246 (member server gnus-agent-covered-methods)))))
4247 (cdr gnus-agent-method-p-cache))
4249 (defun gnus-online (method)
4250 (not
4251 (if gnus-plugged
4252 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4253 (gnus-agent-method-p method))))
4255 ;;; User-level commands.
4257 ;;;###autoload
4258 (defun gnus-slave-no-server (&optional arg)
4259 "Read network news as a slave, without connecting to the local server."
4260 (interactive "P")
4261 (gnus-no-server arg t))
4263 ;;;###autoload
4264 (defun gnus-no-server (&optional arg slave)
4265 "Read network news.
4266 If ARG is a positive number, Gnus will use that as the startup
4267 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4268 non-nil and not a positive number, Gnus will prompt the user for the
4269 name of an NNTP server to use.
4270 As opposed to `gnus', this command will not connect to the local
4271 server."
4272 (interactive "P")
4273 (gnus-no-server-1 arg slave))
4275 ;;;###autoload
4276 (defun gnus-slave (&optional arg)
4277 "Read news as a slave."
4278 (interactive "P")
4279 (gnus arg nil 'slave))
4281 ;;;###autoload
4282 (defun gnus-other-frame (&optional arg display)
4283 "Pop up a frame to read news.
4284 This will call one of the Gnus commands which is specified by the user
4285 option `gnus-other-frame-function' (default `gnus') with the argument
4286 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4287 optional second argument DISPLAY should be a standard display string
4289 omitted or the function `make-frame-on-display' is not available, the
4290 current display is used."
4291 (interactive "P")
4292 (if (fboundp 'make-frame-on-display)
4293 (unless display
4294 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4295 (setq display nil))
4296 (let ((alive (gnus-alive-p)))
4297 (unless (and alive
4298 (catch 'found
4299 (walk-windows
4300 (lambda (window)
4301 (when (and (or (not display)
4302 (equal display
4303 (gnus-frame-or-window-display-name
4304 window)))
4305 (with-current-buffer (window-buffer window)
4307 (symbol-name major-mode))))
4308 (gnus-select-frame-set-input-focus
4309 (setq gnus-other-frame-object (window-frame window)))
4310 (select-window window)
4311 (throw 'found t)))
4312 'ignore t)))
4313 (gnus-select-frame-set-input-focus
4314 (setq gnus-other-frame-object
4315 (if display
4316 (make-frame-on-display display gnus-other-frame-parameters)
4317 (make-frame gnus-other-frame-parameters))))
4318 (if alive
4319 (switch-to-buffer gnus-group-buffer)
4320 (funcall gnus-other-frame-function arg)
4321 (add-hook 'gnus-exit-gnus-hook
4322 '(lambda nil
4323 (when (and (frame-live-p gnus-other-frame-object)
4324 (cdr (frame-list)))
4325 (delete-frame gnus-other-frame-object))
4326 (setq gnus-other-frame-object nil)))))))
4328 ;;;###autoload
4329 (defun gnus (&optional arg dont-connect slave)
4330 "Read network news.
4331 If ARG is non-nil and a positive number, Gnus will use that as the
4332 startup level. If ARG is non-nil and not a positive number, Gnus will
4333 prompt the user for the name of an NNTP server to use."
4334 (interactive "P")
4335 ;; When using the development version of Gnus, load the gnus-load
4336 ;; file.
4337 (unless (string-match "^Gnus" gnus-version)
4338 (load "gnus-load" nil t))
4339 (unless (byte-code-function-p (symbol-function 'gnus))
4340 (message "You should byte-compile Gnus")
4341 (sit-for 2))
4342 (let ((gnus-action-message-log (list nil)))
4343 (gnus-1 arg dont-connect slave)
4344 (gnus-final-warning)))
4346 ;; Allow redefinition of Gnus functions.
4348 (gnus-ems-redefine)
4350 (provide 'gnus)
4352 ;;; gnus.el ends here