| blob | 20986d259428feb72d0b4ed0ecfba554206a3212 |
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
9 ;; Version: 5.13
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 effect until Gnus
279 is restarted, and sometimes reloaded."
283 "Other Gnus options."
288 "Exiting Gnus."
293 "Frivolous Gnus extensions."
304 "If non-nil, the startup message will not be displayed.
305 This variable is used before `.gnus.el' is loaded, so it should
306 be set in `.emacs' instead."
335 0 5
344 gnus-mode-line-image-cache)
346 "This is %s, %s."
348 str)
350 line)))
355 ;;(defalias 'gnus-decode-rfc1522 'ignore)
356 )
358 ;; We define these group faces here to avoid the display
359 ;; update forced when creating new faces.
369 ()))
370 "Level 1 newsgroup face."
372 ;; backward-compatibility alias
384 ()))
385 "Level 1 empty newsgroup face."
387 ;; backward-compatibility alias
399 ()))
400 "Level 2 newsgroup face."
402 ;; backward-compatibility alias
414 ()))
415 "Level 2 empty newsgroup face."
417 ;; backward-compatibility alias
429 ()))
430 "Level 3 newsgroup face."
432 ;; backward-compatibility alias
439 ())
442 ())
444 ()))
445 "Level 3 empty newsgroup face."
447 ;; backward-compatibility alias
459 ()))
460 "Level 4 newsgroup face."
462 ;; backward-compatibility alias
469 ())
472 ())
474 ()))
475 "Level 4 empty newsgroup face."
477 ;; backward-compatibility alias
489 ()))
490 "Level 5 newsgroup face."
492 ;; backward-compatibility alias
499 ())
502 ())
504 ()))
505 "Level 5 empty newsgroup face."
507 ;; backward-compatibility alias
519 ()))
520 "Level 6 newsgroup face."
522 ;; backward-compatibility alias
529 ())
532 ())
534 ()))
535 "Level 6 empty newsgroup face."
537 ;; backward-compatibility alias
549 ()))
550 "Low level newsgroup face."
552 ;; backward-compatibility alias
564 ()))
565 "Low level empty newsgroup face."
567 ;; backward-compatibility alias
580 "Level 1 mailgroup face."
582 ;; backward-compatibility alias
595 "Level 1 empty mailgroup face."
597 ;; backward-compatibility alias
610 "Level 2 mailgroup face."
612 ;; backward-compatibility alias
625 "Level 2 empty mailgroup face."
627 ;; backward-compatibility alias
640 "Level 3 mailgroup face."
642 ;; backward-compatibility alias
654 ()))
655 "Level 3 empty mailgroup face."
657 ;; backward-compatibility alias
670 "Low level mailgroup face."
672 ;; backward-compatibility alias
685 "Low level empty mailgroup face."
687 ;; backward-compatibility alias
691 ;; Summary mode faces.
694 "Face used for selected articles."
696 ;; backward-compatibility alias
703 "Face used for cancelled articles."
705 ;; backward-compatibility alias
718 "Face used for high interest ticked articles."
720 ;; backward-compatibility alias
733 "Face used for low interest ticked articles."
735 ;; backward-compatibility alias
747 ()))
748 "Face used for normal interest ticked articles."
750 ;; backward-compatibility alias
763 "Face used for high interest ancient articles."
765 ;; backward-compatibility alias
778 "Face used for low interest ancient articles."
780 ;; backward-compatibility alias
792 ()))
793 "Face used for normal interest ancient articles."
795 ;; backward-compatibility alias
806 "Face used for high interest uncached articles."
808 ;; backward-compatibility alias
819 "Face used for low interest uncached articles."
821 ;; backward-compatibility alias
832 "Face used for normal interest uncached articles."
834 ;; backward-compatibility alias
841 "Face used for high interest unread articles."
843 ;; backward-compatibility alias
850 "Face used for low interest unread articles."
852 ;; backward-compatibility alias
858 ()))
859 "Face used for normal interest unread articles."
861 ;; backward-compatibility alias
876 "Face used for high interest read articles."
878 ;; backward-compatibility alias
893 "Face used for low interest read articles."
895 ;; backward-compatibility alias
907 ()))
908 "Face used for normal interest read articles."
910 ;; backward-compatibility alias
915 ;;;
916 ;;; Gnus buffers
917 ;;;
923 "Do the same as `get-buffer-create', but store the created buffer."
928 "Add the current buffer to the list of Gnus buffers."
932 "Kill BUFFER and remove from the list of Gnus buffers."
939 "Return a list of live Gnus buffers."
948 gnus-buffers)
950 ;;; Splash screen.
963 ()))
964 "Face for the splash screen."
966 ;; backward-compatibility alias
980 "Indent rigidly using only spaces and no tabs."
986 ;; We translate tabs into spaces -- not everybody uses
987 ;; an 8-character tab.
992 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1016 "*Color styles used for the Gnus logo."
1018 gnus-logo-color-alist))
1028 "Insert startup message in current buffer."
1029 ;; Insert the message.
1034 ;; Make sure the library defining `image-load-path' is
1035 ;; loaded (`find-image' is autoloaded) (and discard the
1036 ;; result). Else, we may get "defvar ignored because
1037 ;; image-load-path is let-bound" when calling `find-image'
1038 ;; below.
1048 :color-symbols
1052 :color-symbols
1057 ;; Account for the pbm's background.
1061 ;; Account for the xbm's background.
1072 t)))
1075 _ ___ _ _
1076 _ ___ __ ___ __ _ ___
1077 __ _ ___ __ ___
1078 _ ___ _
1079 _ _ __ _
1080 ___ __ _
1081 __ _
1082 _ _ _
1083 _ _ _
1084 _ _ _
1085 __ ___
1086 _ _ _ _
1087 _ _
1088 _ _
1089 _ _
1090 _
1091 __
1094 ;; And then hack it.
1103 ;; Fontify some.
1110 "Do color-symbol search-and-replace in svg file."
1121 color-symbols)
1123 list)))
1132 ;;; Do the rest.
1138 "Alist of group parameters.
1140 For example:
1142 (gnus-use-scoring nil)
1143 (gnus-summary-line-format
1145 (gcc-self . t)
1146 (display . all))
1149 (broken-reply-to . t)))"
1156 "If it is t, ignore case of group names specified in `gnus-parameters'.
1157 If it is nil, don't ignore case. If it is `default', which is for the
1158 backward compatibility, use the value of `case-fold-search'."
1169 "Define a group parameter PARAM.
1170 REST is a plist of following:
1171 :type One of `bool', `list' or nil.
1172 :function The name of the function.
1173 :function-document The documentation of the function.
1174 :parameter-type The type for customizing the parameter.
1175 :parameter-document The documentation for the parameter.
1176 :variable The name of the variable.
1177 :variable-document The documentation for the variable.
1178 :variable-group The group for customizing the variable.
1179 :variable-type The type for customizing the variable.
1180 :variable-default The default value of the variable."
1197 'progn
1199 ,variable-document
1205 gnus-group-parameters-more))
1208 ,parameter-type
1212 ,function-document
1214 val)
1217 t)
1222 (,variable
1224 elem value)
1232 ,function-document
1236 elem value)
1243 'value
1248 All other Gnus file and directory variables are initialized from this variable."
1254 "*Directory variable from which all other Gnus file variables are derived.
1256 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1257 This means that other directory variables that are initialized from
1258 this variable won't be set properly if you set this variable in `.gnus.el'.
1259 Set this variable in `.emacs' instead."
1264 "*Default directory for all Gnus buffers."
1267 directory))
1269 ;; Site dependent variables. These variables should be defined in
1270 ;; paths.el.
1273 "Specify a default NNTP server.
1274 This variable should be defined in paths.el, and should never be set
1275 by the user.
1276 If you want to change servers, you should use `gnus-select-method'.
1280 "A file with only the name of the nntp server in it."
1286 "Find default nntp server.
1287 Check the NNTPSERVER environment variable and the
1288 `gnus-nntpserver-file' file."
1296 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1297 ;; starting or even loading Gnus.
1298 ;;;###autoload(when (fboundp 'custom-autoload)
1299 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1305 gnus-default-nntp-server)
1307 "Default method for selecting a newsgroup.
1308 This variable should be a list, where the first element is how the
1309 news is to be fetched, the second is the address.
1312 NNTP, you could say:
1316 If you want to use your local spool, say:
1318 \(setq gnus-select-method (list 'nnspool (system-name)))
1320 If you use this variable, you must set `gnus-nntp-server' to nil.
1322 There is a lot more to know about select methods and virtual servers -
1323 see the manual for details."
1330 "*Method used for archiving messages you've sent.
1331 This should be a mail method.
1333 See also `gnus-update-message-archive-method'."
1337 gnus-select-method))
1342 The archive method is initially set according to the value of
1344 so that it may be used as a real method of the server which is named
1346 updated if the value of this variable is nil, even if you change the
1347 value of `gnus-message-archive-method' afterward. If you want the
1349 `gnus-message-archive-method', set this variable to a non-nil value."
1356 "*Name of the group in which to save the messages you've written.
1357 This can either be a string; a list of strings; or an alist
1358 of regexps/functions/forms to be evaluated to return a string (or a list
1359 of strings). The functions are called with the name of the current
1360 group (or nil) as a parameter.
1362 If you want to save your mail in one group and the news articles you
1363 write in another group, you could say something like:
1365 \(setq gnus-message-archive-group
1366 '((if (message-news-p)
1370 Normally the group names returned by this variable should be
1372 However, you may wish to store the message on some other server. In
1373 that case, just return a fully prefixed name of the group --
1381 function
1382 sexp
1383 string))
1386 "List of NNTP servers that the user can choose between interactively.
1387 To make Gnus query you for a server, you have to give `gnus' a
1388 non-numeric prefix - `C-u M-x gnus', in short."
1394 "The name of the host running the NNTP server."
1397 string))
1401 "A list of secondary methods that will be used for reading news.
1402 This is a list where each element is a complete select method (see
1403 `gnus-select-method').
1405 If, for instance, you want to read your mail with the nnml back end,
1406 you could set this variable:
1413 "Local domain name without a host name.
1414 The DOMAINNAME environment variable is used instead if it is defined.
1415 If the function `system-name' returns the full Internet name, there is
1416 no need to set this variable."
1419 string))
1422 ;; Customization variables
1425 "Preferred method for fetching an article by Message-ID.
1426 If you are reading news from the local spool (with nnspool), fetching
1427 articles by Message-ID is painfully slow. By setting this method to an
1428 nntp method, you might get acceptable results.
1430 The value of this variable must be a valid select method as discussed
1431 in the documentation of `gnus-select-method'.
1433 It can also be a list of select methods, as well as the special symbol
1434 `current', which means to use the current select method. If it is a
1435 list, Gnus will try all the methods in the list until it finds a match."
1441 gnus-select-method
1449 gnus-select-method))))
1452 "*Non-nil means that cross referenced articles will be marked as read.
1453 If nil, ignore cross references. If t, mark articles as read in
1454 subscribed newsgroups. If neither t nor nil, mark as read in all
1455 newsgroups."
1463 "*Process mark."
1469 "*The number of articles which indicates a large newsgroup.
1470 If the number of articles in a newsgroup is greater than this value,
1471 confirmation is required for selecting the newsgroup.
1472 If it is nil, no confirmation is required.
1474 Also see `gnus-large-ephemeral-newsgroup'."
1477 integer))
1480 "Non-nil means that the default name of a file to save articles in is the group name.
1481 If it's nil, the directory form of the group name is used instead.
1483 If this variable is a list, and the list contains the element
1484 `not-score', long file names will not be used for score files; if it
1485 contains the element `not-save', long file names will not be used for
1486 saving; and if it contains the element `not-kill', long file names
1487 will not be used for kill files.
1489 Note that the default for this variable varies according to what system
1490 type you're using. On `usg-unix-v' this variable defaults to nil while
1491 on all other systems it defaults to t."
1509 "*If non-nil, save group scoring info."
1515 "*If non-nil, allow undoing in Gnus group mode buffers."
1520 "*If non-nil, use some adaptive scoring scheme.
1521 If a list, then the values `word' and `line' are meaningful. The
1522 former will perform adaption on individual words in the subject
1523 header while `line' will perform adaption on several headers."
1529 "*If nil, Gnus will ignore the article cache.
1530 If `passive', it will allow entering (and reading) articles
1531 explicitly entered into the cache. If anything else, use the
1532 cache to the full extent of the law."
1540 "*If non-nil, display a thread tree buffer."
1545 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1546 If it is a number N, then Gnus will only keep the last N articles
1547 read. If it is neither nil nor a number, Gnus will keep all read
1548 articles. This is not a good idea."
1551 integer
1556 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1561 "*If non-nil, enable scoring."
1567 "*A hook called when preparing to exit from the summary buffer.
1568 It calls `gnus-summary-expire-articles' by default."
1573 "*Non-nil means that you are a Usenet novice.
1574 If non-nil, verbose messages may be displayed and confirmations may be
1575 required."
1580 "*Non-nil means that you will never be asked for confirmation about anything.
1581 That doesn't mean *anything* anything; particularly destructive
1582 commands will still require prompting."
1587 "*If non-nil, require your confirmation when catching up a group."
1592 "*If non-nil, require your confirmation when exiting Gnus."
1597 "*Function for extracting address components from a From header.
1598 Two pre-defined function exist: `gnus-extract-address-components',
1599 which is the default, quite fast, and too simplistic solution, and
1600 `mail-extract-address-components', which works much better, but is
1601 slower."
1608 "String used to separate shell commands."
1630 server-marks)
1633 "*An alist of valid select methods.
1634 The first element of each list lists should be a string with the name
1635 of the select method. The other elements may be the category of
1636 this method (i. e., `post', `mail', `none' or whatever) or other
1637 properties that this method has (like being respoolable).
1638 If you implement a new select method, all you should have to change is
1639 this variable. I think."
1655 "Recomputes the select-method widget based on the value of
1656 `gnus-valid-select-methods'."
1658 "Widget for entering a select method."
1665 gnus-valid-select-methods)
1669 :inline t
1671 variable
1677 "List of buffers that should update their mode lines.
1678 The list may contain the symbols `group', `article', `tree' and
1679 `summary'. If the corresponding symbol is present, Gnus will keep
1680 that mode line updated with information that may be pertinent.
1681 If this variable is nil, screen refresh may be quicker."
1689 "*Max length of mode-line non-string contents.
1690 If this is nil, Gnus will take space as is needed, leaving the rest
1691 of the mode line intact."
1695 integer))
1697 ;; There should be special validation for this.
1702 to-address
1703 :function-document
1704 "Return GROUP's to-address."
1705 :variable-document
1706 "*Alist of group regexps and correspondent to-addresses."
1707 :variable-group gnus-group-parameter
1710 This will be used when doing followups and posts.
1712 This is primarily useful in mail groups that represent closed
1713 mailing lists--mailing lists where it's expected that everybody that
1714 writes to the mailing list is subscribed to it. Since using this
1715 parameter ensures that the mail only goes to the mailing list itself,
1716 it means that members won't receive two copies of your followups.
1718 Using `to-address' will actually work whether the group is foreign or
1719 not. Let's say there's a group on the server that is called
1720 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1721 articles from a mail-to-news gateway. Posting directly to this group
1722 is therefore impossible--you have to send mail to the mailing list
1723 address instead.
1725 The gnus-group-split mail splitting mechanism will behave as if this
1729 to-list
1730 :function-document
1731 "Return GROUP's to-list."
1732 :variable-document
1733 "*Alist of group regexps and correspondent to-lists."
1734 :variable-group gnus-group-parameter
1737 This address will be used when doing a `a' in the group.
1739 It is totally ignored when doing a followup--except that if it is
1740 present in a news group, you'll get mail group semantics when doing
1741 `f'.
1743 The gnus-group-split mail splitting mechanism will behave as if this
1747 subscribed
1748 :type bool
1749 :function-document
1750 "Return GROUP's subscription status."
1751 :variable-document
1752 "*Groups which are automatically considered subscribed."
1753 :variable-group gnus-group-parameter
1756 Gnus assumed that you are subscribed to the To/List address.
1758 When constructing a list of subscribed groups using
1759 `gnus-find-subscribed-addresses', Gnus includes the To address given
1763 auto-expire
1764 :type bool
1765 :function gnus-group-auto-expirable-p
1766 :function-document
1767 "Check whether GROUP is auto-expirable or not."
1768 :variable gnus-auto-expirable-newsgroups
1769 :variable-default nil
1770 :variable-document
1771 "*Groups in which to automatically mark read articles as expirable.
1772 If non-nil, this should be a regexp that should match all groups in
1773 which to perform auto-expiry. This only makes sense for mail groups."
1774 :variable-group nnmail-expire
1776 regexp)
1778 :parameter-document
1782 total-expire
1783 :type bool
1784 :function gnus-group-total-expirable-p
1785 :function-document
1786 "Check whether GROUP is total-expirable or not."
1787 :variable gnus-total-expirable-newsgroups
1788 :variable-default nil
1789 :variable-document
1790 "*Groups in which to perform expiry of all read articles.
1791 Use with extreme caution. All groups that match this regexp will be
1792 expiring - which means that all read articles will be deleted after
1793 \(say) one week. (This only goes for mail groups and the like, of
1794 course.)"
1795 :variable-group nnmail-expire
1797 regexp)
1799 :parameter-document
1800 "All read articles will be put through the expiry process
1802 This happens even if they are not marked as expirable.
1806 charset
1807 :function-document
1808 "Return the default charset of GROUP."
1809 :variable gnus-group-charset-alist
1810 :variable-default
1823 :variable-document
1824 "Alist of regexps (to match group names) and default charsets to be used when reading."
1825 :variable-group gnus-charset
1833 post-method
1834 :type list
1835 :function-document
1836 "Return a posting method for GROUP."
1837 :variable gnus-post-method-alist
1838 :variable-document
1839 "Alist of regexps (to match group names) and method to be used when
1840 posting an article."
1841 :variable-group gnus-group-foreign
1842 :parameter-type
1850 :parameter-document
1854 large-newsgroup-initial
1855 :type integer
1856 :function-document
1857 "Return GROUP's initial input of the number of articles."
1858 :variable-document
1859 "*Alist of group regexps and its initial input of the number of articles."
1860 :variable-group gnus-group-parameter
1866 This number will be prompted as the initial value of the number of
1867 articles to list when the group is a large newsgroup (see
1868 `gnus-large-newsgroup'). If it is nil, the default value is the
1871 ;; The Gnus registry's ignored groups
1873 registry-ignore
1874 :type list
1875 :function-document
1876 "Whether this group should be ignored by the registry."
1877 :variable gnus-registry-ignored-groups
1882 :variable-document
1883 "*Groups in which the registry should be turned off."
1884 :variable-group gnus-registry
1891 :parameter-document
1894 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1896 "*Disable the group parameters for spam detection.
1897 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1904 "Spam group classification (requires spam.el).
1905 This group contains spam messages. On summary entry, unread messages
1906 will be marked as spam. On summary exit, the specified spam
1907 processors will be invoked on spam-marked messages, then those
1908 messages will be expired, so the spam processor will only see a
1912 "The ham value for the spam group parameter (requires spam.el).
1913 On summary exit, the specified ham processors will be invoked on
1914 ham-marked messages. Exercise caution, since the ham processor will
1915 see the same message more than once because there is no ham message
1919 spam-contents
1920 :type list
1921 :function-document
1922 "The spam type (spam, ham, or neither) of the group."
1923 :variable gnus-spam-newsgroup-contents
1924 :variable-default nil
1925 :variable-document
1926 "*Group classification (spam, ham, or neither). Only
1927 meaningful when spam.el is loaded. If non-nil, this should be a
1928 list of group name regexps associated with a classification for
1929 each one. In spam groups, new articles are marked as spam on
1930 summary entry. There is other behavior associated with ham and
1931 no classification when spam.el is loaded - see the manual."
1932 :variable-group spam
1946 :parameter-document
1947 "The spam classification (spam, ham, or neither) of this group.
1948 When a spam group is entered, all unread articles are marked as
1949 spam. There is other behavior associated with ham and no
1953 spam-resend-to
1954 :type list
1955 :function-document
1956 "The address to get spam resent (through spam-report-resend)."
1957 :variable gnus-spam-resend-to
1958 :variable-default nil
1959 :variable-document
1960 "The address to get spam resent (through spam-report-resend)."
1961 :variable-group spam
1965 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1966 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1967 :parameter-document
1971 ham-resend-to
1972 :type list
1973 :function-document
1974 "The address to get ham resent (through spam-report-resend)."
1975 :variable gnus-ham-resend-to
1976 :variable-default nil
1977 :variable-document
1978 "The address to get ham resent (through spam-report-resend)."
1979 :variable-group spam
1983 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1984 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1985 :parameter-document
2001 "OBSOLETE: The Gmane reporting summary exit spam processor.
2008 "OBSOLETE: The ifile summary exit ham processor.
2012 "OBSOLETE: The Bogofilter summary exit ham processor.
2016 "OBSOLETE: The spam-stat summary exit ham processor.
2020 "OBSOLETE: The whitelist summary exit ham processor.
2024 "OBSOLETE: The BBDB summary exit ham processor.
2028 "OBSOLETE: The ham copy exit ham processor.
2032 "OBSOLETE: The spamoracle summary exit ham processor.
2036 spam-process
2037 :type list
2038 :parameter-type
2041 :value nil
2078 :function-document
2079 "Which spam or ham processors will be applied when the summary is exited."
2080 :variable gnus-spam-process-newsgroups
2081 :variable-default nil
2082 :variable-document
2083 "*Groups in which to automatically process spam or ham articles with
2084 a backend on summary exit. If non-nil, this should be a list of group
2085 name regexps that should match all groups in which to do automatic
2086 spam processing, associated with the appropriate processor."
2087 :variable-group spam
2088 :variable-type
2129 :parameter-document
2133 spam-autodetect
2134 :type list
2135 :parameter-type
2137 :function-document
2138 "Should spam be autodetected (with spam-split) in this group?"
2139 :variable gnus-spam-autodetect
2140 :variable-default nil
2141 :variable-document
2142 "*Groups in which spam should be autodetected when they are entered.
2143 Only unseen articles will be examined, unless
2144 spam-autodetect-recheck-messages is set."
2145 :variable-group spam
2146 :variable-type
2151 boolean))
2152 :parameter-document
2153 "Spam autodetection.
2154 Only unseen articles will be examined, unless
2158 spam-autodetect-methods
2159 :type list
2160 :parameter-type
2183 :function-document
2184 "Methods to be used for autodetection in each group"
2185 :variable gnus-spam-autodetect-methods
2186 :variable-default nil
2187 :variable-document
2188 "*Methods for autodetecting spam per group.
2189 Requires the spam-autodetect parameter. Only unseen articles
2190 will be examined, unless spam-autodetect-recheck-messages is
2191 set."
2192 :variable-group spam
2193 :variable-type
2220 :parameter-document
2221 "Spam autodetection methods.
2222 Requires the spam-autodetect parameter. Only unseen articles
2223 will be examined, unless spam-autodetect-recheck-messages is
2227 spam-process-destination
2228 :type list
2229 :parameter-type
2235 :function-document
2236 "Where spam-processed articles will go at summary exit."
2237 :variable gnus-spam-process-destinations
2238 :variable-default nil
2239 :variable-document
2240 "*Groups in which to explicitly send spam-processed articles to
2241 another group, or expire them (the default). If non-nil, this should
2242 be a list of group name regexps that should match all groups in which
2243 to do spam-processed article moving, associated with the destination
2244 group or nil for explicit expiration. This only makes sense for
2245 mail groups."
2246 :variable-group spam
2247 :variable-type
2258 :parameter-document
2262 ham-process-destination
2263 :type list
2264 :parameter-type
2272 :function-document
2273 "Where ham articles will go at summary exit from a spam group."
2274 :variable gnus-ham-process-destinations
2275 :variable-default nil
2276 :variable-document
2277 "*Groups in which to explicitly send ham articles to
2278 another group, or do nothing (the default). If non-nil, this should
2279 be a list of group name regexps that should match all groups in which
2280 to do ham article moving, associated with the destination
2281 group or nil for explicit ignoring. This only makes sense for
2282 mail groups, and only works in spam groups."
2283 :variable-group spam
2284 :variable-type
2296 :parameter-document
2300 ham-marks
2311 :parameter-document
2312 "Marks considered ham (positively not spam). Such articles will be
2313 processed as ham (non-spam) on group exit. When nil, the global
2314 spam-ham-marks variable takes precedence."
2316 gnus-read-mark
2317 gnus-killed-mark
2318 gnus-kill-file-mark
2319 gnus-low-score-mark))))
2320 :variable-group spam
2321 :variable-document
2325 spam-marks
2334 :parameter-document
2335 "Marks considered spam.
2336 Such articles will be processed as spam on group exit. When nil, the global
2337 spam-spam-marks variable takes precedence."
2339 :variable-group spam
2340 :variable-document
2344 "Number of group name elements to leave alone when making a short group name."
2349 "*If non-nil, once you set a level, Gnus will use this level."
2353 ;; Hooks.
2356 "A hook run while Gnus is loaded."
2361 "A hook called to apply kill files to a group.
2362 This hook is intended to apply a kill file to the selected newsgroup.
2363 The function `gnus-apply-kill-file' is called by default.
2365 Since a general kill file is too heavy to use only for a few
2366 newsgroups, I recommend you to use a lighter hook function. For
2367 example, if you'd like to apply a kill file to articles which contains
2368 a string `rmgroup' in subject in newsgroup `control', you can use the
2369 following hook:
2371 (setq gnus-apply-kill-hook
2372 (list
2373 (lambda ()
2382 "Function run when a group level is changed.
2383 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2386 function))
2388 ;;; Face thingies.
2392 mouse-face
2393 summary-menu group-menu article-menu
2394 tree-highlight menu highlight
2395 browse-menu server-menu
2396 page-marker tree-menu binary-menu pick-menu)
2397 "*Enable visual features.
2398 If `visual' is disabled, there will be no menus and few faces. Most of
2399 the visual customization options below will be ignored. Gnus will use
2400 less space and be faster as a result.
2402 This variable can also be a list of visual elements to switch on. For
2403 instance, to switch off all visual things except menus, you can say:
2405 (setq gnus-visual '(menu))
2407 Valid elements include `summary-highlight', `group-highlight',
2408 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2409 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2410 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2430 ;; Byte-compiler warning.
2432 ;; Find out whether the gnus-visual TYPE is wanted.
2436 gnus-visual
2440 t))))
2450 "*Face used for group or summary buffer mouse highlighting.
2451 The line beneath the mouse pointer will be highlighted with this
2452 face."
2465 "Controls use of the agent cache while plugged.
2466 When set, Gnus will prefer using the locally stored content rather
2467 than re-fetching it from the server. You also need to enable
2468 `gnus-agent' for this to have any affect."
2474 "Default charset assumed to be used when viewing non-ASCII characters.
2475 This variable is overridden on a group-to-group basis by the
2476 `gnus-group-charset-alist' variable and is only used on groups not
2477 covered by that variable."
2481 ;; Fixme: Doc reference to agent.
2483 "Whether we want to use the Gnus agent or not.
2485 You may customize gnus-agent to disable its use. However, some
2486 back ends have started to use the agent as a client-side cache.
2487 Disabling the agent may result in noticeable loss of performance."
2493 "Function called by the command `gnus-other-frame'."
2501 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2502 This should be an alist for Emacs, or a plist for XEmacs."
2513 "Which information should be exposed in the User-Agent header.
2515 Can be a list of symbols or a string. Valid symbols are `gnus'
2516 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2517 addition to the Emacs version, you can add `codename' \(show
2518 \(S\)XEmacs codename\) or either `config' \(show system
2519 configuration\) or `type' \(show system type\). If you set it to
2520 a string, be sure to use a valid format, see RFC 2616."
2533 ;; Convert old (< 2005-01-10) symbol type values:
2552 \f
2553 ;;; Internal variables
2558 ; Reset each time gnus-agent-covered-methods is changed else
2559 ; gnus-agent-method-p may mis-report a methods status.
2560 )
2570 ;; The carpal mode has been removed, but define the variable for
2571 ;; backwards compatibility.
2590 ;; Variable holding the user answers to all method prompts.
2593 ;; Variable holding the user answers to all mail method prompts.
2596 ;; Variable holding the user answers to all group prompts.
2604 "*The directory where cached articles will be stored."
2610 nnspool "cache"
2634 ;; Propagate flags to server, with the following exceptions:
2635 ;; `seen' is private to each gnus installation
2636 ;; `cache' is a internal gnus flag for each gnus installation
2637 ;; `download' is a agent flag private to each gnus installation
2638 ;; `unsend' are for nndraft groups only
2639 ;; `score' is not a proper mark
2640 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2643 "Marks that shouldn't be propagated to back ends.
2644 Typical marks are those that make no sense in a standalone back end,
2645 such as a mark that says whether an article is stored in the cache
2658 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2683 gnus-newsrc-last-checked-date
2684 gnus-newsrc-alist gnus-server-alist
2685 gnus-killed-list gnus-zombie-list
2686 gnus-topic-topology gnus-topic-alist
2687 gnus-format-specs)
2691 "Assoc list of read articles.
2695 "Assoc list of registry data.
2722 ;; Save window configuration.
2735 ;;; End of variables.
2737 ;; Define some autoload functions Gnus might use.
2740 ;; This little mapcar goes through the list below and marks the
2741 ;; symbols in question as autoloaded functions.
2761 message-send-and-exit message-yank-original)
2765 ;; This is only used in message.el, which has an autoload.
2767 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2769 ;; Next two only used in gnus-util.
2770 rmail-summary-exists rmail-select-summary)
2771 ;; Only used in gnus-util, which has an autoload.
2776 gnus-Folder-save-name gnus-folder-save-name)
2779 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2780 gnus-demon-add-disconnection gnus-demon-add-handler
2781 gnus-demon-remove-handler)
2783 gnus-demon-init gnus-demon-cancel)
2785 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2786 gnus-face-from-file)
2788 gnus-tree-open gnus-tree-close)
2790 gnus-server-server-name)
2793 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2794 gnus-article-hide-citation gnus-article-fill-cited-article
2795 gnus-article-hide-citation-in-followups
2796 gnus-article-fill-cited-long-lines)
2798 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2799 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2801 gnus-cache-possibly-remove-articles gnus-cache-request-article
2802 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2803 gnus-cache-enter-remove-article gnus-cached-article-p
2804 gnus-cache-open gnus-cache-close gnus-cache-update-article
2805 gnus-cache-articles-in-group)
2807 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2809 gnus-summary-increase-score gnus-summary-set-score
2810 gnus-summary-raise-thread gnus-summary-raise-same-subject
2811 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2812 gnus-summary-lower-thread gnus-summary-lower-same-subject
2813 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2814 gnus-summary-current-score gnus-score-delta-default
2815 gnus-score-flush-cache gnus-score-close
2816 gnus-possibly-score-headers gnus-score-followup-article
2817 gnus-score-followup-thread)
2820 gnus-current-score-file-nondirectory gnus-score-adaptive
2821 gnus-score-find-trace gnus-score-file-name)
2825 gnus-subscribe-topics)
2829 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2830 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2831 gnus-uu-mark-by-regexp gnus-uu-mark-all
2832 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2833 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2834 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2835 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2836 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2837 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2838 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2839 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2842 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2844 gnus-group-post-news gnus-group-mail gnus-group-news
2845 gnus-summary-post-news gnus-summary-news-other-window
2846 gnus-summary-followup gnus-summary-followup-with-original
2847 gnus-summary-cancel-article gnus-summary-supersede-article
2848 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2849 gnus-summary-mail-forward gnus-summary-mail-other-window
2850 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2851 gnus-summary-wide-reply gnus-summary-followup-to-mail
2852 gnus-summary-followup-to-mail-with-original gnus-bug
2853 gnus-summary-wide-reply-with-original
2854 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2855 gnus-summary-post-forward)
2860 gnus-list-of-unread-articles gnus-list-of-read-articles
2861 gnus-offer-save-summaries gnus-make-thread-indent-array
2862 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2863 gnus-summary-skip-intangible gnus-summary-article-number
2864 gnus-data-header gnus-data-find)
2866 gnus-group-list-groups gnus-group-first-unread-group
2867 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2868 gnus-group-setup-buffer gnus-group-get-new-news
2869 gnus-group-make-help-group gnus-group-update-group
2870 gnus-group-iterate gnus-group-group-name)
2872 gnus-backlog-remove-article)
2874 gnus-article-prepare gnus-article-set-window-start
2875 gnus-article-next-page gnus-article-prev-page
2876 gnus-request-article-this-buffer gnus-article-mode
2877 gnus-article-setup-buffer gnus-narrow-to-page
2878 gnus-article-delete-invisible-text gnus-treat-article)
2880 gnus-article-hide-headers gnus-article-hide-boring-headers
2881 gnus-article-treat-overstrike
2882 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2883 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2884 gnus-article-de-base64-unreadable
2885 gnus-article-decode-HZ
2886 gnus-article-wash-html
2887 gnus-article-unsplit-urls
2888 gnus-article-hide-pem gnus-article-hide-signature
2889 gnus-article-strip-leading-blank-lines gnus-article-date-local
2890 gnus-article-date-original gnus-article-date-lapsed
2891 ;;gnus-article-show-all-headers
2892 gnus-article-edit-mode gnus-article-edit-article
2893 gnus-article-edit-done gnus-article-decode-encoded-words
2894 gnus-start-date-timer gnus-stop-date-timer
2895 gnus-mime-view-all-parts)
2898 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2899 gnus-check-reasonable-setup)
2901 gnus-dup-enter-articles)
2907 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2908 gnus-async-halt-prefetch)
2910 gnus-agent-save-active gnus-agent-method-p
2911 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2912 gnus-summary-set-agent-mark gnus-agent-save-group-info
2913 gnus-agent-request-article gnus-agent-retrieve-headers
2914 gnus-agent-store-article gnus-agent-group-covered-p)
2916 gnus-unplugged gnus-agentize gnus-agent-batch)
2918 gnus-summary-save-article-vm)
2923 gnus-group-split-update)
2926 ;;; gnus-sum.el thingies
2930 "*The format specification of the lines in the summary buffer.
2932 It works along the same lines as a normal formatting string,
2933 with some simple extensions.
2935 %N Article number, left padded with spaces (string)
2936 %S Subject (string)
2938 otherwise (string)
2939 %n Name of the poster (string)
2940 %a Extracted name of the poster (string)
2941 %A Extracted address of the poster (string)
2942 %F Contents of the From: header (string)
2943 %f Contents of the From: or To: headers (string)
2944 %x Contents of the Xref: header (string)
2945 %D Date of the article (string)
2946 %d Date of the article (string) in DD-MMM format
2947 %o Date of the article (string) in YYYYMMDD`T'HHMMSS
2948 format
2949 %M Message-id of the article (string)
2950 %r References of the article (string)
2951 %c Number of characters in the article (integer)
2952 %k Pretty-printed version of the above (string)
2954 %L Number of lines in the article (integer)
2955 %I Indentation based on thread level (a string of
2956 spaces)
2957 %B A complex trn-style thread tree (string)
2958 The variables `gnus-sum-thread-*' can be used for
2959 customization.
2960 %T A string with two possible values: 80 spaces if the
2961 article is on thread level two or larger and 0 spaces
2962 on level one
2964 otherwise (character)
2969 %> Spaces of length thread-level (string)
2970 %< Spaces of length (- 20 thread-level) (string)
2971 %i Article score (number)
2972 %z Article zcore (character)
2973 %t Number of articles under the current thread (number).
2974 %e Whether the thread is empty or not (character).
2975 %V Total thread score (number).
2976 %P The line number (number).
2977 %O Download mark (character).
2978 %* If present, indicates desired cursor position
2979 (instead of after first colon).
2980 %u User defined specifier. The next character in the
2981 format string should be a letter. Gnus will call the
2982 function gnus-user-format-function-X, where X is the
2983 letter following %u. The function will be passed the
2984 current header as argument. The function should
2985 return a string, which will be inserted into the
2986 summary just like information from any other summary
2987 specifier.
2988 &user-date; Age sensitive date format. Various date format is
2989 defined in `gnus-summary-user-date-format-alist'.
2992 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2993 with care. For reasons of efficiency, Gnus will compute what column
2995 it is invalid to have these specs after a variable-length spec. Well,
2996 you might not be arrested, but your summary buffer will look strange,
2997 which is bad enough.
2999 The smart choice is to have these specs as far to the left as
3000 possible.
3002 This restriction may disappear in later versions of Gnus.
3004 General format specifiers can also be used.
3005 See Info node `(gnus)Formatting Variables'."
3010 ;;;
3011 ;;; Skeleton keymaps
3012 ;;;
3017 (while keys
3018 (define-key keymap (pop keys) 'undefined))))
3020 (defvar gnus-article-mode-map
3021 (let ((keymap (make-sparse-keymap)))
3022 (gnus-suppress-keymap keymap)
3023 keymap))
3024 (defvar gnus-summary-mode-map
3025 (let ((keymap (make-keymap)))
3026 (gnus-suppress-keymap keymap)
3027 keymap))
3028 (defvar gnus-group-mode-map
3029 (let ((keymap (make-keymap)))
3030 (gnus-suppress-keymap keymap)
3031 keymap))
3033 \f
3035 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3036 ;; If you want the cursor to go somewhere else, set these two
3037 ;; functions in some startup hook to whatever you want.
3038 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3039 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3041 ;;; Various macros and substs.
3043 (defun gnus-header-from (header)
3044 (mail-header-from header))
3046 (defmacro gnus-gethash (string hashtable)
3047 "Get hash value of STRING in HASHTABLE."
3048 `(symbol-value (intern-soft ,string ,hashtable)))
3050 (defmacro gnus-gethash-safe (string hashtable)
3051 "Get hash value of STRING in HASHTABLE.
3052 Return nil if not defined."
3053 `(let ((sym (intern-soft ,string ,hashtable)))
3054 (and (boundp sym) (symbol-value sym))))
3056 (defmacro gnus-sethash (string value hashtable)
3057 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3058 `(set (intern ,string ,hashtable) ,value))
3059 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3061 (defmacro gnus-group-unread (group)
3062 "Get the currently computed number of unread articles in GROUP."
3063 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3065 (defmacro gnus-group-entry (group)
3066 "Get the newsrc entry for GROUP."
3067 `(gnus-gethash ,group gnus-newsrc-hashtb))
3069 (defmacro gnus-active (group)
3070 "Get active info on GROUP."
3071 `(gnus-gethash ,group gnus-active-hashtb))
3073 (defmacro gnus-set-active (group active)
3074 "Set GROUP's active info."
3075 `(gnus-sethash ,group ,active gnus-active-hashtb))
3077 ;; Info access macros.
3079 (defmacro gnus-info-group (info)
3080 `(nth 0 ,info))
3081 (defmacro gnus-info-rank (info)
3082 `(nth 1 ,info))
3083 (defmacro gnus-info-read (info)
3084 `(nth 2 ,info))
3085 (defmacro gnus-info-marks (info)
3086 `(nth 3 ,info))
3087 (defmacro gnus-info-method (info)
3088 `(nth 4 ,info))
3089 (defmacro gnus-info-params (info)
3090 `(nth 5 ,info))
3092 (defmacro gnus-info-level (info)
3093 `(let ((rank (gnus-info-rank ,info)))
3094 (if (consp rank)
3095 (car rank)
3096 rank)))
3097 (defmacro gnus-info-score (info)
3098 `(let ((rank (gnus-info-rank ,info)))
3099 (or (and (consp rank) (cdr rank)) 0)))
3101 (defmacro gnus-info-set-group (info group)
3102 `(setcar ,info ,group))
3103 (defmacro gnus-info-set-rank (info rank)
3104 `(setcar (nthcdr 1 ,info) ,rank))
3105 (defmacro gnus-info-set-read (info read)
3106 `(setcar (nthcdr 2 ,info) ,read))
3107 (defmacro gnus-info-set-marks (info marks &optional extend)
3108 (if extend
3109 `(gnus-info-set-entry ,info ,marks 3)
3110 `(setcar (nthcdr 3 ,info) ,marks)))
3111 (defmacro gnus-info-set-method (info method &optional extend)
3112 (if extend
3113 `(gnus-info-set-entry ,info ,method 4)
3114 `(setcar (nthcdr 4 ,info) ,method)))
3115 (defmacro gnus-info-set-params (info params &optional extend)
3116 (if extend
3117 `(gnus-info-set-entry ,info ,params 5)
3118 `(setcar (nthcdr 5 ,info) ,params)))
3120 (defun gnus-info-set-entry (info entry number)
3121 ;; Extend the info until we have enough elements.
3122 (while (<= (length info) number)
3123 (nconc info (list nil)))
3124 ;; Set the entry.
3125 (setcar (nthcdr number info) entry))
3127 (defmacro gnus-info-set-level (info level)
3128 `(let ((rank (cdr ,info)))
3129 (if (consp (car rank))
3130 (setcar (car rank) ,level)
3131 (setcar rank ,level))))
3132 (defmacro gnus-info-set-score (info score)
3133 `(let ((rank (cdr ,info)))
3134 (if (consp (car rank))
3135 (setcdr (car rank) ,score)
3136 (setcar rank (cons (car rank) ,score)))))
3138 (defmacro gnus-get-info (group)
3139 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3141 (defun gnus-set-info (group info)
3142 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3143 info))
3145 ;;; Load the compatibility functions.
3147 (require 'gnus-ems)
3149 \f
3150 ;;;
3151 ;;; Shutdown
3152 ;;;
3154 (defvar gnus-shutdown-alist nil)
3156 (defun gnus-add-shutdown (function &rest symbols)
3157 "Run FUNCTION whenever one of SYMBOLS is shut down."
3158 (push (cons function symbols) gnus-shutdown-alist))
3160 (defun gnus-shutdown (symbol)
3161 "Shut down everything that waits for SYMBOL."
3162 (dolist (entry gnus-shutdown-alist)
3163 (when (memq symbol (cdr entry))
3164 (funcall (car entry)))))
3166 \f
3167 ;;;
3168 ;;; Gnus Utility Functions
3169 ;;;
3171 (defun gnus-find-subscribed-addresses ()
3172 "Return a regexp matching the addresses of all subscribed mail groups.
3173 It consists of the `to-address' or `to-list' parameter of all groups
3174 with a `subscribed' parameter."
3175 (let (group address addresses)
3176 (dolist (entry (cdr gnus-newsrc-alist))
3177 (setq group (car entry))
3178 (when (gnus-parameter-subscribed group)
3179 (setq address (mail-strip-quoted-names
3180 (or (gnus-group-fast-parameter group 'to-address)
3181 (gnus-group-fast-parameter group 'to-list))))
3182 (when address
3183 (add-to-list 'addresses address))))
3184 (when addresses
3187 (defmacro gnus-string-or (&rest strings)
3188 "Return the first element of STRINGS that is a non-blank string.
3189 STRINGS will be evaluated in normal `or' order."
3190 `(gnus-string-or-1 (list ,@strings)))
3192 (defun gnus-string-or-1 (strings)
3193 (let (string)
3194 (while strings
3195 (setq string (pop strings))
3197 (setq string nil)
3198 (setq strings nil)))
3199 string))
3201 (defun gnus-version (&optional arg)
3202 "Version number of this version of Gnus.
3203 If ARG, insert string at point."
3204 (interactive "P")
3205 (if arg
3206 (insert (message gnus-version))
3207 (message gnus-version)))
3209 (defun gnus-continuum-version (&optional version)
3210 "Return VERSION as a floating point number."
3211 (unless version
3212 (setq version gnus-version))
3215 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3216 (number (match-string 2 version))
3217 major minor least)
3218 (unless (string-match
3220 (error "Invalid version string: %s" version))
3221 (setq major (string-to-number (match-string 1 number))
3222 minor (string-to-number (match-string 2 number))
3223 least (if (match-beginning 3)
3224 (string-to-number (match-string 3 number))
3225 0))
3226 (string-to-number
3227 (if (zerop major)
3228 (format "%s00%02d%02d"
3229 (if (member alpha '("(ding)" "d"))
3230 "4.99"
3231 (+ 5 (* 0.02
3232 (abs
3233 (- (mm-char-int (aref (downcase alpha) 0))
3234 (mm-char-int ?t))))
3235 -0.01))
3236 minor least)
3237 (format "%d.%02d%02d" major minor least))))))
3239 (defun gnus-info-find-node (&optional nodename)
3240 "Find Info documentation of Gnus."
3241 (interactive)
3242 ;; Enlarge info window if needed.
3243 (let (gnus-info-buffer)
3244 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3245 (setq gnus-info-buffer (current-buffer))
3246 (gnus-configure-windows 'info)))
3248 ;;;
3249 ;;; gnus-interactive
3250 ;;;
3252 (defvar gnus-current-prefix-symbol nil
3253 "Current prefix symbol.")
3255 (defvar gnus-current-prefix-symbols nil
3256 "List of current prefix symbols.")
3258 (defun gnus-interactive (string &optional params)
3259 "Return a list that can be fed to `interactive'.
3260 See `interactive' for full documentation.
3262 Adds the following specs:
3264 y -- The current symbolic prefix.
3265 Y -- A list of the current symbolic prefix(es).
3266 A -- Article number.
3267 H -- Article header.
3268 g -- Group name."
3269 (let ((i 0)
3270 out c prompt)
3271 (while (< i (length string))
3273 (setq c (aref string i))
3274 (when (match-end 1)
3275 (setq prompt (match-string 1 string)))
3276 (setq i (match-end 0))
3277 ;; We basically emulate just about everything that
3278 ;; `interactive' does, but add the specs listed above.
3279 (push
3280 (cond
3281 ((= c ?a)
3282 (completing-read prompt obarray 'fboundp t))
3283 ((= c ?b)
3284 (read-buffer prompt (current-buffer) t))
3285 ((= c ?B)
3286 (read-buffer prompt (other-buffer (current-buffer))))
3287 ((= c ?c)
3288 (read-char))
3289 ((= c ?C)
3290 (completing-read prompt obarray 'commandp t))
3291 ((= c ?d)
3292 (point))
3293 ((= c ?D)
3294 (read-directory-name prompt nil default-directory 'lambda))
3295 ((= c ?f)
3296 (read-file-name prompt nil nil 'lambda))
3297 ((= c ?F)
3298 (read-file-name prompt))
3299 ((= c ?k)
3300 (read-key-sequence prompt))
3301 ((= c ?K)
3302 (error "Not implemented spec"))
3303 ((= c ?e)
3304 (error "Not implemented spec"))
3305 ((= c ?m)
3306 (mark))
3307 ((= c ?N)
3308 (error "Not implemented spec"))
3309 ((= c ?n)
3310 (string-to-number (read-from-minibuffer prompt)))
3311 ((= c ?p)
3312 (prefix-numeric-value current-prefix-arg))
3313 ((= c ?P)
3314 current-prefix-arg)
3315 ((= c ?r)
3316 'gnus-prefix-nil)
3317 ((= c ?s)
3318 (read-string prompt))
3319 ((= c ?S)
3320 (intern (read-string prompt)))
3321 ((= c ?v)
3322 (read-variable prompt))
3323 ((= c ?x)
3324 (read-minibuffer prompt))
3325 ((= c ?x)
3326 (eval-minibuffer prompt))
3327 ;; And here the new specs come.
3328 ((= c ?y)
3329 gnus-current-prefix-symbol)
3330 ((= c ?Y)
3331 gnus-current-prefix-symbols)
3332 ((= c ?g)
3333 (gnus-group-group-name))
3334 ((= c ?A)
3335 (gnus-summary-skip-intangible)
3336 (or (get-text-property (point) 'gnus-number)
3337 (gnus-summary-last-subject)))
3338 ((= c ?H)
3339 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3340 (t
3341 (error "Non-implemented spec")))
3342 out)
3343 (cond
3344 ((= c ?r)
3345 (push (if (< (point) (mark)) (point) (mark)) out)
3346 (push (if (> (point) (mark)) (point) (mark)) out))))
3347 (setq out (delq 'gnus-prefix-nil out))
3348 (nreverse out)))
3350 (defun gnus-symbolic-argument (&optional arg)
3351 "Read a symbolic argument and a command, and then execute command."
3352 (interactive "P")
3353 (let* ((in-command (this-command-keys))
3354 (command in-command)
3355 gnus-current-prefix-symbols
3356 gnus-current-prefix-symbol
3357 syms)
3358 (while (equal in-command command)
3359 (message "%s-" (key-description (this-command-keys)))
3360 (push (intern (char-to-string (read-char))) syms)
3361 (setq command (read-key-sequence nil t)))
3362 (setq gnus-current-prefix-symbols (nreverse syms)
3363 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3364 (call-interactively (key-binding command t))))
3366 ;;; More various functions.
3368 (defsubst gnus-check-backend-function (func group)
3369 "Check whether GROUP supports function FUNC.
3370 GROUP can either be a string (a group name) or a select method."
3371 (ignore-errors
3372 (let ((method (if (stringp group)
3373 (car (gnus-find-method-for-group group))
3374 group)))
3375 (unless (featurep method)
3376 (require method))
3377 (fboundp (intern (format "%s-%s" method func))))))
3379 (defun gnus-group-read-only-p (&optional group)
3380 "Check whether GROUP supports editing or not.
3381 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3382 that that variable is buffer-local to the summary buffers."
3383 (let ((group (or group gnus-newsgroup-name)))
3384 (not (gnus-check-backend-function 'request-replace-article group))))
3386 (defun gnus-virtual-group-p (group)
3387 "Say whether GROUP is virtual or not."
3388 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3389 gnus-valid-select-methods)))
3391 (defun gnus-news-group-p (group &optional article)
3392 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3393 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3394 t) ;is news of course.
3395 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3396 nil) ;must be mail then.
3397 ((vectorp article) ;Has header info.
3398 (eq (gnus-request-type group (mail-header-id article)) 'news))
3399 ((null article) ;Hasn't header info
3400 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3401 ((< article 0) ;Virtual message
3402 nil) ;we don't know, guess mail.
3403 (t ;Has positive number
3404 (eq (gnus-request-type group article) 'news)))) ;use it.
3406 ;; Returns a list of writable groups.
3407 (defun gnus-writable-groups ()
3408 (let ((alist gnus-newsrc-alist)
3409 groups group)
3410 (while (setq group (car (pop alist)))
3411 (unless (gnus-group-read-only-p group)
3412 (push group groups)))
3413 (nreverse groups)))
3415 ;; Check whether to use long file names.
3416 (defun gnus-use-long-file-name (symbol)
3417 ;; The variable has to be set...
3418 (and gnus-use-long-file-name
3419 ;; If it isn't a list, then we return t.
3420 (or (not (listp gnus-use-long-file-name))
3421 ;; If it is a list, and the list contains `symbol', we
3422 ;; return nil.
3423 (not (memq symbol gnus-use-long-file-name)))))
3425 ;; Generate a unique new group name.
3426 (defun gnus-generate-new-group-name (leaf)
3427 (let ((name leaf)
3428 (num 0))
3429 (while (gnus-group-entry name)
3430 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3431 name))
3433 (defun gnus-ephemeral-group-p (group)
3434 "Say whether GROUP is ephemeral or not."
3435 (gnus-group-get-parameter group 'quit-config t))
3437 (defun gnus-group-quit-config (group)
3438 "Return the quit-config of GROUP."
3439 (gnus-group-get-parameter group 'quit-config t))
3441 (defun gnus-kill-ephemeral-group (group)
3442 "Remove ephemeral GROUP from relevant structures."
3443 (gnus-sethash group nil gnus-newsrc-hashtb))
3445 (defun gnus-simplify-mode-line ()
3446 "Make mode lines a bit simpler."
3447 (setq mode-line-modified (cdr gnus-mode-line-modified))
3448 (when (listp mode-line-format)
3449 (make-local-variable 'mode-line-format)
3450 (setq mode-line-format (copy-sequence mode-line-format))
3451 (when (equal (nth 3 mode-line-format) " ")
3452 (setcar (nthcdr 3 mode-line-format) " "))))
3454 ;;; Servers and groups.
3456 (defsubst gnus-server-add-address (method)
3457 (let ((method-name (symbol-name (car method))))
3458 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3459 (not (assq (intern (concat method-name "-address")) method))
3460 (memq 'physical-address (assq (car method)
3461 gnus-valid-select-methods)))
3462 (append method (list (list (intern (concat method-name "-address"))
3463 (nth 1 method))))
3464 method)))
3466 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3467 (catch 'server-name
3468 (setq method (or method gnus-select-method))
3470 ;; Perhaps it is already in the cache.
3471 (unless nocache
3472 (mapc (lambda (name-method)
3473 (if (equal (cdr name-method) method)
3474 (throw 'server-name (car name-method))))
3475 gnus-server-method-cache))
3477 (mapc
3478 (lambda (server-alist)
3479 (mapc (lambda (name-method)
3480 (when (gnus-methods-equal-p (cdr name-method) method)
3481 (unless (member name-method gnus-server-method-cache)
3482 (push name-method gnus-server-method-cache))
3483 (throw 'server-name (car name-method))))
3484 server-alist))
3485 (list gnus-server-alist
3486 gnus-predefined-server-alist))
3488 (let* ((name (if (member (cadr method) '(nil ""))
3489 (format "%s" (car method))
3490 (format "%s:%s" (car method) (cadr method))))
3491 (name-method (cons name method)))
3492 (when (and (not (member name-method gnus-server-method-cache))
3493 (not no-enter-cache)
3494 (not (assoc (car name-method) gnus-server-method-cache)))
3495 (push name-method gnus-server-method-cache))
3496 name)))
3498 (defsubst gnus-server-to-method (server)
3499 "Map virtual server names to select methods."
3500 (or (and server (listp server) server)
3501 (cdr (assoc server gnus-server-method-cache))
3502 (let ((result
3503 (or
3504 ;; Perhaps this is the native server?
3505 (and (equal server "native") gnus-select-method)
3506 ;; It should be in the server alist.
3507 (cdr (assoc server gnus-server-alist))
3508 ;; It could be in the predefined server alist.
3509 (cdr (assoc server gnus-predefined-server-alist))
3510 ;; If not, we look through all the opened server
3511 ;; to see whether we can find it there.
3512 (let ((opened gnus-opened-servers))
3513 (while (and opened
3514 (not (equal server (format "%s:%s" (caaar opened)
3515 (cadaar opened)))))
3516 (pop opened))
3517 (caar opened))
3518 ;; It could be a named method, search all servers
3519 (let ((servers gnus-secondary-select-methods))
3520 (while (and servers
3521 (not (equal server (format "%s:%s" (caar servers)
3522 (cadar servers)))))
3523 (pop servers))
3524 (car servers))
3525 ;; This could be some sort of foreign server that I
3526 ;; simply haven't opened (yet). Do a brute-force scan
3527 ;; of the entire gnus-newsrc-alist for the server name
3528 ;; of every method. As a side-effect, loads the
3529 ;; gnus-server-method-cache so this only happens once,
3530 ;; if at all.
3531 (let ((alist (cdr gnus-newsrc-alist))
3532 method match)
3533 (while alist
3534 (setq method (gnus-info-method (pop alist)))
3535 (when (and (not (stringp method))
3536 (equal server
3537 (gnus-method-to-server method nil t)))
3538 (setq match method
3539 alist nil)))
3540 match))))
3541 (when (and result
3542 (not (assoc server gnus-server-method-cache)))
3543 (push (cons server result) gnus-server-method-cache))
3544 result)))
3546 (defsubst gnus-server-get-method (group method)
3547 ;; Input either a server name, and extended server name, or a
3548 ;; select method, and return a select method.
3549 (cond ((stringp method)
3550 (gnus-server-to-method method))
3551 ((equal method gnus-select-method)
3552 gnus-select-method)
3553 ((and (stringp (car method))
3554 group)
3555 (gnus-server-extend-method group method))
3556 ((and method
3557 (not group)
3558 (equal (cadr method) ""))
3559 method)
3560 (t
3561 (gnus-server-add-address method))))
3563 (defmacro gnus-method-equal (ss1 ss2)
3564 "Say whether two servers are equal."
3565 `(let ((s1 ,ss1)
3566 (s2 ,ss2))
3567 (or (equal s1 s2)
3568 (and (= (length s1) (length s2))
3569 (progn
3570 (while (and s1 (member (car s1) s2))
3571 (setq s1 (cdr s1)))
3572 (null s1))))))
3574 (defun gnus-methods-equal-p (m1 m2)
3575 (let ((m1 (or m1 gnus-select-method))
3576 (m2 (or m2 gnus-select-method)))
3577 (or (equal m1 m2)
3578 (and (eq (car m1) (car m2))
3579 (or (not (memq 'address (assoc (symbol-name (car m1))
3580 gnus-valid-select-methods)))
3581 (equal (nth 1 m1) (nth 1 m2)))))))
3583 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3584 ;; Check parameters for sloppy equalness.
3585 (let ((p1 (copy-sequence (cddr m1)))
3586 (p2 (copy-sequence (cddr m2)))
3587 e1 e2)
3588 (block nil
3589 (while (setq e1 (pop p1))
3590 (unless (setq e2 (assq (car e1) p2))
3591 ;; The parameter doesn't exist in p2.
3592 (return nil))
3593 (setq p2 (delq e2 p2))
3594 (unless (equal e1 e2)
3595 (if (not (and (stringp (cadr e1))
3596 (stringp (cadr e2))))
3597 (return nil)
3598 ;; Special-case string parameter comparison so that we
3599 ;; can uniquify them.
3600 (let ((s1 (cadr e1))
3601 (s2 (cadr e2)))
3602 (when (string-match "/$" s1)
3603 (setq s1 (directory-file-name s1)))
3604 (when (string-match "/$" s2)
3605 (setq s2 (directory-file-name s2)))
3606 (unless (equal s1 s2)
3607 (return nil))))))
3608 ;; If p2 now is empty, they were equal.
3609 (null p2))))
3611 (defun gnus-methods-sloppily-equal (m1 m2)
3612 ;; Same method.
3613 (or
3614 (eq m1 m2)
3615 ;; Type and name are equal.
3616 (and
3617 (eq (car m1) (car m2))
3618 (equal (cadr m1) (cadr m2))
3619 (gnus-sloppily-equal-method-parameters m1 m2))))
3621 (defun gnus-server-equal (m1 m2)
3622 "Say whether two methods are equal."
3623 (let ((m1 (cond ((null m1) gnus-select-method)
3624 ((stringp m1) (gnus-server-to-method m1))
3625 (t m1)))
3626 (m2 (cond ((null m2) gnus-select-method)
3627 ((stringp m2) (gnus-server-to-method m2))
3628 (t m2))))
3629 (gnus-method-equal m1 m2)))
3631 (defun gnus-servers-using-backend (backend)
3632 "Return a list of known servers using BACKEND."
3633 (let ((opened gnus-opened-servers)
3634 out)
3635 (while opened
3636 (when (eq backend (caaar opened))
3637 (push (caar opened) out))
3638 (pop opened))
3639 out))
3641 (defun gnus-archive-server-wanted-p ()
3642 "Say whether the user wants to use the archive server."
3643 (cond
3644 ((or (not gnus-message-archive-method)
3645 (not gnus-message-archive-group))
3646 nil)
3647 ((and gnus-message-archive-method gnus-message-archive-group)
3648 t)
3649 (t
3650 (let ((active (cadr (assq 'nnfolder-active-file
3651 gnus-message-archive-method))))
3652 (and active
3653 (file-exists-p active))))))
3655 (defsubst gnus-method-to-server-name (method)
3656 (concat
3657 (format "%s" (car method))
3658 (when (and
3659 (or (assoc (format "%s" (car method))
3660 (gnus-methods-using 'address))
3661 (gnus-server-equal method gnus-message-archive-method))
3662 (nth 1 method)
3663 (not (string= (nth 1 method) "")))
3664 (concat "+" (nth 1 method)))))
3666 (defsubst gnus-method-to-full-server-name (method)
3667 (format "%s+%s" (car method) (nth 1 method)))
3669 (defun gnus-group-prefixed-name (group method &optional full)
3670 "Return the whole name from GROUP and METHOD.
3671 Call with full set to get the fully qualified group name (even if the
3672 server is native)."
3673 (when (stringp method)
3674 (setq method (gnus-server-to-method method)))
3675 (if (or (not method)
3676 (and (not full) (gnus-server-equal method "native"))
3677 ;;;!!! This might not be right. We'll see...
3678 ;(string-match ":" group)
3679 )
3680 group
3681 (concat (gnus-method-to-server-name method) ":" group)))
3683 (defun gnus-group-guess-prefixed-name (group)
3684 "Guess the whole name from GROUP and METHOD."
3685 (gnus-group-prefixed-name group (gnus-find-method-for-group
3686 group)))
3688 (defun gnus-group-full-name (group method)
3689 "Return the full name from GROUP and METHOD, even if the method is native."
3690 (gnus-group-prefixed-name group method t))
3692 (defun gnus-group-guess-full-name (group)
3693 "Guess the full name from GROUP, even if the method is native."
3694 (if (gnus-group-prefixed-p group)
3695 group
3696 (gnus-group-full-name group (gnus-find-method-for-group group))))
3698 (defun gnus-group-guess-full-name-from-command-method (group)
3699 "Guess the full name from GROUP, even if the method is native."
3700 (if (gnus-group-prefixed-p group)
3701 group
3702 (gnus-group-full-name group gnus-command-method)))
3704 (defun gnus-group-real-prefix (group)
3705 "Return the prefix of the current group name."
3706 (if (stringp group)
3707 (if (string-match "^[^:]+:" group)
3708 (substring group 0 (match-end 0))
3709 "")
3710 nil))
3712 (defun gnus-group-short-name (group)
3713 "Return the short group name."
3714 (let ((prefix (gnus-group-real-prefix group)))
3715 (if (< 0 (length prefix))
3716 (substring group (length prefix) nil)
3717 group)))
3719 (defun gnus-group-prefixed-p (group)
3720 "Return the prefix of the current group name."
3721 (< 0 (length (gnus-group-real-prefix group))))
3723 (declare-function gnus-group-decoded-name "gnus-group" (string))
3725 (defun gnus-summary-buffer-name (group)
3726 "Return the summary buffer name of GROUP."
3727 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3729 (defun gnus-group-method (group)
3730 "Return the server or method used for selecting GROUP.
3731 You should probably use `gnus-find-method-for-group' instead."
3732 (let ((prefix (gnus-group-real-prefix group)))
3733 (if (equal prefix "")
3734 gnus-select-method
3735 (let ((servers gnus-opened-servers)
3736 (server "")
3737 backend possible found)
3739 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3740 server (substring prefix (match-end 0) (1- (length prefix))))
3741 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3742 (while servers
3743 (when (eq (caaar servers) backend)
3744 (setq possible (caar servers))
3745 (when (equal (cadaar servers) server)
3746 (setq found (caar servers))))
3747 (pop servers))
3748 (or (car (rassoc found gnus-server-alist))
3749 found
3750 (car (rassoc possible gnus-server-alist))
3751 possible
3752 (list backend server))))))
3754 (defsubst gnus-native-method-p (method)
3755 "Return whether METHOD is the native select method."
3756 (gnus-method-equal method gnus-select-method))
3758 (defsubst gnus-secondary-method-p (method)
3759 "Return whether METHOD is a secondary select method."
3760 (let ((methods gnus-secondary-select-methods)
3761 (gmethod (inline (gnus-server-get-method nil method))))
3762 (while (and methods
3763 (not (gnus-method-equal
3764 (inline (gnus-server-get-method nil (car methods)))
3765 gmethod)))
3766 (setq methods (cdr methods)))
3767 methods))
3769 (defun gnus-method-simplify (method)
3770 "Return the shortest uniquely identifying string or method for METHOD."
3771 (cond ((stringp method)
3772 method)
3773 ((gnus-native-method-p method)
3774 nil)
3775 ((gnus-secondary-method-p method)
3776 (format "%s:%s" (nth 0 method) (nth 1 method)))
3777 (t
3778 method)))
3780 (defun gnus-groups-from-server (server)
3781 "Return a list of all groups that are fetched from SERVER."
3782 (let ((alist (cdr gnus-newsrc-alist))
3783 info groups)
3784 (while (setq info (pop alist))
3785 (when (gnus-server-equal (gnus-info-method info) server)
3786 (push (gnus-info-group info) groups)))
3787 (sort groups 'string<)))
3789 (defun gnus-group-foreign-p (group)
3790 "Say whether a group is foreign or not."
3791 (and (not (gnus-group-native-p group))
3792 (not (gnus-group-secondary-p group))))
3794 (defun gnus-group-native-p (group)
3795 "Say whether the group is native or not."
3796 (not (string-match ":" group)))
3798 (defun gnus-group-secondary-p (group)
3799 "Say whether the group is secondary or not."
3800 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3802 (defun gnus-parameters-get-parameter (group)
3803 "Return the group parameters for GROUP from `gnus-parameters'."
3804 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3805 case-fold-search
3806 gnus-parameters-case-fold-search))
3807 params-list)
3808 (dolist (elem gnus-parameters)
3809 (when (string-match (car elem) group)
3810 (setq params-list
3811 (nconc (gnus-expand-group-parameters
3812 (car elem) (cdr elem) group)
3813 params-list))))
3814 params-list))
3816 (defun gnus-expand-group-parameter (match value group)
3817 "Use MATCH to expand VALUE in GROUP."
3818 (let ((start (string-match match group)))
3819 (if start
3820 (let ((matched-string (substring group start (match-end 0))))
3821 ;; Build match groups
3822 (string-match match matched-string)
3823 (replace-match value nil nil matched-string))
3824 group)))
3826 (defun gnus-expand-group-parameters (match parameters group)
3827 "Go through PARAMETERS and expand them according to the match data."
3828 (let (new)
3829 (dolist (elem parameters)
3830 (if (and (stringp (cdr elem))
3832 (push (cons (car elem)
3833 (gnus-expand-group-parameter match (cdr elem) group))
3834 new)
3835 (push elem new)))
3836 new))
3838 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3839 "For GROUP, return the value of SYMBOL.
3841 You should call this in the `gnus-group-buffer' buffer.
3842 The function `gnus-group-find-parameter' will do that for you."
3843 ;; The speed trick: No cons'ing and quit early.
3844 (let* ((params (funcall gnus-group-get-parameter-function group))
3845 ;; Start easy, check the "real" group parameters.
3846 (simple-results
3847 (gnus-group-parameter-value params symbol allow-list t)))
3848 (if simple-results
3849 ;; Found results; return them.
3850 (car simple-results)
3851 ;; We didn't find it there, try `gnus-parameters'.
3852 (let ((result nil)
3853 (head nil)
3854 (tail gnus-parameters))
3855 ;; A good old-fashioned non-cl loop.
3856 (while tail
3857 (setq head (car tail)
3858 tail (cdr tail))
3859 ;; The car is regexp matching for matching the group name.
3860 (when (string-match (car head) group)
3861 ;; The cdr is the parameters.
3862 (setq result (gnus-group-parameter-value (cdr head)
3863 symbol allow-list))
3864 (when result
3865 ;; Expand if necessary.
3867 (setq result (gnus-expand-group-parameter (car head)
3868 result group))))))
3869 ;; Done.
3870 result))))
3872 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3873 "Return the group parameters for GROUP.
3874 If SYMBOL, return the value of that symbol in the group parameters.
3876 If you call this function inside a loop, consider using the faster
3877 `gnus-group-fast-parameter' instead."
3878 (with-current-buffer gnus-group-buffer
3879 (if symbol
3880 (gnus-group-fast-parameter group symbol allow-list)
3881 (nconc
3882 (copy-sequence
3883 (funcall gnus-group-get-parameter-function group))
3884 (gnus-parameters-get-parameter group)))))
3886 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3887 "Return the group parameters for GROUP.
3888 If SYMBOL, return the value of that symbol in the group parameters.
3889 If ALLOW-LIST, also allow list as a result.
3890 Most functions should use `gnus-group-find-parameter', which
3891 also examines the topic parameters."
3892 (let ((params (gnus-info-params (gnus-get-info group))))
3893 (if symbol
3894 (gnus-group-parameter-value params symbol allow-list)
3895 params)))
3897 (defun gnus-group-parameter-value (params symbol &optional
3898 allow-list present-p)
3899 "Return the value of SYMBOL in group PARAMS.
3900 If ALLOW-LIST, also allow list as a result."
3901 ;; We only wish to return group parameters (dotted lists) and
3902 ;; not local variables, which may have the same names.
3903 ;; But first we handle single elements...
3904 (or (car (memq symbol params))
3905 ;; Handle alist.
3906 (let (elem)
3907 (catch 'found
3908 (while (setq elem (pop params))
3909 (when (and (consp elem)
3910 (eq (car elem) symbol)
3911 (or allow-list
3912 (atom (cdr elem))))
3913 (throw 'found (if present-p (list (cdr elem))
3914 (cdr elem)))))))))
3916 (defun gnus-group-add-parameter (group param)
3917 "Add parameter PARAM to GROUP."
3918 (let ((info (gnus-get-info group)))
3919 (when info
3920 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3921 ;; Cons the new param to the old one and update.
3922 (gnus-group-set-info (cons param (gnus-info-params info))
3923 group 'params))))
3925 (defun gnus-group-set-parameter (group name value)
3926 "Set parameter NAME to VALUE in GROUP.
3927 GROUP can also be an INFO structure."
3928 (let ((info (if (listp group)
3929 group
3930 (gnus-get-info group))))
3931 (when info
3932 (gnus-group-remove-parameter group name)
3933 (let ((old-params (gnus-info-params info))
3934 (new-params (list (cons name value))))
3935 (while old-params
3936 (when (or (not (listp (car old-params)))
3937 (not (eq (caar old-params) name)))
3938 (setq new-params (append new-params (list (car old-params)))))
3939 (setq old-params (cdr old-params)))
3940 (if (listp group)
3941 (gnus-info-set-params info new-params t)
3942 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3944 (defun gnus-group-remove-parameter (group name)
3945 "Remove parameter NAME from GROUP.
3946 GROUP can also be an INFO structure."
3947 (let ((info (if (listp group)
3948 group
3949 (gnus-get-info group))))
3950 (when info
3951 (let ((params (gnus-info-params info)))
3952 (when params
3953 (setq params (delq name params))
3954 (while (assq name params)
3955 (gnus-alist-pull name params))
3956 (gnus-info-set-params info params))))))
3958 (defun gnus-group-add-score (group &optional score)
3959 "Add SCORE to the GROUP score.
3960 If SCORE is nil, add 1 to the score of GROUP."
3961 (let ((info (gnus-get-info group)))
3962 (when info
3963 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3965 (defun gnus-short-group-name (group &optional levels)
3966 "Collapse GROUP name LEVELS.
3967 Select methods are stripped and any remote host name is stripped down to
3968 just the host name."
3969 (let* ((name "")
3970 (foreign "")
3971 (depth 0)
3972 (skip 1)
3973 (levels (or levels
3974 gnus-group-uncollapsed-levels
3975 (progn
3977 (setq skip (match-end 0)
3978 depth (+ depth 1)))
3979 depth))))
3980 ;; Separate foreign select method from group name and collapse.
3981 ;; If method contains a server, collapse to non-domain server name,
3982 ;; otherwise collapse to select method.
3983 (let* ((colon (string-match ":" group))
3984 (server (and colon (substring group 0 colon)))
3985 (plus (and server (string-match "+" server))))
3986 (when server
3987 (if plus
3988 (setq foreign (substring server (+ 1 plus)
3990 group (substring group (+ 1 colon)))
3991 (setq foreign server
3992 group (substring group (+ 1 colon))))
3993 (setq foreign (concat foreign ":")))
3994 ;; Collapse group name leaving LEVELS uncollapsed elements
3995 (let* ((slist (split-string group "/"))
3996 (slen (length slist))
3998 (dlen (length dlist))
3999 glist
4000 glen
4001 gsep
4002 res)
4003 (if (> slen dlen)
4004 (setq glist slist
4005 glen slen
4006 gsep "/")
4007 (setq glist dlist
4008 glen dlen
4009 gsep "."))
4010 (setq levels (- glen levels))
4011 (dolist (g glist)
4012 (push (if (>= (decf levels) 0)
4013 (if (zerop (length g))
4014 ""
4015 (substring g 0 1))
4016 g)
4017 res))
4018 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4020 (defun gnus-narrow-to-body ()
4021 "Narrow to the body of an article."
4022 (narrow-to-region
4023 (progn
4024 (goto-char (point-min))
4026 (point-max)))
4027 (point-max)))
4029 \f
4030 ;;;
4031 ;;; Kill file handling.
4032 ;;;
4034 (defun gnus-apply-kill-file ()
4035 "Apply a kill file to the current newsgroup.
4036 Returns the number of articles marked as read."
4037 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4038 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4039 (gnus-apply-kill-file-internal)
4040 0))
4042 (defun gnus-kill-save-kill-buffer ()
4043 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4044 (when (get-file-buffer file)
4045 (with-current-buffer (get-file-buffer file)
4046 (when (buffer-modified-p)
4047 (save-buffer))
4048 (kill-buffer (current-buffer))))))
4050 (defcustom gnus-kill-file-name "KILL"
4051 "Suffix of the kill files."
4052 :group 'gnus-score-kill
4053 :group 'gnus-score-files
4054 :type 'string)
4056 (defun gnus-newsgroup-kill-file (newsgroup)
4057 "Return the name of a kill file name for NEWSGROUP.
4058 If NEWSGROUP is nil, return the global kill file name instead."
4059 (cond
4060 ;; The global KILL file is placed at top of the directory.
4061 ((or (null newsgroup)
4062 (string-equal newsgroup ""))
4063 (expand-file-name gnus-kill-file-name
4064 gnus-kill-files-directory))
4065 ;; Append ".KILL" to newsgroup name.
4066 ((gnus-use-long-file-name 'not-kill)
4067 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4068 "." gnus-kill-file-name)
4069 gnus-kill-files-directory))
4070 ;; Place "KILL" under the hierarchical directory.
4071 (t
4072 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4073 "/" gnus-kill-file-name)
4074 gnus-kill-files-directory))))
4076 ;;; Server things.
4078 (defun gnus-member-of-valid (symbol group)
4080 (memq symbol (assoc
4081 (symbol-name (car (gnus-find-method-for-group group)))
4082 gnus-valid-select-methods)))
4084 (defun gnus-method-option-p (method option)
4085 "Return non-nil if select METHOD has OPTION as a parameter."
4086 (when (stringp method)
4087 (setq method (gnus-server-to-method method)))
4088 (memq option (assoc (format "%s" (car method))
4089 gnus-valid-select-methods)))
4091 (defun gnus-similar-server-opened (method)
4092 "Return non-nil if we have a similar server opened.
4093 This is defined as a server with the same name, but different
4094 parameters."
4095 (let ((opened gnus-opened-servers)
4096 open)
4097 (while (and method opened)
4098 (setq open (car (pop opened)))
4099 ;; Type and name are the same...
4100 (when (and (equal (car method) (car open))
4101 (equal (cadr method) (cadr open))
4102 ;; ... but the rest of the parameters differ.
4103 (not (gnus-methods-sloppily-equal method open)))
4104 (setq method nil)))
4105 (not method)))
4107 (defun gnus-server-extend-method (group method)
4108 ;; This function "extends" a virtual server. If the server is
4109 ;; "hello", and the select method is ("hello" (my-var "something"))
4110 ;; in the group "alt.alt", this will result in a new virtual server
4111 ;; called "hello+alt.alt".
4112 (if (or (not (inline (gnus-similar-server-opened method)))
4113 (not (cddr method)))
4114 method
4115 (setq method
4116 `(,(car method) ,(concat (cadr method) "+" group)
4117 (,(intern (format "%s-address" (car method))) ,(cadr method))
4118 ,@(cddr method)))
4119 (push method gnus-extended-servers)
4120 method))
4122 (defun gnus-server-status (method)
4123 "Return the status of METHOD."
4124 (nth 1 (assoc method gnus-opened-servers)))
4126 (defun gnus-group-name-to-method (group)
4127 "Guess a select method based on GROUP."
4128 (if (string-match ":" group)
4129 (let ((server (substring group 0 (match-beginning 0))))
4131 (list (intern (substring server 0 (match-beginning 0)))
4132 (substring server (match-end 0)))
4133 (list (intern server) "")))
4134 gnus-select-method))
4136 (defun gnus-server-string (server)
4137 "Return a readable string that describes SERVER."
4138 (let* ((server (gnus-server-to-method server))
4139 (address (nth 1 server)))
4140 (if (and address
4141 (not (zerop (length address))))
4142 (format "%s using %s" address (car server))
4143 (format "%s" (car server)))))
4145 (defun gnus-same-method-different-name (method)
4146 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4147 (unless (assq slot (cddr method))
4148 (setq method
4149 (append method (list (list slot (nth 1 method)))))))
4150 (let ((methods gnus-extended-servers)
4151 open found)
4152 (while (and (not found)
4153 (setq open (pop methods)))
4154 (when (and (eq (car method) (car open))
4155 (gnus-sloppily-equal-method-parameters method open))
4156 (setq found open)))
4157 found))
4159 (defun gnus-find-method-for-group (group &optional info)
4160 "Find the select method that GROUP uses."
4161 (or gnus-override-method
4162 (and (not group)
4163 gnus-select-method)
4164 (and (not (gnus-group-entry group))
4165 ;; Killed or otherwise unknown group.
4166 (or
4167 ;; If we know a virtual server by that name, return its method.
4168 (gnus-server-to-method (gnus-group-server group))
4169 ;; Guess a new method as last resort.
4170 (gnus-group-name-to-method group)))
4171 (let ((info (or info (gnus-get-info group)))
4172 method)
4173 (if (or (not info)
4174 (not (setq method (gnus-info-method info)))
4175 (equal method "native"))
4176 gnus-select-method
4177 (setq method
4178 (cond ((stringp method)
4179 (inline (gnus-server-to-method method)))
4180 ((stringp (cadr method))
4181 (or
4182 (inline
4183 (gnus-same-method-different-name method))
4184 (inline (gnus-server-extend-method group method))))
4185 (t
4186 method)))
4187 (cond ((equal (cadr method) "")
4188 method)
4189 ((null (cadr method))
4190 (list (car method) ""))
4191 (t
4192 (gnus-server-add-address method)))))))
4194 (defun gnus-methods-using (feature)
4195 "Find all methods that have FEATURE."
4196 (let ((valids gnus-valid-select-methods)
4197 outs)
4198 (while valids
4199 (when (memq feature (car valids))
4200 (push (car valids) outs))
4201 (setq valids (cdr valids)))
4202 outs))
4204 (eval-and-compile
4205 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4207 (defun gnus-read-group (prompt &optional default)
4208 "Prompt the user for a group name.
4209 Disallow invalid group names."
4210 (let ((prefix "")
4211 group)
4212 (while (not group)
4213 (when (string-match
4214 gnus-invalid-group-regexp
4215 (setq group (read-string (concat prefix prompt)
4216 (cons (or default "") 0)
4217 'gnus-group-history)))
4218 (let ((match (match-string 0 group)))
4219 ;; Might be okay (e.g. for nnimap), so ask the user:
4221 (message-y-or-n-p
4222 "Proceed and create group anyway? " t
4225 Usually, it's dangerous to create a group with this name, because it's not
4226 supported by all back ends and servers. On IMAP servers it should work,
4227 though. If you are really sure, you can proceed anyway and create the group.
4229 You may customize the variable `gnus-invalid-group-regexp', which currently is
4233 group nil)))))
4234 group))
4236 (defun gnus-read-method (prompt)
4237 "Prompt the user for a method.
4238 Allow completion over sensible values."
4239 (let* ((open-servers
4240 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4241 gnus-opened-servers))
4242 (valid-methods
4243 (let (methods)
4244 (dolist (method gnus-valid-select-methods)
4245 (if (or (memq 'prompt-address method)
4246 (not (assoc (format "%s:" (car method)) open-servers)))
4247 (push method methods)))
4248 methods))
4249 (servers
4250 (append valid-methods
4251 open-servers
4252 gnus-predefined-server-alist
4253 gnus-server-alist))
4254 (method
4255 (gnus-completing-read
4256 prompt (mapcar 'car servers)
4257 t nil 'gnus-method-history)))
4258 (cond
4259 ((equal method "")
4260 (setq method gnus-select-method))
4261 ((assoc method gnus-valid-select-methods)
4262 (let ((address (if (memq 'prompt-address
4263 (assoc method gnus-valid-select-methods))
4264 (read-string "Address: ")
4265 "")))
4266 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4267 (list (intern method) address))))
4268 ((assoc method servers)
4269 method)
4270 (t
4271 (list (intern method) "")))))
4273 ;;; Agent functions
4275 (defun gnus-agent-method-p (method-or-server)
4276 "Say whether METHOD is covered by the agent."
4277 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4278 (let* ((method (if (stringp method-or-server)
4279 (gnus-server-to-method method-or-server)
4280 method-or-server))
4281 (server (gnus-method-to-server method t)))
4282 (setq gnus-agent-method-p-cache
4283 (cons method-or-server
4284 (member server gnus-agent-covered-methods)))))
4285 (cdr gnus-agent-method-p-cache))
4287 (defun gnus-online (method)
4288 (not
4289 (if gnus-plugged
4290 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4291 (gnus-agent-method-p method))))
4293 ;;; User-level commands.
4295 ;;;###autoload
4296 (defun gnus-slave-no-server (&optional arg)
4297 "Read network news as a slave, without connecting to the local server."
4298 (interactive "P")
4299 (gnus-no-server arg t))
4301 ;;;###autoload
4302 (defun gnus-no-server (&optional arg slave)
4303 "Read network news.
4304 If ARG is a positive number, Gnus will use that as the startup
4305 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4306 non-nil and not a positive number, Gnus will prompt the user for the
4307 name of an NNTP server to use.
4308 As opposed to `gnus', this command will not connect to the local
4309 server."
4310 (interactive "P")
4311 (gnus-no-server-1 arg slave))
4313 ;;;###autoload
4314 (defun gnus-slave (&optional arg)
4315 "Read news as a slave."
4316 (interactive "P")
4317 (gnus arg nil 'slave))
4319 ;;;###autoload
4320 (defun gnus-other-frame (&optional arg display)
4321 "Pop up a frame to read news.
4322 This will call one of the Gnus commands which is specified by the user
4323 option `gnus-other-frame-function' (default `gnus') with the argument
4324 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4325 optional second argument DISPLAY should be a standard display string
4327 omitted or the function `make-frame-on-display' is not available, the
4328 current display is used."
4329 (interactive "P")
4330 (if (fboundp 'make-frame-on-display)
4331 (unless display
4332 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4333 (setq display nil))
4334 (let ((alive (gnus-alive-p)))
4335 (unless (and alive
4336 (catch 'found
4337 (walk-windows
4338 (lambda (window)
4339 (when (and (or (not display)
4340 (equal display
4341 (gnus-frame-or-window-display-name
4342 window)))
4343 (with-current-buffer (window-buffer window)
4345 (symbol-name major-mode))))
4346 (gnus-select-frame-set-input-focus
4347 (setq gnus-other-frame-object (window-frame window)))
4348 (select-window window)
4349 (throw 'found t)))
4350 'ignore t)))
4351 (gnus-select-frame-set-input-focus
4352 (setq gnus-other-frame-object
4353 (if display
4354 (make-frame-on-display display gnus-other-frame-parameters)
4355 (make-frame gnus-other-frame-parameters))))
4356 (if alive
4357 (switch-to-buffer gnus-group-buffer)
4358 (funcall gnus-other-frame-function arg)
4359 (add-hook 'gnus-exit-gnus-hook
4360 (lambda nil
4361 (when (and (frame-live-p gnus-other-frame-object)
4362 (cdr (frame-list)))
4363 (delete-frame gnus-other-frame-object))
4364 (setq gnus-other-frame-object nil)))))))
4366 ;;;###autoload
4367 (defun gnus (&optional arg dont-connect slave)
4368 "Read network news.
4369 If ARG is non-nil and a positive number, Gnus will use that as the
4370 startup level. If ARG is non-nil and not a positive number, Gnus will
4371 prompt the user for the name of an NNTP server to use."
4372 (interactive "P")
4373 ;; When using the development version of Gnus, load the gnus-load
4374 ;; file.
4375 (unless (string-match "^Gnus" gnus-version)
4376 (load "gnus-load" nil t))
4377 (unless (byte-code-function-p (symbol-function 'gnus))
4378 (message "You should byte-compile Gnus")
4379 (sit-for 2))
4380 (let ((gnus-action-message-log (list nil)))
4381 (gnus-1 arg dont-connect slave)
4382 (gnus-final-warning)))
4384 ;; Allow redefinition of Gnus functions.
4386 (gnus-ems-redefine)
4388 (provide 'gnus)
4390 ;;; gnus.el ends here