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