| blob | 36066e821667f04c1b6975a6244bfb43ef1309a1 |
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:
33 ;; For Emacs < 22.2.
42 ;; These are defined afterwards with gnus-define-group-parameter
56 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
61 "Starting your favorite newsreader."
65 "Dealing with formatting issues."
69 "Group character set issues."
75 "Cache interface."
80 "Article Registry."
84 "Server options at startup."
87 ;; These belong to gnus-group.el.
89 "Group buffers."
94 "Foreign groups."
99 "Automatic subscription of new groups."
103 "Group levels."
108 "Selecting a Group."
113 "Showing slices of the group list."
118 "Sorting the group buffer."
124 "Various group options."
128 ;; These belong to gnus-sum.el.
130 "Summary buffers."
135 "Leaving summary buffers."
140 "Marks used in summary buffers."
145 "Ordering articles according to replies."
150 "Formatting of the summary buffer."
155 "Choosing Articles."
160 "Summary movement commands."
165 "Show pictures of people, domains, and newsgroups."
169 "Mail group commands."
174 "Sorting the summary buffer."
179 "Highlighting and menus in the summary buffer."
185 "Various summary buffer options."
190 "Pick mode in the summary buffer."
196 "Tree display of threads in the summary buffer."
201 ;; Belongs to gnus-uu.el
203 "Viewing extracted files."
207 ;; Belongs to gnus-score.el
209 "Score and kill file handling."
213 "Kill files."
217 "Adaptive score files."
221 "Default values for score files."
225 "Expiring score rules."
229 "Decaying score rules."
233 "Score and kill file names."
238 "Various scoring and killing options."
241 ;; Other
243 "Options controlling the visual fluff."
248 "Offline support for Gnus."
252 "Files used by Gnus."
256 "Auto save file."
261 "Storing Gnus state."
265 "Options related to newsservers and other servers used by Gnus."
269 "Highlighting and menus in the server buffer."
274 "Composing replies and followups in Gnus."
278 "Meta variables controlling major portions of Gnus.
279 In general, modifying these variables does not take affect until Gnus
280 is restarted, and sometimes reloaded."
284 "Other Gnus options."
289 "Exiting Gnus."
294 "Frivolous Gnus extensions."
305 "If non-nil, the startup message will not be displayed.
306 This variable is used before `.gnus.el' is loaded, so it should
307 be set in `.emacs' instead."
312 "If non-nil, play the Gnus jingle at startup."
342 0 5
351 gnus-mode-line-image-cache)
353 "This is %s, %s."
355 str)
357 line)))
363 ;;(defalias 'gnus-decode-rfc1522 'ignore)
364 )
366 ;; We define these group faces here to avoid the display
367 ;; update forced when creating new faces.
377 ()))
378 "Level 1 newsgroup face."
380 ;; backward-compatibility alias
391 ()))
392 "Level 1 empty newsgroup face."
394 ;; backward-compatibility alias
405 ()))
406 "Level 2 newsgroup face."
408 ;; backward-compatibility alias
419 ()))
420 "Level 2 empty newsgroup face."
422 ;; backward-compatibility alias
433 ()))
434 "Level 3 newsgroup face."
436 ;; backward-compatibility alias
442 ())
445 ())
447 ()))
448 "Level 3 empty newsgroup face."
450 ;; backward-compatibility alias
461 ()))
462 "Level 4 newsgroup face."
464 ;; backward-compatibility alias
470 ())
473 ())
475 ()))
476 "Level 4 empty newsgroup face."
478 ;; backward-compatibility alias
489 ()))
490 "Level 5 newsgroup face."
492 ;; backward-compatibility alias
498 ())
501 ())
503 ()))
504 "Level 5 empty newsgroup face."
506 ;; backward-compatibility alias
517 ()))
518 "Level 6 newsgroup face."
520 ;; backward-compatibility alias
526 ())
529 ())
531 ()))
532 "Level 6 empty newsgroup face."
534 ;; backward-compatibility alias
545 ()))
546 "Low level newsgroup face."
548 ;; backward-compatibility alias
559 ()))
560 "Low level empty newsgroup face."
562 ;; backward-compatibility alias
574 "Level 1 mailgroup face."
576 ;; backward-compatibility alias
588 "Level 1 empty mailgroup face."
590 ;; backward-compatibility alias
602 "Level 2 mailgroup face."
604 ;; backward-compatibility alias
616 "Level 2 empty mailgroup face."
618 ;; backward-compatibility alias
630 "Level 3 mailgroup face."
632 ;; backward-compatibility alias
643 ()))
644 "Level 3 empty mailgroup face."
646 ;; backward-compatibility alias
658 "Low level mailgroup face."
660 ;; backward-compatibility alias
672 "Low level empty mailgroup face."
674 ;; backward-compatibility alias
677 ;; Summary mode faces.
680 "Face used for selected articles."
682 ;; backward-compatibility alias
688 "Face used for cancelled articles."
690 ;; backward-compatibility alias
702 "Face used for high interest ticked articles."
704 ;; backward-compatibility alias
716 "Face used for low interest ticked articles."
718 ;; backward-compatibility alias
729 ()))
730 "Face used for normal interest ticked articles."
732 ;; backward-compatibility alias
744 "Face used for high interest ancient articles."
746 ;; backward-compatibility alias
758 "Face used for low interest ancient articles."
760 ;; backward-compatibility alias
771 ()))
772 "Face used for normal interest ancient articles."
774 ;; backward-compatibility alias
784 "Face used for high interest uncached articles."
786 ;; backward-compatibility alias
796 "Face used for low interest uncached articles."
798 ;; backward-compatibility alias
808 "Face used for normal interest uncached articles."
810 ;; backward-compatibility alias
816 "Face used for high interest unread articles."
818 ;; backward-compatibility alias
824 "Face used for low interest unread articles."
826 ;; backward-compatibility alias
831 ()))
832 "Face used for normal interest unread articles."
834 ;; backward-compatibility alias
848 "Face used for high interest read articles."
850 ;; backward-compatibility alias
864 "Face used for low interest read articles."
866 ;; backward-compatibility alias
877 ()))
878 "Face used for normal interest read articles."
880 ;; backward-compatibility alias
884 ;;;
885 ;;; Gnus buffers
886 ;;;
891 "Do the same as `get-buffer-create', but store the created buffer."
896 "Add the current buffer to the list of Gnus buffers."
900 "Kill BUFFER and remove from the list of Gnus buffers."
907 "Return a list of live Gnus buffers."
916 gnus-buffers)
918 ;;; Splash screen.
933 ()))
934 "Face for the splash screen."
936 ;; backward-compatibility alias
951 "Indent rigidly using only spaces and no tabs."
957 ;; We translate tabs into spaces -- not everybody uses
958 ;; an 8-character tab.
965 ;;(format "%02x%02x%02x" 114 66 20) "724214"
989 "*Color styles used for the Gnus logo."
991 gnus-logo-color-alist))
999 "Insert startup message in current buffer."
1000 ;; Insert the message.
1014 :color-symbols
1020 ;; Account for the pbm's blackground.
1024 ;; Account for the xbm's blackground.
1035 t))))
1039 _ ___ _ _
1040 _ ___ __ ___ __ _ ___
1041 __ _ ___ __ ___
1042 _ ___ _
1043 _ _ __ _
1044 ___ __ _
1045 __ _
1046 _ _ _
1047 _ _ _
1048 _ _ _
1049 __ ___
1050 _ _ _ _
1051 _ _
1052 _ _
1053 _ _
1054 _
1055 __
1057 "
1059 ;; And then hack it.
1068 ;; Fontify some.
1082 ;;; Do the rest.
1088 "Alist of group parameters.
1090 For example:
1092 (gnus-use-scoring nil)
1093 (gnus-summary-line-format
1095 (gcc-self . t)
1096 (display . all))
1099 (broken-reply-to . t)))"
1106 "If it is t, ignore case of group names specified in `gnus-parameters'.
1107 If it is nil, don't ignore case. If it is `default', which is for the
1108 backward compatibility, use the value of `case-fold-search'."
1119 "Define a group parameter PARAM.
1120 REST is a plist of following:
1121 :type One of `bool', `list' or nil.
1122 :function The name of the function.
1123 :function-document The documentation of the function.
1124 :parameter-type The type for customizing the parameter.
1125 :parameter-document The documentation for the parameter.
1126 :variable The name of the variable.
1127 :variable-document The documentation for the variable.
1128 :variable-group The group for customizing the variable.
1129 :variable-type The type for customizing the variable.
1130 :variable-default The default value of the variable."
1147 'progn
1149 ,variable-document
1155 gnus-group-parameters-more))
1158 ,parameter-type
1162 ,function-document
1164 val)
1167 t)
1172 (,variable
1174 elem value)
1182 ,function-document
1186 elem value)
1193 'value
1198 All other Gnus file and directory variables are initialized from this variable."
1204 "*Directory variable from which all other Gnus file variables are derived.
1206 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1207 This means that other directory variables that are initialized from
1208 this variable won't be set properly if you set this variable in `.gnus.el'.
1209 Set this variable in `.emacs' instead."
1214 "*Default directory for all Gnus buffers."
1217 directory))
1219 ;; Site dependent variables. These variables should be defined in
1220 ;; paths.el.
1223 "Specify a default NNTP server.
1224 This variable should be defined in paths.el, and should never be set
1225 by the user.
1226 If you want to change servers, you should use `gnus-select-method'.
1229 ;; Don't touch this variable.
1232 This is an obsolete variable, which is scarcely used. If you use an
1233 nntp server for your newsgroup and want to change the port number
1234 used to 899, you would say something along these lines:
1239 "A file with only the name of the nntp server in it."
1245 "Find default nntp server.
1246 Check the NNTPSERVER environment variable and the
1247 `gnus-nntpserver-file' file."
1255 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1256 ;; starting or even loading Gnus.
1257 ;;;###autoload(when (fboundp 'custom-autoload)
1258 ;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1268 gnus-default-nntp-server)
1272 nil
1275 "Default method for selecting a newsgroup.
1276 This variable should be a list, where the first element is how the
1277 news is to be fetched, the second is the address.
1280 NNTP, you could say:
1284 If you want to use your local spool, say:
1286 \(setq gnus-select-method (list 'nnspool (system-name)))
1288 If you use this variable, you must set `gnus-nntp-server' to nil.
1290 There is a lot more to know about select methods and virtual servers -
1291 see the manual for details."
1298 "*Method used for archiving messages you've sent.
1299 This should be a mail method.
1301 See also `gnus-update-message-archive-method'."
1305 gnus-select-method))
1310 The archive method is initially set according to the value of
1312 so that it may be used as a real method of the server which is named
1314 updated if the value of this variable is nil, even if you change the
1315 value of `gnus-message-archive-method' afterward. If you want the
1317 `gnus-message-archive-method', set this variable to a non-nil value."
1324 "*Name of the group in which to save the messages you've written.
1325 This can either be a string; a list of strings; or an alist
1326 of regexps/functions/forms to be evaluated to return a string (or a list
1327 of strings). The functions are called with the name of the current
1328 group (or nil) as a parameter.
1330 If you want to save your mail in one group and the news articles you
1331 write in another group, you could say something like:
1333 \(setq gnus-message-archive-group
1334 '((if (message-news-p)
1338 Normally the group names returned by this variable should be
1340 However, you may wish to store the message on some other server. In
1341 that case, just return a fully prefixed name of the group --
1345 function
1346 sexp
1347 string))
1350 "List of NNTP servers that the user can choose between interactively.
1351 To make Gnus query you for a server, you have to give `gnus' a
1352 non-numeric prefix - `C-u M-x gnus', in short."
1357 "*The name of the host running the NNTP server.
1358 This variable is semi-obsolete. Use the `gnus-select-method'
1359 variable instead."
1362 string))
1365 "A list of secondary methods that will be used for reading news.
1366 This is a list where each element is a complete select method (see
1367 `gnus-select-method').
1369 If, for instance, you want to read your mail with the nnml back end,
1370 you could set this variable:
1378 "Default default new newsgroups the first time Gnus is run.
1382 "Local domain name without a host name.
1383 The DOMAINNAME environment variable is used instead if it is defined.
1384 If the function `system-name' returns the full Internet name, there is
1385 no need to set this variable."
1388 string))
1391 "String with a description of what organization (if any) the user belongs to.
1394 ;; Customization variables
1397 "Preferred method for fetching an article by Message-ID.
1398 If you are reading news from the local spool (with nnspool), fetching
1399 articles by Message-ID is painfully slow. By setting this method to an
1400 nntp method, you might get acceptable results.
1402 The value of this variable must be a valid select method as discussed
1403 in the documentation of `gnus-select-method'.
1405 It can also be a list of select methods, as well as the special symbol
1406 `current', which means to use the current select method. If it is a
1407 list, Gnus will try all the methods in the list until it finds a match."
1412 gnus-select-method
1420 gnus-select-method))))
1424 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1425 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1426 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1427 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1428 "/ftp@rtfm.mit.edu:/pub/usenet/"
1429 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1430 "/ftp@ftp.sunet.se:/pub/usenet/"
1431 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1432 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1434 "*Directory where the group FAQs are stored.
1435 This will most commonly be on a remote machine, and the file will be
1436 fetched by ange-ftp.
1438 This variable can also be a list of directories. In that case, the
1439 first element in the list will be used by default. The others can
1440 be used when being prompted for a site.
1442 Note that Gnus uses an aol machine as the default directory. If this
1443 feels fundamentally unclean, just think of it as a way to finally get
1444 something of value back from them.
1446 If the default site is too slow, try one of these:
1448 North America: mirrors.aol.com /pub/rtfm/usenet
1449 ftp.seas.gwu.edu /pub/rtfm
1450 rtfm.mit.edu /pub/usenet
1451 Europe: ftp.uni-paderborn.de /pub/FAQ
1452 src.doc.ic.ac.uk /usenet/news-FAQS
1453 ftp.sunet.se /pub/usenet
1454 ftp.pasteur.fr /pub/FAQ
1455 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1456 hwarang.postech.ac.kr /pub/usenet
1457 ftp.hk.super.net /mirror/faqs"
1484 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1485 When FORM is evaluated `name' is bound to the name of the group."
1492 "*Non-nil means that control messages are displayed using `browse-url'.
1493 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1494 group."
1500 "*Non-nil means that cross referenced articles will be marked as read.
1501 If nil, ignore cross references. If t, mark articles as read in
1502 subscribed newsgroups. If neither t nor nil, mark as read in all
1503 newsgroups."
1511 "*Process mark."
1517 "*The number of articles which indicates a large newsgroup.
1518 If the number of articles in a newsgroup is greater than this value,
1519 confirmation is required for selecting the newsgroup.
1520 If it is nil, no confirmation is required."
1523 integer))
1526 "*Non-nil means that the default name of a file to save articles in is the group name.
1527 If it's nil, the directory form of the group name is used instead.
1529 If this variable is a list, and the list contains the element
1530 `not-score', long file names will not be used for score files; if it
1531 contains the element `not-save', long file names will not be used for
1532 saving; and if it contains the element `not-kill', long file names
1533 will not be used for kill files.
1535 Note that the default for this variable varies according to what system
1536 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1537 to nil while on all other systems it defaults to t."
1555 "*If non-nil, save group scoring info."
1561 "*If non-nil, allow undoing in Gnus group mode buffers."
1566 "*If non-nil, use some adaptive scoring scheme.
1567 If a list, then the values `word' and `line' are meaningful. The
1568 former will perform adaption on individual words in the subject
1569 header while `line' will perform adaption on several headers."
1575 "*If nil, Gnus will ignore the article cache.
1576 If `passive', it will allow entering (and reading) articles
1577 explicitly entered into the cache. If anything else, use the
1578 cache to the full extent of the law."
1586 "*If non-nil, display a thread tree buffer."
1591 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1592 If it is a number N, then Gnus will only keep the last N articles
1593 read. If it is neither nil nor a number, Gnus will keep all read
1594 articles. This is not a good idea."
1597 integer
1602 "*If non-nil, Gnus will read NoCeM cancel messages.
1603 You can also set this variable to a positive number as a group level.
1604 In that case, Gnus scans NoCeM messages when checking new news if this
1605 value is not exceeding a group level that you specify as the prefix
1606 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1607 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1608 level to those commands."
1617 gnus-level-default-subscribed
1621 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1626 "*If non-nil, enable scoring."
1632 "*A hook called when preparing to exit from the summary buffer.
1633 It calls `gnus-summary-expire-articles' by default."
1638 "*Non-nil means that you are a Usenet novice.
1639 If non-nil, verbose messages may be displayed and confirmations may be
1640 required."
1645 "*Non-nil means that you will never be asked for confirmation about anything.
1646 That doesn't mean *anything* anything; particularly destructive
1647 commands will still require prompting."
1652 "*If non-nil, require your confirmation when catching up a group."
1657 "*If non-nil, require your confirmation when exiting Gnus."
1662 "*Function for extracting address components from a From header.
1663 Two pre-defined function exist: `gnus-extract-address-components',
1664 which is the default, quite fast, and too simplistic solution, and
1665 `mail-extract-address-components', which works much better, but is
1666 slower."
1673 "*If non-nil, display clickable icons."
1678 "String used to separate shell commands."
1710 "*An alist of valid select methods.
1711 The first element of each list lists should be a string with the name
1712 of the select method. The other elements may be the category of
1713 this method (i. e., `post', `mail', `none' or whatever) or other
1714 properties that this method has (like being respoolable).
1715 If you implement a new select method, all you should have to change is
1716 this variable. I think."
1731 "Recomputes the select-method widget based on the value of
1732 `gnus-valid-select-methods'."
1734 "Widget for entering a select method."
1741 gnus-valid-select-methods)
1745 :inline t
1747 variable
1753 "List of buffers that should update their mode lines.
1754 The list may contain the symbols `group', `article', `tree' and
1755 `summary'. If the corresponding symbol is present, Gnus will keep
1756 that mode line updated with information that may be pertinent.
1757 If this variable is nil, screen refresh may be quicker."
1764 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1766 "*Max length of mode-line non-string contents.
1767 If this is nil, Gnus will take space as is needed, leaving the rest
1768 of the mode line intact. Note that the default of nil is unlikely
1769 to be desirable; see the manual for further details."
1772 integer))
1774 ;; There should be special validation for this.
1779 to-address
1780 :function-document
1781 "Return GROUP's to-address."
1782 :variable-document
1783 "*Alist of group regexps and correspondent to-addresses."
1784 :variable-group gnus-group-parameter
1787 This will be used when doing followups and posts.
1789 This is primarily useful in mail groups that represent closed
1790 mailing lists--mailing lists where it's expected that everybody that
1791 writes to the mailing list is subscribed to it. Since using this
1792 parameter ensures that the mail only goes to the mailing list itself,
1793 it means that members won't receive two copies of your followups.
1795 Using `to-address' will actually work whether the group is foreign or
1796 not. Let's say there's a group on the server that is called
1797 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1798 articles from a mail-to-news gateway. Posting directly to this group
1799 is therefore impossible--you have to send mail to the mailing list
1800 address instead.
1802 The gnus-group-split mail splitting mechanism will behave as if this
1806 to-list
1807 :function-document
1808 "Return GROUP's to-list."
1809 :variable-document
1810 "*Alist of group regexps and correspondent to-lists."
1811 :variable-group gnus-group-parameter
1814 This address will be used when doing a `a' in the group.
1816 It is totally ignored when doing a followup--except that if it is
1817 present in a news group, you'll get mail group semantics when doing
1818 `f'.
1820 The gnus-group-split mail splitting mechanism will behave as if this
1824 subscribed
1825 :type bool
1826 :function-document
1827 "Return GROUP's subscription status."
1828 :variable-document
1829 "*Groups which are automatically considered subscribed."
1830 :variable-group gnus-group-parameter
1833 Gnus assumed that you are subscribed to the To/List address.
1835 When constructing a list of subscribed groups using
1836 `gnus-find-subscribed-addresses', Gnus includes the To address given
1840 auto-expire
1841 :type bool
1842 :function gnus-group-auto-expirable-p
1843 :function-document
1844 "Check whether GROUP is auto-expirable or not."
1845 :variable gnus-auto-expirable-newsgroups
1846 :variable-default nil
1847 :variable-document
1848 "*Groups in which to automatically mark read articles as expirable.
1849 If non-nil, this should be a regexp that should match all groups in
1850 which to perform auto-expiry. This only makes sense for mail groups."
1851 :variable-group nnmail-expire
1853 regexp)
1855 :parameter-document
1859 total-expire
1860 :type bool
1861 :function gnus-group-total-expirable-p
1862 :function-document
1863 "Check whether GROUP is total-expirable or not."
1864 :variable gnus-total-expirable-newsgroups
1865 :variable-default nil
1866 :variable-document
1867 "*Groups in which to perform expiry of all read articles.
1868 Use with extreme caution. All groups that match this regexp will be
1869 expiring - which means that all read articles will be deleted after
1870 \(say) one week. (This only goes for mail groups and the like, of
1871 course.)"
1872 :variable-group nnmail-expire
1874 regexp)
1876 :parameter-document
1877 "All read articles will be put through the expiry process
1879 This happens even if they are not marked as expirable.
1883 charset
1884 :function-document
1885 "Return the default charset of GROUP."
1886 :variable gnus-group-charset-alist
1887 :variable-default
1900 :variable-document
1901 "Alist of regexps (to match group names) and default charsets to be used when reading."
1902 :variable-group gnus-charset
1910 post-method
1911 :type list
1912 :function-document
1913 "Return a posting method for GROUP."
1914 :variable gnus-post-method-alist
1915 :variable-document
1916 "Alist of regexps (to match group names) and method to be used when
1917 posting an article."
1918 :variable-group gnus-group-foreign
1919 :parameter-type
1927 :parameter-document
1931 large-newsgroup-initial
1932 :type integer
1933 :function-document
1934 "Return GROUP's initial input of the number of articles."
1935 :variable-document
1936 "*Alist of group regexps and its initial input of the number of articles."
1937 :variable-group gnus-group-parameter
1943 This number will be prompted as the initial value of the number of
1944 articles to list when the group is a large newsgroup (see
1945 `gnus-large-newsgroup'). If it is nil, the default value is the
1948 ;; The Gnus registry's ignored groups
1950 registry-ignore
1951 :type list
1952 :function-document
1953 "Whether this group should be ignored by the registry."
1954 :variable gnus-registry-ignored-groups
1955 :variable-default nil
1956 :variable-document
1957 "*Groups in which the registry should be turned off."
1958 :variable-group gnus-registry
1965 :parameter-document
1968 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1970 "*Disable the group parameters for spam detection.
1971 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1978 "Spam group classification (requires spam.el).
1979 This group contains spam messages. On summary entry, unread messages
1980 will be marked as spam. On summary exit, the specified spam
1981 processors will be invoked on spam-marked messages, then those
1982 messages will be expired, so the spam processor will only see a
1986 "The ham value for the spam group parameter (requires spam.el).
1987 On summary exit, the specified ham processors will be invoked on
1988 ham-marked messages. Exercise caution, since the ham processor will
1989 see the same message more than once because there is no ham message
1993 spam-contents
1994 :type list
1995 :function-document
1996 "The spam type (spam, ham, or neither) of the group."
1997 :variable gnus-spam-newsgroup-contents
1998 :variable-default nil
1999 :variable-document
2000 "*Group classification (spam, ham, or neither). Only
2001 meaningful when spam.el is loaded. If non-nil, this should be a
2002 list of group name regexps associated with a classification for
2003 each one. In spam groups, new articles are marked as spam on
2004 summary entry. There is other behavior associated with ham and
2005 no classification when spam.el is loaded - see the manual."
2006 :variable-group spam
2020 :parameter-document
2021 "The spam classification (spam, ham, or neither) of this group.
2022 When a spam group is entered, all unread articles are marked as
2023 spam. There is other behavior associated with ham and no
2027 spam-resend-to
2028 :type list
2029 :function-document
2030 "The address to get spam resent (through spam-report-resend)."
2031 :variable gnus-spam-resend-to
2032 :variable-default nil
2033 :variable-document
2034 "The address to get spam resent (through spam-report-resend)."
2035 :variable-group spam
2039 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2040 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2041 :parameter-document
2045 ham-resend-to
2046 :type list
2047 :function-document
2048 "The address to get ham resent (through spam-report-resend)."
2049 :variable gnus-ham-resend-to
2050 :variable-default nil
2051 :variable-document
2052 "The address to get ham resent (through spam-report-resend)."
2053 :variable-group spam
2057 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2058 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2059 :parameter-document
2075 "OBSOLETE: The Gmane reporting summary exit spam processor.
2082 "OBSOLETE: The ifile summary exit ham processor.
2086 "OBSOLETE: The Bogofilter summary exit ham processor.
2090 "OBSOLETE: The spam-stat summary exit ham processor.
2094 "OBSOLETE: The whitelist summary exit ham processor.
2098 "OBSOLETE: The BBDB summary exit ham processor.
2102 "OBSOLETE: The ham copy exit ham processor.
2106 "OBSOLETE: The spamoracle summary exit ham processor.
2110 spam-process
2111 :type list
2112 :parameter-type
2115 :value nil
2152 :function-document
2153 "Which spam or ham processors will be applied when the summary is exited."
2154 :variable gnus-spam-process-newsgroups
2155 :variable-default nil
2156 :variable-document
2157 "*Groups in which to automatically process spam or ham articles with
2158 a backend on summary exit. If non-nil, this should be a list of group
2159 name regexps that should match all groups in which to do automatic
2160 spam processing, associated with the appropriate processor."
2161 :variable-group spam
2162 :variable-type
2203 :parameter-document
2207 spam-autodetect
2208 :type list
2209 :parameter-type
2211 :function-document
2212 "Should spam be autodetected (with spam-split) in this group?"
2213 :variable gnus-spam-autodetect
2214 :variable-default nil
2215 :variable-document
2216 "*Groups in which spam should be autodetected when they are entered.
2217 Only unseen articles will be examined, unless
2218 spam-autodetect-recheck-messages is set."
2219 :variable-group spam
2220 :variable-type
2225 boolean))
2226 :parameter-document
2227 "Spam autodetection.
2228 Only unseen articles will be examined, unless
2232 spam-autodetect-methods
2233 :type list
2234 :parameter-type
2257 :function-document
2258 "Methods to be used for autodetection in each group"
2259 :variable gnus-spam-autodetect-methods
2260 :variable-default nil
2261 :variable-document
2262 "*Methods for autodetecting spam per group.
2263 Requires the spam-autodetect parameter. Only unseen articles
2264 will be examined, unless spam-autodetect-recheck-messages is
2265 set."
2266 :variable-group spam
2267 :variable-type
2294 :parameter-document
2295 "Spam autodetection methods.
2296 Requires the spam-autodetect parameter. Only unseen articles
2297 will be examined, unless spam-autodetect-recheck-messages is
2301 spam-process-destination
2302 :type list
2303 :parameter-type
2309 :function-document
2310 "Where spam-processed articles will go at summary exit."
2311 :variable gnus-spam-process-destinations
2312 :variable-default nil
2313 :variable-document
2314 "*Groups in which to explicitly send spam-processed articles to
2315 another group, or expire them (the default). If non-nil, this should
2316 be a list of group name regexps that should match all groups in which
2317 to do spam-processed article moving, associated with the destination
2318 group or nil for explicit expiration. This only makes sense for
2319 mail groups."
2320 :variable-group spam
2321 :variable-type
2332 :parameter-document
2336 ham-process-destination
2337 :type list
2338 :parameter-type
2346 :function-document
2347 "Where ham articles will go at summary exit from a spam group."
2348 :variable gnus-ham-process-destinations
2349 :variable-default nil
2350 :variable-document
2351 "*Groups in which to explicitly send ham articles to
2352 another group, or do nothing (the default). If non-nil, this should
2353 be a list of group name regexps that should match all groups in which
2354 to do ham article moving, associated with the destination
2355 group or nil for explicit ignoring. This only makes sense for
2356 mail groups, and only works in spam groups."
2357 :variable-group spam
2358 :variable-type
2370 :parameter-document
2374 ham-marks
2385 :parameter-document
2386 "Marks considered ham (positively not spam). Such articles will be
2387 processed as ham (non-spam) on group exit. When nil, the global
2388 spam-ham-marks variable takes precedence."
2390 gnus-read-mark
2391 gnus-killed-mark
2392 gnus-kill-file-mark
2393 gnus-low-score-mark))))
2394 :variable-group spam
2395 :variable-document
2399 spam-marks
2408 :parameter-document
2409 "Marks considered spam.
2410 Such articles will be processed as spam on group exit. When nil, the global
2411 spam-spam-marks variable takes precedence."
2413 :variable-group spam
2414 :variable-document
2418 "Number of group name elements to leave alone when making a short group name."
2423 "*If non-nil, once you set a level, Gnus will use this level."
2427 ;; Hooks.
2430 "A hook run while Gnus is loaded."
2435 "A hook called to apply kill files to a group.
2436 This hook is intended to apply a kill file to the selected newsgroup.
2437 The function `gnus-apply-kill-file' is called by default.
2439 Since a general kill file is too heavy to use only for a few
2440 newsgroups, I recommend you to use a lighter hook function. For
2441 example, if you'd like to apply a kill file to articles which contains
2442 a string `rmgroup' in subject in newsgroup `control', you can use the
2443 following hook:
2445 (setq gnus-apply-kill-hook
2446 (list
2447 (lambda ()
2456 "Function run when a group level is changed.
2457 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2460 function))
2462 ;;; Face thingies.
2466 mouse-face
2467 summary-menu group-menu article-menu
2468 tree-highlight menu highlight
2469 browse-menu server-menu
2470 page-marker tree-menu binary-menu pick-menu)
2471 "*Enable visual features.
2472 If `visual' is disabled, there will be no menus and few faces. Most of
2473 the visual customization options below will be ignored. Gnus will use
2474 less space and be faster as a result.
2476 This variable can also be a list of visual elements to switch on. For
2477 instance, to switch off all visual things except menus, you can say:
2479 (setq gnus-visual '(menu))
2481 Valid elements include `summary-highlight', `group-highlight',
2482 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2483 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2484 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2504 ;; Byte-compiler warning.
2506 ;; Find out whether the gnus-visual TYPE is wanted.
2510 gnus-visual
2514 t))))
2524 "*Face used for group or summary buffer mouse highlighting.
2525 The line beneath the mouse pointer will be highlighted with this
2526 face."
2539 "Controls use of the agent cache while plugged.
2540 When set, Gnus will prefer using the locally stored content rather
2541 than re-fetching it from the server. You also need to enable
2542 `gnus-agent' for this to have any affect."
2548 "Default charset assumed to be used when viewing non-ASCII characters.
2549 This variable is overridden on a group-to-group basis by the
2550 `gnus-group-charset-alist' variable and is only used on groups not
2551 covered by that variable."
2555 ;; Fixme: Doc reference to agent.
2557 "Whether we want to use the Gnus agent or not.
2559 You may customize gnus-agent to disable its use. However, some
2560 back ends have started to use the agent as a client-side cache.
2561 Disabling the agent may result in noticeable loss of performance."
2567 "Function called by the command `gnus-other-frame'."
2575 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2576 This should be an alist for Emacs, or a plist for XEmacs."
2587 "Which information should be exposed in the User-Agent header.
2589 Can be a list of symbols or a string. Valid symbols are `gnus'
2590 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2591 addition to the Emacs version, you can add `codename' \(show
2592 \(S\)XEmacs codename\) or either `config' \(show system
2593 configuration\) or `type' \(show system type\). If you set it to
2594 a string, be sure to use a valid format, see RFC 2616."
2607 ;; Convert old (< 2005-01-10) symbol type values:
2626 \f
2627 ;;; Internal variables
2632 ; Reset each time gnus-agent-covered-methods is changed else
2633 ; gnus-agent-method-p may mis-report a methods status.
2634 )
2658 ;; Dummy variable.
2661 ;; Variable holding the user answers to all method prompts.
2664 ;; Variable holding the user answers to all mail method prompts.
2667 ;; Variable holding the user answers to all group prompts.
2675 "*The directory where cached articles will be stored."
2681 nnspool "cache"
2705 ;; Propagate flags to server, with the following exceptions:
2706 ;; `seen' is private to each gnus installation
2707 ;; `cache' is a internal gnus flag for each gnus installation
2708 ;; `download' is a agent flag private to each gnus installation
2709 ;; `unsend' are for nndraft groups only
2710 ;; `score' is not a proper mark
2711 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2714 "Marks that shouldn't be propagated to back ends.
2715 Typical marks are those that make no sense in a standalone back end,
2716 such as a mark that says whether an article is stored in the cache
2729 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2754 gnus-newsrc-last-checked-date
2755 gnus-newsrc-alist gnus-server-alist
2756 gnus-killed-list gnus-zombie-list
2757 gnus-topic-topology gnus-topic-alist
2758 gnus-format-specs)
2762 "Assoc list of read articles.
2766 "Assoc list of registry data.
2793 ;; Save window configuration.
2798 ;;; Let the byte-compiler know that we know about this variable.
2809 ;;; End of variables.
2811 ;; Define some autoload functions Gnus might use.
2814 ;; This little mapcar goes through the list below and marks the
2815 ;; symbols in question as autoloaded functions.
2835 message-send-and-exit message-yank-original)
2841 rmail-show-message rmail-summary-exists
2842 rmail-select-summary rmail-update-summary)
2846 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2847 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2851 gnus-Folder-save-name gnus-folder-save-name)
2854 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2855 gnus-demon-add-disconnection gnus-demon-add-handler
2856 gnus-demon-remove-handler)
2858 gnus-demon-init gnus-demon-cancel)
2860 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2861 gnus-face-from-file)
2863 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2865 gnus-nocem-unwanted-article-p)
2867 gnus-server-server-name)
2870 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2871 gnus-article-hide-citation gnus-article-fill-cited-article
2872 gnus-article-hide-citation-in-followups)
2874 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2875 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2877 gnus-cache-possibly-remove-articles gnus-cache-request-article
2878 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2879 gnus-cache-enter-remove-article gnus-cached-article-p
2880 gnus-cache-open gnus-cache-close gnus-cache-update-article
2881 gnus-cache-articles-in-group)
2883 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2885 gnus-summary-increase-score gnus-summary-set-score
2886 gnus-summary-raise-thread gnus-summary-raise-same-subject
2887 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2888 gnus-summary-lower-thread gnus-summary-lower-same-subject
2889 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2890 gnus-summary-current-score gnus-score-delta-default
2891 gnus-score-flush-cache gnus-score-close
2892 gnus-possibly-score-headers gnus-score-followup-article
2893 gnus-score-followup-thread)
2896 gnus-current-score-file-nondirectory gnus-score-adaptive
2897 gnus-score-find-trace gnus-score-file-name)
2901 gnus-subscribe-topics)
2905 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2906 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2907 gnus-uu-mark-by-regexp gnus-uu-mark-all
2908 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2909 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2910 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2911 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2912 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2913 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2914 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2915 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2918 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2920 gnus-group-post-news gnus-group-mail gnus-group-news
2921 gnus-summary-post-news gnus-summary-news-other-window
2922 gnus-summary-followup gnus-summary-followup-with-original
2923 gnus-summary-cancel-article gnus-summary-supersede-article
2924 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2925 gnus-summary-mail-forward gnus-summary-mail-other-window
2926 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2927 gnus-summary-wide-reply gnus-summary-followup-to-mail
2928 gnus-summary-followup-to-mail-with-original gnus-bug
2929 gnus-summary-wide-reply-with-original
2930 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2931 gnus-summary-post-forward)
2936 gnus-list-of-unread-articles gnus-list-of-read-articles
2937 gnus-offer-save-summaries gnus-make-thread-indent-array
2938 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2939 gnus-summary-skip-intangible gnus-summary-article-number
2940 gnus-data-header gnus-data-find)
2942 gnus-group-list-groups gnus-group-first-unread-group
2943 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2944 gnus-group-setup-buffer gnus-group-get-new-news
2945 gnus-group-make-help-group gnus-group-update-group
2946 gnus-group-iterate gnus-group-group-name)
2948 gnus-backlog-remove-article)
2950 gnus-article-prepare gnus-article-set-window-start
2951 gnus-article-next-page gnus-article-prev-page
2952 gnus-request-article-this-buffer gnus-article-mode
2953 gnus-article-setup-buffer gnus-narrow-to-page
2954 gnus-article-delete-invisible-text gnus-treat-article)
2956 gnus-article-hide-headers gnus-article-hide-boring-headers
2957 gnus-article-treat-overstrike
2958 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2959 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2960 gnus-article-de-base64-unreadable
2961 gnus-article-decode-HZ
2962 gnus-article-wash-html
2963 gnus-article-unsplit-urls
2964 gnus-article-hide-pem gnus-article-hide-signature
2965 gnus-article-strip-leading-blank-lines gnus-article-date-local
2966 gnus-article-date-original gnus-article-date-lapsed
2967 ;;gnus-article-show-all-headers
2968 gnus-article-edit-mode gnus-article-edit-article
2969 gnus-article-edit-done gnus-article-decode-encoded-words
2970 gnus-start-date-timer gnus-stop-date-timer
2971 gnus-mime-view-all-parts)
2974 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2975 gnus-check-reasonable-setup)
2977 gnus-dup-enter-articles)
2981 gnus-group-move-group-to-server gnus-change-server)
2985 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2986 gnus-async-halt-prefetch)
2988 gnus-agent-save-active gnus-agent-method-p
2989 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2990 gnus-summary-set-agent-mark gnus-agent-save-group-info
2991 gnus-agent-request-article gnus-agent-retrieve-headers)
2993 gnus-unplugged gnus-agentize gnus-agent-batch)
2995 gnus-summary-save-article-vm)
3000 gnus-group-split-update)
3003 ;;; gnus-sum.el thingies
3007 "*The format specification of the lines in the summary buffer.
3009 It works along the same lines as a normal formatting string,
3010 with some simple extensions.
3012 %N Article number, left padded with spaces (string)
3013 %S Subject (string)
3015 %n Name of the poster (string)
3016 %a Extracted name of the poster (string)
3017 %A Extracted address of the poster (string)
3018 %F Contents of the From: header (string)
3019 %f Contents of the From: or To: headers (string)
3020 %x Contents of the Xref: header (string)
3021 %D Date of the article (string)
3022 %d Date of the article (string) in DD-MMM format
3023 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
3024 %M Message-id of the article (string)
3025 %r References of the article (string)
3026 %c Number of characters in the article (integer)
3027 %k Pretty-printed version of the above (string)
3029 %L Number of lines in the article (integer)
3030 %I Indentation based on thread level (a string of spaces)
3031 %B A complex trn-style thread tree (string)
3032 The variables `gnus-sum-thread-*' can be used for customization.
3033 %T A string with two possible values: 80 spaces if the article
3034 is on thread level two or larger and 0 spaces on level one
3039 %> Spaces of length thread-level (string)
3040 %< Spaces of length (- 20 thread-level) (string)
3041 %i Article score (number)
3042 %z Article zcore (character)
3043 %t Number of articles under the current thread (number).
3044 %e Whether the thread is empty or not (character).
3045 %V Total thread score (number).
3046 %P The line number (number).
3047 %O Download mark (character).
3048 %* If present, indicates desired cursor position
3049 (instead of after first colon).
3050 %u User defined specifier. The next character in the format string should
3051 be a letter. Gnus will call the function gnus-user-format-function-X,
3052 where X is the letter following %u. The function will be passed the
3053 current header as argument. The function should return a string, which
3054 will be inserted into the summary just like information from any other
3055 summary specifier.
3057 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3058 with care. For reasons of efficiency, Gnus will compute what column
3060 it is invalid to have these specs after a variable-length spec. Well,
3061 you might not be arrested, but your summary buffer will look strange,
3062 which is bad enough.
3064 The smart choice is to have these specs as far to the left as
3065 possible.
3067 This restriction may disappear in later versions of Gnus.
3069 General format specifiers can also be used.
3070 See Info node `(gnus)Formatting Variables'."
3075 ;;;
3076 ;;; Skeleton keymaps
3077 ;;;
3082 (while keys
3083 (define-key keymap (pop keys) 'undefined))))
3085 (defvar gnus-article-mode-map
3086 (let ((keymap (make-sparse-keymap)))
3087 (gnus-suppress-keymap keymap)
3088 keymap))
3089 (defvar gnus-summary-mode-map
3090 (let ((keymap (make-keymap)))
3091 (gnus-suppress-keymap keymap)
3092 keymap))
3093 (defvar gnus-group-mode-map
3094 (let ((keymap (make-keymap)))
3095 (gnus-suppress-keymap keymap)
3096 keymap))
3098 \f
3100 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3101 ;; If you want the cursor to go somewhere else, set these two
3102 ;; functions in some startup hook to whatever you want.
3103 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3104 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3106 ;;; Various macros and substs.
3108 (defun gnus-header-from (header)
3109 (mail-header-from header))
3111 (defmacro gnus-gethash (string hashtable)
3112 "Get hash value of STRING in HASHTABLE."
3113 `(symbol-value (intern-soft ,string ,hashtable)))
3115 (defmacro gnus-gethash-safe (string hashtable)
3116 "Get hash value of STRING in HASHTABLE.
3117 Return nil if not defined."
3118 `(let ((sym (intern-soft ,string ,hashtable)))
3119 (and (boundp sym) (symbol-value sym))))
3121 (defmacro gnus-sethash (string value hashtable)
3122 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3123 `(set (intern ,string ,hashtable) ,value))
3124 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3126 (defmacro gnus-group-unread (group)
3127 "Get the currently computed number of unread articles in GROUP."
3128 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3130 (defmacro gnus-group-entry (group)
3131 "Get the newsrc entry for GROUP."
3132 `(gnus-gethash ,group gnus-newsrc-hashtb))
3134 (defmacro gnus-active (group)
3135 "Get active info on GROUP."
3136 `(gnus-gethash ,group gnus-active-hashtb))
3138 (defmacro gnus-set-active (group active)
3139 "Set GROUP's active info."
3140 `(gnus-sethash ,group ,active gnus-active-hashtb))
3142 ;; Info access macros.
3144 (defmacro gnus-info-group (info)
3145 `(nth 0 ,info))
3146 (defmacro gnus-info-rank (info)
3147 `(nth 1 ,info))
3148 (defmacro gnus-info-read (info)
3149 `(nth 2 ,info))
3150 (defmacro gnus-info-marks (info)
3151 `(nth 3 ,info))
3152 (defmacro gnus-info-method (info)
3153 `(nth 4 ,info))
3154 (defmacro gnus-info-params (info)
3155 `(nth 5 ,info))
3157 (defmacro gnus-info-level (info)
3158 `(let ((rank (gnus-info-rank ,info)))
3159 (if (consp rank)
3160 (car rank)
3161 rank)))
3162 (defmacro gnus-info-score (info)
3163 `(let ((rank (gnus-info-rank ,info)))
3164 (or (and (consp rank) (cdr rank)) 0)))
3166 (defmacro gnus-info-set-group (info group)
3167 `(setcar ,info ,group))
3168 (defmacro gnus-info-set-rank (info rank)
3169 `(setcar (nthcdr 1 ,info) ,rank))
3170 (defmacro gnus-info-set-read (info read)
3171 `(setcar (nthcdr 2 ,info) ,read))
3172 (defmacro gnus-info-set-marks (info marks &optional extend)
3173 (if extend
3174 `(gnus-info-set-entry ,info ,marks 3)
3175 `(setcar (nthcdr 3 ,info) ,marks)))
3176 (defmacro gnus-info-set-method (info method &optional extend)
3177 (if extend
3178 `(gnus-info-set-entry ,info ,method 4)
3179 `(setcar (nthcdr 4 ,info) ,method)))
3180 (defmacro gnus-info-set-params (info params &optional extend)
3181 (if extend
3182 `(gnus-info-set-entry ,info ,params 5)
3183 `(setcar (nthcdr 5 ,info) ,params)))
3185 (defun gnus-info-set-entry (info entry number)
3186 ;; Extend the info until we have enough elements.
3187 (while (<= (length info) number)
3188 (nconc info (list nil)))
3189 ;; Set the entry.
3190 (setcar (nthcdr number info) entry))
3192 (defmacro gnus-info-set-level (info level)
3193 `(let ((rank (cdr ,info)))
3194 (if (consp (car rank))
3195 (setcar (car rank) ,level)
3196 (setcar rank ,level))))
3197 (defmacro gnus-info-set-score (info score)
3198 `(let ((rank (cdr ,info)))
3199 (if (consp (car rank))
3200 (setcdr (car rank) ,score)
3201 (setcar rank (cons (car rank) ,score)))))
3203 (defmacro gnus-get-info (group)
3204 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3206 ;;; Load the compatibility functions.
3208 (require 'gnus-ems)
3210 \f
3211 ;;;
3212 ;;; Shutdown
3213 ;;;
3215 (defvar gnus-shutdown-alist nil)
3217 (defun gnus-add-shutdown (function &rest symbols)
3218 "Run FUNCTION whenever one of SYMBOLS is shut down."
3219 (push (cons function symbols) gnus-shutdown-alist))
3221 (defun gnus-shutdown (symbol)
3222 "Shut down everything that waits for SYMBOL."
3223 (dolist (entry gnus-shutdown-alist)
3224 (when (memq symbol (cdr entry))
3225 (funcall (car entry)))))
3227 \f
3228 ;;;
3229 ;;; Gnus Utility Functions
3230 ;;;
3232 (defun gnus-find-subscribed-addresses ()
3233 "Return a regexp matching the addresses of all subscribed mail groups.
3234 It consists of the `to-address' or `to-list' parameter of all groups
3235 with a `subscribed' parameter."
3236 (let (group address addresses)
3237 (dolist (entry (cdr gnus-newsrc-alist))
3238 (setq group (car entry))
3239 (when (gnus-parameter-subscribed group)
3240 (setq address (mail-strip-quoted-names
3241 (or (gnus-group-fast-parameter group 'to-address)
3242 (gnus-group-fast-parameter group 'to-list))))
3243 (when address
3244 (add-to-list 'addresses address))))
3245 (when addresses
3248 (defmacro gnus-string-or (&rest strings)
3249 "Return the first element of STRINGS that is a non-blank string.
3250 STRINGS will be evaluated in normal `or' order."
3251 `(gnus-string-or-1 ',strings))
3253 (defun gnus-string-or-1 (strings)
3254 (let (string)
3255 (while strings
3256 (setq string (eval (pop strings)))
3258 (setq string nil)
3259 (setq strings nil)))
3260 string))
3262 (defun gnus-version (&optional arg)
3263 "Version number of this version of Gnus.
3264 If ARG, insert string at point."
3265 (interactive "P")
3266 (if arg
3267 (insert (message gnus-version))
3268 (message gnus-version)))
3270 (defun gnus-continuum-version (&optional version)
3271 "Return VERSION as a floating point number."
3272 (interactive)
3273 (unless version
3274 (setq version gnus-version))
3277 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3278 (number (match-string 2 version))
3279 major minor least)
3280 (unless (string-match
3282 (error "Invalid version string: %s" version))
3283 (setq major (string-to-number (match-string 1 number))
3284 minor (string-to-number (match-string 2 number))
3285 least (if (match-beginning 3)
3286 (string-to-number (match-string 3 number))
3287 0))
3288 (string-to-number
3289 (if (zerop major)
3290 (format "%s00%02d%02d"
3291 (if (member alpha '("(ding)" "d"))
3292 "4.99"
3293 (+ 5 (* 0.02
3294 (abs
3295 (- (mm-char-int (aref (downcase alpha) 0))
3296 (mm-char-int ?t))))
3297 -0.01))
3298 minor least)
3299 (format "%d.%02d%02d" major minor least))))))
3301 (defun gnus-info-find-node (&optional nodename)
3302 "Find Info documentation of Gnus."
3303 (interactive)
3304 ;; Enlarge info window if needed.
3305 (let (gnus-info-buffer)
3306 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3307 (setq gnus-info-buffer (current-buffer))
3308 (gnus-configure-windows 'info)))
3310 ;;;
3311 ;;; gnus-interactive
3312 ;;;
3314 (defvar gnus-current-prefix-symbol nil
3315 "Current prefix symbol.")
3317 (defvar gnus-current-prefix-symbols nil
3318 "List of current prefix symbols.")
3320 (defun gnus-interactive (string &optional params)
3321 "Return a list that can be fed to `interactive'.
3322 See `interactive' for full documentation.
3324 Adds the following specs:
3326 y -- The current symbolic prefix.
3327 Y -- A list of the current symbolic prefix(es).
3328 A -- Article number.
3329 H -- Article header.
3330 g -- Group name."
3331 (let ((i 0)
3332 out c prompt)
3333 (while (< i (length string))
3335 (setq c (aref string i))
3336 (when (match-end 1)
3337 (setq prompt (match-string 1 string)))
3338 (setq i (match-end 0))
3339 ;; We basically emulate just about everything that
3340 ;; `interactive' does, but add the specs listed above.
3341 (push
3342 (cond
3343 ((= c ?a)
3344 (completing-read prompt obarray 'fboundp t))
3345 ((= c ?b)
3346 (read-buffer prompt (current-buffer) t))
3347 ((= c ?B)
3348 (read-buffer prompt (other-buffer (current-buffer))))
3349 ((= c ?c)
3350 (read-char))
3351 ((= c ?C)
3352 (completing-read prompt obarray 'commandp t))
3353 ((= c ?d)
3354 (point))
3355 ((= c ?D)
3356 (read-file-name prompt nil default-directory 'lambda))
3357 ((= c ?f)
3358 (read-file-name prompt nil nil 'lambda))
3359 ((= c ?F)
3360 (read-file-name prompt))
3361 ((= c ?k)
3362 (read-key-sequence prompt))
3363 ((= c ?K)
3364 (error "Not implemented spec"))
3365 ((= c ?e)
3366 (error "Not implemented spec"))
3367 ((= c ?m)
3368 (mark))
3369 ((= c ?N)
3370 (error "Not implemented spec"))
3371 ((= c ?n)
3372 (string-to-number (read-from-minibuffer prompt)))
3373 ((= c ?p)
3374 (prefix-numeric-value current-prefix-arg))
3375 ((= c ?P)
3376 current-prefix-arg)
3377 ((= c ?r)
3378 'gnus-prefix-nil)
3379 ((= c ?s)
3380 (read-string prompt))
3381 ((= c ?S)
3382 (intern (read-string prompt)))
3383 ((= c ?v)
3384 (read-variable prompt))
3385 ((= c ?x)
3386 (read-minibuffer prompt))
3387 ((= c ?x)
3388 (eval-minibuffer prompt))
3389 ;; And here the new specs come.
3390 ((= c ?y)
3391 gnus-current-prefix-symbol)
3392 ((= c ?Y)
3393 gnus-current-prefix-symbols)
3394 ((= c ?g)
3395 (gnus-group-group-name))
3396 ((= c ?A)
3397 (gnus-summary-skip-intangible)
3398 (or (get-text-property (point) 'gnus-number)
3399 (gnus-summary-last-subject)))
3400 ((= c ?H)
3401 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3402 (t
3403 (error "Non-implemented spec")))
3404 out)
3405 (cond
3406 ((= c ?r)
3407 (push (if (< (point) (mark)) (point) (mark)) out)
3408 (push (if (> (point) (mark)) (point) (mark)) out))))
3409 (setq out (delq 'gnus-prefix-nil out))
3410 (nreverse out)))
3412 (defun gnus-symbolic-argument (&optional arg)
3413 "Read a symbolic argument and a command, and then execute command."
3414 (interactive "P")
3415 (let* ((in-command (this-command-keys))
3416 (command in-command)
3417 gnus-current-prefix-symbols
3418 gnus-current-prefix-symbol
3419 syms)
3420 (while (equal in-command command)
3421 (message "%s-" (key-description (this-command-keys)))
3422 (push (intern (char-to-string (read-char))) syms)
3423 (setq command (read-key-sequence nil t)))
3424 (setq gnus-current-prefix-symbols (nreverse syms)
3425 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3426 (call-interactively (key-binding command t))))
3428 ;;; More various functions.
3430 (defsubst gnus-check-backend-function (func group)
3431 "Check whether GROUP supports function FUNC.
3432 GROUP can either be a string (a group name) or a select method."
3433 (ignore-errors
3434 (let ((method (if (stringp group)
3435 (car (gnus-find-method-for-group group))
3436 group)))
3437 (unless (featurep method)
3438 (require method))
3439 (fboundp (intern (format "%s-%s" method func))))))
3441 (defun gnus-group-read-only-p (&optional group)
3442 "Check whether GROUP supports editing or not.
3443 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3444 that that variable is buffer-local to the summary buffers."
3445 (let ((group (or group gnus-newsgroup-name)))
3446 (not (gnus-check-backend-function 'request-replace-article group))))
3448 (defun gnus-virtual-group-p (group)
3449 "Say whether GROUP is virtual or not."
3450 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3451 gnus-valid-select-methods)))
3453 (defun gnus-news-group-p (group &optional article)
3454 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3455 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3456 t) ;is news of course.
3457 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3458 nil) ;must be mail then.
3459 ((vectorp article) ;Has header info.
3460 (eq (gnus-request-type group (mail-header-id article)) 'news))
3461 ((null article) ;Hasn't header info
3462 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3463 ((< article 0) ;Virtual message
3464 nil) ;we don't know, guess mail.
3465 (t ;Has positive number
3466 (eq (gnus-request-type group article) 'news)))) ;use it.
3468 ;; Returns a list of writable groups.
3469 (defun gnus-writable-groups ()
3470 (let ((alist gnus-newsrc-alist)
3471 groups group)
3472 (while (setq group (car (pop alist)))
3473 (unless (gnus-group-read-only-p group)
3474 (push group groups)))
3475 (nreverse groups)))
3477 ;; Check whether to use long file names.
3478 (defun gnus-use-long-file-name (symbol)
3479 ;; The variable has to be set...
3480 (and gnus-use-long-file-name
3481 ;; If it isn't a list, then we return t.
3482 (or (not (listp gnus-use-long-file-name))
3483 ;; If it is a list, and the list contains `symbol', we
3484 ;; return nil.
3485 (not (memq symbol gnus-use-long-file-name)))))
3487 ;; Generate a unique new group name.
3488 (defun gnus-generate-new-group-name (leaf)
3489 (let ((name leaf)
3490 (num 0))
3491 (while (gnus-group-entry name)
3492 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3493 name))
3495 (defun gnus-ephemeral-group-p (group)
3496 "Say whether GROUP is ephemeral or not."
3497 (gnus-group-get-parameter group 'quit-config t))
3499 (defun gnus-group-quit-config (group)
3500 "Return the quit-config of GROUP."
3501 (gnus-group-get-parameter group 'quit-config t))
3503 (defun gnus-kill-ephemeral-group (group)
3504 "Remove ephemeral GROUP from relevant structures."
3505 (gnus-sethash group nil gnus-newsrc-hashtb))
3507 (defun gnus-simplify-mode-line ()
3508 "Make mode lines a bit simpler."
3509 (setq mode-line-modified (cdr gnus-mode-line-modified))
3510 (when (listp mode-line-format)
3511 (make-local-variable 'mode-line-format)
3512 (setq mode-line-format (copy-sequence mode-line-format))
3513 (when (equal (nth 3 mode-line-format) " ")
3514 (setcar (nthcdr 3 mode-line-format) " "))))
3516 ;;; Servers and groups.
3518 (defsubst gnus-server-add-address (method)
3519 (let ((method-name (symbol-name (car method))))
3520 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3521 (not (assq (intern (concat method-name "-address")) method))
3522 (memq 'physical-address (assq (car method)
3523 gnus-valid-select-methods)))
3524 (append method (list (list (intern (concat method-name "-address"))
3525 (nth 1 method))))
3526 method)))
3528 (defsubst gnus-method-to-server (method &optional nocache)
3529 (catch 'server-name
3530 (setq method (or method gnus-select-method))
3532 ;; Perhaps it is already in the cache.
3533 (unless nocache
3534 (mapc (lambda (name-method)
3535 (if (equal (cdr name-method) method)
3536 (throw 'server-name (car name-method))))
3537 gnus-server-method-cache))
3539 (mapc
3540 (lambda (server-alist)
3541 (mapc (lambda (name-method)
3542 (when (gnus-methods-equal-p (cdr name-method) method)
3543 (unless (member name-method gnus-server-method-cache)
3544 (push name-method gnus-server-method-cache))
3545 (throw 'server-name (car name-method))))
3546 server-alist))
3547 (list gnus-server-alist
3548 gnus-predefined-server-alist))
3550 (let* ((name (if (member (cadr method) '(nil ""))
3551 (format "%s" (car method))
3552 (format "%s:%s" (car method) (cadr method))))
3553 (name-method (cons name method)))
3554 (unless (member name-method gnus-server-method-cache)
3555 (push name-method gnus-server-method-cache))
3556 name)))
3558 (defsubst gnus-server-to-method (server)
3559 "Map virtual server names to select methods."
3560 (or (and server (listp server) server)
3561 (cdr (assoc server gnus-server-method-cache))
3562 (let ((result
3563 (or
3564 ;; Perhaps this is the native server?
3565 (and (equal server "native") gnus-select-method)
3566 ;; It should be in the server alist.
3567 (cdr (assoc server gnus-server-alist))
3568 ;; It could be in the predefined server alist.
3569 (cdr (assoc server gnus-predefined-server-alist))
3570 ;; If not, we look through all the opened server
3571 ;; to see whether we can find it there.
3572 (let ((opened gnus-opened-servers))
3573 (while (and opened
3574 (not (equal server (format "%s:%s" (caaar opened)
3575 (cadaar opened)))))
3576 (pop opened))
3577 (caar opened))
3578 ;; It could be a named method, search all servers
3579 (let ((servers gnus-secondary-select-methods))
3580 (while (and servers
3581 (not (equal server (format "%s:%s" (caar servers)
3582 (cadar servers)))))
3583 (pop servers))
3584 (car servers))
3585 ;; This could be some sort of foreign server that I
3586 ;; simply haven't opened (yet). Do a brute-force scan
3587 ;; of the entire gnus-newsrc-alist for the server name
3588 ;; of every method. As a side-effect, loads the
3589 ;; gnus-server-method-cache so this only happens once,
3590 ;; if at all.
3591 (let ((alist (cdr gnus-newsrc-alist))
3592 method match)
3593 (while alist
3594 (setq method (gnus-info-method (pop alist)))
3595 (when (and (not (stringp method))
3596 (equal server (gnus-method-to-server method)))
3597 (setq match method
3598 alist nil)))
3599 match))))
3600 (when result
3601 (push (cons server result) gnus-server-method-cache))
3602 result)))
3604 (defsubst gnus-server-get-method (group method)
3605 ;; Input either a server name, and extended server name, or a
3606 ;; select method, and return a select method.
3607 (cond ((stringp method)
3608 (gnus-server-to-method method))
3609 ((equal method gnus-select-method)
3610 gnus-select-method)
3611 ((and (stringp (car method))
3612 group)
3613 (gnus-server-extend-method group method))
3614 ((and method
3615 (not group)
3616 (equal (cadr method) ""))
3617 method)
3618 (t
3619 (gnus-server-add-address method))))
3621 (defmacro gnus-method-equal (ss1 ss2)
3622 "Say whether two servers are equal."
3623 `(let ((s1 ,ss1)
3624 (s2 ,ss2))
3625 (or (equal s1 s2)
3626 (and (= (length s1) (length s2))
3627 (progn
3628 (while (and s1 (member (car s1) s2))
3629 (setq s1 (cdr s1)))
3630 (null s1))))))
3632 (defun gnus-methods-equal-p (m1 m2)
3633 (let ((m1 (or m1 gnus-select-method))
3634 (m2 (or m2 gnus-select-method)))
3635 (or (equal m1 m2)
3636 (and (eq (car m1) (car m2))
3637 (or (not (memq 'address (assoc (symbol-name (car m1))
3638 gnus-valid-select-methods)))
3639 (equal (nth 1 m1) (nth 1 m2)))))))
3641 (defun gnus-server-equal (m1 m2)
3642 "Say whether two methods are equal."
3643 (let ((m1 (cond ((null m1) gnus-select-method)
3644 ((stringp m1) (gnus-server-to-method m1))
3645 (t m1)))
3646 (m2 (cond ((null m2) gnus-select-method)
3647 ((stringp m2) (gnus-server-to-method m2))
3648 (t m2))))
3649 (gnus-method-equal m1 m2)))
3651 (defun gnus-servers-using-backend (backend)
3652 "Return a list of known servers using BACKEND."
3653 (let ((opened gnus-opened-servers)
3654 out)
3655 (while opened
3656 (when (eq backend (caaar opened))
3657 (push (caar opened) out))
3658 (pop opened))
3659 out))
3661 (defun gnus-archive-server-wanted-p ()
3662 "Say whether the user wants to use the archive server."
3663 (cond
3664 ((or (not gnus-message-archive-method)
3665 (not gnus-message-archive-group))
3666 nil)
3667 ((and gnus-message-archive-method gnus-message-archive-group)
3668 t)
3669 (t
3670 (let ((active (cadr (assq 'nnfolder-active-file
3671 gnus-message-archive-method))))
3672 (and active
3673 (file-exists-p active))))))
3675 (defsubst gnus-method-to-server-name (method)
3676 (concat
3677 (format "%s" (car method))
3678 (when (and
3679 (or (assoc (format "%s" (car method))
3680 (gnus-methods-using 'address))
3681 (gnus-server-equal method gnus-message-archive-method))
3682 (nth 1 method)
3683 (not (string= (nth 1 method) "")))
3684 (concat "+" (nth 1 method)))))
3686 (defsubst gnus-method-to-full-server-name (method)
3687 (format "%s+%s" (car method) (nth 1 method)))
3689 (defun gnus-group-prefixed-name (group method &optional full)
3690 "Return the whole name from GROUP and METHOD.
3691 Call with full set to get the fully qualified group name (even if the
3692 server is native)."
3693 (when (stringp method)
3694 (setq method (gnus-server-to-method method)))
3695 (if (or (not method)
3696 (and (not full) (gnus-server-equal method "native"))
3697 ;;;!!! This might not be right. We'll see...
3698 ;(string-match ":" group)
3699 )
3700 group
3701 (concat (gnus-method-to-server-name method) ":" group)))
3703 (defun gnus-group-guess-prefixed-name (group)
3704 "Guess the whole name from GROUP and METHOD."
3705 (gnus-group-prefixed-name group (gnus-find-method-for-group
3706 group)))
3708 (defun gnus-group-full-name (group method)
3709 "Return the full name from GROUP and METHOD, even if the method is native."
3710 (gnus-group-prefixed-name group method t))
3712 (defun gnus-group-guess-full-name (group)
3713 "Guess the full name from GROUP, even if the method is native."
3714 (if (gnus-group-prefixed-p group)
3715 group
3716 (gnus-group-full-name group (gnus-find-method-for-group group))))
3718 (defun gnus-group-guess-full-name-from-command-method (group)
3719 "Guess the full name from GROUP, even if the method is native."
3720 (if (gnus-group-prefixed-p group)
3721 group
3722 (gnus-group-full-name group gnus-command-method)))
3724 (defun gnus-group-real-prefix (group)
3725 "Return the prefix of the current group name."
3726 (if (stringp group)
3727 (if (string-match "^[^:]+:" group)
3728 (substring group 0 (match-end 0))
3729 "")
3730 nil))
3732 (defun gnus-group-short-name (group)
3733 "Return the short group name."
3734 (let ((prefix (gnus-group-real-prefix group)))
3735 (if (< 0 (length prefix))
3736 (substring group (length prefix) nil)
3737 group)))
3739 (defun gnus-group-prefixed-p (group)
3740 "Return the prefix of the current group name."
3741 (< 0 (length (gnus-group-real-prefix group))))
3743 (declare-function gnus-group-decoded-name "gnus-group" (string))
3745 (defun gnus-summary-buffer-name (group)
3746 "Return the summary buffer name of GROUP."
3747 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3749 (defun gnus-group-method (group)
3750 "Return the server or method used for selecting GROUP.
3751 You should probably use `gnus-find-method-for-group' instead."
3752 (let ((prefix (gnus-group-real-prefix group)))
3753 (if (equal prefix "")
3754 gnus-select-method
3755 (let ((servers gnus-opened-servers)
3756 (server "")
3757 backend possible found)
3759 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3760 server (substring prefix (match-end 0) (1- (length prefix))))
3761 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3762 (while servers
3763 (when (eq (caaar servers) backend)
3764 (setq possible (caar servers))
3765 (when (equal (cadaar servers) server)
3766 (setq found (caar servers))))
3767 (pop servers))
3768 (or (car (rassoc found gnus-server-alist))
3769 found
3770 (car (rassoc possible gnus-server-alist))
3771 possible
3772 (list backend server))))))
3774 (defsubst gnus-native-method-p (method)
3775 "Return whether METHOD is the native select method."
3776 (gnus-method-equal method gnus-select-method))
3778 (defsubst gnus-secondary-method-p (method)
3779 "Return whether METHOD is a secondary select method."
3780 (let ((methods gnus-secondary-select-methods)
3781 (gmethod (inline (gnus-server-get-method nil method))))
3782 (while (and methods
3783 (not (gnus-method-equal
3784 (inline (gnus-server-get-method nil (car methods)))
3785 gmethod)))
3786 (setq methods (cdr methods)))
3787 methods))
3789 (defun gnus-method-simplify (method)
3790 "Return the shortest uniquely identifying string or method for METHOD."
3791 (cond ((stringp method)
3792 method)
3793 ((gnus-native-method-p method)
3794 nil)
3795 ((gnus-secondary-method-p method)
3796 (format "%s:%s" (nth 0 method) (nth 1 method)))
3797 (t
3798 method)))
3800 (defun gnus-groups-from-server (server)
3801 "Return a list of all groups that are fetched from SERVER."
3802 (let ((alist (cdr gnus-newsrc-alist))
3803 info groups)
3804 (while (setq info (pop alist))
3805 (when (gnus-server-equal (gnus-info-method info) server)
3806 (push (gnus-info-group info) groups)))
3807 (sort groups 'string<)))
3809 (defun gnus-group-foreign-p (group)
3810 "Say whether a group is foreign or not."
3811 (and (not (gnus-group-native-p group))
3812 (not (gnus-group-secondary-p group))))
3814 (defun gnus-group-native-p (group)
3815 "Say whether the group is native or not."
3816 (not (string-match ":" group)))
3818 (defun gnus-group-secondary-p (group)
3819 "Say whether the group is secondary or not."
3820 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3822 (defun gnus-parameters-get-parameter (group)
3823 "Return the group parameters for GROUP from `gnus-parameters'."
3824 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3825 case-fold-search
3826 gnus-parameters-case-fold-search))
3827 params-list)
3828 (dolist (elem gnus-parameters)
3829 (when (string-match (car elem) group)
3830 (setq params-list
3831 (nconc (gnus-expand-group-parameters
3832 (car elem) (cdr elem) group)
3833 params-list))))
3834 params-list))
3836 (defun gnus-expand-group-parameter (match value group)
3837 "Use MATCH to expand VALUE in GROUP."
3838 (with-temp-buffer
3839 (insert group)
3840 (goto-char (point-min))
3841 (while (re-search-forward match nil t)
3842 (replace-match value))
3843 (buffer-string)))
3845 (defun gnus-expand-group-parameters (match parameters group)
3846 "Go through PARAMETERS and expand them according to the match data."
3847 (let (new)
3848 (dolist (elem parameters)
3849 (if (and (stringp (cdr elem))
3851 (push (cons (car elem)
3852 (gnus-expand-group-parameter match (cdr elem) group))
3853 new)
3854 (push elem new)))
3855 new))
3857 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3858 "For GROUP, return the value of SYMBOL.
3860 You should call this in the `gnus-group-buffer' buffer.
3861 The function `gnus-group-find-parameter' will do that for you."
3862 ;; The speed trick: No cons'ing and quit early.
3863 (let* ((params (funcall gnus-group-get-parameter-function group))
3864 ;; Start easy, check the "real" group parameters.
3865 (simple-results
3866 (gnus-group-parameter-value params symbol allow-list t)))
3867 (if simple-results
3868 ;; Found results; return them.
3869 (car simple-results)
3870 ;; We didn't find it there, try `gnus-parameters'.
3871 (let ((result nil)
3872 (head nil)
3873 (tail gnus-parameters))
3874 ;; A good old-fashioned non-cl loop.
3875 (while tail
3876 (setq head (car tail)
3877 tail (cdr tail))
3878 ;; The car is regexp matching for matching the group name.
3879 (when (string-match (car head) group)
3880 ;; The cdr is the parameters.
3881 (setq result (gnus-group-parameter-value (cdr head)
3882 symbol allow-list))
3883 (when result
3884 ;; Expand if necessary.
3886 (setq result (gnus-expand-group-parameter (car head)
3887 result group)))
3888 ;; Exit the loop early.
3889 (setq tail nil))))
3890 ;; Done.
3891 result))))
3893 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3894 "Return the group parameters for GROUP.
3895 If SYMBOL, return the value of that symbol in the group parameters.
3897 If you call this function inside a loop, consider using the faster
3898 `gnus-group-fast-parameter' instead."
3899 (save-excursion
3900 (set-buffer gnus-group-buffer)
3901 (if symbol
3902 (gnus-group-fast-parameter group symbol allow-list)
3903 (nconc
3904 (copy-sequence
3905 (funcall gnus-group-get-parameter-function group))
3906 (gnus-parameters-get-parameter group)))))
3908 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3909 "Return the group parameters for GROUP.
3910 If SYMBOL, return the value of that symbol in the group parameters.
3911 If ALLOW-LIST, also allow list as a result.
3912 Most functions should use `gnus-group-find-parameter', which
3913 also examines the topic parameters."
3914 (let ((params (gnus-info-params (gnus-get-info group))))
3915 (if symbol
3916 (gnus-group-parameter-value params symbol allow-list)
3917 params)))
3919 (defun gnus-group-parameter-value (params symbol &optional
3920 allow-list present-p)
3921 "Return the value of SYMBOL in group PARAMS.
3922 If ALLOW-LIST, also allow list as a result."
3923 ;; We only wish to return group parameters (dotted lists) and
3924 ;; not local variables, which may have the same names.
3925 ;; But first we handle single elements...
3926 (or (car (memq symbol params))
3927 ;; Handle alist.
3928 (let (elem)
3929 (catch 'found
3930 (while (setq elem (pop params))
3931 (when (and (consp elem)
3932 (eq (car elem) symbol)
3933 (or allow-list
3934 (atom (cdr elem))))
3935 (throw 'found (if present-p (list (cdr elem))
3936 (cdr elem)))))))))
3938 (defun gnus-group-add-parameter (group param)
3939 "Add parameter PARAM to GROUP."
3940 (let ((info (gnus-get-info group)))
3941 (when info
3942 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3943 ;; Cons the new param to the old one and update.
3944 (gnus-group-set-info (cons param (gnus-info-params info))
3945 group 'params))))
3947 (defun gnus-group-set-parameter (group name value)
3948 "Set parameter NAME to VALUE in GROUP."
3949 (let ((info (gnus-get-info group)))
3950 (when info
3951 (gnus-group-remove-parameter group name)
3952 (let ((old-params (gnus-info-params info))
3953 (new-params (list (cons name value))))
3954 (while old-params
3955 (when (or (not (listp (car old-params)))
3956 (not (eq (caar old-params) name)))
3957 (setq new-params (append new-params (list (car old-params)))))
3958 (setq old-params (cdr old-params)))
3959 (gnus-group-set-info new-params group 'params)))))
3961 (defun gnus-group-remove-parameter (group name)
3962 "Remove parameter NAME from GROUP."
3963 (let ((info (gnus-get-info group)))
3964 (when info
3965 (let ((params (gnus-info-params info)))
3966 (when params
3967 (setq params (delq name params))
3968 (while (assq name params)
3969 (gnus-pull name params))
3970 (gnus-info-set-params info params))))))
3972 (defun gnus-group-add-score (group &optional score)
3973 "Add SCORE to the GROUP score.
3974 If SCORE is nil, add 1 to the score of GROUP."
3975 (let ((info (gnus-get-info group)))
3976 (when info
3977 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3979 (defun gnus-short-group-name (group &optional levels)
3980 "Collapse GROUP name LEVELS.
3981 Select methods are stripped and any remote host name is stripped down to
3982 just the host name."
3983 (let* ((name "")
3984 (foreign "")
3985 (depth 0)
3986 (skip 1)
3987 (levels (or levels
3988 gnus-group-uncollapsed-levels
3989 (progn
3991 (setq skip (match-end 0)
3992 depth (+ depth 1)))
3993 depth))))
3994 ;; Separate foreign select method from group name and collapse.
3995 ;; If method contains a server, collapse to non-domain server name,
3996 ;; otherwise collapse to select method.
3997 (let* ((colon (string-match ":" group))
3998 (server (and colon (substring group 0 colon)))
3999 (plus (and server (string-match "+" server))))
4000 (when server
4001 (if plus
4002 (setq foreign (substring server (+ 1 plus)
4004 group (substring group (+ 1 colon)))
4005 (setq foreign server
4006 group (substring group (+ 1 colon))))
4007 (setq foreign (concat foreign ":")))
4008 ;; Collapse group name leaving LEVELS uncollapsed elements
4009 (let* ((slist (split-string group "/"))
4010 (slen (length slist))
4012 (dlen (length dlist))
4013 glist
4014 glen
4015 gsep
4016 res)
4017 (if (> slen dlen)
4018 (setq glist slist
4019 glen slen
4020 gsep "/")
4021 (setq glist dlist
4022 glen dlen
4023 gsep "."))
4024 (setq levels (- glen levels))
4025 (dolist (g glist)
4026 (push (if (>= (decf levels) 0)
4027 (if (zerop (length g))
4028 ""
4029 (substring g 0 1))
4030 g)
4031 res))
4032 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4034 (defun gnus-narrow-to-body ()
4035 "Narrow to the body of an article."
4036 (narrow-to-region
4037 (progn
4038 (goto-char (point-min))
4040 (point-max)))
4041 (point-max)))
4043 \f
4044 ;;;
4045 ;;; Kill file handling.
4046 ;;;
4048 (defun gnus-apply-kill-file ()
4049 "Apply a kill file to the current newsgroup.
4050 Returns the number of articles marked as read."
4051 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4052 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4053 (gnus-apply-kill-file-internal)
4054 0))
4056 (defun gnus-kill-save-kill-buffer ()
4057 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4058 (when (get-file-buffer file)
4059 (save-excursion
4060 (set-buffer (get-file-buffer file))
4061 (when (buffer-modified-p)
4062 (save-buffer))
4063 (kill-buffer (current-buffer))))))
4065 (defcustom gnus-kill-file-name "KILL"
4066 "Suffix of the kill files."
4067 :group 'gnus-score-kill
4068 :group 'gnus-score-files
4069 :type 'string)
4071 (defun gnus-newsgroup-kill-file (newsgroup)
4072 "Return the name of a kill file name for NEWSGROUP.
4073 If NEWSGROUP is nil, return the global kill file name instead."
4074 (cond
4075 ;; The global KILL file is placed at top of the directory.
4076 ((or (null newsgroup)
4077 (string-equal newsgroup ""))
4078 (expand-file-name gnus-kill-file-name
4079 gnus-kill-files-directory))
4080 ;; Append ".KILL" to newsgroup name.
4081 ((gnus-use-long-file-name 'not-kill)
4082 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4083 "." gnus-kill-file-name)
4084 gnus-kill-files-directory))
4085 ;; Place "KILL" under the hierarchical directory.
4086 (t
4087 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4088 "/" gnus-kill-file-name)
4089 gnus-kill-files-directory))))
4091 ;;; Server things.
4093 (defun gnus-member-of-valid (symbol group)
4095 (memq symbol (assoc
4096 (symbol-name (car (gnus-find-method-for-group group)))
4097 gnus-valid-select-methods)))
4099 (defun gnus-method-option-p (method option)
4100 "Return non-nil if select METHOD has OPTION as a parameter."
4101 (when (stringp method)
4102 (setq method (gnus-server-to-method method)))
4103 (memq option (assoc (format "%s" (car method))
4104 gnus-valid-select-methods)))
4106 (defun gnus-similar-server-opened (method)
4107 (let ((opened gnus-opened-servers))
4108 (while (and method opened)
4109 (when (and (equal (cadr method) (cadaar opened))
4110 (equal (car method) (caaar opened))
4111 (not (equal method (caar opened))))
4112 (setq method nil))
4113 (pop opened))
4114 (not method)))
4116 (defun gnus-server-extend-method (group method)
4117 ;; This function "extends" a virtual server. If the server is
4118 ;; "hello", and the select method is ("hello" (my-var "something"))
4119 ;; in the group "alt.alt", this will result in a new virtual server
4120 ;; called "hello+alt.alt".
4121 (if (or (not (inline (gnus-similar-server-opened method)))
4122 (not (cddr method)))
4123 method
4124 `(,(car method) ,(concat (cadr method) "+" group)
4125 (,(intern (format "%s-address" (car method))) ,(cadr method))
4126 ,@(cddr method))))
4128 (defun gnus-server-status (method)
4129 "Return the status of METHOD."
4130 (nth 1 (assoc method gnus-opened-servers)))
4132 (defun gnus-group-name-to-method (group)
4133 "Guess a select method based on GROUP."
4134 (if (string-match ":" group)
4135 (let ((server (substring group 0 (match-beginning 0))))
4137 (list (intern (substring server 0 (match-beginning 0)))
4138 (substring server (match-end 0)))
4139 (list (intern server) "")))
4140 gnus-select-method))
4142 (defun gnus-server-string (server)
4143 "Return a readable string that describes SERVER."
4144 (let* ((server (gnus-server-to-method server))
4145 (address (nth 1 server)))
4146 (if (and address
4147 (not (zerop (length address))))
4148 (format "%s using %s" address (car server))
4149 (format "%s" (car server)))))
4151 (defun gnus-find-method-for-group (group &optional info)
4152 "Find the select method that GROUP uses."
4153 (or gnus-override-method
4154 (and (not group)
4155 gnus-select-method)
4156 (and (not (gnus-group-entry group))
4157 ;; Killed or otherwise unknown group.
4158 (or
4159 ;; If we know a virtual server by that name, return its method.
4160 (gnus-server-to-method (gnus-group-server group))
4161 ;; Guess a new method as last resort.
4162 (gnus-group-name-to-method group)))
4163 (let ((info (or info (gnus-get-info group)))
4164 method)
4165 (if (or (not info)
4166 (not (setq method (gnus-info-method info)))
4167 (equal method "native"))
4168 gnus-select-method
4169 (setq method
4170 (cond ((stringp method)
4171 (inline (gnus-server-to-method method)))
4172 ((stringp (cadr method))
4173 (inline (gnus-server-extend-method group method)))
4174 (t
4175 method)))
4176 (cond ((equal (cadr method) "")
4177 method)
4178 ((null (cadr method))
4179 (list (car method) ""))
4180 (t
4181 (gnus-server-add-address method)))))))
4183 (defun gnus-methods-using (feature)
4184 "Find all methods that have FEATURE."
4185 (let ((valids gnus-valid-select-methods)
4186 outs)
4187 (while valids
4188 (when (memq feature (car valids))
4189 (push (car valids) outs))
4190 (setq valids (cdr valids)))
4191 outs))
4193 (eval-and-compile
4194 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4196 (defun gnus-read-group (prompt &optional default)
4197 "Prompt the user for a group name.
4198 Disallow invalid group names."
4199 (let ((prefix "")
4200 group)
4201 (while (not group)
4202 (when (string-match
4203 gnus-invalid-group-regexp
4204 (setq group (read-string (concat prefix prompt)
4205 (cons (or default "") 0)
4206 'gnus-group-history)))
4207 (let ((match (match-string 0 group)))
4208 ;; Might be okay (e.g. for nnimap), so ask the user:
4210 (message-y-or-n-p
4211 "Proceed and create group anyway? " t
4214 Usually, it's dangerous to create a group with this name, because it's not
4215 supported by all back ends and servers. On IMAP servers it should work,
4216 though. If you are really sure, you can proceed anyway and create the group.
4218 You may customize the variable `gnus-invalid-group-regexp', which currently is
4222 group nil)))))
4223 group))
4225 (defun gnus-read-method (prompt)
4226 "Prompt the user for a method.
4227 Allow completion over sensible values."
4228 (let* ((open-servers
4229 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4230 gnus-opened-servers))
4231 (valid-methods
4232 (let (methods)
4233 (dolist (method gnus-valid-select-methods)
4234 (if (or (memq 'prompt-address method)
4235 (not (assoc (format "%s:" (car method)) open-servers)))
4236 (push method methods)))
4237 methods))
4238 (servers
4239 (append valid-methods
4240 open-servers
4241 gnus-predefined-server-alist
4242 gnus-server-alist))
4243 (method
4244 (completing-read
4245 prompt servers
4246 nil t nil 'gnus-method-history)))
4247 (cond
4248 ((equal method "")
4249 (setq method gnus-select-method))
4250 ((assoc method gnus-valid-select-methods)
4251 (let ((address (if (memq 'prompt-address
4252 (assoc method gnus-valid-select-methods))
4253 (read-string "Address: ")
4254 "")))
4255 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4256 (list (intern method) address))))
4257 ((assoc method servers)
4258 method)
4259 (t
4260 (list (intern method) "")))))
4262 ;;; Agent functions
4264 (defun gnus-agent-method-p (method-or-server)
4265 "Say whether METHOD is covered by the agent."
4266 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4267 (let* ((method (if (stringp method-or-server)
4268 (gnus-server-to-method method-or-server)
4269 method-or-server))
4270 (server (gnus-method-to-server method t)))
4271 (setq gnus-agent-method-p-cache
4272 (cons method-or-server
4273 (member server gnus-agent-covered-methods)))))
4274 (cdr gnus-agent-method-p-cache))
4276 (defun gnus-online (method)
4277 (not
4278 (if gnus-plugged
4279 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4280 (gnus-agent-method-p method))))
4282 ;;; User-level commands.
4284 ;;;###autoload
4285 (defun gnus-slave-no-server (&optional arg)
4286 "Read network news as a slave, without connecting to the local server."
4287 (interactive "P")
4288 (gnus-no-server arg t))
4290 ;;;###autoload
4291 (defun gnus-no-server (&optional arg slave)
4292 "Read network news.
4293 If ARG is a positive number, Gnus will use that as the startup
4294 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4295 non-nil and not a positive number, Gnus will prompt the user for the
4296 name of an NNTP server to use.
4297 As opposed to `gnus', this command will not connect to the local
4298 server."
4299 (interactive "P")
4300 (gnus-no-server-1 arg slave))
4302 ;;;###autoload
4303 (defun gnus-slave (&optional arg)
4304 "Read news as a slave."
4305 (interactive "P")
4306 (gnus arg nil 'slave))
4308 ;;;###autoload
4309 (defun gnus-other-frame (&optional arg display)
4310 "Pop up a frame to read news.
4311 This will call one of the Gnus commands which is specified by the user
4312 option `gnus-other-frame-function' (default `gnus') with the argument
4313 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4314 optional second argument DISPLAY should be a standard display string
4316 omitted or the function `make-frame-on-display' is not available, the
4317 current display is used."
4318 (interactive "P")
4319 (if (fboundp 'make-frame-on-display)
4320 (unless display
4321 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4322 (setq display nil))
4323 (let ((alive (gnus-alive-p)))
4324 (unless (and alive
4325 (catch 'found
4326 (walk-windows
4327 (lambda (window)
4328 (when (and (or (not display)
4329 (equal display
4330 (gnus-frame-or-window-display-name
4331 window)))
4332 (with-current-buffer (window-buffer window)
4334 (symbol-name major-mode))))
4335 (gnus-select-frame-set-input-focus
4336 (setq gnus-other-frame-object (window-frame window)))
4337 (select-window window)
4338 (throw 'found t)))
4339 'ignore t)))
4340 (gnus-select-frame-set-input-focus
4341 (setq gnus-other-frame-object
4342 (if display
4343 (make-frame-on-display display gnus-other-frame-parameters)
4344 (make-frame gnus-other-frame-parameters))))
4345 (if alive
4346 (switch-to-buffer gnus-group-buffer)
4347 (funcall gnus-other-frame-function arg)
4348 (add-hook 'gnus-exit-gnus-hook
4349 '(lambda nil
4350 (when (and (frame-live-p gnus-other-frame-object)
4351 (cdr (frame-list)))
4352 (delete-frame gnus-other-frame-object))
4353 (setq gnus-other-frame-object nil)))))))
4355 ;;;###autoload
4356 (defun gnus (&optional arg dont-connect slave)
4357 "Read network news.
4358 If ARG is non-nil and a positive number, Gnus will use that as the
4359 startup level. If ARG is non-nil and not a positive number, Gnus will
4360 prompt the user for the name of an NNTP server to use."
4361 (interactive "P")
4362 (unless (byte-code-function-p (symbol-function 'gnus))
4363 (message "You should byte-compile Gnus")
4364 (sit-for 2))
4365 (gnus-1 arg dont-connect slave))
4367 ;; Allow redefinition of Gnus functions.
4369 (gnus-ems-redefine)
4371 (provide 'gnus)
4373 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4374 ;;; gnus.el ends here