| blob | bbf85fe584ac6198e6017cc9c3d331313949fc58 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987-1990, 1993-1998, 2000-2017 Free Software
4 ;; 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:
37 ;; These are defined afterwards with gnus-define-group-parameter
51 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
56 "Starting your favorite newsreader."
60 "Dealing with formatting issues."
64 "Group character set issues."
70 "Cache interface."
75 "Article Registry."
79 "Server options at startup."
82 ;; These belong to gnus-group.el.
84 "Group buffers."
89 "Foreign groups."
94 "Automatic subscription of new groups."
98 "Group levels."
103 "Selecting a Group."
108 "Showing slices of the group list."
113 "Sorting the group buffer."
119 "Various group options."
123 ;; These belong to gnus-sum.el.
125 "Summary buffers."
130 "Leaving summary buffers."
135 "Marks used in summary buffers."
140 "Ordering articles according to replies."
145 "Formatting of the summary buffer."
150 "Choosing Articles."
155 "Summary movement commands."
160 "Show pictures of people, domains, and newsgroups."
164 "Mail group commands."
169 "Sorting the summary buffer."
174 "Highlighting and menus in the summary buffer."
180 "Various summary buffer options."
185 "Pick mode in the summary buffer."
191 "Tree display of threads in the summary buffer."
196 ;; Belongs to gnus-uu.el
198 "Viewing extracted files."
202 ;; Belongs to gnus-score.el
204 "Score and kill file handling."
208 "Kill files."
212 "Adaptive score files."
216 "Default values for score files."
220 "Expiring score rules."
224 "Decaying score rules."
228 "Score and kill file names."
233 "Various scoring and killing options."
236 ;; Other
238 "Options controlling the visual fluff."
243 "Offline support for Gnus."
247 "Files used by Gnus."
251 "Auto save file."
256 "Storing Gnus state."
260 "Options related to newsservers and other servers used by Gnus."
264 "Highlighting and menus in the server buffer."
269 "Composing replies and followups in Gnus."
273 "Meta variables controlling major portions of Gnus.
274 In general, modifying these variables does not take effect until Gnus
275 is restarted, and sometimes reloaded."
279 "Other Gnus options."
284 "Exiting Gnus."
289 "Frivolous Gnus extensions."
300 "If non-nil, the startup message will not be displayed.
301 This variable is used before `.gnus.el' is loaded, so it should
302 be set in `.emacs' instead."
317 0 5
326 gnus-mode-line-image-cache)
328 "This is %s, %s."
330 str)
332 line)))
335 ;; We define these group faces here to avoid the display
336 ;; update forced when creating new faces.
346 ()))
347 "Level 1 newsgroup face."
349 ;; backward-compatibility alias
361 ()))
362 "Level 1 empty newsgroup face."
364 ;; backward-compatibility alias
376 ()))
377 "Level 2 newsgroup face."
379 ;; backward-compatibility alias
391 ()))
392 "Level 2 empty newsgroup face."
394 ;; backward-compatibility alias
406 ()))
407 "Level 3 newsgroup face."
409 ;; backward-compatibility alias
416 ())
419 ())
421 ()))
422 "Level 3 empty newsgroup face."
424 ;; backward-compatibility alias
436 ()))
437 "Level 4 newsgroup face."
439 ;; backward-compatibility alias
446 ())
449 ())
451 ()))
452 "Level 4 empty newsgroup face."
454 ;; backward-compatibility alias
466 ()))
467 "Level 5 newsgroup face."
469 ;; backward-compatibility alias
476 ())
479 ())
481 ()))
482 "Level 5 empty newsgroup face."
484 ;; backward-compatibility alias
496 ()))
497 "Level 6 newsgroup face."
499 ;; backward-compatibility alias
506 ())
509 ())
511 ()))
512 "Level 6 empty newsgroup face."
514 ;; backward-compatibility alias
526 ()))
527 "Low level newsgroup face."
529 ;; backward-compatibility alias
541 ()))
542 "Low level empty newsgroup face."
544 ;; backward-compatibility alias
557 "Level 1 mailgroup face."
559 ;; backward-compatibility alias
572 "Level 1 empty mailgroup face."
574 ;; backward-compatibility alias
587 "Level 2 mailgroup face."
589 ;; backward-compatibility alias
602 "Level 2 empty mailgroup face."
604 ;; backward-compatibility alias
617 "Level 3 mailgroup face."
619 ;; backward-compatibility alias
631 ()))
632 "Level 3 empty mailgroup face."
634 ;; backward-compatibility alias
647 "Low level mailgroup face."
649 ;; backward-compatibility alias
662 "Low level empty mailgroup face."
664 ;; backward-compatibility alias
668 ;; Summary mode faces.
671 "Face used for selected articles."
673 ;; backward-compatibility alias
680 "Face used for canceled articles."
682 ;; backward-compatibility alias
695 "Face used for high interest ticked articles."
697 ;; backward-compatibility alias
710 "Face used for low interest ticked articles."
712 ;; backward-compatibility alias
724 ()))
725 "Face used for normal interest ticked articles."
727 ;; backward-compatibility alias
740 "Face used for high interest ancient articles."
742 ;; backward-compatibility alias
755 "Face used for low interest ancient articles."
757 ;; backward-compatibility alias
769 ()))
770 "Face used for normal interest ancient articles."
772 ;; backward-compatibility alias
783 "Face used for high interest uncached articles."
785 ;; backward-compatibility alias
796 "Face used for low interest uncached articles."
798 ;; backward-compatibility alias
809 "Face used for normal interest uncached articles."
811 ;; backward-compatibility alias
818 "Face used for high interest unread articles."
820 ;; backward-compatibility alias
827 "Face used for low interest unread articles."
829 ;; backward-compatibility alias
835 ()))
836 "Face used for normal interest unread articles."
838 ;; backward-compatibility alias
853 "Face used for high interest read articles."
855 ;; backward-compatibility alias
870 "Face used for low interest read articles."
872 ;; backward-compatibility alias
884 ()))
885 "Face used for normal interest read articles."
887 ;; backward-compatibility alias
892 ;;;
893 ;;; Gnus buffers
894 ;;;
900 "Do the same as `get-buffer-create', but store the created buffer."
905 "Add the current buffer to the list of Gnus buffers."
910 "Kill BUFFER and remove from the list of Gnus buffers."
922 "Return a list of live Gnus buffers."
931 gnus-buffers)
933 ;;; Splash screen.
946 ()))
947 "Face for the splash screen."
949 ;; backward-compatibility alias
963 "Indent rigidly using only spaces and no tabs."
969 ;; We translate tabs into spaces -- not everybody uses
970 ;; an 8-character tab.
975 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1000 "Color styles used for the Gnus logo."
1002 gnus-logo-color-alist))
1012 "Insert startup message in current buffer."
1013 ;; Insert the message.
1018 ;; Make sure the library defining `image-load-path' is
1019 ;; loaded (`find-image' is autoloaded) (and discard the
1020 ;; result). Else, we may get "defvar ignored because
1021 ;; image-load-path is let-bound" when calling `find-image'
1022 ;; below.
1032 :color-symbols
1036 :color-symbols
1041 ;; Account for the pbm's background.
1045 ;; Account for the xbm's background.
1056 t)))
1059 _ ___ _ _
1060 _ ___ __ ___ __ _ ___
1061 __ _ ___ __ ___
1062 _ ___ _
1063 _ _ __ _
1064 ___ __ _
1065 __ _
1066 _ _ _
1067 _ _ _
1068 _ _ _
1069 __ ___
1070 _ _ _ _
1071 _ _
1072 _ _
1073 _ _
1074 _
1075 __
1078 ;; And then hack it.
1087 ;; Fontify some.
1094 "Do color-symbol search-and-replace in svg file."
1105 color-symbols)
1107 list)))
1116 ;;; Do the rest.
1122 "Alist of group parameters.
1124 For example:
1126 (gnus-use-scoring nil)
1127 (gnus-summary-line-format
1129 (gcc-self . t)
1130 (display . all))
1133 (broken-reply-to . t)))"
1140 "If it is t, ignore case of group names specified in `gnus-parameters'.
1141 If it is nil, don't ignore case. If it is `default', which is for the
1142 backward compatibility, use the value of `case-fold-search'."
1153 "Define a group parameter PARAM.
1154 REST is a plist of following:
1155 :type One of `bool', `list' or nil.
1156 :function The name of the function.
1157 :function-document The documentation of the function.
1158 :parameter-type The type for customizing the parameter.
1159 :parameter-document The documentation for the parameter.
1160 :variable The name of the variable.
1161 :variable-document The documentation for the variable.
1162 :variable-group The group for customizing the variable.
1163 :variable-type The type for customizing the variable.
1164 :variable-default The default value of the variable."
1181 'progn
1183 ,variable-document
1189 gnus-group-parameters-more))
1192 ,parameter-type
1196 ,function-document
1198 val)
1201 t)
1206 (,variable
1208 elem value)
1216 ,function-document
1220 elem value)
1227 'value
1232 All other Gnus file and directory variables are initialized from this variable.
1234 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1235 This means that other directory variables that are initialized
1236 from this variable won't be set properly if you set this variable
1237 in `.gnus.el'. Set this variable in `.emacs' instead."
1243 "Directory variable from which all other Gnus file variables are derived.
1245 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1246 This means that other directory variables that are initialized from
1247 this variable won't be set properly if you set this variable in `.gnus.el'.
1248 Set this variable in `.emacs' instead."
1253 "Default directory for all Gnus buffers."
1256 directory))
1258 ;; Site dependent variables.
1260 ;; Should this be obsolete?
1262 "The hostname of the default NNTP server.
1263 The empty string, or nil, means to use the local host.
1264 You may wish to set this on a site-wide basis.
1266 If you want to change servers, you should use `gnus-select-method'."
1272 "A file with only the name of the nntp server in it."
1278 "Find default nntp server.
1279 Check the NNTPSERVER environment variable and the
1280 `gnus-nntpserver-file' file."
1288 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1289 ;; starting or even loading Gnus.
1290 ;;;###autoload(when (fboundp 'custom-autoload)
1291 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1297 gnus-default-nntp-server)
1299 "Default method for selecting a newsgroup.
1300 This variable should be a list, where the first element is how the
1301 news is to be fetched, the second is the address.
1304 NNTP, you could say:
1308 If you want to use your local spool, say:
1312 If you use this variable, you must set `gnus-nntp-server' to nil.
1314 There is a lot more to know about select methods and virtual servers -
1315 see the manual for details."
1316 ;; Emacs has set-after since 22.1.
1317 ;set-after '(gnus-default-nntp-server)
1324 "Method used for archiving messages you've sent.
1325 This should be a mail method.
1327 See also `gnus-update-message-archive-method'."
1331 gnus-select-method))
1336 The archive method is initially set according to the value of
1338 so that it may be used as a real method of the server which is named
1340 updated if the value of this variable is nil, even if you change the
1341 value of `gnus-message-archive-method' afterward. If you want the
1343 `gnus-message-archive-method', set this variable to a non-nil value."
1350 "Name of the group in which to save the messages you've written.
1351 This can either be a string; a list of strings; or an alist
1352 of regexps/functions/forms to be evaluated to return a string (or a list
1353 of strings). The functions are called with the name of the current
1354 group (or nil) as a parameter.
1356 If you want to save your mail in one group and the news articles you
1357 write in another group, you could say something like:
1359 (setq gnus-message-archive-group
1364 Normally the group names returned by this variable should be
1366 However, you may wish to store the message on some other server. In
1367 that case, just return a fully prefixed name of the group --
1375 function
1376 sexp
1377 string))
1380 "List of NNTP servers that the user can choose between interactively.
1381 To make Gnus query you for a server, you have to give `gnus' a
1382 non-numeric prefix - `C-u M-x gnus', in short."
1388 "A list of secondary methods that will be used for reading news.
1389 This is a list where each element is a complete select method (see
1390 `gnus-select-method').
1392 If, for instance, you want to read your mail with the nnml back end,
1393 you could set this variable:
1400 "Local domain name without a host name.
1401 The DOMAINNAME environment variable is used instead if it is defined.
1402 If the function `system-name' returns the full Internet name, there is
1403 no need to set this variable."
1406 string))
1409 ;; Customization variables
1412 "Preferred method for fetching an article by Message-ID.
1413 The value of this variable must be a valid select method as discussed
1414 in the documentation of `gnus-select-method'.
1416 It can also be a list of select methods, as well as the special symbol
1417 `current', which means to use the current select method. If it is a
1418 list, Gnus will try all the methods in the list until it finds a match."
1424 gnus-select-method
1425 sexp
1433 gnus-select-method))))
1436 "Non-nil means that cross referenced articles will be marked as read.
1437 If nil, ignore cross references. If t, mark articles as read in
1438 subscribed newsgroups. If neither t nor nil, mark as read in all
1439 newsgroups."
1447 "Process mark."
1453 "The number of articles which indicates a large newsgroup.
1454 If the number of articles in a newsgroup is greater than this value,
1455 confirmation is required for selecting the newsgroup.
1456 If it is nil, no confirmation is required.
1458 Also see `gnus-large-ephemeral-newsgroup'."
1461 integer))
1464 "Non-nil means that the default name of a file to save articles in is the group name.
1465 If it's nil, the directory form of the group name is used instead.
1467 If this variable is a list, and the list contains the element
1468 `not-score', long file names will not be used for score files; if it
1469 contains the element `not-save', long file names will not be used for
1470 saving; and if it contains the element `not-kill', long file names
1471 will not be used for kill files.
1473 Note that the default for this variable varies according to what system
1474 type you're using. On `usg-unix-v' this variable defaults to nil while
1475 on all other systems it defaults to t."
1493 "If non-nil, save group scoring info."
1499 "If non-nil, allow undoing in Gnus group mode buffers."
1504 "If non-nil, use some adaptive scoring scheme.
1505 If a list, then the values `word' and `line' are meaningful. The
1506 former will perform adaption on individual words in the subject
1507 header while `line' will perform adaption on several headers."
1513 "If nil, Gnus will ignore the article cache.
1514 If `passive', it will allow entering (and reading) articles
1515 explicitly entered into the cache. If anything else, use the
1516 cache to the full extent of the law."
1524 "If non-nil, display a thread tree buffer."
1529 "If non-nil, Gnus will keep read articles for later re-retrieval.
1530 If it is a number N, then Gnus will only keep the last N articles
1531 read. If it is neither nil nor a number, Gnus will keep all read
1532 articles. This is not a good idea."
1535 integer
1540 "If non-nil, Gnus will mark duplicate copies of the same article as read."
1545 "If non-nil, enable scoring."
1551 "A hook called when preparing to exit from the summary buffer.
1552 It calls `gnus-summary-expire-articles' by default."
1557 "Non-nil means that you are a Usenet novice.
1558 If non-nil, verbose messages may be displayed and confirmations may be
1559 required."
1564 "Non-nil means that you will never be asked for confirmation about anything.
1565 That doesn't mean *anything* anything; particularly destructive
1566 commands will still require prompting."
1571 "If non-nil, require your confirmation when catching up a group."
1576 "If non-nil, require your confirmation when exiting Gnus.
1577 If `quiet', update any active summary buffers automatically
1578 first before exiting."
1584 "Function for extracting address components from a From header.
1585 Two pre-defined function exist: `gnus-extract-address-components',
1586 which is the default, quite fast, and too simplistic solution, and
1587 `mail-extract-address-components', which works much better, but is
1588 slower."
1595 "String used to separate shell commands."
1617 server-marks cloud)
1620 "An alist of valid select methods.
1621 The first element of each list lists should be a string with the name
1622 of the select method. The other elements may be the category of
1623 this method (i. e., `post', `mail', `none' or whatever) or other
1624 properties that this method has (like being respoolable).
1625 If you implement a new select method, all you should have to change is
1626 this variable. I think."
1645 "Recomputes the select-method widget based on the value of
1646 `gnus-valid-select-methods'."
1648 "Widget for entering a select method."
1655 gnus-valid-select-methods)
1659 :inline t
1661 variable
1667 "List of buffers that should update their mode lines.
1668 The list may contain the symbols `group', `article', `tree' and
1669 `summary'. If the corresponding symbol is present, Gnus will keep
1670 that mode line updated with information that may be pertinent.
1671 If this variable is nil, screen refresh may be quicker."
1679 "Max length of mode-line non-string contents.
1680 If this is nil, Gnus will take space as is needed, leaving the rest
1681 of the mode line intact."
1685 integer))
1687 ;; There should be special validation for this.
1692 to-address
1693 :function-document
1694 "Return GROUP's to-address."
1695 :variable-document
1696 "Alist of group regexps and correspondent to-addresses."
1697 :variable-group gnus-group-parameter
1700 This will be used when doing followups and posts.
1702 This is primarily useful in mail groups that represent closed
1703 mailing lists--mailing lists where it's expected that everybody that
1704 writes to the mailing list is subscribed to it. Since using this
1705 parameter ensures that the mail only goes to the mailing list itself,
1706 it means that members won't receive two copies of your followups.
1708 Using `to-address' will actually work whether the group is foreign or
1709 not. Let's say there's a group on the server that is called
1710 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1711 articles from a mail-to-news gateway. Posting directly to this group
1712 is therefore impossible--you have to send mail to the mailing list
1713 address instead.
1715 The gnus-group-split mail splitting mechanism will behave as if this
1719 to-list
1720 :function-document
1721 "Return GROUP's to-list."
1722 :variable-document
1723 "Alist of group regexps and correspondent to-lists."
1724 :variable-group gnus-group-parameter
1727 This address will be used when doing a `a' in the group.
1729 It is totally ignored when doing a followup--except that if it is
1730 present in a news group, you'll get mail group semantics when doing
1731 `f'.
1733 The gnus-group-split mail splitting mechanism will behave as if this
1737 subscribed
1738 :type bool
1739 :function-document
1740 "Return GROUP's subscription status."
1741 :variable-document
1742 "Groups which are automatically considered subscribed."
1743 :variable-group gnus-group-parameter
1746 Gnus assumed that you are subscribed to the To/List address.
1748 When constructing a list of subscribed groups using
1749 `gnus-find-subscribed-addresses', Gnus includes the To address given
1753 auto-expire
1754 :type bool
1755 :function gnus-group-auto-expirable-p
1756 :function-document
1757 "Check whether GROUP is auto-expirable or not."
1758 :variable gnus-auto-expirable-newsgroups
1759 :variable-default nil
1760 :variable-document
1761 "Groups in which to automatically mark read articles as expirable.
1762 If non-nil, this should be a regexp that should match all groups in
1763 which to perform auto-expiry. This only makes sense for mail groups."
1764 :variable-group nnmail-expire
1766 regexp)
1768 :parameter-document
1772 total-expire
1773 :type bool
1774 :function gnus-group-total-expirable-p
1775 :function-document
1776 "Check whether GROUP is total-expirable or not."
1777 :variable gnus-total-expirable-newsgroups
1778 :variable-default nil
1779 :variable-document
1780 "Groups in which to perform expiry of all read articles.
1781 Use with extreme caution. All groups that match this regexp will be
1782 expiring - which means that all read articles will be deleted after
1783 \(say) one week. (This only goes for mail groups and the like, of
1784 course.)"
1785 :variable-group nnmail-expire
1787 regexp)
1789 :parameter-document
1790 "All read articles will be put through the expiry process
1792 This happens even if they are not marked as expirable.
1796 charset
1797 :function-document
1798 "Return the default charset of GROUP."
1799 :variable gnus-group-charset-alist
1800 :variable-default
1813 :variable-document
1814 "Alist of regexps (to match group names) and default charsets to be used when reading."
1815 :variable-group gnus-charset
1823 post-method
1824 :type list
1825 :function-document
1826 "Return a posting method for GROUP."
1827 :variable gnus-post-method-alist
1828 :variable-document
1829 "Alist of regexps (to match group names) and method to be used when
1830 posting an article."
1831 :variable-group gnus-group-foreign
1832 :parameter-type
1840 :parameter-document
1844 large-newsgroup-initial
1845 :type integer
1846 :function-document
1847 "Return GROUP's initial input of the number of articles."
1848 :variable-document
1849 "Alist of group regexps and its initial input of the number of articles."
1850 :variable-group gnus-group-parameter
1856 This number will be prompted as the initial value of the number of
1857 articles to list when the group is a large newsgroup (see
1858 `gnus-large-newsgroup'). If it is nil, the default value is the
1861 ;; The Gnus registry's ignored groups
1863 registry-ignore
1864 :type list
1865 :function-document
1866 "Whether this group should be ignored by the registry."
1867 :variable gnus-registry-ignored-groups
1872 :variable-document
1873 "Groups in which the registry should be turned off."
1874 :variable-group gnus-registry
1881 :parameter-document
1884 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1886 "Disable the group parameters for spam detection.
1887 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1894 "Spam group classification (requires spam.el).
1895 This group contains spam messages. On summary entry, unread messages
1896 will be marked as spam. On summary exit, the specified spam
1897 processors will be invoked on spam-marked messages, then those
1898 messages will be expired, so the spam processor will only see a
1902 "The ham value for the spam group parameter (requires spam.el).
1903 On summary exit, the specified ham processors will be invoked on
1904 ham-marked messages. Exercise caution, since the ham processor will
1905 see the same message more than once because there is no ham message
1909 spam-contents
1910 :type list
1911 :function-document
1912 "The spam type (spam, ham, or neither) of the group."
1913 :variable gnus-spam-newsgroup-contents
1914 :variable-default nil
1915 :variable-document
1916 "Group classification (spam, ham, or neither). Only
1917 meaningful when spam.el is loaded. If non-nil, this should be a
1918 list of group name regexps associated with a classification for
1919 each one. In spam groups, new articles are marked as spam on
1920 summary entry. There is other behavior associated with ham and
1921 no classification when spam.el is loaded - see the manual."
1922 :variable-group spam
1936 :parameter-document
1937 "The spam classification (spam, ham, or neither) of this group.
1938 When a spam group is entered, all unread articles are marked as
1939 spam. There is other behavior associated with ham and no
1943 spam-resend-to
1944 :type list
1945 :function-document
1946 "The address to get spam resent (through spam-report-resend)."
1947 :variable gnus-spam-resend-to
1948 :variable-default nil
1949 :variable-document
1950 "The address to get spam resent (through spam-report-resend)."
1951 :variable-group spam
1955 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1956 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1957 :parameter-document
1961 ham-resend-to
1962 :type list
1963 :function-document
1964 "The address to get ham resent (through spam-report-resend)."
1965 :variable gnus-ham-resend-to
1966 :variable-default nil
1967 :variable-document
1968 "The address to get ham resent (through spam-report-resend)."
1969 :variable-group spam
1973 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1974 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1975 :parameter-document
1991 "OBSOLETE: The Gmane reporting summary exit spam processor.
1998 "OBSOLETE: The ifile summary exit ham processor.
2002 "OBSOLETE: The Bogofilter summary exit ham processor.
2006 "OBSOLETE: The spam-stat summary exit ham processor.
2010 "OBSOLETE: The whitelist summary exit ham processor.
2014 "OBSOLETE: The BBDB summary exit ham processor.
2018 "OBSOLETE: The ham copy exit ham processor.
2022 "OBSOLETE: The spamoracle summary exit ham processor.
2026 spam-process
2027 :type list
2028 :parameter-type
2031 :value nil
2068 :function-document
2069 "Which spam or ham processors will be applied when the summary is exited."
2070 :variable gnus-spam-process-newsgroups
2071 :variable-default nil
2072 :variable-document
2073 "Groups in which to automatically process spam or ham articles with
2074 a backend on summary exit. If non-nil, this should be a list of group
2075 name regexps that should match all groups in which to do automatic
2076 spam processing, associated with the appropriate processor."
2077 :variable-group spam
2078 :variable-type
2119 :parameter-document
2123 spam-autodetect
2124 :type list
2125 :parameter-type
2127 :function-document
2128 "Should spam be autodetected (with spam-split) in this group?"
2129 :variable gnus-spam-autodetect
2130 :variable-default nil
2131 :variable-document
2132 "Groups in which spam should be autodetected when they are entered.
2133 Only unseen articles will be examined, unless
2134 spam-autodetect-recheck-messages is set."
2135 :variable-group spam
2136 :variable-type
2141 boolean))
2142 :parameter-document
2143 "Spam autodetection.
2144 Only unseen articles will be examined, unless
2148 spam-autodetect-methods
2149 :type list
2150 :parameter-type
2173 :function-document
2174 "Methods to be used for autodetection in each group"
2175 :variable gnus-spam-autodetect-methods
2176 :variable-default nil
2177 :variable-document
2178 "Methods for autodetecting spam per group.
2179 Requires the spam-autodetect parameter. Only unseen articles
2180 will be examined, unless spam-autodetect-recheck-messages is
2181 set."
2182 :variable-group spam
2183 :variable-type
2210 :parameter-document
2211 "Spam autodetection methods.
2212 Requires the spam-autodetect parameter. Only unseen articles
2213 will be examined, unless spam-autodetect-recheck-messages is
2217 spam-process-destination
2218 :type list
2219 :parameter-type
2225 :function-document
2226 "Where spam-processed articles will go at summary exit."
2227 :variable gnus-spam-process-destinations
2228 :variable-default nil
2229 :variable-document
2230 "Groups in which to explicitly send spam-processed articles to
2231 another group, or expire them (the default). If non-nil, this should
2232 be a list of group name regexps that should match all groups in which
2233 to do spam-processed article moving, associated with the destination
2234 group or nil for explicit expiration. This only makes sense for
2235 mail groups."
2236 :variable-group spam
2237 :variable-type
2248 :parameter-document
2252 ham-process-destination
2253 :type list
2254 :parameter-type
2262 :function-document
2263 "Where ham articles will go at summary exit from a spam group."
2264 :variable gnus-ham-process-destinations
2265 :variable-default nil
2266 :variable-document
2267 "Groups in which to explicitly send ham articles to
2268 another group, or do nothing (the default). If non-nil, this should
2269 be a list of group name regexps that should match all groups in which
2270 to do ham article moving, associated with the destination
2271 group or nil for explicit ignoring. This only makes sense for
2272 mail groups, and only works in spam groups."
2273 :variable-group spam
2274 :variable-type
2286 :parameter-document
2290 ham-marks
2301 :parameter-document
2302 "Marks considered ham (positively not spam). Such articles will be
2303 processed as ham (non-spam) on group exit. When nil, the global
2304 spam-ham-marks variable takes precedence."
2306 gnus-read-mark
2307 gnus-killed-mark
2308 gnus-kill-file-mark
2309 gnus-low-score-mark))))
2310 :variable-group spam
2311 :variable-document
2315 spam-marks
2324 :parameter-document
2325 "Marks considered spam.
2326 Such articles will be processed as spam on group exit. When nil, the global
2327 spam-spam-marks variable takes precedence."
2329 :variable-group spam
2330 :variable-document
2334 "Number of group name elements to leave alone when making a short group name."
2339 "If non-nil, once you set a level, Gnus will use this level."
2343 ;; Hooks.
2346 "A hook run while Gnus is loaded."
2351 "A hook called to apply kill files to a group.
2352 This hook is intended to apply a kill file to the selected newsgroup.
2353 The function `gnus-apply-kill-file' is called by default.
2355 Since a general kill file is too heavy to use only for a few
2356 newsgroups, I recommend you to use a lighter hook function. For
2357 example, if you'd like to apply a kill file to articles which contains
2358 a string `rmgroup' in subject in newsgroup `control', you can use the
2359 following hook:
2361 (setq gnus-apply-kill-hook
2362 (list
2363 (lambda ()
2372 "Function run when a group level is changed.
2373 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2376 function))
2378 ;;; Face thingies.
2382 mouse-face
2383 summary-menu group-menu article-menu
2384 tree-highlight menu highlight
2385 browse-menu server-menu
2386 page-marker tree-menu binary-menu pick-menu)
2387 "Enable visual features.
2388 If `visual' is disabled, there will be no menus and few faces. Most of
2389 the visual customization options below will be ignored. Gnus will use
2390 less space and be faster as a result.
2392 This variable can also be a list of visual elements to switch on. For
2393 instance, to switch off all visual things except menus, you can say:
2397 Valid elements include `summary-highlight', `group-highlight',
2398 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2399 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2400 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2420 ;; Byte-compiler warning.
2422 ;; Find out whether the gnus-visual TYPE is wanted.
2426 gnus-visual
2430 t))))
2440 "Face used for group or summary buffer mouse highlighting.
2441 The line beneath the mouse pointer will be highlighted with this
2442 face."
2455 "Controls use of the agent cache while plugged.
2456 When set, Gnus will prefer using the locally stored content rather
2457 than re-fetching it from the server. You also need to enable
2458 `gnus-agent' for this to have any affect."
2464 "Default charset assumed to be used when viewing non-ASCII characters.
2465 This variable is overridden on a group-to-group basis by the
2466 `gnus-group-charset-alist' variable and is only used on groups not
2467 covered by that variable."
2471 ;; Fixme: Doc reference to agent.
2473 "Whether we want to use the Gnus agent or not.
2475 You may customize gnus-agent to disable its use. However, some
2476 back ends have started to use the agent as a client-side cache.
2477 Disabling the agent may result in noticeable loss of performance."
2483 "Function called by the command `gnus-other-frame' when starting Gnus."
2491 "Function called by the command `gnus-other-frame' when resuming Gnus."
2501 "Frame parameters used by `gnus-other-frame' to create a Gnus frame."
2508 "Which information should be exposed in the User-Agent header.
2510 Can be a list of symbols or a string. Valid symbols are `gnus'
2511 \(show Gnus version) and `emacs' \(show Emacs version). In
2512 addition to the Emacs version, you can add `codename' \(show
2513 \(S)XEmacs codename) or either `config' \(show system
2514 configuration) or `type' \(show system type). If you set it to
2515 a string, be sure to use a valid format, see RFC 2616."
2528 ;; Convert old (< 2005-01-10) symbol type values:
2547 \f
2548 ;;; Internal variables
2553 ; Reset each time gnus-agent-covered-methods is changed else
2554 ; gnus-agent-method-p may mis-report a methods status.
2555 )
2565 ;; The carpal mode has been removed, but define the variable for
2566 ;; backwards compatibility.
2585 ;; Variable holding the user answers to all method prompts.
2588 ;; Variable holding the user answers to all mail method prompts.
2591 ;; Variable holding the user answers to all group prompts.
2599 "The directory where cached articles will be stored."
2605 nnspool "cache"
2630 ;; Propagate flags to server, with the following exceptions:
2631 ;; `seen' is private to each gnus installation
2632 ;; `cache' is a internal gnus flag for each gnus installation
2633 ;; `download' is a agent flag private to each gnus installation
2634 ;; `unsend' are for nndraft groups only
2635 ;; `score' is not a proper mark
2636 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2639 "Marks that shouldn't be propagated to back ends.
2640 Typical marks are those that make no sense in a standalone back end,
2641 such as a mark that says whether an article is stored in the cache
2654 "submit@debbugs.gnu.org (The Gnus Bugfixing Girls + Boys)"
2678 gnus-newsrc-last-checked-date
2679 gnus-newsrc-alist gnus-server-alist
2680 gnus-killed-list gnus-zombie-list
2681 gnus-topic-topology gnus-topic-alist
2682 gnus-cloud-sequence
2683 gnus-cloud-covered-servers
2684 gnus-cloud-file-timestamps)
2688 "Assoc list of read articles.
2692 "Assoc list of registry data.
2719 ;; Save window configuration.
2732 ;;; End of variables.
2734 ;; Define some autoload functions Gnus might use.
2737 ;; This little mapcar goes through the list below and marks the
2738 ;; symbols in question as autoloaded functions.
2758 message-send-and-exit message-yank-original)
2762 ;; This is only used in message.el, which has an autoload.
2764 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2766 ;; Next two only used in gnus-util.
2767 rmail-summary-exists rmail-select-summary)
2768 ;; Only used in gnus-util, which has an autoload.
2773 gnus-Folder-save-name gnus-folder-save-name)
2776 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2777 gnus-demon-add-disconnection gnus-demon-add-handler
2778 gnus-demon-remove-handler)
2780 gnus-demon-init gnus-demon-cancel)
2782 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2783 gnus-face-from-file)
2785 gnus-tree-open gnus-tree-close)
2787 gnus-server-server-name)
2790 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2791 gnus-article-hide-citation gnus-article-fill-cited-article
2792 gnus-article-hide-citation-in-followups
2793 gnus-article-fill-cited-long-lines)
2795 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2796 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2798 gnus-registry-handle-action)
2800 gnus-cache-possibly-remove-articles gnus-cache-request-article
2801 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2802 gnus-cache-enter-remove-article gnus-cached-article-p
2803 gnus-cache-open gnus-cache-close gnus-cache-update-article
2804 gnus-cache-articles-in-group)
2806 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2808 gnus-summary-increase-score gnus-summary-set-score
2809 gnus-summary-raise-thread gnus-summary-raise-same-subject
2810 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2811 gnus-summary-lower-thread gnus-summary-lower-same-subject
2812 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2813 gnus-summary-current-score gnus-score-delta-default
2814 gnus-score-flush-cache gnus-score-close
2815 gnus-possibly-score-headers gnus-score-followup-article
2816 gnus-score-followup-thread)
2819 gnus-current-score-file-nondirectory gnus-score-adaptive
2820 gnus-score-find-trace gnus-score-file-name)
2824 gnus-subscribe-topics)
2828 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2829 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2830 gnus-uu-mark-by-regexp gnus-uu-mark-all
2831 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2832 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2833 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2834 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2835 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2836 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2837 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2838 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2841 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2843 gnus-group-post-news gnus-group-mail gnus-group-news
2844 gnus-summary-post-news gnus-summary-news-other-window
2845 gnus-summary-followup gnus-summary-followup-with-original
2846 gnus-summary-cancel-article gnus-summary-supersede-article
2847 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2848 gnus-summary-mail-forward gnus-summary-mail-other-window
2849 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2850 gnus-summary-wide-reply gnus-summary-followup-to-mail
2851 gnus-summary-followup-to-mail-with-original gnus-bug
2852 gnus-summary-wide-reply-with-original
2853 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2854 gnus-summary-post-forward)
2859 gnus-list-of-unread-articles gnus-list-of-read-articles
2860 gnus-offer-save-summaries gnus-make-thread-indent-array
2861 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2862 gnus-summary-skip-intangible gnus-summary-article-number
2863 gnus-data-header gnus-data-find)
2865 gnus-group-list-groups gnus-group-first-unread-group
2866 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2867 gnus-group-setup-buffer gnus-group-get-new-news
2868 gnus-group-make-help-group gnus-group-update-group
2869 gnus-group-iterate gnus-group-group-name)
2871 gnus-backlog-remove-article)
2873 gnus-article-prepare gnus-article-set-window-start
2874 gnus-article-next-page gnus-article-prev-page
2875 gnus-request-article-this-buffer gnus-article-mode
2876 gnus-article-setup-buffer gnus-narrow-to-page
2877 gnus-article-delete-invisible-text gnus-treat-article)
2879 gnus-article-hide-headers gnus-article-hide-boring-headers
2880 gnus-article-treat-overstrike
2881 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2882 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2883 gnus-article-de-base64-unreadable
2884 gnus-article-decode-HZ
2885 gnus-article-wash-html
2886 gnus-article-unsplit-urls
2887 gnus-article-hide-pem gnus-article-hide-signature
2888 gnus-article-strip-leading-blank-lines gnus-article-date-local
2889 gnus-article-date-original gnus-article-date-lapsed
2890 ;;gnus-article-show-all-headers
2891 gnus-article-edit-mode gnus-article-edit-article
2892 gnus-article-edit-done gnus-article-decode-encoded-words
2893 gnus-start-date-timer gnus-stop-date-timer
2894 gnus-mime-view-all-parts)
2897 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2898 gnus-check-reasonable-setup)
2900 gnus-dup-enter-articles)
2906 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2907 gnus-async-halt-prefetch)
2909 gnus-agent-save-active gnus-agent-method-p
2910 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2911 gnus-summary-set-agent-mark gnus-agent-save-group-info
2912 gnus-agent-request-article gnus-agent-retrieve-headers
2913 gnus-agent-store-article gnus-agent-group-covered-p)
2915 gnus-unplugged gnus-agentize gnus-agent-batch)
2917 gnus-summary-save-article-vm)
2922 gnus-group-split-update)
2925 ;;; gnus-sum.el thingies
2929 "The format specification of the lines in the summary buffer.
2931 It works along the same lines as a normal formatting string,
2932 with some simple extensions.
2934 %N Article number, left padded with spaces (string)
2935 %S Subject (string)
2937 otherwise (string)
2938 %n Name of the poster (string)
2939 %a Extracted name of the poster (string)
2940 %A Extracted address of the poster (string)
2941 %F Contents of the From: header (string)
2942 %f Contents of the From: or To: headers (string)
2943 %x Contents of the Xref: header (string)
2944 %D Date of the article (string)
2945 %d Date of the article (string) in DD-MMM format
2946 %o Date of the article (string) in YYYYMMDD`T'HHMMSS
2947 format
2948 %M Message-id of the article (string)
2949 %r References of the article (string)
2950 %c Number of characters in the article (integer)
2951 %k Pretty-printed version of the above (string)
2953 %L Number of lines in the article (integer)
2954 %I Indentation based on thread level (a string of
2955 spaces)
2956 %B A complex trn-style thread tree (string)
2957 The variables `gnus-sum-thread-*' can be used for
2958 customization.
2959 %T A string with two possible values: 80 spaces if the
2960 article is on thread level two or larger and 0 spaces
2961 on level one
2963 otherwise (character)
2965 See Info node `(gnus)Marking Articles'
2968 %> Spaces of length thread-level (string)
2969 %< Spaces of length (- 20 thread-level) (string)
2970 %i Article score (number)
2971 %z Article zcore (character)
2972 %t Number of articles under the current thread (number).
2973 %e Whether the thread is empty or not (character).
2974 %V Total thread score (number).
2975 %P The line number (number).
2976 %O Download mark (character).
2977 %* If present, indicates desired cursor position
2978 (instead of after first colon).
2979 %u User defined specifier. The next character in the
2980 format string should be a letter. Gnus will call the
2981 function gnus-user-format-function-X, where X is the
2982 letter following %u. The function will be passed the
2983 current header as argument. The function should
2984 return a string, which will be inserted into the
2985 summary just like information from any other summary
2986 specifier.
2987 &user-date; Age sensitive date format. Various date format is
2988 defined in `gnus-user-date-format-alist'.
2991 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2992 with care. For reasons of efficiency, Gnus will compute what column
2994 it is invalid to have these specs after a variable-length spec. Well,
2995 you might not be arrested, but your summary buffer will look strange,
2996 which is bad enough.
2998 The smart choice is to have these specs as far to the left as
2999 possible.
3001 This restriction may disappear in later versions of Gnus.
3003 General format specifiers can also be used.
3004 See Info node `(gnus)Formatting Variables'."
3009 ;;;
3010 ;;; Skeleton keymaps
3011 ;;;
3016 (while keys
3017 (define-key keymap (pop keys) 'undefined))))
3019 (defvar gnus-article-mode-map
3020 (let ((keymap (make-sparse-keymap)))
3021 (gnus-suppress-keymap keymap)
3022 keymap))
3023 (defvar gnus-summary-mode-map
3024 (let ((keymap (make-keymap)))
3025 (gnus-suppress-keymap keymap)
3026 keymap))
3027 (defvar gnus-group-mode-map
3028 (let ((keymap (make-keymap)))
3029 (gnus-suppress-keymap keymap)
3030 keymap))
3032 \f
3034 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3035 ;; If you want the cursor to go somewhere else, set these two
3036 ;; functions in some startup hook to whatever you want.
3037 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3038 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3040 ;;; Various macros and substs.
3042 (defun gnus-header-from (header)
3043 (mail-header-from header))
3045 (defmacro gnus-gethash (string hashtable)
3046 "Get hash value of STRING in HASHTABLE."
3047 `(symbol-value (intern-soft ,string ,hashtable)))
3049 (defmacro gnus-gethash-safe (string hashtable)
3050 "Get hash value of STRING in HASHTABLE.
3051 Return nil if not defined."
3052 `(let ((sym (intern-soft ,string ,hashtable)))
3053 (and (boundp sym) (symbol-value sym))))
3055 (defmacro gnus-sethash (string value hashtable)
3056 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3057 `(set (intern ,string ,hashtable) ,value))
3058 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3060 (defmacro gnus-group-unread (group)
3061 "Get the currently computed number of unread articles in GROUP."
3062 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3064 (defmacro gnus-group-entry (group)
3065 "Get the newsrc entry for GROUP."
3066 `(gnus-gethash ,group gnus-newsrc-hashtb))
3068 (defmacro gnus-active (group)
3069 "Get active info on GROUP."
3070 `(gnus-gethash ,group gnus-active-hashtb))
3072 (defmacro gnus-set-active (group active)
3073 "Set GROUP's active info."
3074 `(gnus-sethash ,group ,active gnus-active-hashtb))
3076 ;; Info access macros.
3078 (defmacro gnus-info-group (info)
3079 `(nth 0 ,info))
3080 (defmacro gnus-info-rank (info)
3081 `(nth 1 ,info))
3082 (defmacro gnus-info-read (info)
3083 `(nth 2 ,info))
3084 (defmacro gnus-info-marks (info)
3085 `(nth 3 ,info))
3086 (defmacro gnus-info-method (info)
3087 `(nth 4 ,info))
3088 (defmacro gnus-info-params (info)
3089 `(nth 5 ,info))
3091 (defmacro gnus-info-level (info)
3092 `(let ((rank (gnus-info-rank ,info)))
3093 (if (consp rank)
3094 (car rank)
3095 rank)))
3096 (defmacro gnus-info-score (info)
3097 `(let ((rank (gnus-info-rank ,info)))
3098 (or (and (consp rank) (cdr rank)) 0)))
3100 (defmacro gnus-info-set-group (info group)
3101 `(setcar ,info ,group))
3102 (defmacro gnus-info-set-rank (info rank)
3103 `(setcar (nthcdr 1 ,info) ,rank))
3104 (defmacro gnus-info-set-read (info read)
3105 `(setcar (nthcdr 2 ,info) ,read))
3106 (defmacro gnus-info-set-marks (info marks &optional extend)
3107 (if extend
3108 `(gnus-info-set-entry ,info ,marks 3)
3109 `(setcar (nthcdr 3 ,info) ,marks)))
3110 (defmacro gnus-info-set-method (info method &optional extend)
3111 (if extend
3112 `(gnus-info-set-entry ,info ,method 4)
3113 `(setcar (nthcdr 4 ,info) ,method)))
3114 (defmacro gnus-info-set-params (info params &optional extend)
3115 (if extend
3116 `(gnus-info-set-entry ,info ,params 5)
3117 `(setcar (nthcdr 5 ,info) ,params)))
3119 (defun gnus-info-set-entry (info entry number)
3120 ;; Extend the info until we have enough elements.
3121 (while (<= (length info) number)
3122 (nconc info (list nil)))
3123 ;; Set the entry.
3124 (setcar (nthcdr number info) entry))
3126 (defmacro gnus-info-set-level (info level)
3127 `(let ((rank (cdr ,info)))
3128 (if (consp (car rank))
3129 (setcar (car rank) ,level)
3130 (setcar rank ,level))))
3131 (defmacro gnus-info-set-score (info score)
3132 `(let ((rank (cdr ,info)))
3133 (if (consp (car rank))
3134 (setcdr (car rank) ,score)
3135 (setcar rank (cons (car rank) ,score)))))
3137 (defmacro gnus-get-info (group)
3138 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3140 (defun gnus-set-info (group info)
3141 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3142 info))
3144 \f
3145 ;;;
3146 ;;; Shutdown
3147 ;;;
3149 (defvar gnus-shutdown-alist nil)
3151 (defun gnus-add-shutdown (function &rest symbols)
3152 "Run FUNCTION whenever one of SYMBOLS is shut down."
3153 (push (cons function symbols) gnus-shutdown-alist))
3155 (defun gnus-shutdown (symbol)
3156 "Shut down everything that waits for SYMBOL."
3157 (dolist (entry gnus-shutdown-alist)
3158 (when (memq symbol (cdr entry))
3159 (funcall (car entry)))))
3161 \f
3162 ;;;
3163 ;;; Gnus Utility Functions
3164 ;;;
3166 (defun gnus-find-subscribed-addresses ()
3167 "Return a regexp matching the addresses of all subscribed mail groups.
3168 It consists of the `to-address' or `to-list' parameter of all groups
3169 with a `subscribed' parameter."
3170 (let (group address addresses)
3171 (dolist (entry (cdr gnus-newsrc-alist))
3172 (setq group (car entry))
3173 (when (gnus-parameter-subscribed group)
3174 (setq address (mail-strip-quoted-names
3175 (or (gnus-group-fast-parameter group 'to-address)
3176 (gnus-group-fast-parameter group 'to-list))))
3177 (when address
3178 (add-to-list 'addresses address))))
3179 (when addresses
3182 (defmacro gnus-string-or (&rest strings)
3183 "Return the first element of STRINGS that is a non-blank string.
3184 STRINGS will be evaluated in normal `or' order."
3185 `(gnus-string-or-1 (list ,@strings)))
3187 (defun gnus-string-or-1 (strings)
3188 (let (string)
3189 (while strings
3190 (setq string (pop strings))
3192 (setq string nil)
3193 (setq strings nil)))
3194 string))
3196 (defun gnus-version (&optional arg)
3197 "Version number of this version of Gnus.
3198 If ARG, insert string at point."
3199 (interactive "P")
3200 (if arg
3201 (insert (message gnus-version))
3202 (message gnus-version)))
3204 (defun gnus-continuum-version (&optional version)
3205 "Return VERSION as a floating point number."
3206 (unless version
3207 (setq version gnus-version))
3210 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3211 (number (match-string 2 version))
3212 major minor least)
3213 (unless (string-match
3215 (error "Invalid version string: %s" version))
3216 (setq major (string-to-number (match-string 1 number))
3217 minor (string-to-number (match-string 2 number))
3218 least (if (match-beginning 3)
3219 (string-to-number (match-string 3 number))
3220 0))
3221 (string-to-number
3222 (if (zerop major)
3223 (format "%1.2f00%02d%02d"
3224 (if (member alpha '("(ding)" "d"))
3225 4.99
3226 (+ 5 (* 0.02
3227 (abs
3228 (- (aref (downcase alpha) 0) ?t)))
3229 -0.01))
3230 minor least)
3231 (format "%d.%02d%02d" major minor least))))))
3233 (defun gnus-info-find-node (&optional nodename)
3234 "Find Info documentation of Gnus."
3235 (interactive)
3236 ;; Enlarge info window if needed.
3237 (let (gnus-info-buffer)
3238 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3239 (setq gnus-info-buffer (current-buffer))
3240 (gnus-configure-windows 'info)))
3242 ;;;
3243 ;;; gnus-interactive
3244 ;;;
3246 (defvar gnus-current-prefix-symbol nil
3247 "Current prefix symbol.")
3249 (defvar gnus-current-prefix-symbols nil
3250 "List of current prefix symbols.")
3252 (defun gnus-interactive (string &optional params)
3253 "Return a list that can be fed to `interactive'.
3254 See `interactive' for full documentation.
3256 Adds the following specs:
3258 y -- The current symbolic prefix.
3259 Y -- A list of the current symbolic prefix(es).
3260 A -- Article number.
3261 H -- Article header.
3262 g -- Group name."
3263 (let ((i 0)
3264 out c prompt)
3265 (while (< i (length string))
3267 (setq c (aref string i))
3268 (when (match-end 1)
3269 (setq prompt (match-string 1 string)))
3270 (setq i (match-end 0))
3271 ;; We basically emulate just about everything that
3272 ;; `interactive' does, but add the specs listed above.
3273 (push
3274 (cond
3275 ((= c ?a)
3276 (completing-read prompt obarray 'fboundp t))
3277 ((= c ?b)
3278 (read-buffer prompt (current-buffer) t))
3279 ((= c ?B)
3280 (read-buffer prompt (other-buffer (current-buffer))))
3281 ((= c ?c)
3282 (read-char))
3283 ((= c ?C)
3284 (completing-read prompt obarray 'commandp t))
3285 ((= c ?d)
3286 (point))
3287 ((= c ?D)
3288 (read-directory-name prompt nil default-directory 'lambda))
3289 ((= c ?f)
3290 (read-file-name prompt nil nil 'lambda))
3291 ((= c ?F)
3292 (read-file-name prompt))
3293 ((= c ?k)
3294 (read-key-sequence prompt))
3295 ((= c ?K)
3296 (error "Not implemented spec"))
3297 ((= c ?e)
3298 (error "Not implemented spec"))
3299 ((= c ?m)
3300 (mark))
3301 ((= c ?N)
3302 (error "Not implemented spec"))
3303 ((= c ?n)
3304 (string-to-number (read-from-minibuffer prompt)))
3305 ((= c ?p)
3306 (prefix-numeric-value current-prefix-arg))
3307 ((= c ?P)
3308 current-prefix-arg)
3309 ((= c ?r)
3310 'gnus-prefix-nil)
3311 ((= c ?s)
3312 (read-string prompt))
3313 ((= c ?S)
3314 (intern (read-string prompt)))
3315 ((= c ?v)
3316 (read-variable prompt))
3317 ((= c ?x)
3318 (read-minibuffer prompt))
3319 ((= c ?x)
3320 (eval-minibuffer prompt))
3321 ;; And here the new specs come.
3322 ((= c ?y)
3323 gnus-current-prefix-symbol)
3324 ((= c ?Y)
3325 gnus-current-prefix-symbols)
3326 ((= c ?g)
3327 (gnus-group-group-name))
3328 ((= c ?A)
3329 (gnus-summary-skip-intangible)
3330 (or (get-text-property (point) 'gnus-number)
3331 (gnus-summary-last-subject)))
3332 ((= c ?H)
3333 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3334 (t
3335 (error "Non-implemented spec")))
3336 out)
3337 (cond
3338 ((= c ?r)
3339 (push (if (< (point) (mark)) (point) (mark)) out)
3340 (push (if (> (point) (mark)) (point) (mark)) out))))
3341 (setq out (delq 'gnus-prefix-nil out))
3342 (nreverse out)))
3344 (defun gnus-symbolic-argument (&optional arg)
3345 "Read a symbolic argument and a command, and then execute command."
3346 (interactive "P")
3347 (let* ((in-command (this-command-keys))
3348 (command in-command)
3349 gnus-current-prefix-symbols
3350 gnus-current-prefix-symbol
3351 syms)
3352 (while (equal in-command command)
3353 (message "%s-" (key-description (this-command-keys)))
3354 (push (intern (char-to-string (read-char))) syms)
3355 (setq command (read-key-sequence nil t)))
3356 (setq gnus-current-prefix-symbols (nreverse syms)
3357 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3358 (call-interactively (key-binding command t))))
3360 ;;; More various functions.
3362 (defsubst gnus-check-backend-function (func group)
3363 "Check whether GROUP supports function FUNC.
3364 GROUP can either be a string (a group name) or a select method."
3365 (ignore-errors
3366 (let ((method (if (stringp group)
3367 (car (gnus-find-method-for-group group))
3368 group)))
3369 (unless (featurep method)
3370 (require method))
3371 (fboundp (intern (format "%s-%s" method func))))))
3373 (defun gnus-group-read-only-p (&optional group)
3374 "Check whether GROUP supports editing or not.
3375 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3376 that that variable is buffer-local to the summary buffers."
3377 (let ((group (or group gnus-newsgroup-name)))
3378 (not (gnus-check-backend-function 'request-replace-article group))))
3380 (defun gnus-virtual-group-p (group)
3381 "Say whether GROUP is virtual or not."
3382 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3383 gnus-valid-select-methods)))
3385 (defun gnus-news-group-p (group &optional article)
3386 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3387 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3388 t) ;is news of course.
3389 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3390 nil) ;must be mail then.
3391 ((vectorp article) ;Has header info.
3392 (eq (gnus-request-type group (mail-header-id article)) 'news))
3393 ((null article) ;Hasn't header info
3394 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3395 ((< article 0) ;Virtual message
3396 nil) ;we don't know, guess mail.
3397 (t ;Has positive number
3398 (eq (gnus-request-type group article) 'news)))) ;use it.
3400 ;; Check whether to use long file names.
3401 (defun gnus-use-long-file-name (symbol)
3402 ;; The variable has to be set...
3403 (and gnus-use-long-file-name
3404 ;; If it isn't a list, then we return t.
3405 (or (not (listp gnus-use-long-file-name))
3406 ;; If it is a list, and the list contains `symbol', we
3407 ;; return nil.
3408 (not (memq symbol gnus-use-long-file-name)))))
3410 ;; Generate a unique new group name.
3411 (defun gnus-generate-new-group-name (leaf)
3412 (let ((name leaf)
3413 (num 0))
3414 (while (gnus-group-entry name)
3415 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3416 name))
3418 (defun gnus-ephemeral-group-p (group)
3419 "Say whether GROUP is ephemeral or not."
3420 (gnus-group-get-parameter group 'quit-config t))
3422 (defun gnus-group-quit-config (group)
3423 "Return the quit-config of GROUP."
3424 (gnus-group-get-parameter group 'quit-config t))
3426 (defun gnus-kill-ephemeral-group (group)
3427 "Remove ephemeral GROUP from relevant structures."
3428 (gnus-sethash group nil gnus-newsrc-hashtb))
3430 (defun gnus-simplify-mode-line ()
3431 "Make mode lines a bit simpler."
3432 (setq mode-line-modified "--")
3433 (when (listp mode-line-format)
3434 (make-local-variable 'mode-line-format)
3435 (setq mode-line-format (copy-sequence mode-line-format))
3436 (when (equal (nth 3 mode-line-format) " ")
3437 (setcar (nthcdr 3 mode-line-format) " "))))
3439 ;;; Servers and groups.
3441 (defsubst gnus-server-add-address (method)
3442 (let ((method-name (symbol-name (car method))))
3443 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3444 (not (assq (intern (concat method-name "-address")) method))
3445 (memq 'physical-address (assq (car method)
3446 gnus-valid-select-methods)))
3447 (append method (list (list (intern (concat method-name "-address"))
3448 (nth 1 method))))
3449 method)))
3451 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3452 (catch 'server-name
3453 (setq method (or method gnus-select-method))
3455 ;; Perhaps it is already in the cache.
3456 (unless nocache
3457 (mapc (lambda (name-method)
3458 (if (equal (cdr name-method) method)
3459 (throw 'server-name (car name-method))))
3460 gnus-server-method-cache))
3462 (mapc
3463 (lambda (server-alist)
3464 (mapc (lambda (name-method)
3465 (when (gnus-methods-equal-p (cdr name-method) method)
3466 (unless (member name-method gnus-server-method-cache)
3467 (push name-method gnus-server-method-cache))
3468 (throw 'server-name (car name-method))))
3469 server-alist))
3470 (list gnus-server-alist
3471 gnus-predefined-server-alist))
3473 (let* ((name (if (member (cadr method) '(nil ""))
3474 (format "%s" (car method))
3475 (format "%s:%s" (car method) (cadr method))))
3476 (name-method (cons name method)))
3477 (when (and (not (member name-method gnus-server-method-cache))
3478 (not no-enter-cache)
3479 (not (assoc (car name-method) gnus-server-method-cache)))
3480 (push name-method gnus-server-method-cache))
3481 name)))
3483 (defsubst gnus-server-to-method (server)
3484 "Map virtual server names to select methods."
3485 (or (and server (listp server) server)
3486 (cdr (assoc server gnus-server-method-cache))
3487 (let ((result
3488 (or
3489 ;; Perhaps this is the native server?
3490 (and (equal server "native") gnus-select-method)
3491 ;; It should be in the server alist.
3492 (cdr (assoc server gnus-server-alist))
3493 ;; It could be in the predefined server alist.
3494 (cdr (assoc server gnus-predefined-server-alist))
3495 ;; If not, we look through all the opened server
3496 ;; to see whether we can find it there.
3497 (let ((opened gnus-opened-servers))
3498 (while (and opened
3499 (not (equal server (format "%s:%s" (caaar opened)
3500 (cadaar opened)))))
3501 (pop opened))
3502 (caar opened))
3503 ;; It could be a named method, search all servers
3504 (let ((servers gnus-secondary-select-methods))
3505 (while (and servers
3506 (not (equal server (format "%s:%s" (caar servers)
3507 (cadar servers)))))
3508 (pop servers))
3509 (car servers))
3510 ;; This could be some sort of foreign server that I
3511 ;; simply haven't opened (yet). Do a brute-force scan
3512 ;; of the entire gnus-newsrc-alist for the server name
3513 ;; of every method. As a side-effect, loads the
3514 ;; gnus-server-method-cache so this only happens once,
3515 ;; if at all.
3516 (let ((alist (cdr gnus-newsrc-alist))
3517 method match)
3518 (while alist
3519 (setq method (gnus-info-method (pop alist)))
3520 (when (and (not (stringp method))
3521 (equal server
3522 (gnus-method-to-server method nil t)))
3523 (setq match method
3524 alist nil)))
3525 match))))
3526 (when (and result
3527 (not (assoc server gnus-server-method-cache)))
3528 (push (cons server result) gnus-server-method-cache))
3529 result)))
3531 (defsubst gnus-server-get-method (group method)
3532 ;; Input either a server name, and extended server name, or a
3533 ;; select method, and return a select method.
3534 (cond ((stringp method)
3535 (gnus-server-to-method method))
3536 ((equal method gnus-select-method)
3537 gnus-select-method)
3538 ((and (stringp (car method))
3539 group)
3540 (gnus-server-extend-method group method))
3541 ((and method
3542 (not group)
3543 (equal (cadr method) ""))
3544 method)
3545 (t
3546 (gnus-server-add-address method))))
3548 (defmacro gnus-method-equal (ss1 ss2)
3549 "Say whether two servers are equal."
3550 `(let ((s1 ,ss1)
3551 (s2 ,ss2))
3552 (or (equal s1 s2)
3553 (and (= (length s1) (length s2))
3554 (progn
3555 (while (and s1 (member (car s1) s2))
3556 (setq s1 (cdr s1)))
3557 (null s1))))))
3559 (defun gnus-methods-equal-p (m1 m2)
3560 (let ((m1 (or m1 gnus-select-method))
3561 (m2 (or m2 gnus-select-method)))
3562 (or (equal m1 m2)
3563 (and (eq (car m1) (car m2))
3564 (or (not (memq 'address (assoc (symbol-name (car m1))
3565 gnus-valid-select-methods)))
3566 (equal (nth 1 m1) (nth 1 m2)))))))
3568 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3569 ;; Check parameters for sloppy equality.
3570 (let ((p1 (copy-sequence (cddr m1)))
3571 (p2 (copy-sequence (cddr m2)))
3572 e1 e2)
3573 (block nil
3574 (while (setq e1 (pop p1))
3575 (unless (setq e2 (assq (car e1) p2))
3576 ;; The parameter doesn't exist in p2.
3577 (return nil))
3578 (setq p2 (delq e2 p2))
3579 (unless (equal e1 e2)
3580 (if (not (and (stringp (cadr e1))
3581 (stringp (cadr e2))))
3582 (return nil)
3583 ;; Special-case string parameter comparison so that we
3584 ;; can uniquify them.
3585 (let ((s1 (cadr e1))
3586 (s2 (cadr e2)))
3587 (when (string-match "/$" s1)
3588 (setq s1 (directory-file-name s1)))
3589 (when (string-match "/$" s2)
3590 (setq s2 (directory-file-name s2)))
3591 (unless (equal s1 s2)
3592 (return nil))))))
3593 ;; If p2 now is empty, they were equal.
3594 (null p2))))
3596 (defun gnus-method-ephemeral-p (method)
3597 (let ((equal nil))
3598 (dolist (ephemeral gnus-ephemeral-servers)
3599 (when (gnus-sloppily-equal-method-parameters method ephemeral)
3600 (setq equal t)))
3601 equal))
3603 (defun gnus-methods-sloppily-equal (m1 m2)
3604 ;; Same method.
3605 (or
3606 (eq m1 m2)
3607 ;; Type and name are equal.
3608 (and
3609 (eq (car m1) (car m2))
3610 (equal (cadr m1) (cadr m2))
3611 (gnus-sloppily-equal-method-parameters m1 m2))))
3613 (defun gnus-server-equal (m1 m2)
3614 "Say whether two methods are equal."
3615 (let ((m1 (cond ((null m1) gnus-select-method)
3616 ((stringp m1) (gnus-server-to-method m1))
3617 (t m1)))
3618 (m2 (cond ((null m2) gnus-select-method)
3619 ((stringp m2) (gnus-server-to-method m2))
3620 (t m2))))
3621 (gnus-method-equal m1 m2)))
3623 (defun gnus-servers-using-backend (backend)
3624 "Return a list of known servers using BACKEND."
3625 (let ((opened gnus-opened-servers)
3626 out)
3627 (while opened
3628 (when (eq backend (caaar opened))
3629 (push (caar opened) out))
3630 (pop opened))
3631 out))
3633 (defun gnus-archive-server-wanted-p ()
3634 "Say whether the user wants to use the archive server."
3635 (cond
3636 ((or (not gnus-message-archive-method)
3637 (not gnus-message-archive-group))
3638 nil)
3639 ((and gnus-message-archive-method gnus-message-archive-group)
3640 t)
3641 (t
3642 (let ((active (cadr (assq 'nnfolder-active-file
3643 gnus-message-archive-method))))
3644 (and active
3645 (file-exists-p active))))))
3647 (defsubst gnus-method-to-server-name (method)
3648 (concat
3649 (format "%s" (car method))
3650 (when (and
3651 (or (assoc (format "%s" (car method))
3652 (gnus-methods-using 'address))
3653 (gnus-server-equal method gnus-message-archive-method))
3654 (nth 1 method)
3655 (not (string= (nth 1 method) "")))
3656 (concat "+" (nth 1 method)))))
3658 (defsubst gnus-method-to-full-server-name (method)
3659 (format "%s+%s" (car method) (nth 1 method)))
3661 (defun gnus-group-prefixed-name (group method &optional full)
3662 "Return the whole name from GROUP and METHOD.
3663 Call with full set to get the fully qualified group name (even if the
3664 server is native)."
3665 (when (stringp method)
3666 (setq method (gnus-server-to-method method)))
3667 (if (or (not method)
3668 (and (not full) (gnus-server-equal method "native"))
3669 ;;;!!! This might not be right. We'll see...
3670 ;(string-match ":" group)
3671 )
3672 group
3673 (concat (gnus-method-to-server-name method) ":" group)))
3675 (defun gnus-group-full-name (group method)
3676 "Return the full name from GROUP and METHOD, even if the method is native."
3677 (gnus-group-prefixed-name group method t))
3679 (defun gnus-group-guess-full-name-from-command-method (group)
3680 "Guess the full name from GROUP, even if the method is native."
3681 (if (gnus-group-prefixed-p group)
3682 group
3683 (gnus-group-full-name group gnus-command-method)))
3685 (defun gnus-group-real-prefix (group)
3686 "Return the prefix of the current group name."
3687 (if (stringp group)
3688 (if (string-match "^[^:]+:" group)
3689 (substring group 0 (match-end 0))
3690 "")
3691 nil))
3693 (defun gnus-group-short-name (group)
3694 "Return the short group name."
3695 (let ((prefix (gnus-group-real-prefix group)))
3696 (if (< 0 (length prefix))
3697 (substring group (length prefix) nil)
3698 group)))
3700 (defun gnus-group-prefixed-p (group)
3701 "Return the prefix of the current group name."
3702 (< 0 (length (gnus-group-real-prefix group))))
3704 (declare-function gnus-group-decoded-name "gnus-group" (string))
3706 (defun gnus-summary-buffer-name (group)
3707 "Return the summary buffer name of GROUP."
3708 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3710 (defun gnus-group-method (group)
3711 "Return the server or method used for selecting GROUP.
3712 You should probably use `gnus-find-method-for-group' instead."
3713 (let ((prefix (gnus-group-real-prefix group)))
3714 (if (equal prefix "")
3715 gnus-select-method
3716 (let ((servers gnus-opened-servers)
3717 (server "")
3718 backend possible found)
3720 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3721 server (substring prefix (match-end 0) (1- (length prefix))))
3722 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3723 (while servers
3724 (when (eq (caaar servers) backend)
3725 (setq possible (caar servers))
3726 (when (equal (cadaar servers) server)
3727 (setq found (caar servers))))
3728 (pop servers))
3729 (or (car (rassoc found gnus-server-alist))
3730 found
3731 (car (rassoc possible gnus-server-alist))
3732 possible
3733 (list backend server))))))
3735 (defsubst gnus-native-method-p (method)
3736 "Return whether METHOD is the native select method."
3737 (gnus-method-equal method gnus-select-method))
3739 (defsubst gnus-secondary-method-p (method)
3740 "Return whether METHOD is a secondary select method."
3741 (let ((methods gnus-secondary-select-methods)
3742 (gmethod (inline (gnus-server-get-method nil method))))
3743 (while (and methods
3744 (not (gnus-method-equal
3745 (inline (gnus-server-get-method nil (car methods)))
3746 gmethod)))
3747 (setq methods (cdr methods)))
3748 methods))
3750 (defun gnus-method-simplify (method)
3751 "Return the shortest uniquely identifying string or method for METHOD."
3752 (cond ((stringp method)
3753 method)
3754 ((gnus-native-method-p method)
3755 nil)
3756 ((gnus-secondary-method-p method)
3757 (format "%s:%s" (nth 0 method) (nth 1 method)))
3758 (t
3759 method)))
3761 (defun gnus-groups-from-server (server)
3762 "Return a list of all groups that are fetched from SERVER."
3763 (let ((alist (cdr gnus-newsrc-alist))
3764 info groups)
3765 (while (setq info (pop alist))
3766 (when (gnus-server-equal (gnus-info-method info) server)
3767 (push (gnus-info-group info) groups)))
3768 (sort groups 'string<)))
3770 (defun gnus-group-foreign-p (group)
3771 "Say whether a group is foreign or not."
3772 (and (not (gnus-group-native-p group))
3773 (not (gnus-group-secondary-p group))))
3775 (defun gnus-group-native-p (group)
3776 "Say whether the group is native or not."
3777 (not (string-match ":" group)))
3779 (defun gnus-group-secondary-p (group)
3780 "Say whether the group is secondary or not."
3781 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3783 (defun gnus-parameters-get-parameter (group)
3784 "Return the group parameters for GROUP from `gnus-parameters'."
3785 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3786 case-fold-search
3787 gnus-parameters-case-fold-search))
3788 params-list)
3789 (dolist (elem gnus-parameters)
3790 (when (string-match (car elem) group)
3791 (setq params-list
3792 (nconc (gnus-expand-group-parameters
3793 (car elem) (cdr elem) group)
3794 params-list))))
3795 params-list))
3797 (defun gnus-expand-group-parameter (match value group)
3798 "Use MATCH to expand VALUE in GROUP."
3799 (let ((start (string-match match group)))
3800 (if start
3801 (let ((matched-string (substring group start (match-end 0))))
3802 ;; Build match groups
3803 (string-match match matched-string)
3804 (replace-match value nil nil matched-string))
3805 group)))
3807 (defun gnus-expand-group-parameters (match parameters group)
3808 "Go through PARAMETERS and expand them according to the match data."
3809 (let (new)
3810 (dolist (elem parameters)
3811 (cond
3812 ((and (stringp (cdr elem))
3814 (push (cons (car elem)
3815 (gnus-expand-group-parameter match (cdr elem) group))
3816 new))
3817 ;; For `sieve' group parameters, perform substitutions for every
3818 ;; string within the match rule. This allows for parameters such
3819 ;; as:
3822 ((eq 'sieve (car elem))
3823 (push (mapcar (lambda (sieve-elem)
3824 (if (and (stringp sieve-elem)
3826 (gnus-expand-group-parameter match sieve-elem
3827 group)
3828 sieve-elem))
3829 (cdr elem))
3830 new))
3831 (t
3832 (push elem new))))
3833 new))
3835 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3836 "For GROUP, return the value of SYMBOL.
3838 You should call this in the `gnus-group-buffer' buffer.
3839 The function `gnus-group-find-parameter' will do that for you."
3840 ;; The speed trick: No cons'ing and quit early.
3841 (let* ((params (funcall gnus-group-get-parameter-function group))
3842 ;; Start easy, check the "real" group parameters.
3843 (simple-results
3844 (gnus-group-parameter-value params symbol allow-list t)))
3845 (if simple-results
3846 ;; Found results; return them.
3847 (car simple-results)
3848 ;; We didn't find it there, try `gnus-parameters'.
3849 (let ((result nil)
3850 (head nil)
3851 (tail gnus-parameters))
3852 ;; A good old-fashioned non-cl loop.
3853 (while tail
3854 (setq head (car tail)
3855 tail (cdr tail))
3856 ;; The car is regexp matching for matching the group name.
3857 (when (string-match (car head) group)
3858 ;; The cdr is the parameters.
3859 (let ((this-result
3860 (gnus-group-parameter-value (cdr head) symbol allow-list t)))
3861 (when this-result
3862 (setq result (car this-result))
3863 ;; Expand if necessary.
3864 (cond
3866 (setq result (gnus-expand-group-parameter
3867 (car head) result group)))
3868 ;; For `sieve' group parameters, perform substitutions
3869 ;; for every string within the match rule (see above).
3870 ((eq symbol 'sieve)
3871 (setq result
3872 (mapcar (lambda (elem)
3873 (if (stringp elem)
3874 (gnus-expand-group-parameter (car head)
3875 elem group)
3876 elem))
3877 result))))))))
3878 ;; Done.
3879 result))))
3881 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3882 "Return the group parameters for GROUP.
3883 If SYMBOL, return the value of that symbol in the group parameters.
3885 If you call this function inside a loop, consider using the faster
3886 `gnus-group-fast-parameter' instead."
3887 (with-current-buffer (if (buffer-live-p (get-buffer gnus-group-buffer))
3888 gnus-group-buffer
3889 (current-buffer))
3890 (if symbol
3891 (gnus-group-fast-parameter group symbol allow-list)
3892 (nconc
3893 (copy-sequence
3894 (funcall gnus-group-get-parameter-function group))
3895 (gnus-parameters-get-parameter group)))))
3897 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3898 "Return the group parameters for GROUP.
3899 If SYMBOL, return the value of that symbol in the group parameters.
3900 If ALLOW-LIST, also allow list as a result.
3901 Most functions should use `gnus-group-find-parameter', which
3902 also examines the topic parameters."
3903 (let ((params (gnus-info-params (gnus-get-info group))))
3904 (if symbol
3905 (gnus-group-parameter-value params symbol allow-list)
3906 params)))
3908 (defun gnus-group-parameter-value (params symbol &optional
3909 allow-list present-p)
3910 "Return the value of SYMBOL in group PARAMS.
3911 If ALLOW-LIST, also allow list as a result."
3912 ;; We only wish to return group parameters (dotted lists) and
3913 ;; not local variables, which may have the same names.
3914 ;; But first we handle single elements...
3915 (or (car (memq symbol params))
3916 ;; Handle alist.
3917 (let (elem)
3918 (catch 'found
3919 (while (setq elem (pop params))
3920 (when (and (consp elem)
3921 (eq (car elem) symbol)
3922 (or allow-list
3923 (atom (cdr elem))))
3924 (throw 'found (if present-p (list (cdr elem))
3925 (cdr elem)))))))))
3927 (defun gnus-group-add-parameter (group param)
3928 "Add parameter PARAM to GROUP."
3929 (let ((info (gnus-get-info group)))
3930 (when info
3931 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3932 ;; Cons the new param to the old one and update.
3933 (gnus-group-set-info (cons param (gnus-info-params info))
3934 group 'params))))
3936 (defun gnus-group-set-parameter (group name value)
3937 "Set parameter NAME to VALUE in GROUP.
3938 GROUP can also be an INFO structure."
3939 (let ((info (if (listp group)
3940 group
3941 (gnus-get-info group))))
3942 (when info
3943 (gnus-group-remove-parameter group name)
3944 (let ((old-params (gnus-info-params info))
3945 (new-params (list (cons name value))))
3946 (while old-params
3947 (when (or (not (listp (car old-params)))
3948 (not (eq (caar old-params) name)))
3949 (setq new-params (append new-params (list (car old-params)))))
3950 (setq old-params (cdr old-params)))
3951 (if (listp group)
3952 (gnus-info-set-params info new-params t)
3953 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3955 (defun gnus-group-remove-parameter (group name)
3956 "Remove parameter NAME from GROUP.
3957 GROUP can also be an INFO structure."
3958 (let ((info (if (listp group)
3959 group
3960 (gnus-get-info group))))
3961 (when info
3962 (let ((params (gnus-info-params info)))
3963 (when params
3964 (setq params (delq name params))
3965 (while (assq name params)
3966 (gnus-alist-pull name params))
3967 (gnus-info-set-params info params))))))
3969 (defun gnus-group-add-score (group &optional score)
3970 "Add SCORE to the GROUP score.
3971 If SCORE is nil, add 1 to the score of GROUP."
3972 (let ((info (gnus-get-info group)))
3973 (when info
3974 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3976 (defun gnus-short-group-name (group &optional levels)
3977 "Collapse GROUP name LEVELS.
3978 Select methods are stripped and any remote host name is stripped down to
3979 just the host name."
3980 (let* ((name "")
3981 (foreign "")
3982 (depth 0)
3983 (skip 1)
3984 (levels (or levels
3985 gnus-group-uncollapsed-levels
3986 (progn
3988 (setq skip (match-end 0)
3989 depth (+ depth 1)))
3990 depth))))
3991 ;; Separate foreign select method from group name and collapse.
3992 ;; If method contains a server, collapse to non-domain server name,
3993 ;; otherwise collapse to select method.
3994 (let* ((colon (string-match ":" group))
3995 (server (and colon (substring group 0 colon)))
3996 (plus (and server (string-match "+" server))))
3997 (when server
3998 (if plus
3999 (setq foreign (substring server (+ 1 plus)
4001 group (substring group (+ 1 colon)))
4002 (setq foreign server
4003 group (substring group (+ 1 colon))))
4004 (setq foreign (concat foreign ":")))
4005 ;; Collapse group name leaving LEVELS uncollapsed elements
4006 (let* ((slist (split-string group "/"))
4007 (slen (length slist))
4009 (dlen (length dlist))
4010 glist
4011 glen
4012 gsep
4013 res)
4014 (if (> slen dlen)
4015 (setq glist slist
4016 glen slen
4017 gsep "/")
4018 (setq glist dlist
4019 glen dlen
4020 gsep "."))
4021 (setq levels (- glen levels))
4022 (dolist (g glist)
4023 (push (if (>= (decf levels) 0)
4024 (if (zerop (length g))
4025 ""
4026 (substring g 0 1))
4027 g)
4028 res))
4029 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4031 (defun gnus-narrow-to-body ()
4032 "Narrow to the body of an article."
4033 (narrow-to-region
4034 (progn
4035 (goto-char (point-min))
4037 (point-max)))
4038 (point-max)))
4040 \f
4041 ;;;
4042 ;;; Kill file handling.
4043 ;;;
4045 (defun gnus-apply-kill-file ()
4046 "Apply a kill file to the current newsgroup.
4047 Returns the number of articles marked as read."
4048 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4049 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4050 (gnus-apply-kill-file-internal)
4051 0))
4053 (defun gnus-kill-save-kill-buffer ()
4054 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4055 (when (get-file-buffer file)
4056 (with-current-buffer (get-file-buffer file)
4057 (when (buffer-modified-p)
4058 (save-buffer))
4059 (kill-buffer (current-buffer))))))
4061 (defcustom gnus-kill-file-name "KILL"
4062 "Suffix of the kill files."
4063 :group 'gnus-score-kill
4064 :group 'gnus-score-files
4065 :type 'string)
4067 (defun gnus-newsgroup-kill-file (newsgroup)
4068 "Return the name of a kill file name for NEWSGROUP.
4069 If NEWSGROUP is nil, return the global kill file name instead."
4070 (cond
4071 ;; The global KILL file is placed at top of the directory.
4072 ((or (null newsgroup)
4073 (string-equal newsgroup ""))
4074 (expand-file-name gnus-kill-file-name
4075 gnus-kill-files-directory))
4076 ;; Append ".KILL" to newsgroup name.
4077 ((gnus-use-long-file-name 'not-kill)
4078 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4079 "." gnus-kill-file-name)
4080 gnus-kill-files-directory))
4081 ;; Place "KILL" under the hierarchical directory.
4082 (t
4083 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4084 "/" gnus-kill-file-name)
4085 gnus-kill-files-directory))))
4087 ;;; Server things.
4089 (defun gnus-member-of-valid (symbol group)
4091 (memq symbol (assoc
4092 (symbol-name (car (gnus-find-method-for-group group)))
4093 gnus-valid-select-methods)))
4095 (defun gnus-method-option-p (method option)
4096 "Return non-nil if select METHOD has OPTION as a parameter."
4097 (when (stringp method)
4098 (setq method (gnus-server-to-method method)))
4099 (memq option (assoc (format "%s" (car method))
4100 gnus-valid-select-methods)))
4102 (defun gnus-similar-server-opened (method)
4103 "Return non-nil if we have a similar server opened.
4104 This is defined as a server with the same name, but different
4105 parameters."
4106 (let ((opened gnus-opened-servers)
4107 open)
4108 (while (and method opened)
4109 (setq open (car (pop opened)))
4110 ;; Type and name are the same...
4111 (when (and (equal (car method) (car open))
4112 (equal (cadr method) (cadr open))
4113 ;; ... but the rest of the parameters differ.
4114 (not (gnus-methods-sloppily-equal method open)))
4115 (setq method nil)))
4116 (not method)))
4118 (defun gnus-server-extend-method (group method)
4119 ;; This function "extends" a virtual server. If the server is
4120 ;; "hello", and the select method is ("hello" (my-var "something"))
4121 ;; in the group "alt.alt", this will result in a new virtual server
4122 ;; called "hello+alt.alt".
4123 (if (or (not (inline (gnus-similar-server-opened method)))
4124 (not (cddr method)))
4125 method
4126 (let ((address-slot
4127 (intern (format "%s-address" (car method)))))
4128 (setq method
4129 (if (assq address-slot (cddr method))
4130 `(,(car method) ,(concat (cadr method) "+" group)
4131 ,@(cddr method))
4132 `(,(car method) ,(concat (cadr method) "+" group)
4133 (,address-slot ,(cadr method))
4134 ,@(cddr method))))
4135 (push method gnus-extended-servers)
4136 method)))
4138 (defun gnus-server-status (method)
4139 "Return the status of METHOD."
4140 (nth 1 (assoc method gnus-opened-servers)))
4142 (defun gnus-group-name-to-method (group)
4143 "Guess a select method based on GROUP."
4144 (if (string-match ":" group)
4145 (let ((server (substring group 0 (match-beginning 0))))
4147 (list (intern (substring server 0 (match-beginning 0)))
4148 (substring server (match-end 0)))
4149 (list (intern server) "")))
4150 gnus-select-method))
4152 (defun gnus-server-string (server)
4153 "Return a readable string that describes SERVER."
4154 (let* ((server (gnus-server-to-method server))
4155 (address (nth 1 server)))
4156 (if (and address
4157 (not (zerop (length address))))
4158 (format "%s using %s" address (car server))
4159 (format "%s" (car server)))))
4161 (defun gnus-same-method-different-name (method)
4162 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4163 (unless (assq slot (cddr method))
4164 (setq method
4165 (append method (list (list slot (nth 1 method)))))))
4166 (let ((methods gnus-extended-servers)
4167 open found)
4168 (while (and (not found)
4169 (setq open (pop methods)))
4170 (when (and (eq (car method) (car open))
4171 (gnus-sloppily-equal-method-parameters method open))
4172 (setq found open)))
4173 found))
4175 (defun gnus-find-method-for-group (group &optional info)
4176 "Find the select method that GROUP uses."
4177 (or gnus-override-method
4178 (and (not group)
4179 gnus-select-method)
4180 (and (not (gnus-group-entry group))
4181 ;; Killed or otherwise unknown group.
4182 (or
4183 ;; If we know a virtual server by that name, return its method.
4184 (gnus-server-to-method (gnus-group-server group))
4185 ;; Guess a new method as last resort.
4186 (gnus-group-name-to-method group)))
4187 (let ((info (or info (gnus-get-info group)))
4188 method)
4189 (if (or (not info)
4190 (not (setq method (gnus-info-method info)))
4191 (equal method "native"))
4192 gnus-select-method
4193 (setq method
4194 (cond ((stringp method)
4195 (inline (gnus-server-to-method method)))
4196 ((stringp (cadr method))
4197 (or
4198 (inline
4199 (gnus-same-method-different-name method))
4200 (inline (gnus-server-extend-method group method))))
4201 (t
4202 method)))
4203 (cond ((equal (cadr method) "")
4204 method)
4205 ((null (cadr method))
4206 (list (car method) ""))
4207 (t
4208 (gnus-server-add-address method)))))))
4210 (defun gnus-methods-using (feature)
4211 "Find all methods that have FEATURE."
4212 (let ((valids gnus-valid-select-methods)
4213 outs)
4214 (while valids
4215 (when (memq feature (car valids))
4216 (push (car valids) outs))
4217 (setq valids (cdr valids)))
4218 outs))
4220 (autoload 'message-y-or-n-p "message" nil nil 'macro)
4222 (defun gnus-read-group (prompt &optional default)
4223 "Prompt the user for a group name.
4224 Disallow invalid group names."
4225 (let ((prefix "")
4226 group)
4227 (while (not group)
4228 (when (string-match
4229 gnus-invalid-group-regexp
4230 (setq group (read-string (concat prefix prompt)
4231 (cons (or default "") 0)
4232 'gnus-group-history)))
4233 (let ((match (match-string 0 group)))
4234 ;; Might be okay (e.g. for nnimap), so ask the user:
4236 (message-y-or-n-p
4237 "Proceed and create group anyway? " t
4240 Usually, it's dangerous to create a group with this name, because it's not
4241 supported by all back ends and servers. On IMAP servers it should work,
4242 though. If you are really sure, you can proceed anyway and create the group.
4244 You may customize the variable `gnus-invalid-group-regexp', which currently is
4248 group nil)))))
4249 group))
4251 (defun gnus-read-method (prompt)
4252 "Prompt the user for a method.
4253 Allow completion over sensible values."
4254 (let* ((open-servers
4255 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4256 gnus-opened-servers))
4257 (valid-methods
4258 (let (methods)
4259 (dolist (method gnus-valid-select-methods)
4260 (if (or (memq 'prompt-address method)
4261 (not (assoc (format "%s:" (car method)) open-servers)))
4262 (push method methods)))
4263 methods))
4264 (servers
4265 (append valid-methods
4266 open-servers
4267 gnus-predefined-server-alist
4268 gnus-server-alist))
4269 (method
4270 (gnus-completing-read
4271 prompt (mapcar 'car servers)
4272 t nil 'gnus-method-history)))
4273 (cond
4274 ((equal method "")
4275 (setq method gnus-select-method))
4276 ((assoc method gnus-valid-select-methods)
4277 (let ((address (if (memq 'prompt-address
4278 (assoc method gnus-valid-select-methods))
4279 (read-string "Address: ")
4280 "")))
4281 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4282 (list (intern method) address))))
4283 ((assoc method servers)
4284 method)
4285 (t
4286 (list (intern method) "")))))
4288 ;;; Agent functions
4290 (defun gnus-agent-method-p (method-or-server)
4291 "Say whether METHOD is covered by the agent."
4292 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4293 (let* ((method (if (stringp method-or-server)
4294 (gnus-server-to-method method-or-server)
4295 method-or-server))
4296 (server (gnus-method-to-server method t)))
4297 (setq gnus-agent-method-p-cache
4298 (cons method-or-server
4299 (member server gnus-agent-covered-methods)))))
4300 (cdr gnus-agent-method-p-cache))
4302 (defun gnus-online (method)
4303 (not
4304 (if gnus-plugged
4305 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4306 (gnus-agent-method-p method))))
4308 ;;; User-level commands.
4310 ;;;###autoload
4311 (defun gnus-slave-no-server (&optional arg)
4312 "Read network news as a slave, without connecting to the local server."
4313 (interactive "P")
4314 (gnus-no-server arg t))
4316 ;;;###autoload
4317 (defun gnus-no-server (&optional arg slave)
4318 "Read network news.
4319 If ARG is a positive number, Gnus will use that as the startup
4320 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4321 non-nil and not a positive number, Gnus will prompt the user for the
4322 name of an NNTP server to use.
4323 As opposed to `gnus', this command will not connect to the local
4324 server."
4325 (interactive "P")
4326 (gnus-no-server-1 arg slave))
4328 ;;;###autoload
4329 (defun gnus-slave (&optional arg)
4330 "Read news as a slave."
4331 (interactive "P")
4332 (gnus arg nil 'slave))
4334 (defun gnus-delete-gnus-frame ()
4335 "Delete gnus frame unless it is the only one.
4336 Used for `gnus-exit-gnus-hook' in `gnus-other-frame'."
4337 (when (and (frame-live-p gnus-other-frame-object)
4338 (cdr (frame-list)))
4339 (delete-frame gnus-other-frame-object))
4340 (setq gnus-other-frame-object nil))
4342 ;;;###autoload
4343 (defun gnus-other-frame (&optional arg display)
4344 "Pop up a frame to read news.
4345 This will call one of the Gnus commands which is specified by the user
4346 option `gnus-other-frame-function' (default `gnus') with the argument
4347 ARG if Gnus is not running, otherwise pop up a Gnus frame and run the
4348 command specified by `gnus-other-frame-resume-function'.
4349 The optional second argument DISPLAY should be a standard display string
4351 omitted or the function `make-frame-on-display' is not available, the
4352 current display is used."
4353 (interactive "P")
4354 (if (fboundp 'make-frame-on-display)
4355 (unless display
4356 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4357 (setq display nil))
4358 (let ((alive (gnus-alive-p)))
4359 (unless (and alive
4360 (catch 'found
4361 (walk-windows
4362 (lambda (window)
4363 (when (and (or (not display)
4364 (equal display
4365 (gnus-frame-or-window-display-name
4366 window)))
4367 (with-current-buffer (window-buffer window)
4369 (symbol-name major-mode))))
4370 (select-frame-set-input-focus
4371 (setq gnus-other-frame-object (window-frame window)))
4372 (select-window window)
4373 (throw 'found t)))
4374 'ignore t)))
4375 (select-frame-set-input-focus
4376 (setq gnus-other-frame-object
4377 (if display
4378 (make-frame-on-display display gnus-other-frame-parameters)
4379 (make-frame gnus-other-frame-parameters))))
4380 (if alive
4381 (progn (switch-to-buffer gnus-group-buffer)
4382 (funcall gnus-other-frame-resume-function arg))
4383 (funcall gnus-other-frame-function arg)
4384 (add-hook 'gnus-exit-gnus-hook 'gnus-delete-gnus-frame)
4385 ;; One might argue that `gnus-delete-gnus-frame' should not be called
4386 ;; from `gnus-suspend-gnus-hook', but, on the other hand, one might
4387 ;; argue that it should. No matter what you think, for the sake of
4388 ;; those who want it to be called from it, please keep (defun
4389 ;; gnus-delete-gnus-frame) even if you remove the next `add-hook'.
4390 (add-hook 'gnus-suspend-gnus-hook 'gnus-delete-gnus-frame)))))
4392 ;;;###autoload
4393 (defun gnus (&optional arg dont-connect slave)
4394 "Read network news.
4395 If ARG is non-nil and a positive number, Gnus will use that as the
4396 startup level. If ARG is non-nil and not a positive number, Gnus will
4397 prompt the user for the name of an NNTP server to use."
4398 (interactive "P")
4399 ;; When using the development version of Gnus, load the gnus-load
4400 ;; file.
4401 (unless (string-match "^Gnus" gnus-version)
4402 (load "gnus-load" nil t))
4403 (unless (byte-code-function-p (symbol-function 'gnus))
4404 (message "You should byte-compile Gnus")
4405 (sit-for 2))
4406 (let ((gnus-action-message-log (list nil)))
4407 (gnus-1 arg dont-connect slave)
4408 (gnus-final-warning)))
4410 (declare-function debbugs-gnu "ext:debbugs-gnu"
4411 (severities &optional packages archivedp suppress tags))
4413 (defun gnus-list-debbugs ()
4414 "List all open Gnus bug reports."
4415 (interactive)
4416 (require 'debbugs-gnu)
4417 (debbugs-gnu nil "gnus"))
4419 (provide 'gnus)
4421 ;;; gnus.el ends here