| blob | bd96e52d65f13ff316267e0d10fa4249d2f23086 |
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
52 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
57 "Starting your favorite newsreader."
61 "Dealing with formatting issues."
65 "Group character set issues."
71 "Cache interface."
76 "Article Registry."
80 "Server options at startup."
83 ;; These belong to gnus-group.el.
85 "Group buffers."
90 "Foreign groups."
95 "Automatic subscription of new groups."
99 "Group levels."
104 "Selecting a Group."
109 "Showing slices of the group list."
114 "Sorting the group buffer."
120 "Various group options."
124 ;; These belong to gnus-sum.el.
126 "Summary buffers."
131 "Leaving summary buffers."
136 "Marks used in summary buffers."
141 "Ordering articles according to replies."
146 "Formatting of the summary buffer."
151 "Choosing Articles."
156 "Summary movement commands."
161 "Show pictures of people, domains, and newsgroups."
165 "Mail group commands."
170 "Sorting the summary buffer."
175 "Highlighting and menus in the summary buffer."
181 "Various summary buffer options."
186 "Pick mode in the summary buffer."
192 "Tree display of threads in the summary buffer."
197 ;; Belongs to gnus-uu.el
199 "Viewing extracted files."
203 ;; Belongs to gnus-score.el
205 "Score and kill file handling."
209 "Kill files."
213 "Adaptive score files."
217 "Default values for score files."
221 "Expiring score rules."
225 "Decaying score rules."
229 "Score and kill file names."
234 "Various scoring and killing options."
237 ;; Other
239 "Options controlling the visual fluff."
244 "Offline support for Gnus."
248 "Files used by Gnus."
252 "Auto save file."
257 "Storing Gnus state."
261 "Options related to newsservers and other servers used by Gnus."
265 "Highlighting and menus in the server buffer."
270 "Composing replies and followups in Gnus."
274 "Meta variables controlling major portions of Gnus.
275 In general, modifying these variables does not take affect until Gnus
276 is restarted, and sometimes reloaded."
280 "Other Gnus options."
285 "Exiting Gnus."
290 "Frivolous Gnus extensions."
301 "If non-nil, the startup message will not be displayed.
302 This variable is used before `.gnus.el' is loaded, so it should
303 be set in `.emacs' instead."
308 "If non-nil, play the Gnus jingle at startup."
338 0 5
347 gnus-mode-line-image-cache)
349 "This is %s, %s."
351 str)
353 line)))
359 ;;(defalias 'gnus-decode-rfc1522 'ignore)
360 )
362 ;; We define these group faces here to avoid the display
363 ;; update forced when creating new faces.
373 ()))
374 "Level 1 newsgroup face."
376 ;; backward-compatibility alias
387 ()))
388 "Level 1 empty newsgroup face."
390 ;; backward-compatibility alias
401 ()))
402 "Level 2 newsgroup face."
404 ;; backward-compatibility alias
415 ()))
416 "Level 2 empty newsgroup face."
418 ;; backward-compatibility alias
429 ()))
430 "Level 3 newsgroup face."
432 ;; backward-compatibility alias
438 ())
441 ())
443 ()))
444 "Level 3 empty newsgroup face."
446 ;; backward-compatibility alias
457 ()))
458 "Level 4 newsgroup face."
460 ;; backward-compatibility alias
466 ())
469 ())
471 ()))
472 "Level 4 empty newsgroup face."
474 ;; backward-compatibility alias
485 ()))
486 "Level 5 newsgroup face."
488 ;; backward-compatibility alias
494 ())
497 ())
499 ()))
500 "Level 5 empty newsgroup face."
502 ;; backward-compatibility alias
513 ()))
514 "Level 6 newsgroup face."
516 ;; backward-compatibility alias
522 ())
525 ())
527 ()))
528 "Level 6 empty newsgroup face."
530 ;; backward-compatibility alias
541 ()))
542 "Low level newsgroup face."
544 ;; backward-compatibility alias
555 ()))
556 "Low level empty newsgroup face."
558 ;; backward-compatibility alias
570 "Level 1 mailgroup face."
572 ;; backward-compatibility alias
584 "Level 1 empty mailgroup face."
586 ;; backward-compatibility alias
598 "Level 2 mailgroup face."
600 ;; backward-compatibility alias
612 "Level 2 empty mailgroup face."
614 ;; backward-compatibility alias
626 "Level 3 mailgroup face."
628 ;; backward-compatibility alias
639 ()))
640 "Level 3 empty mailgroup face."
642 ;; backward-compatibility alias
654 "Low level mailgroup face."
656 ;; backward-compatibility alias
668 "Low level empty mailgroup face."
670 ;; backward-compatibility alias
673 ;; Summary mode faces.
676 "Face used for selected articles."
678 ;; backward-compatibility alias
684 "Face used for cancelled articles."
686 ;; backward-compatibility alias
698 "Face used for high interest ticked articles."
700 ;; backward-compatibility alias
712 "Face used for low interest ticked articles."
714 ;; backward-compatibility alias
725 ()))
726 "Face used for normal interest ticked articles."
728 ;; backward-compatibility alias
740 "Face used for high interest ancient articles."
742 ;; backward-compatibility alias
754 "Face used for low interest ancient articles."
756 ;; backward-compatibility alias
767 ()))
768 "Face used for normal interest ancient articles."
770 ;; backward-compatibility alias
780 "Face used for high interest uncached articles."
782 ;; backward-compatibility alias
792 "Face used for low interest uncached articles."
794 ;; backward-compatibility alias
804 "Face used for normal interest uncached articles."
806 ;; backward-compatibility alias
812 "Face used for high interest unread articles."
814 ;; backward-compatibility alias
820 "Face used for low interest unread articles."
822 ;; backward-compatibility alias
827 ()))
828 "Face used for normal interest unread articles."
830 ;; backward-compatibility alias
844 "Face used for high interest read articles."
846 ;; backward-compatibility alias
860 "Face used for low interest read articles."
862 ;; backward-compatibility alias
873 ()))
874 "Face used for normal interest read articles."
876 ;; backward-compatibility alias
880 ;;;
881 ;;; Gnus buffers
882 ;;;
887 "Do the same as `get-buffer-create', but store the created buffer."
892 "Add the current buffer to the list of Gnus buffers."
896 "Kill BUFFER and remove from the list of Gnus buffers."
903 "Return a list of live Gnus buffers."
912 gnus-buffers)
914 ;;; Splash screen.
929 ()))
930 "Face for the splash screen."
932 ;; backward-compatibility alias
947 "Indent rigidly using only spaces and no tabs."
953 ;; We translate tabs into spaces -- not everybody uses
954 ;; an 8-character tab.
961 ;;(format "%02x%02x%02x" 114 66 20) "724214"
985 "*Color styles used for the Gnus logo."
987 gnus-logo-color-alist))
995 "Insert startup message in current buffer."
996 ;; Insert the message.
1010 :color-symbols
1016 ;; Account for the pbm's blackground.
1020 ;; Account for the xbm's blackground.
1031 t))))
1035 _ ___ _ _
1036 _ ___ __ ___ __ _ ___
1037 __ _ ___ __ ___
1038 _ ___ _
1039 _ _ __ _
1040 ___ __ _
1041 __ _
1042 _ _ _
1043 _ _ _
1044 _ _ _
1045 __ ___
1046 _ _ _ _
1047 _ _
1048 _ _
1049 _ _
1050 _
1051 __
1053 "
1055 ;; And then hack it.
1064 ;; Fontify some.
1078 ;;; Do the rest.
1084 "Alist of group parameters.
1086 For example:
1088 (gnus-use-scoring nil)
1089 (gnus-summary-line-format
1091 (gcc-self . t)
1092 (display . all))
1095 (broken-reply-to . t)))"
1102 "If it is t, ignore case of group names specified in `gnus-parameters'.
1103 If it is nil, don't ignore case. If it is `default', which is for the
1104 backward compatibility, use the value of `case-fold-search'."
1115 "Define a group parameter PARAM.
1116 REST is a plist of following:
1117 :type One of `bool', `list' or nil.
1118 :function The name of the function.
1119 :function-document The documentation of the function.
1120 :parameter-type The type for customizing the parameter.
1121 :parameter-document The documentation for the parameter.
1122 :variable The name of the variable.
1123 :variable-document The documentation for the variable.
1124 :variable-group The group for customizing the variable.
1125 :variable-type The type for customizing the variable.
1126 :variable-default The default value of the variable."
1143 'progn
1145 ,variable-document
1151 gnus-group-parameters-more))
1154 ,parameter-type
1158 ,function-document
1160 val)
1163 t)
1168 (,variable
1170 elem value)
1178 ,function-document
1182 elem value)
1189 'value
1194 All other Gnus file and directory variables are initialized from this variable."
1200 "*Directory variable from which all other Gnus file variables are derived.
1202 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1203 This means that other directory variables that are initialized from
1204 this variable won't be set properly if you set this variable in `.gnus.el'.
1205 Set this variable in `.emacs' instead."
1210 "*Default directory for all Gnus buffers."
1213 directory))
1215 ;; Site dependent variables. These variables should be defined in
1216 ;; paths.el.
1219 "Specify a default NNTP server.
1220 This variable should be defined in paths.el, and should never be set
1221 by the user.
1222 If you want to change servers, you should use `gnus-select-method'.
1225 ;; Don't touch this variable.
1228 This is an obsolete variable, which is scarcely used. If you use an
1229 nntp server for your newsgroup and want to change the port number
1230 used to 899, you would say something along these lines:
1235 "A file with only the name of the nntp server in it."
1241 "Find default nntp server.
1242 Check the NNTPSERVER environment variable and the
1243 `gnus-nntpserver-file' file."
1251 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1252 ;; starting or even loading Gnus.
1253 ;;;###autoload(when (fboundp 'custom-autoload)
1254 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1264 gnus-default-nntp-server)
1268 nil
1271 "Default method for selecting a newsgroup.
1272 This variable should be a list, where the first element is how the
1273 news is to be fetched, the second is the address.
1276 NNTP, you could say:
1280 If you want to use your local spool, say:
1282 \(setq gnus-select-method (list 'nnspool (system-name)))
1284 If you use this variable, you must set `gnus-nntp-server' to nil.
1286 There is a lot more to know about select methods and virtual servers -
1287 see the manual for details."
1294 "*Method used for archiving messages you've sent.
1295 This should be a mail method.
1297 See also `gnus-update-message-archive-method'."
1301 gnus-select-method))
1306 The archive method is initially set according to the value of
1308 so that it may be used as a real method of the server which is named
1310 updated if the value of this variable is nil, even if you change the
1311 value of `gnus-message-archive-method' afterward. If you want the
1313 `gnus-message-archive-method', set this variable to a non-nil value."
1320 "*Name of the group in which to save the messages you've written.
1321 This can either be a string; a list of strings; or an alist
1322 of regexps/functions/forms to be evaluated to return a string (or a list
1323 of strings). The functions are called with the name of the current
1324 group (or nil) as a parameter.
1326 If you want to save your mail in one group and the news articles you
1327 write in another group, you could say something like:
1329 \(setq gnus-message-archive-group
1330 '((if (message-news-p)
1334 Normally the group names returned by this variable should be
1336 However, you may wish to store the message on some other server. In
1337 that case, just return a fully prefixed name of the group --
1341 function
1342 sexp
1343 string))
1346 "List of NNTP servers that the user can choose between interactively.
1347 To make Gnus query you for a server, you have to give `gnus' a
1348 non-numeric prefix - `C-u M-x gnus', in short."
1353 "*The name of the host running the NNTP server.
1354 This variable is semi-obsolete. Use the `gnus-select-method'
1355 variable instead."
1358 string))
1361 "A list of secondary methods that will be used for reading news.
1362 This is a list where each element is a complete select method (see
1363 `gnus-select-method').
1365 If, for instance, you want to read your mail with the nnml back end,
1366 you could set this variable:
1374 "Default default new newsgroups the first time Gnus is run.
1378 "Local domain name without a host name.
1379 The DOMAINNAME environment variable is used instead if it is defined.
1380 If the function `system-name' returns the full Internet name, there is
1381 no need to set this variable."
1384 string))
1387 "String with a description of what organization (if any) the user belongs to.
1390 ;; Customization variables
1393 "Preferred method for fetching an article by Message-ID.
1394 If you are reading news from the local spool (with nnspool), fetching
1395 articles by Message-ID is painfully slow. By setting this method to an
1396 nntp method, you might get acceptable results.
1398 The value of this variable must be a valid select method as discussed
1399 in the documentation of `gnus-select-method'.
1401 It can also be a list of select methods, as well as the special symbol
1402 `current', which means to use the current select method. If it is a
1403 list, Gnus will try all the methods in the list until it finds a match."
1408 gnus-select-method
1416 gnus-select-method))))
1420 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1421 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1422 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1423 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1424 "/ftp@rtfm.mit.edu:/pub/usenet/"
1425 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1426 "/ftp@ftp.sunet.se:/pub/usenet/"
1427 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1428 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1430 "*Directory where the group FAQs are stored.
1431 This will most commonly be on a remote machine, and the file will be
1432 fetched by ange-ftp.
1434 This variable can also be a list of directories. In that case, the
1435 first element in the list will be used by default. The others can
1436 be used when being prompted for a site.
1438 Note that Gnus uses an aol machine as the default directory. If this
1439 feels fundamentally unclean, just think of it as a way to finally get
1440 something of value back from them.
1442 If the default site is too slow, try one of these:
1444 North America: mirrors.aol.com /pub/rtfm/usenet
1445 ftp.seas.gwu.edu /pub/rtfm
1446 rtfm.mit.edu /pub/usenet
1447 Europe: ftp.uni-paderborn.de /pub/FAQ
1448 src.doc.ic.ac.uk /usenet/news-FAQS
1449 ftp.sunet.se /pub/usenet
1450 ftp.pasteur.fr /pub/FAQ
1451 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1452 hwarang.postech.ac.kr /pub/usenet
1453 ftp.hk.super.net /mirror/faqs"
1480 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1481 When FORM is evaluated `name' is bound to the name of the group."
1488 "*Non-nil means that control messages are displayed using `browse-url'.
1489 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1490 group."
1496 "*Non-nil means that cross referenced articles will be marked as read.
1497 If nil, ignore cross references. If t, mark articles as read in
1498 subscribed newsgroups. If neither t nor nil, mark as read in all
1499 newsgroups."
1507 "*Process mark."
1513 "*The number of articles which indicates a large newsgroup.
1514 If the number of articles in a newsgroup is greater than this value,
1515 confirmation is required for selecting the newsgroup.
1516 If it is nil, no confirmation is required."
1519 integer))
1522 "*Non-nil means that the default name of a file to save articles in is the group name.
1523 If it's nil, the directory form of the group name is used instead.
1525 If this variable is a list, and the list contains the element
1526 `not-score', long file names will not be used for score files; if it
1527 contains the element `not-save', long file names will not be used for
1528 saving; and if it contains the element `not-kill', long file names
1529 will not be used for kill files.
1531 Note that the default for this variable varies according to what system
1532 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1533 to nil while on all other systems it defaults to t."
1551 "*If non-nil, save group scoring info."
1557 "*If non-nil, allow undoing in Gnus group mode buffers."
1562 "*If non-nil, use some adaptive scoring scheme.
1563 If a list, then the values `word' and `line' are meaningful. The
1564 former will perform adaption on individual words in the subject
1565 header while `line' will perform adaption on several headers."
1571 "*If nil, Gnus will ignore the article cache.
1572 If `passive', it will allow entering (and reading) articles
1573 explicitly entered into the cache. If anything else, use the
1574 cache to the full extent of the law."
1582 "*If non-nil, display a thread tree buffer."
1587 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1588 If it is a number N, then Gnus will only keep the last N articles
1589 read. If it is neither nil nor a number, Gnus will keep all read
1590 articles. This is not a good idea."
1593 integer
1598 "*If non-nil, Gnus will read NoCeM cancel messages.
1599 You can also set this variable to a positive number as a group level.
1600 In that case, Gnus scans NoCeM messages when checking new news if this
1601 value is not exceeding a group level that you specify as the prefix
1602 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1603 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1604 level to those commands."
1613 gnus-level-default-subscribed
1617 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1622 "*If non-nil, enable scoring."
1628 "*A hook called when preparing to exit from the summary buffer.
1629 It calls `gnus-summary-expire-articles' by default."
1634 "*Non-nil means that you are a Usenet novice.
1635 If non-nil, verbose messages may be displayed and confirmations may be
1636 required."
1641 "*Non-nil means that you will never be asked for confirmation about anything.
1642 That doesn't mean *anything* anything; particularly destructive
1643 commands will still require prompting."
1648 "*If non-nil, require your confirmation when catching up a group."
1653 "*If non-nil, require your confirmation when exiting Gnus."
1658 "*Function for extracting address components from a From header.
1659 Two pre-defined function exist: `gnus-extract-address-components',
1660 which is the default, quite fast, and too simplistic solution, and
1661 `mail-extract-address-components', which works much better, but is
1662 slower."
1669 "*If non-nil, display clickable icons."
1674 "String used to separate shell commands."
1706 "*An alist of valid select methods.
1707 The first element of each list lists should be a string with the name
1708 of the select method. The other elements may be the category of
1709 this method (i. e., `post', `mail', `none' or whatever) or other
1710 properties that this method has (like being respoolable).
1711 If you implement a new select method, all you should have to change is
1712 this variable. I think."
1727 "Recomputes the select-method widget based on the value of
1728 `gnus-valid-select-methods'."
1730 "Widget for entering a select method."
1737 gnus-valid-select-methods)
1741 :inline t
1743 variable
1749 "List of buffers that should update their mode lines.
1750 The list may contain the symbols `group', `article', `tree' and
1751 `summary'. If the corresponding symbol is present, Gnus will keep
1752 that mode line updated with information that may be pertinent.
1753 If this variable is nil, screen refresh may be quicker."
1760 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1762 "*Max length of mode-line non-string contents.
1763 If this is nil, Gnus will take space as is needed, leaving the rest
1764 of the mode line intact. Note that the default of nil is unlikely
1765 to be desirable; see the manual for further details."
1768 integer))
1770 ;; There should be special validation for this.
1775 to-address
1776 :function-document
1777 "Return GROUP's to-address."
1778 :variable-document
1779 "*Alist of group regexps and correspondent to-addresses."
1780 :variable-group gnus-group-parameter
1783 This will be used when doing followups and posts.
1785 This is primarily useful in mail groups that represent closed
1786 mailing lists--mailing lists where it's expected that everybody that
1787 writes to the mailing list is subscribed to it. Since using this
1788 parameter ensures that the mail only goes to the mailing list itself,
1789 it means that members won't receive two copies of your followups.
1791 Using `to-address' will actually work whether the group is foreign or
1792 not. Let's say there's a group on the server that is called
1793 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1794 articles from a mail-to-news gateway. Posting directly to this group
1795 is therefore impossible--you have to send mail to the mailing list
1796 address instead.
1798 The gnus-group-split mail splitting mechanism will behave as if this
1802 to-list
1803 :function-document
1804 "Return GROUP's to-list."
1805 :variable-document
1806 "*Alist of group regexps and correspondent to-lists."
1807 :variable-group gnus-group-parameter
1810 This address will be used when doing a `a' in the group.
1812 It is totally ignored when doing a followup--except that if it is
1813 present in a news group, you'll get mail group semantics when doing
1814 `f'.
1816 The gnus-group-split mail splitting mechanism will behave as if this
1820 subscribed
1821 :type bool
1822 :function-document
1823 "Return GROUP's subscription status."
1824 :variable-document
1825 "*Groups which are automatically considered subscribed."
1826 :variable-group gnus-group-parameter
1829 Gnus assumed that you are subscribed to the To/List address.
1831 When constructing a list of subscribed groups using
1832 `gnus-find-subscribed-addresses', Gnus includes the To address given
1836 auto-expire
1837 :type bool
1838 :function gnus-group-auto-expirable-p
1839 :function-document
1840 "Check whether GROUP is auto-expirable or not."
1841 :variable gnus-auto-expirable-newsgroups
1842 :variable-default nil
1843 :variable-document
1844 "*Groups in which to automatically mark read articles as expirable.
1845 If non-nil, this should be a regexp that should match all groups in
1846 which to perform auto-expiry. This only makes sense for mail groups."
1847 :variable-group nnmail-expire
1849 regexp)
1851 :parameter-document
1855 total-expire
1856 :type bool
1857 :function gnus-group-total-expirable-p
1858 :function-document
1859 "Check whether GROUP is total-expirable or not."
1860 :variable gnus-total-expirable-newsgroups
1861 :variable-default nil
1862 :variable-document
1863 "*Groups in which to perform expiry of all read articles.
1864 Use with extreme caution. All groups that match this regexp will be
1865 expiring - which means that all read articles will be deleted after
1866 \(say) one week. (This only goes for mail groups and the like, of
1867 course.)"
1868 :variable-group nnmail-expire
1870 regexp)
1872 :parameter-document
1873 "All read articles will be put through the expiry process
1875 This happens even if they are not marked as expirable.
1879 charset
1880 :function-document
1881 "Return the default charset of GROUP."
1882 :variable gnus-group-charset-alist
1883 :variable-default
1896 :variable-document
1897 "Alist of regexps (to match group names) and default charsets to be used when reading."
1898 :variable-group gnus-charset
1906 post-method
1907 :type list
1908 :function-document
1909 "Return a posting method for GROUP."
1910 :variable gnus-post-method-alist
1911 :variable-document
1912 "Alist of regexps (to match group names) and method to be used when
1913 posting an article."
1914 :variable-group gnus-group-foreign
1915 :parameter-type
1923 :parameter-document
1927 large-newsgroup-initial
1928 :type integer
1929 :function-document
1930 "Return GROUP's initial input of the number of articles."
1931 :variable-document
1932 "*Alist of group regexps and its initial input of the number of articles."
1933 :variable-group gnus-group-parameter
1939 This number will be prompted as the initial value of the number of
1940 articles to list when the group is a large newsgroup (see
1941 `gnus-large-newsgroup'). If it is nil, the default value is the
1944 ;; The Gnus registry's ignored groups
1946 registry-ignore
1947 :type list
1948 :function-document
1949 "Whether this group should be ignored by the registry."
1950 :variable gnus-registry-ignored-groups
1951 :variable-default nil
1952 :variable-document
1953 "*Groups in which the registry should be turned off."
1954 :variable-group gnus-registry
1961 :parameter-document
1964 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1966 "*Disable the group parameters for spam detection.
1967 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1974 "Spam group classification (requires spam.el).
1975 This group contains spam messages. On summary entry, unread messages
1976 will be marked as spam. On summary exit, the specified spam
1977 processors will be invoked on spam-marked messages, then those
1978 messages will be expired, so the spam processor will only see a
1982 "The ham value for the spam group parameter (requires spam.el).
1983 On summary exit, the specified ham processors will be invoked on
1984 ham-marked messages. Exercise caution, since the ham processor will
1985 see the same message more than once because there is no ham message
1989 spam-contents
1990 :type list
1991 :function-document
1992 "The spam type (spam, ham, or neither) of the group."
1993 :variable gnus-spam-newsgroup-contents
1994 :variable-default nil
1995 :variable-document
1996 "*Group classification (spam, ham, or neither). Only
1997 meaningful when spam.el is loaded. If non-nil, this should be a
1998 list of group name regexps associated with a classification for
1999 each one. In spam groups, new articles are marked as spam on
2000 summary entry. There is other behavior associated with ham and
2001 no classification when spam.el is loaded - see the manual."
2002 :variable-group spam
2016 :parameter-document
2017 "The spam classification (spam, ham, or neither) of this group.
2018 When a spam group is entered, all unread articles are marked as
2019 spam. There is other behavior associated with ham and no
2023 spam-resend-to
2024 :type list
2025 :function-document
2026 "The address to get spam resent (through spam-report-resend)."
2027 :variable gnus-spam-resend-to
2028 :variable-default nil
2029 :variable-document
2030 "The address to get spam resent (through spam-report-resend)."
2031 :variable-group spam
2035 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2036 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2037 :parameter-document
2041 ham-resend-to
2042 :type list
2043 :function-document
2044 "The address to get ham resent (through spam-report-resend)."
2045 :variable gnus-ham-resend-to
2046 :variable-default nil
2047 :variable-document
2048 "The address to get ham resent (through spam-report-resend)."
2049 :variable-group spam
2053 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2054 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2055 :parameter-document
2071 "OBSOLETE: The Gmane reporting summary exit spam processor.
2078 "OBSOLETE: The ifile summary exit ham processor.
2082 "OBSOLETE: The Bogofilter summary exit ham processor.
2086 "OBSOLETE: The spam-stat summary exit ham processor.
2090 "OBSOLETE: The whitelist summary exit ham processor.
2094 "OBSOLETE: The BBDB summary exit ham processor.
2098 "OBSOLETE: The ham copy exit ham processor.
2102 "OBSOLETE: The spamoracle summary exit ham processor.
2106 spam-process
2107 :type list
2108 :parameter-type
2111 :value nil
2148 :function-document
2149 "Which spam or ham processors will be applied when the summary is exited."
2150 :variable gnus-spam-process-newsgroups
2151 :variable-default nil
2152 :variable-document
2153 "*Groups in which to automatically process spam or ham articles with
2154 a backend on summary exit. If non-nil, this should be a list of group
2155 name regexps that should match all groups in which to do automatic
2156 spam processing, associated with the appropriate processor."
2157 :variable-group spam
2158 :variable-type
2199 :parameter-document
2203 spam-autodetect
2204 :type list
2205 :parameter-type
2207 :function-document
2208 "Should spam be autodetected (with spam-split) in this group?"
2209 :variable gnus-spam-autodetect
2210 :variable-default nil
2211 :variable-document
2212 "*Groups in which spam should be autodetected when they are entered.
2213 Only unseen articles will be examined, unless
2214 spam-autodetect-recheck-messages is set."
2215 :variable-group spam
2216 :variable-type
2221 boolean))
2222 :parameter-document
2223 "Spam autodetection.
2224 Only unseen articles will be examined, unless
2228 spam-autodetect-methods
2229 :type list
2230 :parameter-type
2253 :function-document
2254 "Methods to be used for autodetection in each group"
2255 :variable gnus-spam-autodetect-methods
2256 :variable-default nil
2257 :variable-document
2258 "*Methods for autodetecting spam per group.
2259 Requires the spam-autodetect parameter. Only unseen articles
2260 will be examined, unless spam-autodetect-recheck-messages is
2261 set."
2262 :variable-group spam
2263 :variable-type
2290 :parameter-document
2291 "Spam autodetection methods.
2292 Requires the spam-autodetect parameter. Only unseen articles
2293 will be examined, unless spam-autodetect-recheck-messages is
2297 spam-process-destination
2298 :type list
2299 :parameter-type
2305 :function-document
2306 "Where spam-processed articles will go at summary exit."
2307 :variable gnus-spam-process-destinations
2308 :variable-default nil
2309 :variable-document
2310 "*Groups in which to explicitly send spam-processed articles to
2311 another group, or expire them (the default). If non-nil, this should
2312 be a list of group name regexps that should match all groups in which
2313 to do spam-processed article moving, associated with the destination
2314 group or nil for explicit expiration. This only makes sense for
2315 mail groups."
2316 :variable-group spam
2317 :variable-type
2328 :parameter-document
2332 ham-process-destination
2333 :type list
2334 :parameter-type
2342 :function-document
2343 "Where ham articles will go at summary exit from a spam group."
2344 :variable gnus-ham-process-destinations
2345 :variable-default nil
2346 :variable-document
2347 "*Groups in which to explicitly send ham articles to
2348 another group, or do nothing (the default). If non-nil, this should
2349 be a list of group name regexps that should match all groups in which
2350 to do ham article moving, associated with the destination
2351 group or nil for explicit ignoring. This only makes sense for
2352 mail groups, and only works in spam groups."
2353 :variable-group spam
2354 :variable-type
2366 :parameter-document
2370 ham-marks
2381 :parameter-document
2382 "Marks considered ham (positively not spam). Such articles will be
2383 processed as ham (non-spam) on group exit. When nil, the global
2384 spam-ham-marks variable takes precedence."
2386 gnus-read-mark
2387 gnus-killed-mark
2388 gnus-kill-file-mark
2389 gnus-low-score-mark))))
2390 :variable-group spam
2391 :variable-document
2395 spam-marks
2404 :parameter-document
2405 "Marks considered spam.
2406 Such articles will be processed as spam on group exit. When nil, the global
2407 spam-spam-marks variable takes precedence."
2409 :variable-group spam
2410 :variable-document
2414 "Number of group name elements to leave alone when making a short group name."
2419 "*If non-nil, once you set a level, Gnus will use this level."
2423 ;; Hooks.
2426 "A hook run while Gnus is loaded."
2431 "A hook called to apply kill files to a group.
2432 This hook is intended to apply a kill file to the selected newsgroup.
2433 The function `gnus-apply-kill-file' is called by default.
2435 Since a general kill file is too heavy to use only for a few
2436 newsgroups, I recommend you to use a lighter hook function. For
2437 example, if you'd like to apply a kill file to articles which contains
2438 a string `rmgroup' in subject in newsgroup `control', you can use the
2439 following hook:
2441 (setq gnus-apply-kill-hook
2442 (list
2443 (lambda ()
2452 "Function run when a group level is changed.
2453 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2456 function))
2458 ;;; Face thingies.
2462 mouse-face
2463 summary-menu group-menu article-menu
2464 tree-highlight menu highlight
2465 browse-menu server-menu
2466 page-marker tree-menu binary-menu pick-menu)
2467 "*Enable visual features.
2468 If `visual' is disabled, there will be no menus and few faces. Most of
2469 the visual customization options below will be ignored. Gnus will use
2470 less space and be faster as a result.
2472 This variable can also be a list of visual elements to switch on. For
2473 instance, to switch off all visual things except menus, you can say:
2475 (setq gnus-visual '(menu))
2477 Valid elements include `summary-highlight', `group-highlight',
2478 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2479 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2480 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2500 ;; Byte-compiler warning.
2502 ;; Find out whether the gnus-visual TYPE is wanted.
2506 gnus-visual
2510 t))))
2520 "*Face used for group or summary buffer mouse highlighting.
2521 The line beneath the mouse pointer will be highlighted with this
2522 face."
2535 "Controls use of the agent cache while plugged.
2536 When set, Gnus will prefer using the locally stored content rather
2537 than re-fetching it from the server. You also need to enable
2538 `gnus-agent' for this to have any affect."
2544 "Default charset assumed to be used when viewing non-ASCII characters.
2545 This variable is overridden on a group-to-group basis by the
2546 `gnus-group-charset-alist' variable and is only used on groups not
2547 covered by that variable."
2551 ;; Fixme: Doc reference to agent.
2553 "Whether we want to use the Gnus agent or not.
2555 You may customize gnus-agent to disable its use. However, some
2556 back ends have started to use the agent as a client-side cache.
2557 Disabling the agent may result in noticeable loss of performance."
2563 "Function called by the command `gnus-other-frame'."
2571 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2572 This should be an alist for Emacs, or a plist for XEmacs."
2583 "Which information should be exposed in the User-Agent header.
2585 Can be a list of symbols or a string. Valid symbols are `gnus'
2586 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2587 addition to the Emacs version, you can add `codename' \(show
2588 \(S\)XEmacs codename\) or either `config' \(show system
2589 configuration\) or `type' \(show system type\). If you set it to
2590 a string, be sure to use a valid format, see RFC 2616."
2603 ;; Convert old (< 2005-01-10) symbol type values:
2622 \f
2623 ;;; Internal variables
2628 ; Reset each time gnus-agent-covered-methods is changed else
2629 ; gnus-agent-method-p may mis-report a methods status.
2630 )
2654 ;; Dummy variable.
2657 ;; Variable holding the user answers to all method prompts.
2660 ;; Variable holding the user answers to all mail method prompts.
2663 ;; Variable holding the user answers to all group prompts.
2671 "*The directory where cached articles will be stored."
2677 nnspool "cache"
2701 ;; Propagate flags to server, with the following exceptions:
2702 ;; `seen' is private to each gnus installation
2703 ;; `cache' is a internal gnus flag for each gnus installation
2704 ;; `download' is a agent flag private to each gnus installation
2705 ;; `unsend' are for nndraft groups only
2706 ;; `score' is not a proper mark
2707 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2710 "Marks that shouldn't be propagated to back ends.
2711 Typical marks are those that make no sense in a standalone back end,
2712 such as a mark that says whether an article is stored in the cache
2725 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2750 gnus-newsrc-last-checked-date
2751 gnus-newsrc-alist gnus-server-alist
2752 gnus-killed-list gnus-zombie-list
2753 gnus-topic-topology gnus-topic-alist
2754 gnus-format-specs)
2758 "Assoc list of read articles.
2762 "Assoc list of registry data.
2789 ;; Save window configuration.
2794 ;;; Let the byte-compiler know that we know about this variable.
2805 ;;; End of variables.
2807 ;; Define some autoload functions Gnus might use.
2810 ;; This little mapcar goes through the list below and marks the
2811 ;; symbols in question as autoloaded functions.
2831 message-send-and-exit message-yank-original)
2837 rmail-show-message rmail-summary-exists
2838 rmail-select-summary rmail-update-summary)
2842 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2843 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2847 gnus-Folder-save-name gnus-folder-save-name)
2850 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2851 gnus-demon-add-disconnection gnus-demon-add-handler
2852 gnus-demon-remove-handler)
2854 gnus-demon-init gnus-demon-cancel)
2856 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2857 gnus-face-from-file)
2859 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2861 gnus-nocem-unwanted-article-p)
2863 gnus-server-server-name)
2866 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2867 gnus-article-hide-citation gnus-article-fill-cited-article
2868 gnus-article-hide-citation-in-followups)
2870 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2871 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2873 gnus-cache-possibly-remove-articles gnus-cache-request-article
2874 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2875 gnus-cache-enter-remove-article gnus-cached-article-p
2876 gnus-cache-open gnus-cache-close gnus-cache-update-article
2877 gnus-cache-articles-in-group)
2879 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2881 gnus-summary-increase-score gnus-summary-set-score
2882 gnus-summary-raise-thread gnus-summary-raise-same-subject
2883 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2884 gnus-summary-lower-thread gnus-summary-lower-same-subject
2885 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2886 gnus-summary-current-score gnus-score-delta-default
2887 gnus-score-flush-cache gnus-score-close
2888 gnus-possibly-score-headers gnus-score-followup-article
2889 gnus-score-followup-thread)
2892 gnus-current-score-file-nondirectory gnus-score-adaptive
2893 gnus-score-find-trace gnus-score-file-name)
2897 gnus-subscribe-topics)
2901 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2902 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2903 gnus-uu-mark-by-regexp gnus-uu-mark-all
2904 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2905 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2906 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2907 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2908 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2909 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2910 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2911 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2914 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2916 gnus-group-post-news gnus-group-mail gnus-group-news
2917 gnus-summary-post-news gnus-summary-news-other-window
2918 gnus-summary-followup gnus-summary-followup-with-original
2919 gnus-summary-cancel-article gnus-summary-supersede-article
2920 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2921 gnus-summary-mail-forward gnus-summary-mail-other-window
2922 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2923 gnus-summary-wide-reply gnus-summary-followup-to-mail
2924 gnus-summary-followup-to-mail-with-original gnus-bug
2925 gnus-summary-wide-reply-with-original
2926 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2927 gnus-summary-post-forward)
2932 gnus-list-of-unread-articles gnus-list-of-read-articles
2933 gnus-offer-save-summaries gnus-make-thread-indent-array
2934 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2935 gnus-summary-skip-intangible gnus-summary-article-number
2936 gnus-data-header gnus-data-find)
2938 gnus-group-list-groups gnus-group-first-unread-group
2939 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2940 gnus-group-setup-buffer gnus-group-get-new-news
2941 gnus-group-make-help-group gnus-group-update-group
2942 gnus-group-iterate gnus-group-group-name)
2944 gnus-backlog-remove-article)
2946 gnus-article-prepare gnus-article-set-window-start
2947 gnus-article-next-page gnus-article-prev-page
2948 gnus-request-article-this-buffer gnus-article-mode
2949 gnus-article-setup-buffer gnus-narrow-to-page
2950 gnus-article-delete-invisible-text gnus-treat-article)
2952 gnus-article-hide-headers gnus-article-hide-boring-headers
2953 gnus-article-treat-overstrike
2954 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2955 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2956 gnus-article-de-base64-unreadable
2957 gnus-article-decode-HZ
2958 gnus-article-wash-html
2959 gnus-article-unsplit-urls
2960 gnus-article-hide-pem gnus-article-hide-signature
2961 gnus-article-strip-leading-blank-lines gnus-article-date-local
2962 gnus-article-date-original gnus-article-date-lapsed
2963 ;;gnus-article-show-all-headers
2964 gnus-article-edit-mode gnus-article-edit-article
2965 gnus-article-edit-done gnus-article-decode-encoded-words
2966 gnus-start-date-timer gnus-stop-date-timer
2967 gnus-mime-view-all-parts)
2970 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2971 gnus-check-reasonable-setup)
2973 gnus-dup-enter-articles)
2977 gnus-group-move-group-to-server gnus-change-server)
2981 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2982 gnus-async-halt-prefetch)
2984 gnus-agent-save-active gnus-agent-method-p
2985 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2986 gnus-summary-set-agent-mark gnus-agent-save-group-info
2987 gnus-agent-request-article gnus-agent-retrieve-headers)
2989 gnus-unplugged gnus-agentize gnus-agent-batch)
2991 gnus-summary-save-article-vm)
2996 gnus-group-split-update)
2999 ;;; gnus-sum.el thingies
3003 "*The format specification of the lines in the summary buffer.
3005 It works along the same lines as a normal formatting string,
3006 with some simple extensions.
3008 %N Article number, left padded with spaces (string)
3009 %S Subject (string)
3011 %n Name of the poster (string)
3012 %a Extracted name of the poster (string)
3013 %A Extracted address of the poster (string)
3014 %F Contents of the From: header (string)
3015 %f Contents of the From: or To: headers (string)
3016 %x Contents of the Xref: header (string)
3017 %D Date of the article (string)
3018 %d Date of the article (string) in DD-MMM format
3019 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
3020 %M Message-id of the article (string)
3021 %r References of the article (string)
3022 %c Number of characters in the article (integer)
3023 %k Pretty-printed version of the above (string)
3025 %L Number of lines in the article (integer)
3026 %I Indentation based on thread level (a string of spaces)
3027 %B A complex trn-style thread tree (string)
3028 The variables `gnus-sum-thread-*' can be used for customization.
3029 %T A string with two possible values: 80 spaces if the article
3030 is on thread level two or larger and 0 spaces on level one
3035 %> Spaces of length thread-level (string)
3036 %< Spaces of length (- 20 thread-level) (string)
3037 %i Article score (number)
3038 %z Article zcore (character)
3039 %t Number of articles under the current thread (number).
3040 %e Whether the thread is empty or not (character).
3041 %V Total thread score (number).
3042 %P The line number (number).
3043 %O Download mark (character).
3044 %* If present, indicates desired cursor position
3045 (instead of after first colon).
3046 %u User defined specifier. The next character in the format string should
3047 be a letter. Gnus will call the function gnus-user-format-function-X,
3048 where X is the letter following %u. The function will be passed the
3049 current header as argument. The function should return a string, which
3050 will be inserted into the summary just like information from any other
3051 summary specifier.
3053 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3054 with care. For reasons of efficiency, Gnus will compute what column
3056 it is invalid to have these specs after a variable-length spec. Well,
3057 you might not be arrested, but your summary buffer will look strange,
3058 which is bad enough.
3060 The smart choice is to have these specs as far to the left as
3061 possible.
3063 This restriction may disappear in later versions of Gnus.
3065 General format specifiers can also be used.
3066 See Info node `(gnus)Formatting Variables'."
3071 ;;;
3072 ;;; Skeleton keymaps
3073 ;;;
3078 (while keys
3079 (define-key keymap (pop keys) 'undefined))))
3081 (defvar gnus-article-mode-map
3082 (let ((keymap (make-sparse-keymap)))
3083 (gnus-suppress-keymap keymap)
3084 keymap))
3085 (defvar gnus-summary-mode-map
3086 (let ((keymap (make-keymap)))
3087 (gnus-suppress-keymap keymap)
3088 keymap))
3089 (defvar gnus-group-mode-map
3090 (let ((keymap (make-keymap)))
3091 (gnus-suppress-keymap keymap)
3092 keymap))
3094 \f
3096 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3097 ;; If you want the cursor to go somewhere else, set these two
3098 ;; functions in some startup hook to whatever you want.
3099 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3100 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3102 ;;; Various macros and substs.
3104 (defun gnus-header-from (header)
3105 (mail-header-from header))
3107 (defmacro gnus-gethash (string hashtable)
3108 "Get hash value of STRING in HASHTABLE."
3109 `(symbol-value (intern-soft ,string ,hashtable)))
3111 (defmacro gnus-gethash-safe (string hashtable)
3112 "Get hash value of STRING in HASHTABLE.
3113 Return nil if not defined."
3114 `(let ((sym (intern-soft ,string ,hashtable)))
3115 (and (boundp sym) (symbol-value sym))))
3117 (defmacro gnus-sethash (string value hashtable)
3118 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3119 `(set (intern ,string ,hashtable) ,value))
3120 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3122 (defmacro gnus-group-unread (group)
3123 "Get the currently computed number of unread articles in GROUP."
3124 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3126 (defmacro gnus-group-entry (group)
3127 "Get the newsrc entry for GROUP."
3128 `(gnus-gethash ,group gnus-newsrc-hashtb))
3130 (defmacro gnus-active (group)
3131 "Get active info on GROUP."
3132 `(gnus-gethash ,group gnus-active-hashtb))
3134 (defmacro gnus-set-active (group active)
3135 "Set GROUP's active info."
3136 `(gnus-sethash ,group ,active gnus-active-hashtb))
3138 ;; Info access macros.
3140 (defmacro gnus-info-group (info)
3141 `(nth 0 ,info))
3142 (defmacro gnus-info-rank (info)
3143 `(nth 1 ,info))
3144 (defmacro gnus-info-read (info)
3145 `(nth 2 ,info))
3146 (defmacro gnus-info-marks (info)
3147 `(nth 3 ,info))
3148 (defmacro gnus-info-method (info)
3149 `(nth 4 ,info))
3150 (defmacro gnus-info-params (info)
3151 `(nth 5 ,info))
3153 (defmacro gnus-info-level (info)
3154 `(let ((rank (gnus-info-rank ,info)))
3155 (if (consp rank)
3156 (car rank)
3157 rank)))
3158 (defmacro gnus-info-score (info)
3159 `(let ((rank (gnus-info-rank ,info)))
3160 (or (and (consp rank) (cdr rank)) 0)))
3162 (defmacro gnus-info-set-group (info group)
3163 `(setcar ,info ,group))
3164 (defmacro gnus-info-set-rank (info rank)
3165 `(setcar (nthcdr 1 ,info) ,rank))
3166 (defmacro gnus-info-set-read (info read)
3167 `(setcar (nthcdr 2 ,info) ,read))
3168 (defmacro gnus-info-set-marks (info marks &optional extend)
3169 (if extend
3170 `(gnus-info-set-entry ,info ,marks 3)
3171 `(setcar (nthcdr 3 ,info) ,marks)))
3172 (defmacro gnus-info-set-method (info method &optional extend)
3173 (if extend
3174 `(gnus-info-set-entry ,info ,method 4)
3175 `(setcar (nthcdr 4 ,info) ,method)))
3176 (defmacro gnus-info-set-params (info params &optional extend)
3177 (if extend
3178 `(gnus-info-set-entry ,info ,params 5)
3179 `(setcar (nthcdr 5 ,info) ,params)))
3181 (defun gnus-info-set-entry (info entry number)
3182 ;; Extend the info until we have enough elements.
3183 (while (<= (length info) number)
3184 (nconc info (list nil)))
3185 ;; Set the entry.
3186 (setcar (nthcdr number info) entry))
3188 (defmacro gnus-info-set-level (info level)
3189 `(let ((rank (cdr ,info)))
3190 (if (consp (car rank))
3191 (setcar (car rank) ,level)
3192 (setcar rank ,level))))
3193 (defmacro gnus-info-set-score (info score)
3194 `(let ((rank (cdr ,info)))
3195 (if (consp (car rank))
3196 (setcdr (car rank) ,score)
3197 (setcar rank (cons (car rank) ,score)))))
3199 (defmacro gnus-get-info (group)
3200 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3202 ;;; Load the compatibility functions.
3204 (require 'gnus-ems)
3206 \f
3207 ;;;
3208 ;;; Shutdown
3209 ;;;
3211 (defvar gnus-shutdown-alist nil)
3213 (defun gnus-add-shutdown (function &rest symbols)
3214 "Run FUNCTION whenever one of SYMBOLS is shut down."
3215 (push (cons function symbols) gnus-shutdown-alist))
3217 (defun gnus-shutdown (symbol)
3218 "Shut down everything that waits for SYMBOL."
3219 (dolist (entry gnus-shutdown-alist)
3220 (when (memq symbol (cdr entry))
3221 (funcall (car entry)))))
3223 \f
3224 ;;;
3225 ;;; Gnus Utility Functions
3226 ;;;
3228 (defun gnus-find-subscribed-addresses ()
3229 "Return a regexp matching the addresses of all subscribed mail groups.
3230 It consists of the `to-address' or `to-list' parameter of all groups
3231 with a `subscribed' parameter."
3232 (let (group address addresses)
3233 (dolist (entry (cdr gnus-newsrc-alist))
3234 (setq group (car entry))
3235 (when (gnus-parameter-subscribed group)
3236 (setq address (mail-strip-quoted-names
3237 (or (gnus-group-fast-parameter group 'to-address)
3238 (gnus-group-fast-parameter group 'to-list))))
3239 (when address
3240 (add-to-list 'addresses address))))
3241 (when addresses
3244 (defmacro gnus-string-or (&rest strings)
3245 "Return the first element of STRINGS that is a non-blank string.
3246 STRINGS will be evaluated in normal `or' order."
3247 `(gnus-string-or-1 ',strings))
3249 (defun gnus-string-or-1 (strings)
3250 (let (string)
3251 (while strings
3252 (setq string (eval (pop strings)))
3254 (setq string nil)
3255 (setq strings nil)))
3256 string))
3258 (defun gnus-version (&optional arg)
3259 "Version number of this version of Gnus.
3260 If ARG, insert string at point."
3261 (interactive "P")
3262 (if arg
3263 (insert (message gnus-version))
3264 (message gnus-version)))
3266 (defun gnus-continuum-version (&optional version)
3267 "Return VERSION as a floating point number."
3268 (interactive)
3269 (unless version
3270 (setq version gnus-version))
3273 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3274 (number (match-string 2 version))
3275 major minor least)
3276 (unless (string-match
3278 (error "Invalid version string: %s" version))
3279 (setq major (string-to-number (match-string 1 number))
3280 minor (string-to-number (match-string 2 number))
3281 least (if (match-beginning 3)
3282 (string-to-number (match-string 3 number))
3283 0))
3284 (string-to-number
3285 (if (zerop major)
3286 (format "%s00%02d%02d"
3287 (if (member alpha '("(ding)" "d"))
3288 "4.99"
3289 (+ 5 (* 0.02
3290 (abs
3291 (- (mm-char-int (aref (downcase alpha) 0))
3292 (mm-char-int ?t))))
3293 -0.01))
3294 minor least)
3295 (format "%d.%02d%02d" major minor least))))))
3297 (defun gnus-info-find-node (&optional nodename)
3298 "Find Info documentation of Gnus."
3299 (interactive)
3300 ;; Enlarge info window if needed.
3301 (let (gnus-info-buffer)
3302 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3303 (setq gnus-info-buffer (current-buffer))
3304 (gnus-configure-windows 'info)))
3306 ;;;
3307 ;;; gnus-interactive
3308 ;;;
3310 (defvar gnus-current-prefix-symbol nil
3311 "Current prefix symbol.")
3313 (defvar gnus-current-prefix-symbols nil
3314 "List of current prefix symbols.")
3316 (defun gnus-interactive (string &optional params)
3317 "Return a list that can be fed to `interactive'.
3318 See `interactive' for full documentation.
3320 Adds the following specs:
3322 y -- The current symbolic prefix.
3323 Y -- A list of the current symbolic prefix(es).
3324 A -- Article number.
3325 H -- Article header.
3326 g -- Group name."
3327 (let ((i 0)
3328 out c prompt)
3329 (while (< i (length string))
3331 (setq c (aref string i))
3332 (when (match-end 1)
3333 (setq prompt (match-string 1 string)))
3334 (setq i (match-end 0))
3335 ;; We basically emulate just about everything that
3336 ;; `interactive' does, but add the specs listed above.
3337 (push
3338 (cond
3339 ((= c ?a)
3340 (completing-read prompt obarray 'fboundp t))
3341 ((= c ?b)
3342 (read-buffer prompt (current-buffer) t))
3343 ((= c ?B)
3344 (read-buffer prompt (other-buffer (current-buffer))))
3345 ((= c ?c)
3346 (read-char))
3347 ((= c ?C)
3348 (completing-read prompt obarray 'commandp t))
3349 ((= c ?d)
3350 (point))
3351 ((= c ?D)
3352 (read-file-name prompt nil default-directory 'lambda))
3353 ((= c ?f)
3354 (read-file-name prompt nil nil 'lambda))
3355 ((= c ?F)
3356 (read-file-name prompt))
3357 ((= c ?k)
3358 (read-key-sequence prompt))
3359 ((= c ?K)
3360 (error "Not implemented spec"))
3361 ((= c ?e)
3362 (error "Not implemented spec"))
3363 ((= c ?m)
3364 (mark))
3365 ((= c ?N)
3366 (error "Not implemented spec"))
3367 ((= c ?n)
3368 (string-to-number (read-from-minibuffer prompt)))
3369 ((= c ?p)
3370 (prefix-numeric-value current-prefix-arg))
3371 ((= c ?P)
3372 current-prefix-arg)
3373 ((= c ?r)
3374 'gnus-prefix-nil)
3375 ((= c ?s)
3376 (read-string prompt))
3377 ((= c ?S)
3378 (intern (read-string prompt)))
3379 ((= c ?v)
3380 (read-variable prompt))
3381 ((= c ?x)
3382 (read-minibuffer prompt))
3383 ((= c ?x)
3384 (eval-minibuffer prompt))
3385 ;; And here the new specs come.
3386 ((= c ?y)
3387 gnus-current-prefix-symbol)
3388 ((= c ?Y)
3389 gnus-current-prefix-symbols)
3390 ((= c ?g)
3391 (gnus-group-group-name))
3392 ((= c ?A)
3393 (gnus-summary-skip-intangible)
3394 (or (get-text-property (point) 'gnus-number)
3395 (gnus-summary-last-subject)))
3396 ((= c ?H)
3397 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3398 (t
3399 (error "Non-implemented spec")))
3400 out)
3401 (cond
3402 ((= c ?r)
3403 (push (if (< (point) (mark)) (point) (mark)) out)
3404 (push (if (> (point) (mark)) (point) (mark)) out))))
3405 (setq out (delq 'gnus-prefix-nil out))
3406 (nreverse out)))
3408 (defun gnus-symbolic-argument (&optional arg)
3409 "Read a symbolic argument and a command, and then execute command."
3410 (interactive "P")
3411 (let* ((in-command (this-command-keys))
3412 (command in-command)
3413 gnus-current-prefix-symbols
3414 gnus-current-prefix-symbol
3415 syms)
3416 (while (equal in-command command)
3417 (message "%s-" (key-description (this-command-keys)))
3418 (push (intern (char-to-string (read-char))) syms)
3419 (setq command (read-key-sequence nil t)))
3420 (setq gnus-current-prefix-symbols (nreverse syms)
3421 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3422 (call-interactively (key-binding command t))))
3424 ;;; More various functions.
3426 (defsubst gnus-check-backend-function (func group)
3427 "Check whether GROUP supports function FUNC.
3428 GROUP can either be a string (a group name) or a select method."
3429 (ignore-errors
3430 (let ((method (if (stringp group)
3431 (car (gnus-find-method-for-group group))
3432 group)))
3433 (unless (featurep method)
3434 (require method))
3435 (fboundp (intern (format "%s-%s" method func))))))
3437 (defun gnus-group-read-only-p (&optional group)
3438 "Check whether GROUP supports editing or not.
3439 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3440 that that variable is buffer-local to the summary buffers."
3441 (let ((group (or group gnus-newsgroup-name)))
3442 (not (gnus-check-backend-function 'request-replace-article group))))
3444 (defun gnus-virtual-group-p (group)
3445 "Say whether GROUP is virtual or not."
3446 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3447 gnus-valid-select-methods)))
3449 (defun gnus-news-group-p (group &optional article)
3450 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3451 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3452 t) ;is news of course.
3453 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3454 nil) ;must be mail then.
3455 ((vectorp article) ;Has header info.
3456 (eq (gnus-request-type group (mail-header-id article)) 'news))
3457 ((null article) ;Hasn't header info
3458 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3459 ((< article 0) ;Virtual message
3460 nil) ;we don't know, guess mail.
3461 (t ;Has positive number
3462 (eq (gnus-request-type group article) 'news)))) ;use it.
3464 ;; Returns a list of writable groups.
3465 (defun gnus-writable-groups ()
3466 (let ((alist gnus-newsrc-alist)
3467 groups group)
3468 (while (setq group (car (pop alist)))
3469 (unless (gnus-group-read-only-p group)
3470 (push group groups)))
3471 (nreverse groups)))
3473 ;; Check whether to use long file names.
3474 (defun gnus-use-long-file-name (symbol)
3475 ;; The variable has to be set...
3476 (and gnus-use-long-file-name
3477 ;; If it isn't a list, then we return t.
3478 (or (not (listp gnus-use-long-file-name))
3479 ;; If it is a list, and the list contains `symbol', we
3480 ;; return nil.
3481 (not (memq symbol gnus-use-long-file-name)))))
3483 ;; Generate a unique new group name.
3484 (defun gnus-generate-new-group-name (leaf)
3485 (let ((name leaf)
3486 (num 0))
3487 (while (gnus-group-entry name)
3488 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3489 name))
3491 (defun gnus-ephemeral-group-p (group)
3492 "Say whether GROUP is ephemeral or not."
3493 (gnus-group-get-parameter group 'quit-config t))
3495 (defun gnus-group-quit-config (group)
3496 "Return the quit-config of GROUP."
3497 (gnus-group-get-parameter group 'quit-config t))
3499 (defun gnus-kill-ephemeral-group (group)
3500 "Remove ephemeral GROUP from relevant structures."
3501 (gnus-sethash group nil gnus-newsrc-hashtb))
3503 (defun gnus-simplify-mode-line ()
3504 "Make mode lines a bit simpler."
3505 (setq mode-line-modified (cdr gnus-mode-line-modified))
3506 (when (listp mode-line-format)
3507 (make-local-variable 'mode-line-format)
3508 (setq mode-line-format (copy-sequence mode-line-format))
3509 (when (equal (nth 3 mode-line-format) " ")
3510 (setcar (nthcdr 3 mode-line-format) " "))))
3512 ;;; Servers and groups.
3514 (defsubst gnus-server-add-address (method)
3515 (let ((method-name (symbol-name (car method))))
3516 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3517 (not (assq (intern (concat method-name "-address")) method))
3518 (memq 'physical-address (assq (car method)
3519 gnus-valid-select-methods)))
3520 (append method (list (list (intern (concat method-name "-address"))
3521 (nth 1 method))))
3522 method)))
3524 (defsubst gnus-method-to-server (method &optional nocache)
3525 (catch 'server-name
3526 (setq method (or method gnus-select-method))
3528 ;; Perhaps it is already in the cache.
3529 (unless nocache
3530 (mapc (lambda (name-method)
3531 (if (equal (cdr name-method) method)
3532 (throw 'server-name (car name-method))))
3533 gnus-server-method-cache))
3535 (mapc
3536 (lambda (server-alist)
3537 (mapc (lambda (name-method)
3538 (when (gnus-methods-equal-p (cdr name-method) method)
3539 (unless (member name-method gnus-server-method-cache)
3540 (push name-method gnus-server-method-cache))
3541 (throw 'server-name (car name-method))))
3542 server-alist))
3543 (list gnus-server-alist
3544 gnus-predefined-server-alist))
3546 (let* ((name (if (member (cadr method) '(nil ""))
3547 (format "%s" (car method))
3548 (format "%s:%s" (car method) (cadr method))))
3549 (name-method (cons name method)))
3550 (unless (member name-method gnus-server-method-cache)
3551 (push name-method gnus-server-method-cache))
3552 name)))
3554 (defsubst gnus-server-to-method (server)
3555 "Map virtual server names to select methods."
3556 (or (and server (listp server) server)
3557 (cdr (assoc server gnus-server-method-cache))
3558 (let ((result
3559 (or
3560 ;; Perhaps this is the native server?
3561 (and (equal server "native") gnus-select-method)
3562 ;; It should be in the server alist.
3563 (cdr (assoc server gnus-server-alist))
3564 ;; It could be in the predefined server alist.
3565 (cdr (assoc server gnus-predefined-server-alist))
3566 ;; If not, we look through all the opened server
3567 ;; to see whether we can find it there.
3568 (let ((opened gnus-opened-servers))
3569 (while (and opened
3570 (not (equal server (format "%s:%s" (caaar opened)
3571 (cadaar opened)))))
3572 (pop opened))
3573 (caar opened))
3574 ;; It could be a named method, search all servers
3575 (let ((servers gnus-secondary-select-methods))
3576 (while (and servers
3577 (not (equal server (format "%s:%s" (caar servers)
3578 (cadar servers)))))
3579 (pop servers))
3580 (car servers))
3581 ;; This could be some sort of foreign server that I
3582 ;; simply haven't opened (yet). Do a brute-force scan
3583 ;; of the entire gnus-newsrc-alist for the server name
3584 ;; of every method. As a side-effect, loads the
3585 ;; gnus-server-method-cache so this only happens once,
3586 ;; if at all.
3587 (let ((alist (cdr gnus-newsrc-alist))
3588 method match)
3589 (while alist
3590 (setq method (gnus-info-method (pop alist)))
3591 (when (and (not (stringp method))
3592 (equal server (gnus-method-to-server method)))
3593 (setq match method
3594 alist nil)))
3595 match))))
3596 (when result
3597 (push (cons server result) gnus-server-method-cache))
3598 result)))
3600 (defsubst gnus-server-get-method (group method)
3601 ;; Input either a server name, and extended server name, or a
3602 ;; select method, and return a select method.
3603 (cond ((stringp method)
3604 (gnus-server-to-method method))
3605 ((equal method gnus-select-method)
3606 gnus-select-method)
3607 ((and (stringp (car method))
3608 group)
3609 (gnus-server-extend-method group method))
3610 ((and method
3611 (not group)
3612 (equal (cadr method) ""))
3613 method)
3614 (t
3615 (gnus-server-add-address method))))
3617 (defmacro gnus-method-equal (ss1 ss2)
3618 "Say whether two servers are equal."
3619 `(let ((s1 ,ss1)
3620 (s2 ,ss2))
3621 (or (equal s1 s2)
3622 (and (= (length s1) (length s2))
3623 (progn
3624 (while (and s1 (member (car s1) s2))
3625 (setq s1 (cdr s1)))
3626 (null s1))))))
3628 (defun gnus-methods-equal-p (m1 m2)
3629 (let ((m1 (or m1 gnus-select-method))
3630 (m2 (or m2 gnus-select-method)))
3631 (or (equal m1 m2)
3632 (and (eq (car m1) (car m2))
3633 (or (not (memq 'address (assoc (symbol-name (car m1))
3634 gnus-valid-select-methods)))
3635 (equal (nth 1 m1) (nth 1 m2)))))))
3637 (defun gnus-server-equal (m1 m2)
3638 "Say whether two methods are equal."
3639 (let ((m1 (cond ((null m1) gnus-select-method)
3640 ((stringp m1) (gnus-server-to-method m1))
3641 (t m1)))
3642 (m2 (cond ((null m2) gnus-select-method)
3643 ((stringp m2) (gnus-server-to-method m2))
3644 (t m2))))
3645 (gnus-method-equal m1 m2)))
3647 (defun gnus-servers-using-backend (backend)
3648 "Return a list of known servers using BACKEND."
3649 (let ((opened gnus-opened-servers)
3650 out)
3651 (while opened
3652 (when (eq backend (caaar opened))
3653 (push (caar opened) out))
3654 (pop opened))
3655 out))
3657 (defun gnus-archive-server-wanted-p ()
3658 "Say whether the user wants to use the archive server."
3659 (cond
3660 ((or (not gnus-message-archive-method)
3661 (not gnus-message-archive-group))
3662 nil)
3663 ((and gnus-message-archive-method gnus-message-archive-group)
3664 t)
3665 (t
3666 (let ((active (cadr (assq 'nnfolder-active-file
3667 gnus-message-archive-method))))
3668 (and active
3669 (file-exists-p active))))))
3671 (defsubst gnus-method-to-server-name (method)
3672 (concat
3673 (format "%s" (car method))
3674 (when (and
3675 (or (assoc (format "%s" (car method))
3676 (gnus-methods-using 'address))
3677 (gnus-server-equal method gnus-message-archive-method))
3678 (nth 1 method)
3679 (not (string= (nth 1 method) "")))
3680 (concat "+" (nth 1 method)))))
3682 (defsubst gnus-method-to-full-server-name (method)
3683 (format "%s+%s" (car method) (nth 1 method)))
3685 (defun gnus-group-prefixed-name (group method &optional full)
3686 "Return the whole name from GROUP and METHOD.
3687 Call with full set to get the fully qualified group name (even if the
3688 server is native)."
3689 (when (stringp method)
3690 (setq method (gnus-server-to-method method)))
3691 (if (or (not method)
3692 (and (not full) (gnus-server-equal method "native"))
3693 ;;;!!! This might not be right. We'll see...
3694 ;(string-match ":" group)
3695 )
3696 group
3697 (concat (gnus-method-to-server-name method) ":" group)))
3699 (defun gnus-group-guess-prefixed-name (group)
3700 "Guess the whole name from GROUP and METHOD."
3701 (gnus-group-prefixed-name group (gnus-find-method-for-group
3702 group)))
3704 (defun gnus-group-full-name (group method)
3705 "Return the full name from GROUP and METHOD, even if the method is native."
3706 (gnus-group-prefixed-name group method t))
3708 (defun gnus-group-guess-full-name (group)
3709 "Guess the full name from GROUP, even if the method is native."
3710 (if (gnus-group-prefixed-p group)
3711 group
3712 (gnus-group-full-name group (gnus-find-method-for-group group))))
3714 (defun gnus-group-guess-full-name-from-command-method (group)
3715 "Guess the full name from GROUP, even if the method is native."
3716 (if (gnus-group-prefixed-p group)
3717 group
3718 (gnus-group-full-name group gnus-command-method)))
3720 (defun gnus-group-real-prefix (group)
3721 "Return the prefix of the current group name."
3722 (if (stringp group)
3723 (if (string-match "^[^:]+:" group)
3724 (substring group 0 (match-end 0))
3725 "")
3726 nil))
3728 (defun gnus-group-short-name (group)
3729 "Return the short group name."
3730 (let ((prefix (gnus-group-real-prefix group)))
3731 (if (< 0 (length prefix))
3732 (substring group (length prefix) nil)
3733 group)))
3735 (defun gnus-group-prefixed-p (group)
3736 "Return the prefix of the current group name."
3737 (< 0 (length (gnus-group-real-prefix group))))
3739 (defun gnus-summary-buffer-name (group)
3740 "Return the summary buffer name of GROUP."
3741 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3743 (defun gnus-group-method (group)
3744 "Return the server or method used for selecting GROUP.
3745 You should probably use `gnus-find-method-for-group' instead."
3746 (let ((prefix (gnus-group-real-prefix group)))
3747 (if (equal prefix "")
3748 gnus-select-method
3749 (let ((servers gnus-opened-servers)
3750 (server "")
3751 backend possible found)
3753 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3754 server (substring prefix (match-end 0) (1- (length prefix))))
3755 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3756 (while servers
3757 (when (eq (caaar servers) backend)
3758 (setq possible (caar servers))
3759 (when (equal (cadaar servers) server)
3760 (setq found (caar servers))))
3761 (pop servers))
3762 (or (car (rassoc found gnus-server-alist))
3763 found
3764 (car (rassoc possible gnus-server-alist))
3765 possible
3766 (list backend server))))))
3768 (defsubst gnus-native-method-p (method)
3769 "Return whether METHOD is the native select method."
3770 (gnus-method-equal method gnus-select-method))
3772 (defsubst gnus-secondary-method-p (method)
3773 "Return whether METHOD is a secondary select method."
3774 (let ((methods gnus-secondary-select-methods)
3775 (gmethod (inline (gnus-server-get-method nil method))))
3776 (while (and methods
3777 (not (gnus-method-equal
3778 (inline (gnus-server-get-method nil (car methods)))
3779 gmethod)))
3780 (setq methods (cdr methods)))
3781 methods))
3783 (defun gnus-method-simplify (method)
3784 "Return the shortest uniquely identifying string or method for METHOD."
3785 (cond ((stringp method)
3786 method)
3787 ((gnus-native-method-p method)
3788 nil)
3789 ((gnus-secondary-method-p method)
3790 (format "%s:%s" (nth 0 method) (nth 1 method)))
3791 (t
3792 method)))
3794 (defun gnus-groups-from-server (server)
3795 "Return a list of all groups that are fetched from SERVER."
3796 (let ((alist (cdr gnus-newsrc-alist))
3797 info groups)
3798 (while (setq info (pop alist))
3799 (when (gnus-server-equal (gnus-info-method info) server)
3800 (push (gnus-info-group info) groups)))
3801 (sort groups 'string<)))
3803 (defun gnus-group-foreign-p (group)
3804 "Say whether a group is foreign or not."
3805 (and (not (gnus-group-native-p group))
3806 (not (gnus-group-secondary-p group))))
3808 (defun gnus-group-native-p (group)
3809 "Say whether the group is native or not."
3810 (not (string-match ":" group)))
3812 (defun gnus-group-secondary-p (group)
3813 "Say whether the group is secondary or not."
3814 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3816 (defun gnus-parameters-get-parameter (group)
3817 "Return the group parameters for GROUP from `gnus-parameters'."
3818 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3819 case-fold-search
3820 gnus-parameters-case-fold-search))
3821 params-list)
3822 (dolist (elem gnus-parameters)
3823 (when (string-match (car elem) group)
3824 (setq params-list
3825 (nconc (gnus-expand-group-parameters
3826 (car elem) (cdr elem) group)
3827 params-list))))
3828 params-list))
3830 (defun gnus-expand-group-parameter (match value group)
3831 "Use MATCH to expand VALUE in GROUP."
3832 (with-temp-buffer
3833 (insert group)
3834 (goto-char (point-min))
3835 (while (re-search-forward match nil t)
3836 (replace-match value))
3837 (buffer-string)))
3839 (defun gnus-expand-group-parameters (match parameters group)
3840 "Go through PARAMETERS and expand them according to the match data."
3841 (let (new)
3842 (dolist (elem parameters)
3843 (if (and (stringp (cdr elem))
3845 (push (cons (car elem)
3846 (gnus-expand-group-parameter match (cdr elem) group))
3847 new)
3848 (push elem new)))
3849 new))
3851 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3852 "For GROUP, return the value of SYMBOL.
3854 You should call this in the `gnus-group-buffer' buffer.
3855 The function `gnus-group-find-parameter' will do that for you."
3856 ;; The speed trick: No cons'ing and quit early.
3857 (let* ((params (funcall gnus-group-get-parameter-function group))
3858 ;; Start easy, check the "real" group parameters.
3859 (simple-results
3860 (gnus-group-parameter-value params symbol allow-list t)))
3861 (if simple-results
3862 ;; Found results; return them.
3863 (car simple-results)
3864 ;; We didn't find it there, try `gnus-parameters'.
3865 (let ((result nil)
3866 (head nil)
3867 (tail gnus-parameters))
3868 ;; A good old-fashioned non-cl loop.
3869 (while tail
3870 (setq head (car tail)
3871 tail (cdr tail))
3872 ;; The car is regexp matching for matching the group name.
3873 (when (string-match (car head) group)
3874 ;; The cdr is the parameters.
3875 (setq result (gnus-group-parameter-value (cdr head)
3876 symbol allow-list))
3877 (when result
3878 ;; Expand if necessary.
3880 (setq result (gnus-expand-group-parameter (car head)
3881 result group)))
3882 ;; Exit the loop early.
3883 (setq tail nil))))
3884 ;; Done.
3885 result))))
3887 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3888 "Return the group parameters for GROUP.
3889 If SYMBOL, return the value of that symbol in the group parameters.
3891 If you call this function inside a loop, consider using the faster
3892 `gnus-group-fast-parameter' instead."
3893 (save-excursion
3894 (set-buffer gnus-group-buffer)
3895 (if symbol
3896 (gnus-group-fast-parameter group symbol allow-list)
3897 (nconc
3898 (copy-sequence
3899 (funcall gnus-group-get-parameter-function group))
3900 (gnus-parameters-get-parameter group)))))
3902 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3903 "Return the group parameters for GROUP.
3904 If SYMBOL, return the value of that symbol in the group parameters.
3905 If ALLOW-LIST, also allow list as a result.
3906 Most functions should use `gnus-group-find-parameter', which
3907 also examines the topic parameters."
3908 (let ((params (gnus-info-params (gnus-get-info group))))
3909 (if symbol
3910 (gnus-group-parameter-value params symbol allow-list)
3911 params)))
3913 (defun gnus-group-parameter-value (params symbol &optional
3914 allow-list present-p)
3915 "Return the value of SYMBOL in group PARAMS.
3916 If ALLOW-LIST, also allow list as a result."
3917 ;; We only wish to return group parameters (dotted lists) and
3918 ;; not local variables, which may have the same names.
3919 ;; But first we handle single elements...
3920 (or (car (memq symbol params))
3921 ;; Handle alist.
3922 (let (elem)
3923 (catch 'found
3924 (while (setq elem (pop params))
3925 (when (and (consp elem)
3926 (eq (car elem) symbol)
3927 (or allow-list
3928 (atom (cdr elem))))
3929 (throw 'found (if present-p (list (cdr elem))
3930 (cdr elem)))))))))
3932 (defun gnus-group-add-parameter (group param)
3933 "Add parameter PARAM to GROUP."
3934 (let ((info (gnus-get-info group)))
3935 (when info
3936 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3937 ;; Cons the new param to the old one and update.
3938 (gnus-group-set-info (cons param (gnus-info-params info))
3939 group 'params))))
3941 (defun gnus-group-set-parameter (group name value)
3942 "Set parameter NAME to VALUE in GROUP."
3943 (let ((info (gnus-get-info group)))
3944 (when info
3945 (gnus-group-remove-parameter group name)
3946 (let ((old-params (gnus-info-params info))
3947 (new-params (list (cons name value))))
3948 (while old-params
3949 (when (or (not (listp (car old-params)))
3950 (not (eq (caar old-params) name)))
3951 (setq new-params (append new-params (list (car old-params)))))
3952 (setq old-params (cdr old-params)))
3953 (gnus-group-set-info new-params group 'params)))))
3955 (defun gnus-group-remove-parameter (group name)
3956 "Remove parameter NAME from GROUP."
3957 (let ((info (gnus-get-info group)))
3958 (when info
3959 (let ((params (gnus-info-params info)))
3960 (when params
3961 (setq params (delq name params))
3962 (while (assq name params)
3963 (gnus-pull name params))
3964 (gnus-info-set-params info params))))))
3966 (defun gnus-group-add-score (group &optional score)
3967 "Add SCORE to the GROUP score.
3968 If SCORE is nil, add 1 to the score of GROUP."
3969 (let ((info (gnus-get-info group)))
3970 (when info
3971 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3973 (defun gnus-short-group-name (group &optional levels)
3974 "Collapse GROUP name LEVELS.
3975 Select methods are stripped and any remote host name is stripped down to
3976 just the host name."
3977 (let* ((name "")
3978 (foreign "")
3979 (depth 0)
3980 (skip 1)
3981 (levels (or levels
3982 gnus-group-uncollapsed-levels
3983 (progn
3985 (setq skip (match-end 0)
3986 depth (+ depth 1)))
3987 depth))))
3988 ;; Separate foreign select method from group name and collapse.
3989 ;; If method contains a server, collapse to non-domain server name,
3990 ;; otherwise collapse to select method.
3991 (let* ((colon (string-match ":" group))
3992 (server (and colon (substring group 0 colon)))
3993 (plus (and server (string-match "+" server))))
3994 (when server
3995 (if plus
3996 (setq foreign (substring server (+ 1 plus)
3998 group (substring group (+ 1 colon)))
3999 (setq foreign server
4000 group (substring group (+ 1 colon))))
4001 (setq foreign (concat foreign ":")))
4002 ;; Collapse group name leaving LEVELS uncollapsed elements
4003 (let* ((slist (split-string group "/"))
4004 (slen (length slist))
4006 (dlen (length dlist))
4007 glist
4008 glen
4009 gsep
4010 res)
4011 (if (> slen dlen)
4012 (setq glist slist
4013 glen slen
4014 gsep "/")
4015 (setq glist dlist
4016 glen dlen
4017 gsep "."))
4018 (setq levels (- glen levels))
4019 (dolist (g glist)
4020 (push (if (>= (decf levels) 0)
4021 (if (zerop (length g))
4022 ""
4023 (substring g 0 1))
4024 g)
4025 res))
4026 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4028 (defun gnus-narrow-to-body ()
4029 "Narrow to the body of an article."
4030 (narrow-to-region
4031 (progn
4032 (goto-char (point-min))
4034 (point-max)))
4035 (point-max)))
4037 \f
4038 ;;;
4039 ;;; Kill file handling.
4040 ;;;
4042 (defun gnus-apply-kill-file ()
4043 "Apply a kill file to the current newsgroup.
4044 Returns the number of articles marked as read."
4045 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4046 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4047 (gnus-apply-kill-file-internal)
4048 0))
4050 (defun gnus-kill-save-kill-buffer ()
4051 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4052 (when (get-file-buffer file)
4053 (save-excursion
4054 (set-buffer (get-file-buffer file))
4055 (when (buffer-modified-p)
4056 (save-buffer))
4057 (kill-buffer (current-buffer))))))
4059 (defcustom gnus-kill-file-name "KILL"
4060 "Suffix of the kill files."
4061 :group 'gnus-score-kill
4062 :group 'gnus-score-files
4063 :type 'string)
4065 (defun gnus-newsgroup-kill-file (newsgroup)
4066 "Return the name of a kill file name for NEWSGROUP.
4067 If NEWSGROUP is nil, return the global kill file name instead."
4068 (cond
4069 ;; The global KILL file is placed at top of the directory.
4070 ((or (null newsgroup)
4071 (string-equal newsgroup ""))
4072 (expand-file-name gnus-kill-file-name
4073 gnus-kill-files-directory))
4074 ;; Append ".KILL" to newsgroup name.
4075 ((gnus-use-long-file-name 'not-kill)
4076 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4077 "." gnus-kill-file-name)
4078 gnus-kill-files-directory))
4079 ;; Place "KILL" under the hierarchical directory.
4080 (t
4081 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4082 "/" gnus-kill-file-name)
4083 gnus-kill-files-directory))))
4085 ;;; Server things.
4087 (defun gnus-member-of-valid (symbol group)
4089 (memq symbol (assoc
4090 (symbol-name (car (gnus-find-method-for-group group)))
4091 gnus-valid-select-methods)))
4093 (defun gnus-method-option-p (method option)
4094 "Return non-nil if select METHOD has OPTION as a parameter."
4095 (when (stringp method)
4096 (setq method (gnus-server-to-method method)))
4097 (memq option (assoc (format "%s" (car method))
4098 gnus-valid-select-methods)))
4100 (defun gnus-similar-server-opened (method)
4101 (let ((opened gnus-opened-servers))
4102 (while (and method opened)
4103 (when (and (equal (cadr method) (cadaar opened))
4104 (equal (car method) (caaar opened))
4105 (not (equal method (caar opened))))
4106 (setq method nil))
4107 (pop opened))
4108 (not method)))
4110 (defun gnus-server-extend-method (group method)
4111 ;; This function "extends" a virtual server. If the server is
4112 ;; "hello", and the select method is ("hello" (my-var "something"))
4113 ;; in the group "alt.alt", this will result in a new virtual server
4114 ;; called "hello+alt.alt".
4115 (if (or (not (inline (gnus-similar-server-opened method)))
4116 (not (cddr method)))
4117 method
4118 `(,(car method) ,(concat (cadr method) "+" group)
4119 (,(intern (format "%s-address" (car method))) ,(cadr method))
4120 ,@(cddr method))))
4122 (defun gnus-server-status (method)
4123 "Return the status of METHOD."
4124 (nth 1 (assoc method gnus-opened-servers)))
4126 (defun gnus-group-name-to-method (group)
4127 "Guess a select method based on GROUP."
4128 (if (string-match ":" group)
4129 (let ((server (substring group 0 (match-beginning 0))))
4131 (list (intern (substring server 0 (match-beginning 0)))
4132 (substring server (match-end 0)))
4133 (list (intern server) "")))
4134 gnus-select-method))
4136 (defun gnus-server-string (server)
4137 "Return a readable string that describes SERVER."
4138 (let* ((server (gnus-server-to-method server))
4139 (address (nth 1 server)))
4140 (if (and address
4141 (not (zerop (length address))))
4142 (format "%s using %s" address (car server))
4143 (format "%s" (car server)))))
4145 (defun gnus-find-method-for-group (group &optional info)
4146 "Find the select method that GROUP uses."
4147 (or gnus-override-method
4148 (and (not group)
4149 gnus-select-method)
4150 (and (not (gnus-group-entry group))
4151 ;; Killed or otherwise unknown group.
4152 (or
4153 ;; If we know a virtual server by that name, return its method.
4154 (gnus-server-to-method (gnus-group-server group))
4155 ;; Guess a new method as last resort.
4156 (gnus-group-name-to-method group)))
4157 (let ((info (or info (gnus-get-info group)))
4158 method)
4159 (if (or (not info)
4160 (not (setq method (gnus-info-method info)))
4161 (equal method "native"))
4162 gnus-select-method
4163 (setq method
4164 (cond ((stringp method)
4165 (inline (gnus-server-to-method method)))
4166 ((stringp (cadr method))
4167 (inline (gnus-server-extend-method group method)))
4168 (t
4169 method)))
4170 (cond ((equal (cadr method) "")
4171 method)
4172 ((null (cadr method))
4173 (list (car method) ""))
4174 (t
4175 (gnus-server-add-address method)))))))
4177 (defun gnus-methods-using (feature)
4178 "Find all methods that have FEATURE."
4179 (let ((valids gnus-valid-select-methods)
4180 outs)
4181 (while valids
4182 (when (memq feature (car valids))
4183 (push (car valids) outs))
4184 (setq valids (cdr valids)))
4185 outs))
4187 (eval-and-compile
4188 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4190 (defun gnus-read-group (prompt &optional default)
4191 "Prompt the user for a group name.
4192 Disallow invalid group names."
4193 (let ((prefix "")
4194 group)
4195 (while (not group)
4196 (when (string-match
4197 gnus-invalid-group-regexp
4198 (setq group (read-string (concat prefix prompt)
4199 (cons (or default "") 0)
4200 'gnus-group-history)))
4201 (let ((match (match-string 0 group)))
4202 ;; Might be okay (e.g. for nnimap), so ask the user:
4204 (message-y-or-n-p
4205 "Proceed and create group anyway? " t
4208 Usually, it's dangerous to create a group with this name, because it's not
4209 supported by all back ends and servers. On IMAP servers it should work,
4210 though. If you are really sure, you can proceed anyway and create the group.
4212 You may customize the variable `gnus-invalid-group-regexp', which currently is
4216 group nil)))))
4217 group))
4219 (defun gnus-read-method (prompt)
4220 "Prompt the user for a method.
4221 Allow completion over sensible values."
4222 (let* ((open-servers
4223 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4224 gnus-opened-servers))
4225 (valid-methods
4226 (let (methods)
4227 (dolist (method gnus-valid-select-methods)
4228 (if (or (memq 'prompt-address method)
4229 (not (assoc (format "%s:" (car method)) open-servers)))
4230 (push method methods)))
4231 methods))
4232 (servers
4233 (append valid-methods
4234 open-servers
4235 gnus-predefined-server-alist
4236 gnus-server-alist))
4237 (method
4238 (completing-read
4239 prompt servers
4240 nil t nil 'gnus-method-history)))
4241 (cond
4242 ((equal method "")
4243 (setq method gnus-select-method))
4244 ((assoc method gnus-valid-select-methods)
4245 (let ((address (if (memq 'prompt-address
4246 (assoc method gnus-valid-select-methods))
4247 (read-string "Address: ")
4248 "")))
4249 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4250 (list (intern method) address))))
4251 ((assoc method servers)
4252 method)
4253 (t
4254 (list (intern method) "")))))
4256 ;;; Agent functions
4258 (defun gnus-agent-method-p (method-or-server)
4259 "Say whether METHOD is covered by the agent."
4260 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4261 (let* ((method (if (stringp method-or-server)
4262 (gnus-server-to-method method-or-server)
4263 method-or-server))
4264 (server (gnus-method-to-server method t)))
4265 (setq gnus-agent-method-p-cache
4266 (cons method-or-server
4267 (member server gnus-agent-covered-methods)))))
4268 (cdr gnus-agent-method-p-cache))
4270 (defun gnus-online (method)
4271 (not
4272 (if gnus-plugged
4273 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4274 (gnus-agent-method-p method))))
4276 ;;; User-level commands.
4278 ;;;###autoload
4279 (defun gnus-slave-no-server (&optional arg)
4280 "Read network news as a slave, without connecting to the local server."
4281 (interactive "P")
4282 (gnus-no-server arg t))
4284 ;;;###autoload
4285 (defun gnus-no-server (&optional arg slave)
4286 "Read network news.
4287 If ARG is a positive number, Gnus will use that as the startup
4288 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4289 non-nil and not a positive number, Gnus will prompt the user for the
4290 name of an NNTP server to use.
4291 As opposed to `gnus', this command will not connect to the local
4292 server."
4293 (interactive "P")
4294 (gnus-no-server-1 arg slave))
4296 ;;;###autoload
4297 (defun gnus-slave (&optional arg)
4298 "Read news as a slave."
4299 (interactive "P")
4300 (gnus arg nil 'slave))
4302 ;;;###autoload
4303 (defun gnus-other-frame (&optional arg display)
4304 "Pop up a frame to read news.
4305 This will call one of the Gnus commands which is specified by the user
4306 option `gnus-other-frame-function' (default `gnus') with the argument
4307 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4308 optional second argument DISPLAY should be a standard display string
4310 omitted or the function `make-frame-on-display' is not available, the
4311 current display is used."
4312 (interactive "P")
4313 (if (fboundp 'make-frame-on-display)
4314 (unless display
4315 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4316 (setq display nil))
4317 (let ((alive (gnus-alive-p)))
4318 (unless (and alive
4319 (catch 'found
4320 (walk-windows
4321 (lambda (window)
4322 (when (and (or (not display)
4323 (equal display
4324 (gnus-frame-or-window-display-name
4325 window)))
4326 (with-current-buffer (window-buffer window)
4328 (symbol-name major-mode))))
4329 (gnus-select-frame-set-input-focus
4330 (setq gnus-other-frame-object (window-frame window)))
4331 (select-window window)
4332 (throw 'found t)))
4333 'ignore t)))
4334 (gnus-select-frame-set-input-focus
4335 (setq gnus-other-frame-object
4336 (if display
4337 (make-frame-on-display display gnus-other-frame-parameters)
4338 (make-frame gnus-other-frame-parameters))))
4339 (if alive
4340 (switch-to-buffer gnus-group-buffer)
4341 (funcall gnus-other-frame-function arg)
4342 (add-hook 'gnus-exit-gnus-hook
4343 '(lambda nil
4344 (when (and (frame-live-p gnus-other-frame-object)
4345 (cdr (frame-list)))
4346 (delete-frame gnus-other-frame-object))
4347 (setq gnus-other-frame-object nil)))))))
4349 ;;;###autoload
4350 (defun gnus (&optional arg dont-connect slave)
4351 "Read network news.
4352 If ARG is non-nil and a positive number, Gnus will use that as the
4353 startup level. If ARG is non-nil and not a positive number, Gnus will
4354 prompt the user for the name of an NNTP server to use."
4355 (interactive "P")
4356 (unless (byte-code-function-p (symbol-function 'gnus))
4357 (message "You should byte-compile Gnus")
4358 (sit-for 2))
4359 (gnus-1 arg dont-connect slave))
4361 ;; Allow redefinition of Gnus functions.
4363 (gnus-ems-redefine)
4365 (provide 'gnus)
4367 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4368 ;;; gnus.el ends here