| blob | 663a417c283bfb6e258e97f346a9173030720718 |
1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;;; Code:
38 ;; These are defined afterwards with gnus-define-group-parameter
50 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
55 "Starting your favorite newsreader."
59 "Dealing with formatting issues."
63 "Group character set issues."
69 "Cache interface."
74 "Article Registry."
78 "Server options at startup."
81 ;; These belong to gnus-group.el.
83 "Group buffers."
88 "Foreign groups."
93 "Automatic subscription of new groups."
97 "Group levels."
102 "Selecting a Group."
107 "Showing slices of the group list."
112 "Sorting the group buffer."
118 "Various group options."
122 ;; These belong to gnus-sum.el.
124 "Summary buffers."
129 "Leaving summary buffers."
134 "Marks used in summary buffers."
139 "Ordering articles according to replies."
144 "Formatting of the summary buffer."
149 "Choosing Articles."
154 "Summary movement commands."
159 "Show pictures of people, domains, and newsgroups."
163 "Mail group commands."
168 "Sorting the summary buffer."
173 "Highlighting and menus in the summary buffer."
179 "Various summary buffer options."
184 "Pick mode in the summary buffer."
190 "Tree display of threads in the summary buffer."
195 ;; Belongs to gnus-uu.el
197 "Viewing extracted files."
201 ;; Belongs to gnus-score.el
203 "Score and kill file handling."
207 "Kill files."
211 "Adaptive score files."
215 "Default values for score files."
219 "Expiring score rules."
223 "Decaying score rules."
227 "Score and kill file names."
232 "Various scoring and killing options."
235 ;; Other
237 "Options controlling the visual fluff."
242 "Offline support for Gnus."
246 "Files used by Gnus."
250 "Auto save file."
255 "Storing Gnus state."
259 "Options related to newsservers and other servers used by Gnus."
263 "Highlighting and menus in the server buffer."
268 "Composing replies and followups in Gnus."
272 "Meta variables controlling major portions of Gnus.
273 In general, modifying these variables does not take affect until Gnus
274 is restarted, and sometimes reloaded."
278 "Other Gnus options."
283 "Exiting Gnus."
288 "Frivolous Gnus extensions."
299 "If non-nil, the startup message will not be displayed.
300 This variable is used before `.gnus.el' is loaded, so it should
301 be set in `.emacs' instead."
306 "If non-nil, play the Gnus jingle at startup."
340 0 5
349 gnus-mode-line-image-cache)
351 "This is %s, %s."
353 str)
355 line)))
361 ;;(defalias 'gnus-decode-rfc1522 'ignore)
362 )
364 ;; We define these group faces here to avoid the display
365 ;; update forced when creating new faces.
375 ()))
376 "Level 1 newsgroup face."
378 ;; backward-compatibility alias
389 ()))
390 "Level 1 empty newsgroup face."
392 ;; backward-compatibility alias
403 ()))
404 "Level 2 newsgroup face."
406 ;; backward-compatibility alias
417 ()))
418 "Level 2 empty newsgroup face."
420 ;; backward-compatibility alias
431 ()))
432 "Level 3 newsgroup face."
434 ;; backward-compatibility alias
440 ())
443 ())
445 ()))
446 "Level 3 empty newsgroup face."
448 ;; backward-compatibility alias
459 ()))
460 "Level 4 newsgroup face."
462 ;; backward-compatibility alias
468 ())
471 ())
473 ()))
474 "Level 4 empty newsgroup face."
476 ;; backward-compatibility alias
487 ()))
488 "Level 5 newsgroup face."
490 ;; backward-compatibility alias
496 ())
499 ())
501 ()))
502 "Level 5 empty newsgroup face."
504 ;; backward-compatibility alias
515 ()))
516 "Level 6 newsgroup face."
518 ;; backward-compatibility alias
524 ())
527 ())
529 ()))
530 "Level 6 empty newsgroup face."
532 ;; backward-compatibility alias
543 ()))
544 "Low level newsgroup face."
546 ;; backward-compatibility alias
557 ()))
558 "Low level empty newsgroup face."
560 ;; backward-compatibility alias
572 "Level 1 mailgroup face."
574 ;; backward-compatibility alias
586 "Level 1 empty mailgroup face."
588 ;; backward-compatibility alias
600 "Level 2 mailgroup face."
602 ;; backward-compatibility alias
614 "Level 2 empty mailgroup face."
616 ;; backward-compatibility alias
628 "Level 3 mailgroup face."
630 ;; backward-compatibility alias
641 ()))
642 "Level 3 empty mailgroup face."
644 ;; backward-compatibility alias
656 "Low level mailgroup face."
658 ;; backward-compatibility alias
670 "Low level empty mailgroup face."
672 ;; backward-compatibility alias
675 ;; Summary mode faces.
678 "Face used for selected articles."
680 ;; backward-compatibility alias
686 "Face used for cancelled articles."
688 ;; backward-compatibility alias
700 "Face used for high interest ticked articles."
702 ;; backward-compatibility alias
714 "Face used for low interest ticked articles."
716 ;; backward-compatibility alias
727 ()))
728 "Face used for normal interest ticked articles."
730 ;; backward-compatibility alias
742 "Face used for high interest ancient articles."
744 ;; backward-compatibility alias
756 "Face used for low interest ancient articles."
758 ;; backward-compatibility alias
769 ()))
770 "Face used for normal interest ancient articles."
772 ;; backward-compatibility alias
782 "Face used for high interest uncached articles."
784 ;; backward-compatibility alias
794 "Face used for low interest uncached articles."
796 ;; backward-compatibility alias
806 "Face used for normal interest uncached articles."
808 ;; backward-compatibility alias
814 "Face used for high interest unread articles."
816 ;; backward-compatibility alias
822 "Face used for low interest unread articles."
824 ;; backward-compatibility alias
829 ()))
830 "Face used for normal interest unread articles."
832 ;; backward-compatibility alias
846 "Face used for high interest read articles."
848 ;; backward-compatibility alias
862 "Face used for low interest read articles."
864 ;; backward-compatibility alias
875 ()))
876 "Face used for normal interest read articles."
878 ;; backward-compatibility alias
882 ;;;
883 ;;; Gnus buffers
884 ;;;
889 "Do the same as `get-buffer-create', but store the created buffer."
894 "Add the current buffer to the list of Gnus buffers."
898 "Kill BUFFER and remove from the list of Gnus buffers."
905 "Return a list of live Gnus buffers."
914 gnus-buffers)
916 ;;; Splash screen.
931 ()))
932 "Face for the splash screen."
934 ;; backward-compatibility alias
949 "Indent rigidly using only spaces and no tabs."
955 ;; We translate tabs into spaces -- not everybody uses
956 ;; an 8-character tab.
963 ;;(format "%02x%02x%02x" 114 66 20) "724214"
987 "*Color styles used for the Gnus logo."
989 gnus-logo-color-alist))
997 "Insert startup message in current buffer."
998 ;; Insert the message.
1012 :color-symbols
1018 ;; Account for the pbm's blackground.
1022 ;; Account for the xbm's blackground.
1033 t))))
1037 _ ___ _ _
1038 _ ___ __ ___ __ _ ___
1039 __ _ ___ __ ___
1040 _ ___ _
1041 _ _ __ _
1042 ___ __ _
1043 __ _
1044 _ _ _
1045 _ _ _
1046 _ _ _
1047 __ ___
1048 _ _ _ _
1049 _ _
1050 _ _
1051 _ _
1052 _
1053 __
1055 "
1057 ;; And then hack it.
1066 ;; Fontify some.
1080 ;;; Do the rest.
1086 "Alist of group parameters.
1088 For example:
1090 (gnus-use-scoring nil)
1091 (gnus-summary-line-format
1093 (gcc-self . t)
1094 (display . all))
1097 (broken-reply-to . t)))"
1104 "If it is t, ignore case of group names specified in `gnus-parameters'.
1105 If it is nil, don't ignore case. If it is `default', which is for the
1106 backward compatibility, use the value of `case-fold-search'."
1117 "Define a group parameter PARAM.
1118 REST is a plist of following:
1119 :type One of `bool', `list' or nil.
1120 :function The name of the function.
1121 :function-document The documentation of the function.
1122 :parameter-type The type for customizing the parameter.
1123 :parameter-document The documentation for the parameter.
1124 :variable The name of the variable.
1125 :variable-document The documentation for the variable.
1126 :variable-group The group for customizing the variable.
1127 :variable-type The type for customizing the variable.
1128 :variable-default The default value of the variable."
1145 'progn
1147 ,variable-document
1153 gnus-group-parameters-more))
1156 ,parameter-type
1160 ,function-document
1162 val)
1165 t)
1170 (,variable
1172 elem value)
1180 ,function-document
1184 elem value)
1191 'value
1196 All other Gnus file and directory variables are initialized from this variable."
1202 "*Directory variable from which all other Gnus file variables are derived.
1204 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1205 This means that other directory variables that are initialized from
1206 this variable won't be set properly if you set this variable in `.gnus.el'.
1207 Set this variable in `.emacs' instead."
1212 "*Default directory for all Gnus buffers."
1215 directory))
1217 ;; Site dependent variables. These variables should be defined in
1218 ;; paths.el.
1221 "Specify a default NNTP server.
1222 This variable should be defined in paths.el, and should never be set
1223 by the user.
1224 If you want to change servers, you should use `gnus-select-method'.
1227 ;; Don't touch this variable.
1230 This is an obsolete variable, which is scarcely used. If you use an
1231 nntp server for your newsgroup and want to change the port number
1232 used to 899, you would say something along these lines:
1237 "A file with only the name of the nntp server in it."
1243 "Find default nntp server.
1244 Check the NNTPSERVER environment variable and the
1245 `gnus-nntpserver-file' file."
1253 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1254 ;; starting or even loading Gnus.
1255 ;;;###autoload(when (fboundp 'custom-autoload)
1256 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1266 gnus-default-nntp-server)
1270 nil
1273 "Default method for selecting a newsgroup.
1274 This variable should be a list, where the first element is how the
1275 news is to be fetched, the second is the address.
1278 NNTP, you could say:
1282 If you want to use your local spool, say:
1284 \(setq gnus-select-method (list 'nnspool (system-name)))
1286 If you use this variable, you must set `gnus-nntp-server' to nil.
1288 There is a lot more to know about select methods and virtual servers -
1289 see the manual for details."
1296 "*Method used for archiving messages you've sent.
1297 This should be a mail method."
1301 gnus-select-method))
1304 "*Name of the group in which to save the messages you've written.
1305 This can either be a string; a list of strings; or an alist
1306 of regexps/functions/forms to be evaluated to return a string (or a list
1307 of strings). The functions are called with the name of the current
1308 group (or nil) as a parameter.
1310 If you want to save your mail in one group and the news articles you
1311 write in another group, you could say something like:
1313 \(setq gnus-message-archive-group
1314 '((if (message-news-p)
1318 Normally the group names returned by this variable should be
1320 However, you may wish to store the message on some other server. In
1321 that case, just return a fully prefixed name of the group --
1325 function
1326 sexp
1327 string))
1330 "List of NNTP servers that the user can choose between interactively.
1331 To make Gnus query you for a server, you have to give `gnus' a
1332 non-numeric prefix - `C-u M-x gnus', in short."
1337 "*The name of the host running the NNTP server.
1338 This variable is semi-obsolete. Use the `gnus-select-method'
1339 variable instead."
1342 string))
1345 "A list of secondary methods that will be used for reading news.
1346 This is a list where each element is a complete select method (see
1347 `gnus-select-method').
1349 If, for instance, you want to read your mail with the nnml back end,
1350 you could set this variable:
1358 "Default default new newsgroups the first time Gnus is run.
1362 "Local domain name without a host name.
1363 The DOMAINNAME environment variable is used instead if it is defined.
1364 If the function `system-name' returns the full Internet name, there is
1365 no need to set this variable."
1368 string))
1371 "String with a description of what organization (if any) the user belongs to.
1374 ;; Customization variables
1377 "Preferred method for fetching an article by Message-ID.
1378 If you are reading news from the local spool (with nnspool), fetching
1379 articles by Message-ID is painfully slow. By setting this method to an
1380 nntp method, you might get acceptable results.
1382 The value of this variable must be a valid select method as discussed
1383 in the documentation of `gnus-select-method'.
1385 It can also be a list of select methods, as well as the special symbol
1386 `current', which means to use the current select method. If it is a
1387 list, Gnus will try all the methods in the list until it finds a match."
1392 gnus-select-method
1400 gnus-select-method))))
1404 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1405 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1406 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1407 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1408 "/ftp@rtfm.mit.edu:/pub/usenet/"
1409 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1410 "/ftp@ftp.sunet.se:/pub/usenet/"
1411 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1412 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1414 "*Directory where the group FAQs are stored.
1415 This will most commonly be on a remote machine, and the file will be
1416 fetched by ange-ftp.
1418 This variable can also be a list of directories. In that case, the
1419 first element in the list will be used by default. The others can
1420 be used when being prompted for a site.
1422 Note that Gnus uses an aol machine as the default directory. If this
1423 feels fundamentally unclean, just think of it as a way to finally get
1424 something of value back from them.
1426 If the default site is too slow, try one of these:
1428 North America: mirrors.aol.com /pub/rtfm/usenet
1429 ftp.seas.gwu.edu /pub/rtfm
1430 rtfm.mit.edu /pub/usenet
1431 Europe: ftp.uni-paderborn.de /pub/FAQ
1432 src.doc.ic.ac.uk /usenet/news-FAQS
1433 ftp.sunet.se /pub/usenet
1434 ftp.pasteur.fr /pub/FAQ
1435 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1436 hwarang.postech.ac.kr /pub/usenet
1437 ftp.hk.super.net /mirror/faqs"
1464 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1465 When FORM is evaluated `name' is bound to the name of the group."
1472 "*Non-nil means that control messages are displayed using `browse-url'.
1473 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1474 group."
1480 "*Non-nil means that cross referenced articles will be marked as read.
1481 If nil, ignore cross references. If t, mark articles as read in
1482 subscribed newsgroups. If neither t nor nil, mark as read in all
1483 newsgroups."
1491 "*Process mark."
1497 "*The number of articles which indicates a large newsgroup.
1498 If the number of articles in a newsgroup is greater than this value,
1499 confirmation is required for selecting the newsgroup.
1500 If it is nil, no confirmation is required."
1503 integer))
1506 "*Non-nil means that the default name of a file to save articles in is the group name.
1507 If it's nil, the directory form of the group name is used instead.
1509 If this variable is a list, and the list contains the element
1510 `not-score', long file names will not be used for score files; if it
1511 contains the element `not-save', long file names will not be used for
1512 saving; and if it contains the element `not-kill', long file names
1513 will not be used for kill files.
1515 Note that the default for this variable varies according to what system
1516 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1517 to nil while on all other systems it defaults to t."
1535 "*If non-nil, save group scoring info."
1541 "*If non-nil, allow undoing in Gnus group mode buffers."
1546 "*If non-nil, use some adaptive scoring scheme.
1547 If a list, then the values `word' and `line' are meaningful. The
1548 former will perform adaption on individual words in the subject
1549 header while `line' will perform adaption on several headers."
1555 "*If nil, Gnus will ignore the article cache.
1556 If `passive', it will allow entering (and reading) articles
1557 explicitly entered into the cache. If anything else, use the
1558 cache to the full extent of the law."
1566 "*If non-nil, display a thread tree buffer."
1571 "*If non-nil, use GroupLens ratings."
1576 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1577 If it is a number N, then Gnus will only keep the last N articles
1578 read. If it is neither nil nor a number, Gnus will keep all read
1579 articles. This is not a good idea."
1582 integer
1587 "*If non-nil, Gnus will read NoCeM cancel messages.
1588 You can also set this variable to a positive number as a group level.
1589 In that case, Gnus scans NoCeM messages when checking new news if this
1590 value is not exceeding a group level that you specify as the prefix
1591 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1592 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1593 level to those commands."
1602 gnus-level-default-subscribed
1606 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1611 "*If non-nil, enable scoring."
1617 "*A hook called when preparing to exit from the summary buffer.
1618 It calls `gnus-summary-expire-articles' by default."
1623 "*Non-nil means that you are a Usenet novice.
1624 If non-nil, verbose messages may be displayed and confirmations may be
1625 required."
1630 "*Non-nil means that you will never be asked for confirmation about anything.
1631 That doesn't mean *anything* anything; particularly destructive
1632 commands will still require prompting."
1637 "*If non-nil, require your confirmation when catching up a group."
1642 "*If non-nil, require your confirmation when exiting Gnus."
1647 "*Function for extracting address components from a From header.
1648 Two pre-defined function exist: `gnus-extract-address-components',
1649 which is the default, quite fast, and too simplistic solution, and
1650 `mail-extract-address-components', which works much better, but is
1651 slower."
1658 "*If non-nil, display clickable icons."
1663 "String used to separate shell commands."
1695 "*An alist of valid select methods.
1696 The first element of each list lists should be a string with the name
1697 of the select method. The other elements may be the category of
1698 this method (i. e., `post', `mail', `none' or whatever) or other
1699 properties that this method has (like being respoolable).
1700 If you implement a new select method, all you should have to change is
1701 this variable. I think."
1716 "Recomputes the select-method widget based on the value of
1717 `gnus-valid-select-methods'."
1719 "Widget for entering a select method."
1726 gnus-valid-select-methods)
1730 :inline t
1732 variable
1738 "List of buffers that should update their mode lines.
1739 The list may contain the symbols `group', `article', `tree' and
1740 `summary'. If the corresponding symbol is present, Gnus will keep
1741 that mode line updated with information that may be pertinent.
1742 If this variable is nil, screen refresh may be quicker."
1749 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1751 "*Max length of mode-line non-string contents.
1752 If this is nil, Gnus will take space as is needed, leaving the rest
1753 of the mode line intact. Note that the default of nil is unlikely
1754 to be desirable; see the manual for further details."
1757 integer))
1759 ;; There should be special validation for this.
1764 to-address
1765 :function-document
1766 "Return GROUP's to-address."
1767 :variable-document
1768 "*Alist of group regexps and correspondent to-addresses."
1769 :variable-group gnus-group-parameter
1772 This will be used when doing followups and posts.
1774 This is primarily useful in mail groups that represent closed
1775 mailing lists--mailing lists where it's expected that everybody that
1776 writes to the mailing list is subscribed to it. Since using this
1777 parameter ensures that the mail only goes to the mailing list itself,
1778 it means that members won't receive two copies of your followups.
1780 Using `to-address' will actually work whether the group is foreign or
1781 not. Let's say there's a group on the server that is called
1782 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1783 articles from a mail-to-news gateway. Posting directly to this group
1784 is therefore impossible--you have to send mail to the mailing list
1785 address instead.
1787 The gnus-group-split mail splitting mechanism will behave as if this
1791 to-list
1792 :function-document
1793 "Return GROUP's to-list."
1794 :variable-document
1795 "*Alist of group regexps and correspondent to-lists."
1796 :variable-group gnus-group-parameter
1799 This address will be used when doing a `a' in the group.
1801 It is totally ignored when doing a followup--except that if it is
1802 present in a news group, you'll get mail group semantics when doing
1803 `f'.
1805 The gnus-group-split mail splitting mechanism will behave as if this
1809 subscribed
1810 :type bool
1811 :function-document
1812 "Return GROUP's subscription status."
1813 :variable-document
1814 "*Groups which are automatically considered subscribed."
1815 :variable-group gnus-group-parameter
1818 Gnus assumed that you are subscribed to the To/List address.
1820 When constructing a list of subscribed groups using
1821 `gnus-find-subscribed-addresses', Gnus includes the To address given
1825 auto-expire
1826 :type bool
1827 :function gnus-group-auto-expirable-p
1828 :function-document
1829 "Check whether GROUP is auto-expirable or not."
1830 :variable gnus-auto-expirable-newsgroups
1831 :variable-default nil
1832 :variable-document
1833 "*Groups in which to automatically mark read articles as expirable.
1834 If non-nil, this should be a regexp that should match all groups in
1835 which to perform auto-expiry. This only makes sense for mail groups."
1836 :variable-group nnmail-expire
1838 regexp)
1840 :parameter-document
1844 total-expire
1845 :type bool
1846 :function gnus-group-total-expirable-p
1847 :function-document
1848 "Check whether GROUP is total-expirable or not."
1849 :variable gnus-total-expirable-newsgroups
1850 :variable-default nil
1851 :variable-document
1852 "*Groups in which to perform expiry of all read articles.
1853 Use with extreme caution. All groups that match this regexp will be
1854 expiring - which means that all read articles will be deleted after
1855 \(say) one week. (This only goes for mail groups and the like, of
1856 course.)"
1857 :variable-group nnmail-expire
1859 regexp)
1861 :parameter-document
1862 "All read articles will be put through the expiry process
1864 This happens even if they are not marked as expirable.
1868 charset
1869 :function-document
1870 "Return the default charset of GROUP."
1871 :variable gnus-group-charset-alist
1872 :variable-default
1885 :variable-document
1886 "Alist of regexps (to match group names) and default charsets to be used when reading."
1887 :variable-group gnus-charset
1895 post-method
1896 :type list
1897 :function-document
1898 "Return a posting method for GROUP."
1899 :variable gnus-post-method-alist
1900 :variable-document
1901 "Alist of regexps (to match group names) and method to be used when
1902 posting an article."
1903 :variable-group gnus-group-foreign
1904 :parameter-type
1912 :parameter-document
1916 large-newsgroup-initial
1917 :type integer
1918 :function-document
1919 "Return GROUP's initial input of the number of articles."
1920 :variable-document
1921 "*Alist of group regexps and its initial input of the number of articles."
1922 :variable-group gnus-group-parameter
1928 This number will be prompted as the initial value of the number of
1929 articles to list when the group is a large newsgroup (see
1930 `gnus-large-newsgroup'). If it is nil, the default value is the
1933 ;; The Gnus registry's ignored groups
1935 registry-ignore
1936 :type list
1937 :function-document
1938 "Whether this group should be ignored by the registry."
1939 :variable gnus-registry-ignored-groups
1940 :variable-default nil
1941 :variable-document
1942 "*Groups in which the registry should be turned off."
1943 :variable-group gnus-registry
1950 :parameter-document
1953 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1955 "*Disable the group parameters for spam detection.
1956 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1963 "Spam group classification (requires spam.el).
1964 This group contains spam messages. On summary entry, unread messages
1965 will be marked as spam. On summary exit, the specified spam
1966 processors will be invoked on spam-marked messages, then those
1967 messages will be expired, so the spam processor will only see a
1971 "The ham value for the spam group parameter (requires spam.el).
1972 On summary exit, the specified ham processors will be invoked on
1973 ham-marked messages. Exercise caution, since the ham processor will
1974 see the same message more than once because there is no ham message
1978 spam-contents
1979 :type list
1980 :function-document
1981 "The spam type (spam, ham, or neither) of the group."
1982 :variable gnus-spam-newsgroup-contents
1983 :variable-default nil
1984 :variable-document
1985 "*Group classification (spam, ham, or neither). Only
1986 meaningful when spam.el is loaded. If non-nil, this should be a
1987 list of group name regexps associated with a classification for
1988 each one. In spam groups, new articles are marked as spam on
1989 summary entry. There is other behavior associated with ham and
1990 no classification when spam.el is loaded - see the manual."
1991 :variable-group spam
2005 :parameter-document
2006 "The spam classification (spam, ham, or neither) of this group.
2007 When a spam group is entered, all unread articles are marked as
2008 spam. There is other behavior associated with ham and no
2024 "OBSOLETE: The Gmane reporting summary exit spam processor.
2031 "OBSOLETE: The ifile summary exit ham processor.
2035 "OBSOLETE: The Bogofilter summary exit ham processor.
2039 "OBSOLETE: The spam-stat summary exit ham processor.
2043 "OBSOLETE: The whitelist summary exit ham processor.
2047 "OBSOLETE: The BBDB summary exit ham processor.
2051 "OBSOLETE: The ham copy exit ham processor.
2055 "OBSOLETE: The spamoracle summary exit ham processor.
2059 spam-process
2060 :type list
2061 :parameter-type
2064 :value nil
2093 :function-document
2094 "Which spam or ham processors will be applied when the summary is exited."
2095 :variable gnus-spam-process-newsgroups
2096 :variable-default nil
2097 :variable-document
2098 "*Groups in which to automatically process spam or ham articles with
2099 a backend on summary exit. If non-nil, this should be a list of group
2100 name regexps that should match all groups in which to do automatic
2101 spam processing, associated with the appropriate processor."
2102 :variable-group spam
2103 :variable-type
2136 :parameter-document
2140 spam-autodetect
2141 :type list
2142 :parameter-type
2144 :function-document
2145 "Should spam be autodetected (with spam-split) in this group?"
2146 :variable gnus-spam-autodetect
2147 :variable-default nil
2148 :variable-document
2149 "*Groups in which spam should be autodetected when they are entered.
2150 Only unseen articles will be examined, unless
2151 spam-autodetect-recheck-messages is set."
2152 :variable-group spam
2153 :variable-type
2158 boolean))
2159 :parameter-document
2160 "Spam autodetection.
2161 Only unseen articles will be examined, unless
2165 spam-autodetect-methods
2166 :type list
2167 :parameter-type
2184 :function-document
2185 "Methods to be used for autodetection in each group"
2186 :variable gnus-spam-autodetect-methods
2187 :variable-default nil
2188 :variable-document
2189 "*Methods for autodetecting spam per group.
2190 Requires the spam-autodetect parameter. Only unseen articles
2191 will be examined, unless spam-autodetect-recheck-messages is
2192 set."
2193 :variable-group spam
2194 :variable-type
2215 :parameter-document
2216 "Spam autodetection methods.
2217 Requires the spam-autodetect parameter. Only unseen articles
2218 will be examined, unless spam-autodetect-recheck-messages is
2222 spam-process-destination
2223 :type list
2224 :parameter-type
2230 :function-document
2231 "Where spam-processed articles will go at summary exit."
2232 :variable gnus-spam-process-destinations
2233 :variable-default nil
2234 :variable-document
2235 "*Groups in which to explicitly send spam-processed articles to
2236 another group, or expire them (the default). If non-nil, this should
2237 be a list of group name regexps that should match all groups in which
2238 to do spam-processed article moving, associated with the destination
2239 group or nil for explicit expiration. This only makes sense for
2240 mail groups."
2241 :variable-group spam
2242 :variable-type
2253 :parameter-document
2257 ham-process-destination
2258 :type list
2259 :parameter-type
2267 :function-document
2268 "Where ham articles will go at summary exit from a spam group."
2269 :variable gnus-ham-process-destinations
2270 :variable-default nil
2271 :variable-document
2272 "*Groups in which to explicitly send ham articles to
2273 another group, or do nothing (the default). If non-nil, this should
2274 be a list of group name regexps that should match all groups in which
2275 to do ham article moving, associated with the destination
2276 group or nil for explicit ignoring. This only makes sense for
2277 mail groups, and only works in spam groups."
2278 :variable-group spam
2279 :variable-type
2291 :parameter-document
2295 ham-marks
2306 :parameter-document
2307 "Marks considered ham (positively not spam). Such articles will be
2308 processed as ham (non-spam) on group exit. When nil, the global
2309 spam-ham-marks variable takes precedence."
2311 gnus-read-mark
2312 gnus-killed-mark
2313 gnus-kill-file-mark
2314 gnus-low-score-mark))))
2315 :variable-group spam
2316 :variable-document
2320 spam-marks
2329 :parameter-document
2330 "Marks considered spam.
2331 Such articles will be processed as spam on group exit. When nil, the global
2332 spam-spam-marks variable takes precedence."
2334 :variable-group spam
2335 :variable-document
2339 "Number of group name elements to leave alone when making a short group name."
2344 "*If non-nil, once you set a level, Gnus will use this level."
2348 ;; Hooks.
2351 "A hook run while Gnus is loaded."
2356 "A hook called to apply kill files to a group.
2357 This hook is intended to apply a kill file to the selected newsgroup.
2358 The function `gnus-apply-kill-file' is called by default.
2360 Since a general kill file is too heavy to use only for a few
2361 newsgroups, I recommend you to use a lighter hook function. For
2362 example, if you'd like to apply a kill file to articles which contains
2363 a string `rmgroup' in subject in newsgroup `control', you can use the
2364 following hook:
2366 (setq gnus-apply-kill-hook
2367 (list
2368 (lambda ()
2377 "Function run when a group level is changed.
2378 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2381 function))
2383 ;;; Face thingies.
2387 mouse-face
2388 summary-menu group-menu article-menu
2389 tree-highlight menu highlight
2390 browse-menu server-menu
2391 page-marker tree-menu binary-menu pick-menu
2392 grouplens-menu)
2393 "*Enable visual features.
2394 If `visual' is disabled, there will be no menus and few faces. Most of
2395 the visual customization options below will be ignored. Gnus will use
2396 less space and be faster as a result.
2398 This variable can also be a list of visual elements to switch on. For
2399 instance, to switch off all visual things except menus, you can say:
2401 (setq gnus-visual '(menu))
2403 Valid elements include `summary-highlight', `group-highlight',
2404 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2405 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2406 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2407 and `grouplens-menu'."
2428 ;; Byte-compiler warning.
2430 ;; Find out whether the gnus-visual TYPE is wanted.
2434 gnus-visual
2438 t))))
2448 "*Face used for group or summary buffer mouse highlighting.
2449 The line beneath the mouse pointer will be highlighted with this
2450 face."
2463 "Controls use of the agent cache while plugged.
2464 When set, Gnus will prefer using the locally stored content rather
2465 than re-fetching it from the server. You also need to enable
2466 `gnus-agent' for this to have any affect."
2472 "Default charset assumed to be used when viewing non-ASCII characters.
2473 This variable is overridden on a group-to-group basis by the
2474 `gnus-group-charset-alist' variable and is only used on groups not
2475 covered by that variable."
2479 ;; Fixme: Doc reference to agent.
2481 "Whether we want to use the Gnus agent or not.
2483 You may customize gnus-agent to disable its use. However, some
2484 back ends have started to use the agent as a client-side cache.
2485 Disabling the agent may result in noticeable loss of performance."
2491 "Function called by the command `gnus-other-frame'."
2499 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2500 This should be an alist for Emacs, or a plist for XEmacs."
2511 "Which information should be exposed in the User-Agent header.
2513 Can be a list of symbols or a string. Valid symbols are `gnus'
2514 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2515 addition to the Emacs version, you can add `codename' \(show
2516 \(S\)XEmacs codename\) or either `config' \(show system
2517 configuration\) or `type' \(show system type\). If you set it to
2518 a string, be sure to use a valid format, see RFC 2616."
2531 ;; Convert old (No Gnus < 2005-01-10, v5-10 < 2005-09-05) symbol type values:
2550 \f
2551 ;;; Internal variables
2556 ; Reset each time gnus-agent-covered-methods is changed else
2557 ; gnus-agent-method-p may mis-report a methods status.
2558 )
2582 ;; Dummy variable.
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"
2629 ;; Propagate flags to server, with the following exceptions:
2630 ;; `seen' is private to each gnus installation
2631 ;; `cache' is a internal gnus flag for each gnus installation
2632 ;; `download' is a agent flag private to each gnus installation
2633 ;; `unsend' are for nndraft groups only
2634 ;; `score' is not a proper mark
2635 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2638 "Marks that shouldn't be propagated to back ends.
2639 Typical marks are those that make no sense in a standalone back end,
2640 such as a mark that says whether an article is stored in the cache
2654 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2679 gnus-newsrc-last-checked-date
2680 gnus-newsrc-alist gnus-server-alist
2681 gnus-killed-list gnus-zombie-list
2682 gnus-topic-topology gnus-topic-alist
2683 gnus-format-specs)
2687 "Assoc list of read articles.
2691 "Assoc list of registry data.
2718 ;; Save window configuration.
2723 ;;; Let the byte-compiler know that we know about this variable.
2734 ;;; End of variables.
2736 ;; Define some autoload functions Gnus might use.
2739 ;; This little mapcar goes through the list below and marks the
2740 ;; symbols in question as autoloaded functions.
2760 message-send-and-exit message-yank-original)
2766 rmail-show-message rmail-summary-exists
2767 rmail-select-summary rmail-update-summary)
2771 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2772 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
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 gnus-carpal-setup-buffer)
2790 gnus-nocem-unwanted-article-p)
2792 gnus-server-server-name)
2795 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2796 gnus-article-hide-citation gnus-article-fill-cited-article
2797 gnus-article-hide-citation-in-followups)
2799 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2800 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2802 gnus-cache-possibly-remove-articles gnus-cache-request-article
2803 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2804 gnus-cache-enter-remove-article gnus-cached-article-p
2805 gnus-cache-open gnus-cache-close gnus-cache-update-article
2806 gnus-cache-articles-in-group)
2808 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2810 gnus-summary-increase-score gnus-summary-set-score
2811 gnus-summary-raise-thread gnus-summary-raise-same-subject
2812 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2813 gnus-summary-lower-thread gnus-summary-lower-same-subject
2814 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2815 gnus-summary-current-score gnus-score-delta-default
2816 gnus-score-flush-cache gnus-score-close
2817 gnus-possibly-score-headers gnus-score-followup-article
2818 gnus-score-followup-thread)
2821 gnus-current-score-file-nondirectory gnus-score-adaptive
2822 gnus-score-find-trace gnus-score-file-name)
2826 gnus-subscribe-topics)
2830 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2831 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2832 gnus-uu-mark-by-regexp gnus-uu-mark-all
2833 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2834 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2835 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2836 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2837 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2838 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2839 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2840 gnus-uu-mark-over gnus-uu-post-news)
2843 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2845 gnus-group-post-news gnus-group-mail gnus-group-news
2846 gnus-summary-post-news gnus-summary-news-other-window
2847 gnus-summary-followup gnus-summary-followup-with-original
2848 gnus-summary-cancel-article gnus-summary-supersede-article
2849 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2850 gnus-summary-mail-forward gnus-summary-mail-other-window
2851 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2852 gnus-summary-wide-reply gnus-summary-followup-to-mail
2853 gnus-summary-followup-to-mail-with-original gnus-bug
2854 gnus-summary-wide-reply-with-original
2855 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2856 gnus-summary-post-forward)
2859 gnus-grouplens-mode)
2863 gnus-list-of-unread-articles gnus-list-of-read-articles
2864 gnus-offer-save-summaries gnus-make-thread-indent-array
2865 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2866 gnus-summary-skip-intangible gnus-summary-article-number
2867 gnus-data-header gnus-data-find)
2869 gnus-group-list-groups gnus-group-first-unread-group
2870 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2871 gnus-group-setup-buffer gnus-group-get-new-news
2872 gnus-group-make-help-group gnus-group-update-group
2873 gnus-group-iterate gnus-group-group-name)
2875 gnus-backlog-remove-article)
2877 gnus-article-prepare gnus-article-set-window-start
2878 gnus-article-next-page gnus-article-prev-page
2879 gnus-request-article-this-buffer gnus-article-mode
2880 gnus-article-setup-buffer gnus-narrow-to-page
2881 gnus-article-delete-invisible-text gnus-treat-article)
2883 gnus-article-hide-headers gnus-article-hide-boring-headers
2884 gnus-article-treat-overstrike
2885 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2886 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2887 gnus-article-de-base64-unreadable
2888 gnus-article-decode-HZ
2889 gnus-article-wash-html
2890 gnus-article-unsplit-urls
2891 gnus-article-hide-pem gnus-article-hide-signature
2892 gnus-article-strip-leading-blank-lines gnus-article-date-local
2893 gnus-article-date-original gnus-article-date-lapsed
2894 ;; gnus-article-show-all-headers
2895 gnus-article-edit-mode gnus-article-edit-article
2896 gnus-article-edit-done gnus-article-decode-encoded-words
2897 gnus-start-date-timer gnus-stop-date-timer
2898 gnus-mime-view-all-parts)
2901 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2903 gnus-dup-enter-articles)
2907 gnus-group-move-group-to-server gnus-change-server)
2911 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2912 gnus-async-halt-prefetch)
2914 gnus-agent-save-active gnus-agent-method-p
2915 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2916 gnus-summary-set-agent-mark gnus-agent-save-group-info
2917 gnus-agent-request-article gnus-agent-retrieve-headers)
2919 gnus-unplugged gnus-agentize gnus-agent-batch)
2921 gnus-summary-save-article-vm)
2926 gnus-group-split-update)
2929 ;;; gnus-sum.el thingies
2933 "*The format specification of the lines in the summary buffer.
2935 It works along the same lines as a normal formatting string,
2936 with some simple extensions.
2938 %N Article number, left padded with spaces (string)
2939 %S Subject (string)
2941 %n Name of the poster (string)
2942 %a Extracted name of the poster (string)
2943 %A Extracted address of the poster (string)
2944 %F Contents of the From: header (string)
2945 %f Contents of the From: or To: headers (string)
2946 %x Contents of the Xref: header (string)
2947 %D Date of the article (string)
2948 %d Date of the article (string) in DD-MMM format
2949 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2950 %M Message-id of the article (string)
2951 %r References of the article (string)
2952 %c Number of characters in the article (integer)
2953 %k Pretty-printed version of the above (string)
2955 %L Number of lines in the article (integer)
2956 %I Indentation based on thread level (a string of spaces)
2957 %B A complex trn-style thread tree (string)
2958 The variables `gnus-sum-thread-*' can be used for customization.
2959 %T A string with two possible values: 80 spaces if the article
2960 is on thread level two or larger and 0 spaces on level one
2965 %> Spaces of length thread-level (string)
2966 %< Spaces of length (- 20 thread-level) (string)
2967 %i Article score (number)
2968 %z Article zcore (character)
2969 %t Number of articles under the current thread (number).
2970 %e Whether the thread is empty or not (character).
2971 %l GroupLens score (string).
2972 %V Total thread score (number).
2973 %P The line number (number).
2974 %O Download mark (character).
2975 %* If present, indicates desired cursor position
2976 (instead of after first colon).
2977 %u User defined specifier. The next character in the format string should
2978 be a letter. Gnus will call the function gnus-user-format-function-X,
2979 where X is the letter following %u. The function will be passed the
2980 current header as argument. The function should return a string, which
2981 will be inserted into the summary just like information from any other
2982 summary specifier.
2984 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2985 with care. For reasons of efficiency, Gnus will compute what column
2987 it is invalid to have these specs after a variable-length spec. Well,
2988 you might not be arrested, but your summary buffer will look strange,
2989 which is bad enough.
2991 The smart choice is to have these specs as far to the left as
2992 possible.
2994 This restriction may disappear in later versions of Gnus.
2996 General format specifiers can also be used.
2997 See Info node `(gnus)Formatting Variables'."
3002 ;;;
3003 ;;; Skeleton keymaps
3004 ;;;
3009 (while keys
3010 (define-key keymap (pop keys) 'undefined))))
3012 (defvar gnus-article-mode-map
3013 (let ((keymap (make-sparse-keymap)))
3014 (gnus-suppress-keymap keymap)
3015 keymap))
3016 (defvar gnus-summary-mode-map
3017 (let ((keymap (make-keymap)))
3018 (gnus-suppress-keymap keymap)
3019 keymap))
3020 (defvar gnus-group-mode-map
3021 (let ((keymap (make-keymap)))
3022 (gnus-suppress-keymap keymap)
3023 keymap))
3025 \f
3027 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3028 ;; If you want the cursor to go somewhere else, set these two
3029 ;; functions in some startup hook to whatever you want.
3030 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3031 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3033 ;;; Various macros and substs.
3035 (defun gnus-header-from (header)
3036 (mail-header-from header))
3038 (defmacro gnus-gethash (string hashtable)
3039 "Get hash value of STRING in HASHTABLE."
3040 `(symbol-value (intern-soft ,string ,hashtable)))
3042 (defmacro gnus-gethash-safe (string hashtable)
3043 "Get hash value of STRING in HASHTABLE.
3044 Return nil if not defined."
3045 `(let ((sym (intern-soft ,string ,hashtable)))
3046 (and (boundp sym) (symbol-value sym))))
3048 (defmacro gnus-sethash (string value hashtable)
3049 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3050 `(set (intern ,string ,hashtable) ,value))
3051 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3053 (defmacro gnus-group-unread (group)
3054 "Get the currently computed number of unread articles in GROUP."
3055 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3057 (defmacro gnus-group-entry (group)
3058 "Get the newsrc entry for GROUP."
3059 `(gnus-gethash ,group gnus-newsrc-hashtb))
3061 (defmacro gnus-active (group)
3062 "Get active info on GROUP."
3063 `(gnus-gethash ,group gnus-active-hashtb))
3065 (defmacro gnus-set-active (group active)
3066 "Set GROUP's active info."
3067 `(gnus-sethash ,group ,active gnus-active-hashtb))
3069 ;; Info access macros.
3071 (defmacro gnus-info-group (info)
3072 `(nth 0 ,info))
3073 (defmacro gnus-info-rank (info)
3074 `(nth 1 ,info))
3075 (defmacro gnus-info-read (info)
3076 `(nth 2 ,info))
3077 (defmacro gnus-info-marks (info)
3078 `(nth 3 ,info))
3079 (defmacro gnus-info-method (info)
3080 `(nth 4 ,info))
3081 (defmacro gnus-info-params (info)
3082 `(nth 5 ,info))
3084 (defmacro gnus-info-level (info)
3085 `(let ((rank (gnus-info-rank ,info)))
3086 (if (consp rank)
3087 (car rank)
3088 rank)))
3089 (defmacro gnus-info-score (info)
3090 `(let ((rank (gnus-info-rank ,info)))
3091 (or (and (consp rank) (cdr rank)) 0)))
3093 (defmacro gnus-info-set-group (info group)
3094 `(setcar ,info ,group))
3095 (defmacro gnus-info-set-rank (info rank)
3096 `(setcar (nthcdr 1 ,info) ,rank))
3097 (defmacro gnus-info-set-read (info read)
3098 `(setcar (nthcdr 2 ,info) ,read))
3099 (defmacro gnus-info-set-marks (info marks &optional extend)
3100 (if extend
3101 `(gnus-info-set-entry ,info ,marks 3)
3102 `(setcar (nthcdr 3 ,info) ,marks)))
3103 (defmacro gnus-info-set-method (info method &optional extend)
3104 (if extend
3105 `(gnus-info-set-entry ,info ,method 4)
3106 `(setcar (nthcdr 4 ,info) ,method)))
3107 (defmacro gnus-info-set-params (info params &optional extend)
3108 (if extend
3109 `(gnus-info-set-entry ,info ,params 5)
3110 `(setcar (nthcdr 5 ,info) ,params)))
3112 (defun gnus-info-set-entry (info entry number)
3113 ;; Extend the info until we have enough elements.
3114 (while (<= (length info) number)
3115 (nconc info (list nil)))
3116 ;; Set the entry.
3117 (setcar (nthcdr number info) entry))
3119 (defmacro gnus-info-set-level (info level)
3120 `(let ((rank (cdr ,info)))
3121 (if (consp (car rank))
3122 (setcar (car rank) ,level)
3123 (setcar rank ,level))))
3124 (defmacro gnus-info-set-score (info score)
3125 `(let ((rank (cdr ,info)))
3126 (if (consp (car rank))
3127 (setcdr (car rank) ,score)
3128 (setcar rank (cons (car rank) ,score)))))
3130 (defmacro gnus-get-info (group)
3131 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3133 ;;; Load the compatibility functions.
3135 (require 'gnus-ems)
3137 \f
3138 ;;;
3139 ;;; Shutdown
3140 ;;;
3142 (defvar gnus-shutdown-alist nil)
3144 (defun gnus-add-shutdown (function &rest symbols)
3145 "Run FUNCTION whenever one of SYMBOLS is shut down."
3146 (push (cons function symbols) gnus-shutdown-alist))
3148 (defun gnus-shutdown (symbol)
3149 "Shut down everything that waits for SYMBOL."
3150 (let ((alist gnus-shutdown-alist)
3151 entry)
3152 (while (setq entry (pop alist))
3153 (when (memq symbol (cdr entry))
3154 (funcall (car entry))))))
3156 \f
3157 ;;;
3158 ;;; Gnus Utility Functions
3159 ;;;
3161 (defun gnus-find-subscribed-addresses ()
3162 "Return a regexp matching the addresses of all subscribed mail groups.
3163 It consists of the `to-address' or `to-list' parameter of all groups
3164 with a `subscribed' parameter."
3165 (let (group address addresses)
3166 (dolist (entry (cdr gnus-newsrc-alist))
3167 (setq group (car entry))
3168 (when (gnus-parameter-subscribed group)
3169 (setq address (mail-strip-quoted-names
3170 (or (gnus-group-fast-parameter group 'to-address)
3171 (gnus-group-fast-parameter group 'to-list))))
3172 (when address
3173 (add-to-list 'addresses address))))
3174 (when addresses
3177 (defmacro gnus-string-or (&rest strings)
3178 "Return the first element of STRINGS that is a non-blank string.
3179 STRINGS will be evaluated in normal `or' order."
3180 `(gnus-string-or-1 ',strings))
3182 (defun gnus-string-or-1 (strings)
3183 (let (string)
3184 (while strings
3185 (setq string (eval (pop strings)))
3187 (setq string nil)
3188 (setq strings nil)))
3189 string))
3191 (defun gnus-version (&optional arg)
3192 "Version number of this version of Gnus.
3193 If ARG, insert string at point."
3194 (interactive "P")
3195 (if arg
3196 (insert (message gnus-version))
3197 (message gnus-version)))
3199 (defun gnus-continuum-version (&optional version)
3200 "Return VERSION as a floating point number."
3201 (interactive)
3202 (unless version
3203 (setq version gnus-version))
3206 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3207 (number (match-string 2 version))
3208 major minor least)
3209 (unless (string-match
3211 (error "Invalid version string: %s" version))
3212 (setq major (string-to-number (match-string 1 number))
3213 minor (string-to-number (match-string 2 number))
3214 least (if (match-beginning 3)
3215 (string-to-number (match-string 3 number))
3216 0))
3217 (string-to-number
3218 (if (zerop major)
3219 (format "%s00%02d%02d"
3220 (if (member alpha '("(ding)" "d"))
3221 "4.99"
3222 (+ 5 (* 0.02
3223 (abs
3224 (- (mm-char-int (aref (downcase alpha) 0))
3225 (mm-char-int ?t))))
3226 -0.01))
3227 minor least)
3228 (format "%d.%02d%02d" major minor least))))))
3230 (defun gnus-info-find-node (&optional nodename)
3231 "Find Info documentation of Gnus."
3232 (interactive)
3233 ;; Enlarge info window if needed.
3234 (let (gnus-info-buffer)
3235 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3236 (setq gnus-info-buffer (current-buffer))
3237 (gnus-configure-windows 'info)))
3239 ;;;
3240 ;;; gnus-interactive
3241 ;;;
3243 (defvar gnus-current-prefix-symbol nil
3244 "Current prefix symbol.")
3246 (defvar gnus-current-prefix-symbols nil
3247 "List of current prefix symbols.")
3249 (defun gnus-interactive (string &optional params)
3250 "Return a list that can be fed to `interactive'.
3251 See `interactive' for full documentation.
3253 Adds the following specs:
3255 y -- The current symbolic prefix.
3256 Y -- A list of the current symbolic prefix(es).
3257 A -- Article number.
3258 H -- Article header.
3259 g -- Group name."
3260 (let ((i 0)
3261 out c prompt)
3262 (while (< i (length string))
3264 (setq c (aref string i))
3265 (when (match-end 1)
3266 (setq prompt (match-string 1 string)))
3267 (setq i (match-end 0))
3268 ;; We basically emulate just about everything that
3269 ;; `interactive' does, but add the specs listed above.
3270 (push
3271 (cond
3272 ((= c ?a)
3273 (completing-read prompt obarray 'fboundp t))
3274 ((= c ?b)
3275 (read-buffer prompt (current-buffer) t))
3276 ((= c ?B)
3277 (read-buffer prompt (other-buffer (current-buffer))))
3278 ((= c ?c)
3279 (read-char))
3280 ((= c ?C)
3281 (completing-read prompt obarray 'commandp t))
3282 ((= c ?d)
3283 (point))
3284 ((= c ?D)
3285 (read-file-name prompt nil default-directory 'lambda))
3286 ((= c ?f)
3287 (read-file-name prompt nil nil 'lambda))
3288 ((= c ?F)
3289 (read-file-name prompt))
3290 ((= c ?k)
3291 (read-key-sequence prompt))
3292 ((= c ?K)
3293 (error "Not implemented spec"))
3294 ((= c ?e)
3295 (error "Not implemented spec"))
3296 ((= c ?m)
3297 (mark))
3298 ((= c ?N)
3299 (error "Not implemented spec"))
3300 ((= c ?n)
3301 (string-to-number (read-from-minibuffer prompt)))
3302 ((= c ?p)
3303 (prefix-numeric-value current-prefix-arg))
3304 ((= c ?P)
3305 current-prefix-arg)
3306 ((= c ?r)
3307 'gnus-prefix-nil)
3308 ((= c ?s)
3309 (read-string prompt))
3310 ((= c ?S)
3311 (intern (read-string prompt)))
3312 ((= c ?v)
3313 (read-variable prompt))
3314 ((= c ?x)
3315 (read-minibuffer prompt))
3316 ((= c ?x)
3317 (eval-minibuffer prompt))
3318 ;; And here the new specs come.
3319 ((= c ?y)
3320 gnus-current-prefix-symbol)
3321 ((= c ?Y)
3322 gnus-current-prefix-symbols)
3323 ((= c ?g)
3324 (gnus-group-group-name))
3325 ((= c ?A)
3326 (gnus-summary-skip-intangible)
3327 (or (get-text-property (point) 'gnus-number)
3328 (gnus-summary-last-subject)))
3329 ((= c ?H)
3330 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3331 (t
3332 (error "Non-implemented spec")))
3333 out)
3334 (cond
3335 ((= c ?r)
3336 (push (if (< (point) (mark)) (point) (mark)) out)
3337 (push (if (> (point) (mark)) (point) (mark)) out))))
3338 (setq out (delq 'gnus-prefix-nil out))
3339 (nreverse out)))
3341 (defun gnus-symbolic-argument (&optional arg)
3342 "Read a symbolic argument and a command, and then execute command."
3343 (interactive "P")
3344 (let* ((in-command (this-command-keys))
3345 (command in-command)
3346 gnus-current-prefix-symbols
3347 gnus-current-prefix-symbol
3348 syms)
3349 (while (equal in-command command)
3350 (message "%s-" (key-description (this-command-keys)))
3351 (push (intern (char-to-string (read-char))) syms)
3352 (setq command (read-key-sequence nil t)))
3353 (setq gnus-current-prefix-symbols (nreverse syms)
3354 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3355 (call-interactively (key-binding command t))))
3357 ;;; More various functions.
3359 (defsubst gnus-check-backend-function (func group)
3360 "Check whether GROUP supports function FUNC.
3361 GROUP can either be a string (a group name) or a select method."
3362 (ignore-errors
3363 (let ((method (if (stringp group)
3364 (car (gnus-find-method-for-group group))
3365 group)))
3366 (unless (featurep method)
3367 (require method))
3368 (fboundp (intern (format "%s-%s" method func))))))
3370 (defun gnus-group-read-only-p (&optional group)
3371 "Check whether GROUP supports editing or not.
3372 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3373 that that variable is buffer-local to the summary buffers."
3374 (let ((group (or group gnus-newsgroup-name)))
3375 (not (gnus-check-backend-function 'request-replace-article group))))
3377 (defun gnus-virtual-group-p (group)
3378 "Say whether GROUP is virtual or not."
3379 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3380 gnus-valid-select-methods)))
3382 (defun gnus-news-group-p (group &optional article)
3383 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3384 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3385 t) ;is news of course.
3386 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3387 nil) ;must be mail then.
3388 ((vectorp article) ;Has header info.
3389 (eq (gnus-request-type group (mail-header-id article)) 'news))
3390 ((null article) ;Hasn't header info
3391 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3392 ((< article 0) ;Virtual message
3393 nil) ;we don't know, guess mail.
3394 (t ;Has positive number
3395 (eq (gnus-request-type group article) 'news)))) ;use it.
3397 ;; Returns a list of writable groups.
3398 (defun gnus-writable-groups ()
3399 (let ((alist gnus-newsrc-alist)
3400 groups group)
3401 (while (setq group (car (pop alist)))
3402 (unless (gnus-group-read-only-p group)
3403 (push group groups)))
3404 (nreverse groups)))
3406 ;; Check whether to use long file names.
3407 (defun gnus-use-long-file-name (symbol)
3408 ;; The variable has to be set...
3409 (and gnus-use-long-file-name
3410 ;; If it isn't a list, then we return t.
3411 (or (not (listp gnus-use-long-file-name))
3412 ;; If it is a list, and the list contains `symbol', we
3413 ;; return nil.
3414 (not (memq symbol gnus-use-long-file-name)))))
3416 ;; Generate a unique new group name.
3417 (defun gnus-generate-new-group-name (leaf)
3418 (let ((name leaf)
3419 (num 0))
3420 (while (gnus-gethash name gnus-newsrc-hashtb)
3421 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3422 name))
3424 (defun gnus-ephemeral-group-p (group)
3425 "Say whether GROUP is ephemeral or not."
3426 (gnus-group-get-parameter group 'quit-config t))
3428 (defun gnus-group-quit-config (group)
3429 "Return the quit-config of GROUP."
3430 (gnus-group-get-parameter group 'quit-config t))
3432 (defun gnus-kill-ephemeral-group (group)
3433 "Remove ephemeral GROUP from relevant structures."
3434 (gnus-sethash group nil gnus-newsrc-hashtb))
3436 (defun gnus-simplify-mode-line ()
3437 "Make mode lines a bit simpler."
3438 (setq mode-line-modified (cdr gnus-mode-line-modified))
3439 (when (listp mode-line-format)
3440 (make-local-variable 'mode-line-format)
3441 (setq mode-line-format (copy-sequence mode-line-format))
3442 (when (equal (nth 3 mode-line-format) " ")
3443 (setcar (nthcdr 3 mode-line-format) " "))))
3445 ;;; Servers and groups.
3447 (defsubst gnus-server-add-address (method)
3448 (let ((method-name (symbol-name (car method))))
3449 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3450 (not (assq (intern (concat method-name "-address")) method))
3451 (memq 'physical-address (assq (car method)
3452 gnus-valid-select-methods)))
3453 (append method (list (list (intern (concat method-name "-address"))
3454 (nth 1 method))))
3455 method)))
3457 (defsubst gnus-method-to-server (method)
3458 (catch 'server-name
3459 (setq method (or method gnus-select-method))
3461 ;; Perhaps it is already in the cache.
3462 (mapc (lambda (name-method)
3463 (if (equal (cdr name-method) method)
3464 (throw 'server-name (car name-method))))
3465 gnus-server-method-cache)
3467 (mapc
3468 (lambda (server-alist)
3469 (mapc (lambda (name-method)
3470 (when (gnus-methods-equal-p (cdr name-method) method)
3471 (unless (member name-method gnus-server-method-cache)
3472 (push name-method gnus-server-method-cache))
3473 (throw 'server-name (car name-method))))
3474 server-alist))
3475 (let ((alists (list gnus-server-alist
3476 gnus-predefined-server-alist)))
3477 (if gnus-select-method
3478 (push (list (cons "native" gnus-select-method)) alists))
3479 alists))
3481 (let* ((name (if (member (cadr method) '(nil ""))
3482 (format "%s" (car method))
3483 (format "%s:%s" (car method) (cadr method))))
3484 (name-method (cons name method)))
3485 (unless (member name-method gnus-server-method-cache)
3486 (push name-method gnus-server-method-cache))
3487 name)))
3489 (defsubst gnus-server-to-method (server)
3490 "Map virtual server names to select methods."
3491 (or (and server (listp server) server)
3492 (cdr (assoc server gnus-server-method-cache))
3493 (let ((result
3494 (or
3495 ;; Perhaps this is the native server?
3496 (and (equal server "native") gnus-select-method)
3497 ;; It should be in the server alist.
3498 (cdr (assoc server gnus-server-alist))
3499 ;; It could be in the predefined server alist.
3500 (cdr (assoc server gnus-predefined-server-alist))
3501 ;; If not, we look through all the opened server
3502 ;; to see whether we can find it there.
3503 (let ((opened gnus-opened-servers))
3504 (while (and opened
3505 (not (equal server (format "%s:%s" (caaar opened)
3506 (cadaar opened)))))
3507 (pop opened))
3508 (caar opened))
3509 ;; It could be a named method, search all servers
3510 (let ((servers gnus-secondary-select-methods))
3511 (while (and servers
3512 (not (equal server (format "%s:%s" (caar servers)
3513 (cadar servers)))))
3514 (pop servers))
3515 (car servers))
3516 ;; This could be some sort of foreign server that I
3517 ;; simply haven't opened (yet). Do a brute-force scan
3518 ;; of the entire gnus-newsrc-alist for the server name
3519 ;; of every method. As a side-effect, loads the
3520 ;; gnus-server-method-cache so this only happens once,
3521 ;; if at all.
3522 (let ((alist (cdr gnus-newsrc-alist))
3523 method match)
3524 (while alist
3525 (setq method (gnus-info-method (pop alist)))
3526 (when (and (not (stringp method))
3527 (equal server (gnus-method-to-server method)))
3528 (setq match method
3529 alist nil)))
3530 match))))
3531 (when result
3532 (push (cons server result) gnus-server-method-cache))
3533 result)))
3535 (defsubst gnus-server-get-method (group method)
3536 ;; Input either a server name, and extended server name, or a
3537 ;; select method, and return a select method.
3538 (cond ((stringp method)
3539 (gnus-server-to-method method))
3540 ((equal method gnus-select-method)
3541 gnus-select-method)
3542 ((and (stringp (car method))
3543 group)
3544 (gnus-server-extend-method group method))
3545 ((and method
3546 (not group)
3547 (equal (cadr method) ""))
3548 method)
3549 (t
3550 (gnus-server-add-address method))))
3552 (defmacro gnus-method-equal (ss1 ss2)
3553 "Say whether two servers are equal."
3554 `(let ((s1 ,ss1)
3555 (s2 ,ss2))
3556 (or (equal s1 s2)
3557 (and (= (length s1) (length s2))
3558 (progn
3559 (while (and s1 (member (car s1) s2))
3560 (setq s1 (cdr s1)))
3561 (null s1))))))
3563 (defun gnus-methods-equal-p (m1 m2)
3564 (let ((m1 (or m1 gnus-select-method))
3565 (m2 (or m2 gnus-select-method)))
3566 (or (equal m1 m2)
3567 (and (eq (car m1) (car m2))
3568 (or (not (memq 'address (assoc (symbol-name (car m1))
3569 gnus-valid-select-methods)))
3570 (equal (nth 1 m1) (nth 1 m2)))))))
3572 (defun gnus-server-equal (m1 m2)
3573 "Say whether two methods are equal."
3574 (let ((m1 (cond ((null m1) gnus-select-method)
3575 ((stringp m1) (gnus-server-to-method m1))
3576 (t m1)))
3577 (m2 (cond ((null m2) gnus-select-method)
3578 ((stringp m2) (gnus-server-to-method m2))
3579 (t m2))))
3580 (gnus-method-equal m1 m2)))
3582 (defun gnus-servers-using-backend (backend)
3583 "Return a list of known servers using BACKEND."
3584 (let ((opened gnus-opened-servers)
3585 out)
3586 (while opened
3587 (when (eq backend (caaar opened))
3588 (push (caar opened) out))
3589 (pop opened))
3590 out))
3592 (defun gnus-archive-server-wanted-p ()
3593 "Say whether the user wants to use the archive server."
3594 (cond
3595 ((or (not gnus-message-archive-method)
3596 (not gnus-message-archive-group))
3597 nil)
3598 ((and gnus-message-archive-method gnus-message-archive-group)
3599 t)
3600 (t
3601 (let ((active (cadr (assq 'nnfolder-active-file
3602 gnus-message-archive-method))))
3603 (and active
3604 (file-exists-p active))))))
3606 (defsubst gnus-method-to-server-name (method)
3607 (concat
3608 (format "%s" (car method))
3609 (when (and
3610 (or (assoc (format "%s" (car method))
3611 (gnus-methods-using 'address))
3612 (gnus-server-equal method gnus-message-archive-method))
3613 (nth 1 method)
3614 (not (string= (nth 1 method) "")))
3615 (concat "+" (nth 1 method)))))
3617 (defsubst gnus-method-to-full-server-name (method)
3618 (format "%s+%s" (car method) (nth 1 method)))
3620 (defun gnus-group-prefixed-name (group method &optional full)
3621 "Return the whole name from GROUP and METHOD.
3622 Call with full set to get the fully qualified group name (even if the
3623 server is native)."
3624 (when (stringp method)
3625 (setq method (gnus-server-to-method method)))
3626 (if (or (not method)
3627 (and (not full) (gnus-server-equal method "native"))
3628 ;;;!!! This might not be right. We'll see...
3629 ;(string-match ":" group)
3630 )
3631 group
3632 (concat (gnus-method-to-server-name method) ":" group)))
3634 (defun gnus-group-guess-prefixed-name (group)
3635 "Guess the whole name from GROUP and METHOD."
3636 (gnus-group-prefixed-name group (gnus-find-method-for-group
3637 group)))
3639 (defun gnus-group-full-name (group method)
3640 "Return the full name from GROUP and METHOD, even if the method is native."
3641 (gnus-group-prefixed-name group method t))
3643 (defun gnus-group-guess-full-name (group)
3644 "Guess the full name from GROUP, even if the method is native."
3645 (if (gnus-group-prefixed-p group)
3646 group
3647 (gnus-group-full-name group (gnus-find-method-for-group group))))
3649 (defun gnus-group-guess-full-name-from-command-method (group)
3650 "Guess the full name from GROUP, even if the method is native."
3651 (if (gnus-group-prefixed-p group)
3652 group
3653 (gnus-group-full-name group gnus-command-method)))
3655 (defun gnus-group-real-prefix (group)
3656 "Return the prefix of the current group name."
3657 (if (stringp group)
3658 (if (string-match "^[^:]+:" group)
3659 (substring group 0 (match-end 0))
3660 "")
3661 nil))
3663 (defun gnus-group-short-name (group)
3664 "Return the short group name."
3665 (let ((prefix (gnus-group-real-prefix group)))
3666 (if (< 0 (length prefix))
3667 (substring group (length prefix) nil)
3668 group)))
3670 (defun gnus-group-prefixed-p (group)
3671 "Return the prefix of the current group name."
3672 (< 0 (length (gnus-group-real-prefix group))))
3674 (defun gnus-summary-buffer-name (group)
3675 "Return the summary buffer name of GROUP."
3676 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3678 (defun gnus-group-method (group)
3679 "Return the server or method used for selecting GROUP.
3680 You should probably use `gnus-find-method-for-group' instead."
3681 (let ((prefix (gnus-group-real-prefix group)))
3682 (if (equal prefix "")
3683 gnus-select-method
3684 (let ((servers gnus-opened-servers)
3685 (server "")
3686 backend possible found)
3688 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3689 server (substring prefix (match-end 0) (1- (length prefix))))
3690 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3691 (while servers
3692 (when (eq (caaar servers) backend)
3693 (setq possible (caar servers))
3694 (when (equal (cadaar servers) server)
3695 (setq found (caar servers))))
3696 (pop servers))
3697 (or (car (rassoc found gnus-server-alist))
3698 found
3699 (car (rassoc possible gnus-server-alist))
3700 possible
3701 (list backend server))))))
3703 (defsubst gnus-native-method-p (method)
3704 "Return whether METHOD is the native select method."
3705 (gnus-method-equal method gnus-select-method))
3707 (defsubst gnus-secondary-method-p (method)
3708 "Return whether METHOD is a secondary select method."
3709 (let ((methods gnus-secondary-select-methods)
3710 (gmethod (inline (gnus-server-get-method nil method))))
3711 (while (and methods
3712 (not (gnus-method-equal
3713 (inline (gnus-server-get-method nil (car methods)))
3714 gmethod)))
3715 (setq methods (cdr methods)))
3716 methods))
3718 (defun gnus-method-simplify (method)
3719 "Return the shortest uniquely identifying string or method for METHOD."
3720 (cond ((stringp method)
3721 method)
3722 ((gnus-native-method-p method)
3723 nil)
3724 ((gnus-secondary-method-p method)
3725 (format "%s:%s" (nth 0 method) (nth 1 method)))
3726 (t
3727 method)))
3729 (defun gnus-groups-from-server (server)
3730 "Return a list of all groups that are fetched from SERVER."
3731 (let ((alist (cdr gnus-newsrc-alist))
3732 info groups)
3733 (while (setq info (pop alist))
3734 (when (gnus-server-equal (gnus-info-method info) server)
3735 (push (gnus-info-group info) groups)))
3736 (sort groups 'string<)))
3738 (defun gnus-group-foreign-p (group)
3739 "Say whether a group is foreign or not."
3740 (and (not (gnus-group-native-p group))
3741 (not (gnus-group-secondary-p group))))
3743 (defun gnus-group-native-p (group)
3744 "Say whether the group is native or not."
3745 (not (string-match ":" group)))
3747 (defun gnus-group-secondary-p (group)
3748 "Say whether the group is secondary or not."
3749 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3751 (defun gnus-parameters-get-parameter (group)
3752 "Return the group parameters for GROUP from `gnus-parameters'."
3753 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3754 case-fold-search
3755 gnus-parameters-case-fold-search))
3756 params-list)
3757 (dolist (elem gnus-parameters)
3758 (when (string-match (car elem) group)
3759 (setq params-list
3760 (nconc (gnus-expand-group-parameters
3761 (car elem) (cdr elem) group)
3762 params-list))))
3763 params-list))
3765 (defun gnus-expand-group-parameter (match value group)
3766 "Use MATCH to expand VALUE in GROUP."
3767 (with-temp-buffer
3768 (insert group)
3769 (goto-char (point-min))
3770 (while (re-search-forward match nil t)
3771 (replace-match value))
3772 (buffer-string)))
3774 (defun gnus-expand-group-parameters (match parameters group)
3775 "Go through PARAMETERS and expand them according to the match data."
3776 (let (new)
3777 (dolist (elem parameters)
3778 (if (and (stringp (cdr elem))
3780 (push (cons (car elem)
3781 (gnus-expand-group-parameter match (cdr elem) group))
3782 new)
3783 (push elem new)))
3784 new))
3786 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3787 "For GROUP, return the value of SYMBOL.
3789 You should call this in the `gnus-group-buffer' buffer.
3790 The function `gnus-group-find-parameter' will do that for you."
3791 ;; The speed trick: No cons'ing and quit early.
3792 (let* ((params (funcall gnus-group-get-parameter-function group))
3793 ;; Start easy, check the "real" group parameters.
3794 (simple-results
3795 (gnus-group-parameter-value params symbol allow-list t)))
3796 (if simple-results
3797 ;; Found results; return them.
3798 (car simple-results)
3799 ;; We didn't found it there, try `gnus-parameters'.
3800 (let ((result nil)
3801 (head nil)
3802 (tail gnus-parameters))
3803 ;; A good old-fashioned non-cl loop.
3804 (while tail
3805 (setq head (car tail)
3806 tail (cdr tail))
3807 ;; The car is regexp matching for matching the group name.
3808 (when (string-match (car head) group)
3809 ;; The cdr is the parameters.
3810 (setq result (gnus-group-parameter-value (cdr head)
3811 symbol allow-list))
3812 (when result
3813 ;; Expand if necessary.
3815 (setq result (gnus-expand-group-parameter (car head)
3816 result group)))
3817 ;; Exit the loop early.
3818 (setq tail nil))))
3819 ;; Done.
3820 result))))
3822 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3823 "Return the group parameters for GROUP.
3824 If SYMBOL, return the value of that symbol in the group parameters.
3826 If you call this function inside a loop, consider using the faster
3827 `gnus-group-fast-parameter' instead."
3828 (save-excursion
3829 (set-buffer gnus-group-buffer)
3830 (if symbol
3831 (gnus-group-fast-parameter group symbol allow-list)
3832 (nconc
3833 (copy-sequence
3834 (funcall gnus-group-get-parameter-function group))
3835 (gnus-parameters-get-parameter group)))))
3837 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3838 "Return the group parameters for GROUP.
3839 If SYMBOL, return the value of that symbol in the group parameters.
3840 If ALLOW-LIST, also allow list as a result.
3841 Most functions should use `gnus-group-find-parameter', which
3842 also examines the topic parameters."
3843 (let ((params (gnus-info-params (gnus-get-info group))))
3844 (if symbol
3845 (gnus-group-parameter-value params symbol allow-list)
3846 params)))
3848 (defun gnus-group-parameter-value (params symbol &optional
3849 allow-list present-p)
3850 "Return the value of SYMBOL in group PARAMS.
3851 If ALLOW-LIST, also allow list as a result."
3852 ;; We only wish to return group parameters (dotted lists) and
3853 ;; not local variables, which may have the same names.
3854 ;; But first we handle single elements...
3855 (or (car (memq symbol params))
3856 ;; Handle alist.
3857 (let (elem)
3858 (catch 'found
3859 (while (setq elem (pop params))
3860 (when (and (consp elem)
3861 (eq (car elem) symbol)
3862 (or allow-list
3863 (atom (cdr elem))))
3864 (throw 'found (if present-p (list (cdr elem))
3865 (cdr elem)))))))))
3867 (defun gnus-group-add-parameter (group param)
3868 "Add parameter PARAM to GROUP."
3869 (let ((info (gnus-get-info group)))
3870 (when info
3871 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3872 ;; Cons the new param to the old one and update.
3873 (gnus-group-set-info (cons param (gnus-info-params info))
3874 group 'params))))
3876 (defun gnus-group-set-parameter (group name value)
3877 "Set parameter NAME to VALUE in GROUP."
3878 (let ((info (gnus-get-info group)))
3879 (when info
3880 (gnus-group-remove-parameter group name)
3881 (let ((old-params (gnus-info-params info))
3882 (new-params (list (cons name value))))
3883 (while old-params
3884 (when (or (not (listp (car old-params)))
3885 (not (eq (caar old-params) name)))
3886 (setq new-params (append new-params (list (car old-params)))))
3887 (setq old-params (cdr old-params)))
3888 (gnus-group-set-info new-params group 'params)))))
3890 (defun gnus-group-remove-parameter (group name)
3891 "Remove parameter NAME from GROUP."
3892 (let ((info (gnus-get-info group)))
3893 (when info
3894 (let ((params (gnus-info-params info)))
3895 (when params
3896 (setq params (delq name params))
3897 (while (assq name params)
3898 (gnus-pull name params))
3899 (gnus-info-set-params info params))))))
3901 (defun gnus-group-add-score (group &optional score)
3902 "Add SCORE to the GROUP score.
3903 If SCORE is nil, add 1 to the score of GROUP."
3904 (let ((info (gnus-get-info group)))
3905 (when info
3906 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3908 (defun gnus-short-group-name (group &optional levels)
3909 "Collapse GROUP name LEVELS.
3910 Select methods are stripped and any remote host name is stripped down to
3911 just the host name."
3912 (let* ((name "")
3913 (foreign "")
3914 (depth 0)
3915 (skip 1)
3916 (levels (or levels
3917 gnus-group-uncollapsed-levels
3918 (progn
3920 (setq skip (match-end 0)
3921 depth (+ depth 1)))
3922 depth))))
3923 ;; Separate foreign select method from group name and collapse.
3924 ;; If method contains a server, collapse to non-domain server name,
3925 ;; otherwise collapse to select method.
3926 (let* ((colon (string-match ":" group))
3927 (server (and colon (substring group 0 colon)))
3928 (plus (and server (string-match "+" server))))
3929 (when server
3930 (if plus
3931 (setq foreign (substring server (+ 1 plus)
3933 group (substring group (+ 1 colon)))
3934 (setq foreign server
3935 group (substring group (+ 1 colon))))
3936 (setq foreign (concat foreign ":")))
3937 ;; Collapse group name leaving LEVELS uncollapsed elements
3938 (let* ((slist (split-string group "/"))
3939 (slen (length slist))
3941 (dlen (length dlist))
3942 glist
3943 glen
3944 gsep
3945 res)
3946 (if (> slen dlen)
3947 (setq glist slist
3948 glen slen
3949 gsep "/")
3950 (setq glist dlist
3951 glen dlen
3952 gsep "."))
3953 (setq levels (- glen levels))
3954 (dolist (g glist)
3955 (push (if (>= (decf levels) 0)
3956 (if (zerop (length g))
3957 ""
3958 (substring g 0 1))
3959 g)
3960 res))
3961 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3963 (defun gnus-narrow-to-body ()
3964 "Narrow to the body of an article."
3965 (narrow-to-region
3966 (progn
3967 (goto-char (point-min))
3969 (point-max)))
3970 (point-max)))
3972 \f
3973 ;;;
3974 ;;; Kill file handling.
3975 ;;;
3977 (defun gnus-apply-kill-file ()
3978 "Apply a kill file to the current newsgroup.
3979 Returns the number of articles marked as read."
3980 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3981 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3982 (gnus-apply-kill-file-internal)
3983 0))
3985 (defun gnus-kill-save-kill-buffer ()
3986 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3987 (when (get-file-buffer file)
3988 (save-excursion
3989 (set-buffer (get-file-buffer file))
3990 (when (buffer-modified-p)
3991 (save-buffer))
3992 (kill-buffer (current-buffer))))))
3994 (defcustom gnus-kill-file-name "KILL"
3995 "Suffix of the kill files."
3996 :group 'gnus-score-kill
3997 :group 'gnus-score-files
3998 :type 'string)
4000 (defun gnus-newsgroup-kill-file (newsgroup)
4001 "Return the name of a kill file name for NEWSGROUP.
4002 If NEWSGROUP is nil, return the global kill file name instead."
4003 (cond
4004 ;; The global KILL file is placed at top of the directory.
4005 ((or (null newsgroup)
4006 (string-equal newsgroup ""))
4007 (expand-file-name gnus-kill-file-name
4008 gnus-kill-files-directory))
4009 ;; Append ".KILL" to newsgroup name.
4010 ((gnus-use-long-file-name 'not-kill)
4011 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4012 "." gnus-kill-file-name)
4013 gnus-kill-files-directory))
4014 ;; Place "KILL" under the hierarchical directory.
4015 (t
4016 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4017 "/" gnus-kill-file-name)
4018 gnus-kill-files-directory))))
4020 ;;; Server things.
4022 (defun gnus-member-of-valid (symbol group)
4024 (memq symbol (assoc
4025 (symbol-name (car (gnus-find-method-for-group group)))
4026 gnus-valid-select-methods)))
4028 (defun gnus-method-option-p (method option)
4029 "Return non-nil if select METHOD has OPTION as a parameter."
4030 (when (stringp method)
4031 (setq method (gnus-server-to-method method)))
4032 (memq option (assoc (format "%s" (car method))
4033 gnus-valid-select-methods)))
4035 (defun gnus-similar-server-opened (method)
4036 (let ((opened gnus-opened-servers))
4037 (while (and method opened)
4038 (when (and (equal (cadr method) (cadaar opened))
4039 (equal (car method) (caaar opened))
4040 (not (equal method (caar opened))))
4041 (setq method nil))
4042 (pop opened))
4043 (not method)))
4045 (defun gnus-server-extend-method (group method)
4046 ;; This function "extends" a virtual server. If the server is
4047 ;; "hello", and the select method is ("hello" (my-var "something"))
4048 ;; in the group "alt.alt", this will result in a new virtual server
4049 ;; called "hello+alt.alt".
4050 (if (or (not (inline (gnus-similar-server-opened method)))
4051 (not (cddr method)))
4052 method
4053 `(,(car method) ,(concat (cadr method) "+" group)
4054 (,(intern (format "%s-address" (car method))) ,(cadr method))
4055 ,@(cddr method))))
4057 (defun gnus-server-status (method)
4058 "Return the status of METHOD."
4059 (nth 1 (assoc method gnus-opened-servers)))
4061 (defun gnus-group-name-to-method (group)
4062 "Guess a select method based on GROUP."
4063 (if (string-match ":" group)
4064 (let ((server (substring group 0 (match-beginning 0))))
4066 (list (intern (substring server 0 (match-beginning 0)))
4067 (substring server (match-end 0)))
4068 (list (intern server) "")))
4069 gnus-select-method))
4071 (defun gnus-server-string (server)
4072 "Return a readable string that describes SERVER."
4073 (let* ((server (gnus-server-to-method server))
4074 (address (nth 1 server)))
4075 (if (and address
4076 (not (zerop (length address))))
4077 (format "%s using %s" address (car server))
4078 (format "%s" (car server)))))
4080 (defun gnus-find-method-for-group (group &optional info)
4081 "Find the select method that GROUP uses."
4082 (or gnus-override-method
4083 (and (not group)
4084 gnus-select-method)
4085 (and (not (gnus-group-entry group))
4086 ;; Killed or otherwise unknown group.
4087 (or
4088 ;; If we know a virtual server by that name, return its method.
4089 (gnus-server-to-method (gnus-group-server group))
4090 ;; Guess a new method as last resort.
4091 (gnus-group-name-to-method group)))
4092 (let ((info (or info (gnus-get-info group)))
4093 method)
4094 (if (or (not info)
4095 (not (setq method (gnus-info-method info)))
4096 (equal method "native"))
4097 gnus-select-method
4098 (setq method
4099 (cond ((stringp method)
4100 (inline (gnus-server-to-method method)))
4101 ((stringp (cadr method))
4102 (inline (gnus-server-extend-method group method)))
4103 (t
4104 method)))
4105 (cond ((equal (cadr method) "")
4106 method)
4107 ((null (cadr method))
4108 (list (car method) ""))
4109 (t
4110 (gnus-server-add-address method)))))))
4112 (defun gnus-methods-using (feature)
4113 "Find all methods that have FEATURE."
4114 (let ((valids gnus-valid-select-methods)
4115 outs)
4116 (while valids
4117 (when (memq feature (car valids))
4118 (push (car valids) outs))
4119 (setq valids (cdr valids)))
4120 outs))
4122 (eval-and-compile
4123 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4125 (defun gnus-read-group (prompt &optional default)
4126 "Prompt the user for a group name.
4127 Disallow invalid group names."
4128 (let ((prefix "")
4129 group)
4130 (while (not group)
4131 (when (string-match
4132 gnus-invalid-group-regexp
4133 (setq group (read-string (concat prefix prompt)
4134 (cons (or default "") 0)
4135 'gnus-group-history)))
4136 (let ((match (match-string 0 group)))
4137 ;; Might be okay (e.g. for nnimap), so ask the user:
4139 (message-y-or-n-p
4140 "Proceed and create group anyway? " t
4143 Usually, it's dangerous to create a group with this name, because it's not
4144 supported by all back ends and servers. On IMAP servers it should work,
4145 though. If you are really sure, you can proceed anyway and create the group.
4147 You may customize the variable `gnus-invalid-group-regexp', which currently is
4151 group nil)))))
4152 group))
4154 (defun gnus-read-method (prompt)
4155 "Prompt the user for a method.
4156 Allow completion over sensible values."
4157 (let* ((open-servers
4158 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4159 gnus-opened-servers))
4160 (valid-methods
4161 (let (methods)
4162 (dolist (method gnus-valid-select-methods)
4163 (if (or (memq 'prompt-address method)
4164 (not (assoc (format "%s:" (car method)) open-servers)))
4165 (push method methods)))
4166 methods))
4167 (servers
4168 (append valid-methods
4169 open-servers
4170 gnus-predefined-server-alist
4171 gnus-server-alist))
4172 (method
4173 (completing-read
4174 prompt servers
4175 nil t nil 'gnus-method-history)))
4176 (cond
4177 ((equal method "")
4178 (setq method gnus-select-method))
4179 ((assoc method gnus-valid-select-methods)
4180 (let ((address (if (memq 'prompt-address
4181 (assoc method gnus-valid-select-methods))
4182 (read-string "Address: ")
4183 "")))
4184 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4185 (list (intern method) address))))
4186 ((assoc method servers)
4187 method)
4188 (t
4189 (list (intern method) "")))))
4191 ;;; Agent functions
4193 (defun gnus-agent-method-p (method)
4194 "Say whether METHOD is covered by the agent."
4195 (or (eq (car gnus-agent-method-p-cache) method)
4196 (setq gnus-agent-method-p-cache
4197 (cons method
4198 (member (if (stringp method)
4199 method
4200 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4201 (cdr gnus-agent-method-p-cache))
4203 (defun gnus-online (method)
4204 (not
4205 (if gnus-plugged
4206 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4207 (gnus-agent-method-p method))))
4209 ;;; User-level commands.
4211 ;;;###autoload
4212 (defun gnus-slave-no-server (&optional arg)
4213 "Read network news as a slave, without connecting to the local server."
4214 (interactive "P")
4215 (gnus-no-server arg t))
4217 ;;;###autoload
4218 (defun gnus-no-server (&optional arg slave)
4219 "Read network news.
4220 If ARG is a positive number, Gnus will use that as the startup
4221 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4222 non-nil and not a positive number, Gnus will prompt the user for the
4223 name of an NNTP server to use.
4224 As opposed to `gnus', this command will not connect to the local
4225 server."
4226 (interactive "P")
4227 (gnus-no-server-1 arg slave))
4229 ;;;###autoload
4230 (defun gnus-slave (&optional arg)
4231 "Read news as a slave."
4232 (interactive "P")
4233 (gnus arg nil 'slave))
4235 ;;;###autoload
4236 (defun gnus-other-frame (&optional arg display)
4237 "Pop up a frame to read news.
4238 This will call one of the Gnus commands which is specified by the user
4239 option `gnus-other-frame-function' (default `gnus') with the argument
4240 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4241 optional second argument DISPLAY should be a standard display string
4243 omitted or the function `make-frame-on-display' is not available, the
4244 current display is used."
4245 (interactive "P")
4246 (if (fboundp 'make-frame-on-display)
4247 (unless display
4248 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4249 (setq display nil))
4250 (let ((alive (gnus-alive-p)))
4251 (unless (and alive
4252 (catch 'found
4253 (walk-windows
4254 (lambda (window)
4255 (when (and (or (not display)
4256 (equal display
4257 (gnus-frame-or-window-display-name
4258 window)))
4259 (with-current-buffer (window-buffer window)
4261 (symbol-name major-mode))))
4262 (gnus-select-frame-set-input-focus
4263 (setq gnus-other-frame-object (window-frame window)))
4264 (select-window window)
4265 (throw 'found t)))
4266 'ignore t)))
4267 (gnus-select-frame-set-input-focus
4268 (setq gnus-other-frame-object
4269 (if display
4270 (make-frame-on-display display gnus-other-frame-parameters)
4271 (make-frame gnus-other-frame-parameters))))
4272 (if alive
4273 (switch-to-buffer gnus-group-buffer)
4274 (funcall gnus-other-frame-function arg)
4275 (add-hook 'gnus-exit-gnus-hook
4276 '(lambda nil
4277 (when (and (frame-live-p gnus-other-frame-object)
4278 (cdr (frame-list)))
4279 (delete-frame gnus-other-frame-object))
4280 (setq gnus-other-frame-object nil)))))))
4282 ;;;###autoload
4283 (defun gnus (&optional arg dont-connect slave)
4284 "Read network news.
4285 If ARG is non-nil and a positive number, Gnus will use that as the
4286 startup level. If ARG is non-nil and not a positive number, Gnus will
4287 prompt the user for the name of an NNTP server to use."
4288 (interactive "P")
4289 (unless (byte-code-function-p (symbol-function 'gnus))
4290 (message "You should byte-compile Gnus")
4291 (sit-for 2))
4292 (gnus-1 arg dont-connect slave))
4294 ;; Allow redefinition of Gnus functions.
4296 (gnus-ems-redefine)
4298 (provide 'gnus)
4300 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4301 ;;; gnus.el ends here