| blob | 7a04c61151a9c39dab2ec9a499e4a37a50694982 |
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 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 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;;; Code:
38 ;; These are defined afterwards with gnus-define-group-parameter
50 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
55 "Dealing with formatting issues."
59 "Group character set issues."
65 "Cache interface."
70 "Article Registry."
74 "Starting your favorite newsreader."
78 "Server options at startup."
81 ;; These belong to gnus-group.el.
83 "Group buffers."
88 "Foreign groups."
93 "Automatic subscription of new groups."
97 "Group levels."
102 "Selecting a Group."
107 "Showing slices of the group list."
112 "Sorting the group buffer."
118 "Various group options."
122 ;; These belong to gnus-sum.el.
124 "Summary buffers."
129 "Leaving summary buffers."
134 "Marks used in summary buffers."
139 "Ordering articles according to replies."
144 "Formatting of the summary buffer."
149 "Choosing Articles."
154 "Summary movement commands."
159 "Show pictures of people, domains, and newsgroups."
163 "Mail group commands."
168 "Sorting the summary buffer."
173 "Highlighting and menus in the summary buffer."
179 "Various summary buffer options."
184 "Pick mode in the summary buffer."
190 "Tree display of threads in the summary buffer."
195 ;; Belongs to gnus-uu.el
197 "Viewing extracted files."
201 ;; Belongs to gnus-score.el
203 "Score and kill file handling."
207 "Kill files."
211 "Adaptive score files."
215 "Default values for score files."
219 "Expiring score rules."
223 "Decaying score rules."
227 "Score and kill file names."
232 "Various scoring and killing options."
235 ;; Other
237 "Options controlling the visual fluff."
242 "Offline support for Gnus."
246 "Files used by Gnus."
250 "Auto save file."
255 "Storing Gnus state."
259 "Options related to newsservers and other servers used by Gnus."
263 "Highlighting and menus in the server buffer."
268 "Composing replies and followups in Gnus."
272 "Meta variables controlling major portions of Gnus.
273 In general, modifying these variables does not take affect until Gnus
274 is restarted, and sometimes reloaded."
278 "Other Gnus options."
283 "Variables for controlling the Gnus MIME interface."
287 "Exiting Gnus."
292 "Frivolous Gnus extensions."
303 "If non-nil, the startup message will not be displayed.
304 This variable is used before `.gnus.el' is loaded, so it should
305 be set in `.emacs' instead."
310 "If non-nil, play the Gnus jingle at startup."
344 0 5
353 gnus-mode-line-image-cache)
355 "This is %s, %s."
357 str)
359 line)))
365 ;;(defalias 'gnus-decode-rfc1522 'ignore)
366 )
368 ;; We define these group faces here to avoid the display
369 ;; update forced when creating new faces.
379 ()))
380 "Level 1 newsgroup face."
382 ;; backward-compatibility alias
393 ()))
394 "Level 1 empty newsgroup face."
396 ;; backward-compatibility alias
407 ()))
408 "Level 2 newsgroup face."
410 ;; backward-compatibility alias
421 ()))
422 "Level 2 empty newsgroup face."
424 ;; backward-compatibility alias
435 ()))
436 "Level 3 newsgroup face."
438 ;; backward-compatibility alias
444 ())
447 ())
449 ()))
450 "Level 3 empty newsgroup face."
452 ;; backward-compatibility alias
463 ()))
464 "Level 4 newsgroup face."
466 ;; backward-compatibility alias
472 ())
475 ())
477 ()))
478 "Level 4 empty newsgroup face."
480 ;; backward-compatibility alias
491 ()))
492 "Level 5 newsgroup face."
494 ;; backward-compatibility alias
500 ())
503 ())
505 ()))
506 "Level 5 empty newsgroup face."
508 ;; backward-compatibility alias
519 ()))
520 "Level 6 newsgroup face."
522 ;; backward-compatibility alias
528 ())
531 ())
533 ()))
534 "Level 6 empty newsgroup face."
536 ;; backward-compatibility alias
547 ()))
548 "Low level newsgroup face."
550 ;; backward-compatibility alias
561 ()))
562 "Low level empty newsgroup face."
564 ;; backward-compatibility alias
576 "Level 1 mailgroup face."
578 ;; backward-compatibility alias
590 "Level 1 empty mailgroup face."
592 ;; backward-compatibility alias
604 "Level 2 mailgroup face."
606 ;; backward-compatibility alias
618 "Level 2 empty mailgroup face."
620 ;; backward-compatibility alias
632 "Level 3 mailgroup face."
634 ;; backward-compatibility alias
645 ()))
646 "Level 3 empty mailgroup face."
648 ;; backward-compatibility alias
660 "Low level mailgroup face."
662 ;; backward-compatibility alias
674 "Low level empty mailgroup face."
676 ;; backward-compatibility alias
679 ;; Summary mode faces.
682 "Face used for selected articles."
684 ;; backward-compatibility alias
690 "Face used for cancelled articles."
692 ;; backward-compatibility alias
704 "Face used for high interest ticked articles."
706 ;; backward-compatibility alias
718 "Face used for low interest ticked articles."
720 ;; backward-compatibility alias
731 ()))
732 "Face used for normal interest ticked articles."
734 ;; backward-compatibility alias
746 "Face used for high interest ancient articles."
748 ;; backward-compatibility alias
760 "Face used for low interest ancient articles."
762 ;; backward-compatibility alias
773 ()))
774 "Face used for normal interest ancient articles."
776 ;; backward-compatibility alias
786 "Face used for high interest uncached articles."
788 ;; backward-compatibility alias
798 "Face used for low interest uncached articles."
800 ;; backward-compatibility alias
810 "Face used for normal interest uncached articles."
812 ;; backward-compatibility alias
818 "Face used for high interest unread articles."
820 ;; backward-compatibility alias
826 "Face used for low interest unread articles."
828 ;; backward-compatibility alias
833 ()))
834 "Face used for normal interest unread articles."
836 ;; backward-compatibility alias
850 "Face used for high interest read articles."
852 ;; backward-compatibility alias
866 "Face used for low interest read articles."
868 ;; backward-compatibility alias
879 ()))
880 "Face used for normal interest read articles."
882 ;; backward-compatibility alias
886 ;;;
887 ;;; Gnus buffers
888 ;;;
893 "Do the same as `get-buffer-create', but store the created buffer."
898 "Add the current buffer to the list of Gnus buffers."
902 "Kill BUFFER and remove from the list of Gnus buffers."
909 "Return a list of live Gnus buffers."
918 gnus-buffers)
920 ;;; Splash screen.
935 ()))
936 "Face for the splash screen."
938 ;; backward-compatibility alias
953 "Indent rigidly using only spaces and no tabs."
959 ;; We translate tabs into spaces -- not everybody uses
960 ;; an 8-character tab.
967 ;;(format "%02x%02x%02x" 114 66 20) "724214"
991 "*Color styles used for the Gnus logo."
993 gnus-logo-color-alist))
1001 "Insert startup message in current buffer."
1002 ;; Insert the message.
1016 :color-symbols
1022 ;; Account for the pbm's blackground.
1026 ;; Account for the xbm's blackground.
1037 t))))
1041 _ ___ _ _
1042 _ ___ __ ___ __ _ ___
1043 __ _ ___ __ ___
1044 _ ___ _
1045 _ _ __ _
1046 ___ __ _
1047 __ _
1048 _ _ _
1049 _ _ _
1050 _ _ _
1051 __ ___
1052 _ _ _ _
1053 _ _
1054 _ _
1055 _ _
1056 _
1057 __
1059 "
1061 ;; And then hack it.
1070 ;; Fontify some.
1084 ;;; Do the rest.
1090 "Alist of group parameters.
1092 For example:
1094 (gnus-use-scoring nil)
1095 (gnus-summary-line-format
1097 (gcc-self . t)
1098 (display . all))
1101 (broken-reply-to . t)))"
1108 "If it is t, ignore case of group names specified in `gnus-parameters'.
1109 If it is nil, don't ignore case. If it is `default', which is for the
1110 backward compatibility, use the value of `case-fold-search'."
1121 "Define a group parameter PARAM.
1122 REST is a plist of following:
1123 :type One of `bool', `list' or nil.
1124 :function The name of the function.
1125 :function-document The documentation of the function.
1126 :parameter-type The type for customizing the parameter.
1127 :parameter-document The documentation for the parameter.
1128 :variable The name of the variable.
1129 :variable-document The documentation for the variable.
1130 :variable-group The group for customizing the variable.
1131 :variable-type The type for customizing the variable.
1132 :variable-default The default value of the variable."
1149 'progn
1151 ,variable-document
1157 gnus-group-parameters-more))
1160 ,parameter-type
1164 ,function-document
1166 val)
1169 t)
1174 (,variable
1176 elem value)
1184 ,function-document
1188 elem value)
1195 'value
1200 All other Gnus file and directory variables are initialized from this variable."
1206 "*Directory variable from which all other Gnus file variables are derived.
1208 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1209 This means that other directory variables that are initialized from
1210 this variable won't be set properly if you set this variable in `.gnus.el'.
1211 Set this variable in `.emacs' instead."
1216 "*Default directory for all Gnus buffers."
1219 directory))
1221 ;; Site dependent variables. These variables should be defined in
1222 ;; paths.el.
1225 "Specify a default NNTP server.
1226 This variable should be defined in paths.el, and should never be set
1227 by the user.
1228 If you want to change servers, you should use `gnus-select-method'.
1231 ;; Don't touch this variable.
1234 This is an obsolete variable, which is scarcely used. If you use an
1235 nntp server for your newsgroup and want to change the port number
1236 used to 899, you would say something along these lines:
1241 "A file with only the name of the nntp server in it."
1247 "Find default nntp server.
1248 Check the NNTPSERVER environment variable and the
1249 `gnus-nntpserver-file' file."
1265 gnus-default-nntp-server)
1269 nil
1272 "Default method for selecting a newsgroup.
1273 This variable should be a list, where the first element is how the
1274 news is to be fetched, the second is the address.
1277 NNTP, you could say:
1281 If you want to use your local spool, say:
1283 \(setq gnus-select-method (list 'nnspool (system-name)))
1285 If you use this variable, you must set `gnus-nntp-server' to nil.
1287 There is a lot more to know about select methods and virtual servers -
1288 see the manual for details."
1293 "*Method used for archiving messages you've sent.
1294 This should be a mail method."
1298 gnus-select-method))
1301 "*Name of the group in which to save the messages you've written.
1302 This can either be a string; a list of strings; or an alist
1303 of regexps/functions/forms to be evaluated to return a string (or a list
1304 of strings). The functions are called with the name of the current
1305 group (or nil) as a parameter.
1307 If you want to save your mail in one group and the news articles you
1308 write in another group, you could say something like:
1310 \(setq gnus-message-archive-group
1311 '((if (message-news-p)
1315 Normally the group names returned by this variable should be
1317 However, you may wish to store the message on some other server. In
1318 that case, just return a fully prefixed name of the group --
1322 function
1323 sexp
1324 string))
1327 "List of NNTP servers that the user can choose between interactively.
1328 To make Gnus query you for a server, you have to give `gnus' a
1329 non-numeric prefix - `C-u M-x gnus', in short."
1334 "*The name of the host running the NNTP server.
1335 This variable is semi-obsolete. Use the `gnus-select-method'
1336 variable instead."
1339 string))
1342 "A list of secondary methods that will be used for reading news.
1343 This is a list where each element is a complete select method (see
1344 `gnus-select-method').
1346 If, for instance, you want to read your mail with the nnml back end,
1347 you could set this variable:
1355 "Default default new newsgroups the first time Gnus is run.
1359 "Local domain name without a host name.
1360 The DOMAINNAME environment variable is used instead if it is defined.
1361 If the function `system-name' returns the full Internet name, there is
1362 no need to set this variable."
1365 string))
1368 "String with a description of what organization (if any) the user belongs to.
1371 ;; Customization variables
1374 "Preferred method for fetching an article by Message-ID.
1375 If you are reading news from the local spool (with nnspool), fetching
1376 articles by Message-ID is painfully slow. By setting this method to an
1377 nntp method, you might get acceptable results.
1379 The value of this variable must be a valid select method as discussed
1380 in the documentation of `gnus-select-method'.
1382 It can also be a list of select methods, as well as the special symbol
1383 `current', which means to use the current select method. If it is a
1384 list, Gnus will try all the methods in the list until it finds a match."
1389 gnus-select-method
1397 gnus-select-method))))
1401 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1402 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1403 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1404 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1405 "/ftp@rtfm.mit.edu:/pub/usenet/"
1406 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1407 "/ftp@ftp.sunet.se:/pub/usenet/"
1408 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1409 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1411 "*Directory where the group FAQs are stored.
1412 This will most commonly be on a remote machine, and the file will be
1413 fetched by ange-ftp.
1415 This variable can also be a list of directories. In that case, the
1416 first element in the list will be used by default. The others can
1417 be used when being prompted for a site.
1419 Note that Gnus uses an aol machine as the default directory. If this
1420 feels fundamentally unclean, just think of it as a way to finally get
1421 something of value back from them.
1423 If the default site is too slow, try one of these:
1425 North America: mirrors.aol.com /pub/rtfm/usenet
1426 ftp.seas.gwu.edu /pub/rtfm
1427 rtfm.mit.edu /pub/usenet
1428 Europe: ftp.uni-paderborn.de /pub/FAQ
1429 src.doc.ic.ac.uk /usenet/news-FAQS
1430 ftp.sunet.se /pub/usenet
1431 ftp.pasteur.fr /pub/FAQ
1432 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1433 hwarang.postech.ac.kr /pub/usenet
1434 ftp.hk.super.net /mirror/faqs"
1461 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1462 When FORM is evaluated `name' is bound to the name of the group."
1468 "*Non-nil means that control messages are displayed using `browse-url'.
1469 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1470 group."
1476 "*Non-nil means that cross referenced articles will be marked as read.
1477 If nil, ignore cross references. If t, mark articles as read in
1478 subscribed newsgroups. If neither t nor nil, mark as read in all
1479 newsgroups."
1487 "*Process mark."
1493 "*The number of articles which indicates a large newsgroup.
1494 If the number of articles in a newsgroup is greater than this value,
1495 confirmation is required for selecting the newsgroup.
1496 If it is nil, no confirmation is required."
1499 integer))
1502 "*Non-nil means that the default name of a file to save articles in is the group name.
1503 If it's nil, the directory form of the group name is used instead.
1505 If this variable is a list, and the list contains the element
1506 `not-score', long file names will not be used for score files; if it
1507 contains the element `not-save', long file names will not be used for
1508 saving; and if it contains the element `not-kill', long file names
1509 will not be used for kill files.
1511 Note that the default for this variable varies according to what system
1512 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1513 to nil while on all other systems it defaults to t."
1531 "*If non-nil, save group scoring info."
1537 "*If non-nil, allow undoing in Gnus group mode buffers."
1542 "*If non-nil, use some adaptive scoring scheme.
1543 If a list, then the values `word' and `line' are meaningful. The
1544 former will perform adaption on individual words in the subject
1545 header while `line' will perform adaption on several headers."
1551 "*If nil, Gnus will ignore the article cache.
1552 If `passive', it will allow entering (and reading) articles
1553 explicitly entered into the cache. If anything else, use the
1554 cache to the full extent of the law."
1562 "*If non-nil, display a thread tree buffer."
1567 "*If non-nil, use GroupLens ratings."
1572 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1573 If it is a number N, then Gnus will only keep the last N articles
1574 read. If it is neither nil nor a number, Gnus will keep all read
1575 articles. This is not a good idea."
1578 integer
1583 "*If non-nil, Gnus will read NoCeM cancel messages.
1584 You can also set this variable to a positive number as a group level.
1585 In that case, Gnus scans NoCeM messages when checking new news if this
1586 value is not exceeding a group level that you specify as the prefix
1587 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1588 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1589 level to those commands."
1598 gnus-level-default-subscribed
1602 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1607 "*If non-nil, enable scoring."
1613 "*A hook called when preparing to exit from the summary buffer.
1614 It calls `gnus-summary-expire-articles' by default."
1619 "*Non-nil means that you are a Usenet novice.
1620 If non-nil, verbose messages may be displayed and confirmations may be
1621 required."
1626 "*Non-nil means that you will never be asked for confirmation about anything.
1627 That doesn't mean *anything* anything; particularly destructive
1628 commands will still require prompting."
1633 "*If non-nil, require your confirmation when catching up a group."
1638 "*If non-nil, require your confirmation when exiting Gnus."
1643 "*Function for extracting address components from a From header.
1644 Two pre-defined function exist: `gnus-extract-address-components',
1645 which is the default, quite fast, and too simplistic solution, and
1646 `mail-extract-address-components', which works much better, but is
1647 slower."
1654 "*If non-nil, display clickable icons."
1659 "String used to separate shell commands."
1691 "*An alist of valid select methods.
1692 The first element of each list lists should be a string with the name
1693 of the select method. The other elements may be the category of
1694 this method (i. e., `post', `mail', `none' or whatever) or other
1695 properties that this method has (like being respoolable).
1696 If you implement a new select method, all you should have to change is
1697 this variable. I think."
1712 "Recomputes the select-method widget based on the value of
1713 `gnus-valid-select-methods'."
1715 "Widget for entering a select method."
1722 gnus-valid-select-methods)
1726 :inline t
1728 variable
1734 "List of buffers that should update their mode lines.
1735 The list may contain the symbols `group', `article', `tree' and
1736 `summary'. If the corresponding symbol is present, Gnus will keep
1737 that mode line updated with information that may be pertinent.
1738 If this variable is nil, screen refresh may be quicker."
1745 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1747 "*Max length of mode-line non-string contents.
1748 If this is nil, Gnus will take space as is needed, leaving the rest
1749 of the mode line intact. Note that the default of nil is unlikely
1750 to be desirable; see the manual for further details."
1753 integer))
1755 ;; There should be special validation for this.
1760 to-address
1761 :function-document
1762 "Return GROUP's to-address."
1763 :variable-document
1764 "*Alist of group regexps and correspondent to-addresses."
1765 :variable-group gnus-group-parameter
1768 This will be used when doing followups and posts.
1770 This is primarily useful in mail groups that represent closed
1771 mailing lists--mailing lists where it's expected that everybody that
1772 writes to the mailing list is subscribed to it. Since using this
1773 parameter ensures that the mail only goes to the mailing list itself,
1774 it means that members won't receive two copies of your followups.
1776 Using `to-address' will actually work whether the group is foreign or
1777 not. Let's say there's a group on the server that is called
1778 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1779 articles from a mail-to-news gateway. Posting directly to this group
1780 is therefore impossible--you have to send mail to the mailing list
1781 address instead.
1783 The gnus-group-split mail splitting mechanism will behave as if this
1787 to-list
1788 :function-document
1789 "Return GROUP's to-list."
1790 :variable-document
1791 "*Alist of group regexps and correspondent to-lists."
1792 :variable-group gnus-group-parameter
1795 This address will be used when doing a `a' in the group.
1797 It is totally ignored when doing a followup--except that if it is
1798 present in a news group, you'll get mail group semantics when doing
1799 `f'.
1801 The gnus-group-split mail splitting mechanism will behave as if this
1805 subscribed
1806 :type bool
1807 :function-document
1808 "Return GROUP's subscription status."
1809 :variable-document
1810 "*Groups which are automatically considered subscribed."
1811 :variable-group gnus-group-parameter
1814 Gnus assumed that you are subscribed to the To/List address.
1816 When constructing a list of subscribed groups using
1817 `gnus-find-subscribed-addresses', Gnus includes the To address given
1821 auto-expire
1822 :type bool
1823 :function gnus-group-auto-expirable-p
1824 :function-document
1825 "Check whether GROUP is auto-expirable or not."
1826 :variable gnus-auto-expirable-newsgroups
1827 :variable-default nil
1828 :variable-document
1829 "*Groups in which to automatically mark read articles as expirable.
1830 If non-nil, this should be a regexp that should match all groups in
1831 which to perform auto-expiry. This only makes sense for mail groups."
1832 :variable-group nnmail-expire
1834 regexp)
1836 :parameter-document
1840 total-expire
1841 :type bool
1842 :function gnus-group-total-expirable-p
1843 :function-document
1844 "Check whether GROUP is total-expirable or not."
1845 :variable gnus-total-expirable-newsgroups
1846 :variable-default nil
1847 :variable-document
1848 "*Groups in which to perform expiry of all read articles.
1849 Use with extreme caution. All groups that match this regexp will be
1850 expiring - which means that all read articles will be deleted after
1851 \(say) one week. (This only goes for mail groups and the like, of
1852 course.)"
1853 :variable-group nnmail-expire
1855 regexp)
1857 :parameter-document
1858 "All read articles will be put through the expiry process
1860 This happens even if they are not marked as expirable.
1864 charset
1865 :function-document
1866 "Return the default charset of GROUP."
1867 :variable gnus-group-charset-alist
1868 :variable-default
1881 :variable-document
1882 "Alist of regexps (to match group names) and default charsets to be used when reading."
1883 :variable-group gnus-charset
1891 post-method
1892 :type list
1893 :function-document
1894 "Return a posting method for GROUP."
1895 :variable gnus-post-method-alist
1896 :variable-document
1897 "Alist of regexps (to match group names) and method to be used when
1898 posting an article."
1899 :variable-group gnus-group-foreign
1900 :parameter-type
1908 :parameter-document
1912 large-newsgroup-initial
1913 :type integer
1914 :function-document
1915 "Return GROUP's initial input of the number of articles."
1916 :variable-document
1917 "*Alist of group regexps and its initial input of the number of articles."
1918 :variable-group gnus-group-parameter
1924 This number will be prompted as the initial value of the number of
1925 articles to list when the group is a large newsgroup (see
1926 `gnus-large-newsgroup'). If it is nil, the default value is the
1929 ;; The Gnus registry's ignored groups
1931 registry-ignore
1932 :type list
1933 :function-document
1934 "Whether this group should be ignored by the registry."
1935 :variable gnus-registry-ignored-groups
1936 :variable-default nil
1937 :variable-document
1938 "*Groups in which the registry should be turned off."
1939 :variable-group gnus-registry
1946 :parameter-document
1949 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1951 "*Disable the group parameters for spam detection.
1952 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1959 "Spam group classification (requires spam.el).
1960 This group contains spam messages. On summary entry, unread messages
1961 will be marked as spam. On summary exit, the specified spam
1962 processors will be invoked on spam-marked messages, then those
1963 messages will be expired, so the spam processor will only see a
1967 "The ham value for the spam group parameter (requires spam.el).
1968 On summary exit, the specified ham processors will be invoked on
1969 ham-marked messages. Exercise caution, since the ham processor will
1970 see the same message more than once because there is no ham message
1974 spam-contents
1975 :type list
1976 :function-document
1977 "The spam type (spam, ham, or neither) of the group."
1978 :variable gnus-spam-newsgroup-contents
1979 :variable-default nil
1980 :variable-document
1981 "*Group classification (spam, ham, or neither). Only
1982 meaningful when spam.el is loaded. If non-nil, this should be a
1983 list of group name regexps associated with a classification for
1984 each one. In spam groups, new articles are marked as spam on
1985 summary entry. There is other behavior associated with ham and
1986 no classification when spam.el is loaded - see the manual."
1987 :variable-group spam
2001 :parameter-document
2002 "The spam classification (spam, ham, or neither) of this group.
2003 When a spam group is entered, all unread articles are marked as
2004 spam. There is other behavior associated with ham and no
2020 "OBSOLETE: The Gmane reporting summary exit spam processor.
2027 "OBSOLETE: The ifile summary exit ham processor.
2031 "OBSOLETE: The Bogofilter summary exit ham processor.
2035 "OBSOLETE: The spam-stat summary exit ham processor.
2039 "OBSOLETE: The whitelist summary exit ham processor.
2043 "OBSOLETE: The BBDB summary exit ham processor.
2047 "OBSOLETE: The ham copy exit ham processor.
2051 "OBSOLETE: The spamoracle summary exit ham processor.
2055 spam-process
2056 :type list
2057 :parameter-type
2060 :value nil
2089 :function-document
2090 "Which spam or ham processors will be applied when the summary is exited."
2091 :variable gnus-spam-process-newsgroups
2092 :variable-default nil
2093 :variable-document
2094 "*Groups in which to automatically process spam or ham articles with
2095 a backend on summary exit. If non-nil, this should be a list of group
2096 name regexps that should match all groups in which to do automatic
2097 spam processing, associated with the appropriate processor."
2098 :variable-group spam
2099 :variable-type
2132 :parameter-document
2136 spam-autodetect
2137 :type list
2138 :parameter-type
2140 :function-document
2141 "Should spam be autodetected (with spam-split) in this group?"
2142 :variable gnus-spam-autodetect
2143 :variable-default nil
2144 :variable-document
2145 "*Groups in which spam should be autodetected when they are entered.
2146 Only unseen articles will be examined, unless
2147 spam-autodetect-recheck-messages is set."
2148 :variable-group spam
2149 :variable-type
2154 boolean))
2155 :parameter-document
2156 "Spam autodetection.
2157 Only unseen articles will be examined, unless
2161 spam-autodetect-methods
2162 :type list
2163 :parameter-type
2180 :function-document
2181 "Methods to be used for autodetection in each group"
2182 :variable gnus-spam-autodetect-methods
2183 :variable-default nil
2184 :variable-document
2185 "*Methods for autodetecting spam per group.
2186 Requires the spam-autodetect parameter. Only unseen articles
2187 will be examined, unless spam-autodetect-recheck-messages is
2188 set."
2189 :variable-group spam
2190 :variable-type
2211 :parameter-document
2212 "Spam autodetection methods.
2213 Requires the spam-autodetect parameter. Only unseen articles
2214 will be examined, unless spam-autodetect-recheck-messages is
2218 spam-process-destination
2219 :type list
2220 :parameter-type
2226 :function-document
2227 "Where spam-processed articles will go at summary exit."
2228 :variable gnus-spam-process-destinations
2229 :variable-default nil
2230 :variable-document
2231 "*Groups in which to explicitly send spam-processed articles to
2232 another group, or expire them (the default). If non-nil, this should
2233 be a list of group name regexps that should match all groups in which
2234 to do spam-processed article moving, associated with the destination
2235 group or nil for explicit expiration. This only makes sense for
2236 mail groups."
2237 :variable-group spam
2238 :variable-type
2249 :parameter-document
2253 ham-process-destination
2254 :type list
2255 :parameter-type
2263 :function-document
2264 "Where ham articles will go at summary exit from a spam group."
2265 :variable gnus-ham-process-destinations
2266 :variable-default nil
2267 :variable-document
2268 "*Groups in which to explicitly send ham articles to
2269 another group, or do nothing (the default). If non-nil, this should
2270 be a list of group name regexps that should match all groups in which
2271 to do ham article moving, associated with the destination
2272 group or nil for explicit ignoring. This only makes sense for
2273 mail groups, and only works in spam groups."
2274 :variable-group spam
2275 :variable-type
2287 :parameter-document
2291 ham-marks
2302 :parameter-document
2303 "Marks considered ham (positively not spam). Such articles will be
2304 processed as ham (non-spam) on group exit. When nil, the global
2305 spam-ham-marks variable takes precedence."
2307 gnus-read-mark
2308 gnus-killed-mark
2309 gnus-kill-file-mark
2310 gnus-low-score-mark))))
2311 :variable-group spam
2312 :variable-document
2316 spam-marks
2325 :parameter-document
2326 "Marks considered spam.
2327 Such articles will be processed as spam on group exit. When nil, the global
2328 spam-spam-marks variable takes precedence."
2330 :variable-group spam
2331 :variable-document
2335 "Number of group name elements to leave alone when making a short group name."
2340 "*If non-nil, once you set a level, Gnus will use this level."
2344 ;; Hooks.
2347 "A hook run while Gnus is loaded."
2352 "A hook called to apply kill files to a group.
2353 This hook is intended to apply a kill file to the selected newsgroup.
2354 The function `gnus-apply-kill-file' is called by default.
2356 Since a general kill file is too heavy to use only for a few
2357 newsgroups, I recommend you to use a lighter hook function. For
2358 example, if you'd like to apply a kill file to articles which contains
2359 a string `rmgroup' in subject in newsgroup `control', you can use the
2360 following hook:
2362 (setq gnus-apply-kill-hook
2363 (list
2364 (lambda ()
2373 "Function run when a group level is changed.
2374 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2377 function))
2379 ;;; Face thingies.
2383 mouse-face
2384 summary-menu group-menu article-menu
2385 tree-highlight menu highlight
2386 browse-menu server-menu
2387 page-marker tree-menu binary-menu pick-menu
2388 grouplens-menu)
2389 "*Enable visual features.
2390 If `visual' is disabled, there will be no menus and few faces. Most of
2391 the visual customization options below will be ignored. Gnus will use
2392 less space and be faster as a result.
2394 This variable can also be a list of visual elements to switch on. For
2395 instance, to switch off all visual things except menus, you can say:
2397 (setq gnus-visual '(menu))
2399 Valid elements include `summary-highlight', `group-highlight',
2400 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2401 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2402 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2403 and `grouplens-menu'."
2424 ;; Byte-compiler warning.
2426 ;; Find out whether the gnus-visual TYPE is wanted.
2430 gnus-visual
2434 t))))
2444 "*Face used for group or summary buffer mouse highlighting.
2445 The line beneath the mouse pointer will be highlighted with this
2446 face."
2459 "Controls use of the agent cache while plugged.
2460 When set, Gnus will prefer using the locally stored content rather
2461 than re-fetching it from the server. You also need to enable
2462 `gnus-agent' for this to have any affect."
2468 "Default charset assumed to be used when viewing non-ASCII characters.
2469 This variable is overridden on a group-to-group basis by the
2470 `gnus-group-charset-alist' variable and is only used on groups not
2471 covered by that variable."
2475 ;; Fixme: Doc reference to agent.
2477 "Whether we want to use the Gnus agent or not.
2479 You may customize gnus-agent to disable its use. However, some
2480 back ends have started to use the agent as a client-side cache.
2481 Disabling the agent may result in noticeable loss of performance."
2487 "Function called by the command `gnus-other-frame'."
2495 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2496 This should be an alist for Emacs, or a plist for XEmacs."
2507 "Which information should be exposed in the User-Agent header.
2509 Can be a list of symbols or a string. Valid symbols are `gnus'
2510 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2511 addition to the Emacs version, you can add `codename' \(show
2512 \(S\)XEmacs codename\) or either `config' \(show system
2513 configuration\) or `type' \(show system type\). If you set it to
2514 a string, be sure to use a valid format, see RFC 2616."
2527 ;; Convert old (No Gnus < 2005-01-10, v5-10 < 2005-09-05) symbol type values:
2546 \f
2547 ;;; Internal variables
2552 ; Reset each time gnus-agent-covered-methods is changed else
2553 ; gnus-agent-method-p may mis-report a methods status.
2554 )
2578 ;; Dummy variable.
2581 ;; Variable holding the user answers to all method prompts.
2584 ;; Variable holding the user answers to all mail method prompts.
2587 ;; Variable holding the user answers to all group prompts.
2595 "*The directory where cached articles will be stored."
2601 nnspool "cache"
2625 ;; Propagate flags to server, with the following exceptions:
2626 ;; `seen' is private to each gnus installation
2627 ;; `cache' is a internal gnus flag for each gnus installation
2628 ;; `download' is a agent flag private to each gnus installation
2629 ;; `unsend' are for nndraft groups only
2630 ;; `score' is not a proper mark
2631 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2634 "Marks that shouldn't be propagated to back ends.
2635 Typical marks are those that make no sense in a standalone back end,
2636 such as a mark that says whether an article is stored in the cache
2650 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2675 gnus-newsrc-last-checked-date
2676 gnus-newsrc-alist gnus-server-alist
2677 gnus-killed-list gnus-zombie-list
2678 gnus-topic-topology gnus-topic-alist
2679 gnus-format-specs)
2683 "Assoc list of read articles.
2687 "Assoc list of registry data.
2714 ;; Save window configuration.
2719 ;;; Let the byte-compiler know that we know about this variable.
2730 ;;; End of variables.
2732 ;; Define some autoload functions Gnus might use.
2735 ;; This little mapcar goes through the list below and marks the
2736 ;; symbols in question as autoloaded functions.
2756 message-send-and-exit message-yank-original)
2762 rmail-show-message rmail-summary-exists
2763 rmail-select-summary rmail-update-summary)
2767 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2768 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2772 gnus-Folder-save-name gnus-folder-save-name)
2775 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2776 gnus-demon-add-disconnection gnus-demon-add-handler
2777 gnus-demon-remove-handler)
2779 gnus-demon-init gnus-demon-cancel)
2781 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2782 gnus-face-from-file)
2784 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2786 gnus-nocem-unwanted-article-p)
2788 gnus-server-server-name)
2791 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2792 gnus-article-hide-citation gnus-article-fill-cited-article
2793 gnus-article-hide-citation-in-followups)
2795 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2796 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2798 gnus-cache-possibly-remove-articles gnus-cache-request-article
2799 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2800 gnus-cache-enter-remove-article gnus-cached-article-p
2801 gnus-cache-open gnus-cache-close gnus-cache-update-article
2802 gnus-cache-articles-in-group)
2804 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2806 gnus-summary-increase-score gnus-summary-set-score
2807 gnus-summary-raise-thread gnus-summary-raise-same-subject
2808 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2809 gnus-summary-lower-thread gnus-summary-lower-same-subject
2810 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2811 gnus-summary-current-score gnus-score-delta-default
2812 gnus-score-flush-cache gnus-score-close
2813 gnus-possibly-score-headers gnus-score-followup-article
2814 gnus-score-followup-thread)
2817 gnus-current-score-file-nondirectory gnus-score-adaptive
2818 gnus-score-find-trace gnus-score-file-name)
2822 gnus-subscribe-topics)
2826 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2827 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2828 gnus-uu-mark-by-regexp gnus-uu-mark-all
2829 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2830 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2831 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2832 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2833 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2834 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2835 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2836 gnus-uu-mark-over gnus-uu-post-news)
2839 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2841 gnus-group-post-news gnus-group-mail gnus-group-news
2842 gnus-summary-post-news gnus-summary-news-other-window
2843 gnus-summary-followup gnus-summary-followup-with-original
2844 gnus-summary-cancel-article gnus-summary-supersede-article
2845 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2846 gnus-summary-mail-forward gnus-summary-mail-other-window
2847 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2848 gnus-summary-wide-reply gnus-summary-followup-to-mail
2849 gnus-summary-followup-to-mail-with-original gnus-bug
2850 gnus-summary-wide-reply-with-original
2851 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2852 gnus-summary-post-forward)
2855 gnus-grouplens-mode)
2859 gnus-list-of-unread-articles gnus-list-of-read-articles
2860 gnus-offer-save-summaries gnus-make-thread-indent-array
2861 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2862 gnus-summary-skip-intangible gnus-summary-article-number
2863 gnus-data-header gnus-data-find)
2865 gnus-group-list-groups gnus-group-first-unread-group
2866 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2867 gnus-group-setup-buffer gnus-group-get-new-news
2868 gnus-group-make-help-group gnus-group-update-group
2869 gnus-group-iterate gnus-group-group-name)
2871 gnus-backlog-remove-article)
2873 gnus-article-prepare gnus-article-set-window-start
2874 gnus-article-next-page gnus-article-prev-page
2875 gnus-request-article-this-buffer gnus-article-mode
2876 gnus-article-setup-buffer gnus-narrow-to-page
2877 gnus-article-delete-invisible-text gnus-treat-article)
2879 gnus-article-hide-headers gnus-article-hide-boring-headers
2880 gnus-article-treat-overstrike
2881 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2882 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2883 gnus-article-de-base64-unreadable
2884 gnus-article-decode-HZ
2885 gnus-article-wash-html
2886 gnus-article-unsplit-urls
2887 gnus-article-hide-pem gnus-article-hide-signature
2888 gnus-article-strip-leading-blank-lines gnus-article-date-local
2889 gnus-article-date-original gnus-article-date-lapsed
2890 ;; gnus-article-show-all-headers
2891 gnus-article-edit-mode gnus-article-edit-article
2892 gnus-article-edit-done gnus-article-decode-encoded-words
2893 gnus-start-date-timer gnus-stop-date-timer
2894 gnus-mime-view-all-parts)
2897 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2899 gnus-dup-enter-articles)
2903 gnus-group-move-group-to-server gnus-change-server)
2907 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2908 gnus-async-halt-prefetch)
2910 gnus-agent-save-active gnus-agent-method-p
2911 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2912 gnus-summary-set-agent-mark gnus-agent-save-group-info
2913 gnus-agent-request-article gnus-agent-retrieve-headers)
2915 gnus-unplugged gnus-agentize gnus-agent-batch)
2917 gnus-summary-save-article-vm)
2922 gnus-group-split-update)
2925 ;;; gnus-sum.el thingies
2929 "*The format specification of the lines in the summary buffer.
2931 It works along the same lines as a normal formatting string,
2932 with some simple extensions.
2934 %N Article number, left padded with spaces (string)
2935 %S Subject (string)
2937 %n Name of the poster (string)
2938 %a Extracted name of the poster (string)
2939 %A Extracted address of the poster (string)
2940 %F Contents of the From: header (string)
2941 %f Contents of the From: or To: headers (string)
2942 %x Contents of the Xref: header (string)
2943 %D Date of the article (string)
2944 %d Date of the article (string) in DD-MMM format
2945 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2946 %M Message-id of the article (string)
2947 %r References of the article (string)
2948 %c Number of characters in the article (integer)
2949 %k Pretty-printed version of the above (string)
2951 %L Number of lines in the article (integer)
2952 %I Indentation based on thread level (a string of spaces)
2953 %B A complex trn-style thread tree (string)
2954 The variables `gnus-sum-thread-*' can be used for customization.
2955 %T A string with two possible values: 80 spaces if the article
2956 is on thread level two or larger and 0 spaces on level one
2961 %> Spaces of length thread-level (string)
2962 %< Spaces of length (- 20 thread-level) (string)
2963 %i Article score (number)
2964 %z Article zcore (character)
2965 %t Number of articles under the current thread (number).
2966 %e Whether the thread is empty or not (character).
2967 %l GroupLens score (string).
2968 %V Total thread score (number).
2969 %P The line number (number).
2970 %O Download mark (character).
2971 %* If present, indicates desired cursor position
2972 (instead of after first colon).
2973 %u User defined specifier. The next character in the format string should
2974 be a letter. Gnus will call the function gnus-user-format-function-X,
2975 where X is the letter following %u. The function will be passed the
2976 current header as argument. The function should return a string, which
2977 will be inserted into the summary just like information from any other
2978 summary specifier.
2980 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2981 with care. For reasons of efficiency, Gnus will compute what column
2983 it is invalid to have these specs after a variable-length spec. Well,
2984 you might not be arrested, but your summary buffer will look strange,
2985 which is bad enough.
2987 The smart choice is to have these specs as far to the left as
2988 possible.
2990 This restriction may disappear in later versions of Gnus.
2992 General format specifiers can also be used.
2993 See Info node `(gnus)Formatting Variables'."
2998 ;;;
2999 ;;; Skeleton keymaps
3000 ;;;
3005 (while keys
3006 (define-key keymap (pop keys) 'undefined))))
3008 (defvar gnus-article-mode-map
3009 (let ((keymap (make-sparse-keymap)))
3010 (gnus-suppress-keymap keymap)
3011 keymap))
3012 (defvar gnus-summary-mode-map
3013 (let ((keymap (make-keymap)))
3014 (gnus-suppress-keymap keymap)
3015 keymap))
3016 (defvar gnus-group-mode-map
3017 (let ((keymap (make-keymap)))
3018 (gnus-suppress-keymap keymap)
3019 keymap))
3021 \f
3023 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3024 ;; If you want the cursor to go somewhere else, set these two
3025 ;; functions in some startup hook to whatever you want.
3026 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3027 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3029 ;;; Various macros and substs.
3031 (defun gnus-header-from (header)
3032 (mail-header-from header))
3034 (defmacro gnus-gethash (string hashtable)
3035 "Get hash value of STRING in HASHTABLE."
3036 `(symbol-value (intern-soft ,string ,hashtable)))
3038 (defmacro gnus-gethash-safe (string hashtable)
3039 "Get hash value of STRING in HASHTABLE.
3040 Return nil if not defined."
3041 `(let ((sym (intern-soft ,string ,hashtable)))
3042 (and (boundp sym) (symbol-value sym))))
3044 (defmacro gnus-sethash (string value hashtable)
3045 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3046 `(set (intern ,string ,hashtable) ,value))
3047 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3049 (defmacro gnus-group-unread (group)
3050 "Get the currently computed number of unread articles in GROUP."
3051 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3053 (defmacro gnus-group-entry (group)
3054 "Get the newsrc entry for GROUP."
3055 `(gnus-gethash ,group gnus-newsrc-hashtb))
3057 (defmacro gnus-active (group)
3058 "Get active info on GROUP."
3059 `(gnus-gethash ,group gnus-active-hashtb))
3061 (defmacro gnus-set-active (group active)
3062 "Set GROUP's active info."
3063 `(gnus-sethash ,group ,active gnus-active-hashtb))
3065 ;; Info access macros.
3067 (defmacro gnus-info-group (info)
3068 `(nth 0 ,info))
3069 (defmacro gnus-info-rank (info)
3070 `(nth 1 ,info))
3071 (defmacro gnus-info-read (info)
3072 `(nth 2 ,info))
3073 (defmacro gnus-info-marks (info)
3074 `(nth 3 ,info))
3075 (defmacro gnus-info-method (info)
3076 `(nth 4 ,info))
3077 (defmacro gnus-info-params (info)
3078 `(nth 5 ,info))
3080 (defmacro gnus-info-level (info)
3081 `(let ((rank (gnus-info-rank ,info)))
3082 (if (consp rank)
3083 (car rank)
3084 rank)))
3085 (defmacro gnus-info-score (info)
3086 `(let ((rank (gnus-info-rank ,info)))
3087 (or (and (consp rank) (cdr rank)) 0)))
3089 (defmacro gnus-info-set-group (info group)
3090 `(setcar ,info ,group))
3091 (defmacro gnus-info-set-rank (info rank)
3092 `(setcar (nthcdr 1 ,info) ,rank))
3093 (defmacro gnus-info-set-read (info read)
3094 `(setcar (nthcdr 2 ,info) ,read))
3095 (defmacro gnus-info-set-marks (info marks &optional extend)
3096 (if extend
3097 `(gnus-info-set-entry ,info ,marks 3)
3098 `(setcar (nthcdr 3 ,info) ,marks)))
3099 (defmacro gnus-info-set-method (info method &optional extend)
3100 (if extend
3101 `(gnus-info-set-entry ,info ,method 4)
3102 `(setcar (nthcdr 4 ,info) ,method)))
3103 (defmacro gnus-info-set-params (info params &optional extend)
3104 (if extend
3105 `(gnus-info-set-entry ,info ,params 5)
3106 `(setcar (nthcdr 5 ,info) ,params)))
3108 (defun gnus-info-set-entry (info entry number)
3109 ;; Extend the info until we have enough elements.
3110 (while (<= (length info) number)
3111 (nconc info (list nil)))
3112 ;; Set the entry.
3113 (setcar (nthcdr number info) entry))
3115 (defmacro gnus-info-set-level (info level)
3116 `(let ((rank (cdr ,info)))
3117 (if (consp (car rank))
3118 (setcar (car rank) ,level)
3119 (setcar rank ,level))))
3120 (defmacro gnus-info-set-score (info score)
3121 `(let ((rank (cdr ,info)))
3122 (if (consp (car rank))
3123 (setcdr (car rank) ,score)
3124 (setcar rank (cons (car rank) ,score)))))
3126 (defmacro gnus-get-info (group)
3127 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3129 ;;; Load the compatibility functions.
3131 (require 'gnus-ems)
3133 \f
3134 ;;;
3135 ;;; Shutdown
3136 ;;;
3138 (defvar gnus-shutdown-alist nil)
3140 (defun gnus-add-shutdown (function &rest symbols)
3141 "Run FUNCTION whenever one of SYMBOLS is shut down."
3142 (push (cons function symbols) gnus-shutdown-alist))
3144 (defun gnus-shutdown (symbol)
3145 "Shut down everything that waits for SYMBOL."
3146 (let ((alist gnus-shutdown-alist)
3147 entry)
3148 (while (setq entry (pop alist))
3149 (when (memq symbol (cdr entry))
3150 (funcall (car entry))))))
3152 \f
3153 ;;;
3154 ;;; Gnus Utility Functions
3155 ;;;
3157 (defun gnus-find-subscribed-addresses ()
3158 "Return a regexp matching the addresses of all subscribed mail groups.
3159 It consists of the `to-address' or `to-list' parameter of all groups
3160 with a `subscribed' parameter."
3161 (let (group address addresses)
3162 (dolist (entry (cdr gnus-newsrc-alist))
3163 (setq group (car entry))
3164 (when (gnus-parameter-subscribed group)
3165 (setq address (mail-strip-quoted-names
3166 (or (gnus-group-fast-parameter group 'to-address)
3167 (gnus-group-fast-parameter group 'to-list))))
3168 (when address
3169 (add-to-list 'addresses address))))
3170 (when addresses
3173 (defmacro gnus-string-or (&rest strings)
3174 "Return the first element of STRINGS that is a non-blank string.
3175 STRINGS will be evaluated in normal `or' order."
3176 `(gnus-string-or-1 ',strings))
3178 (defun gnus-string-or-1 (strings)
3179 (let (string)
3180 (while strings
3181 (setq string (eval (pop strings)))
3183 (setq string nil)
3184 (setq strings nil)))
3185 string))
3187 (defun gnus-version (&optional arg)
3188 "Version number of this version of Gnus.
3189 If ARG, insert string at point."
3190 (interactive "P")
3191 (if arg
3192 (insert (message gnus-version))
3193 (message gnus-version)))
3195 (defun gnus-continuum-version (&optional version)
3196 "Return VERSION as a floating point number."
3197 (interactive)
3198 (unless version
3199 (setq version gnus-version))
3202 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3203 (number (match-string 2 version))
3204 major minor least)
3205 (unless (string-match
3207 (error "Invalid version string: %s" version))
3208 (setq major (string-to-number (match-string 1 number))
3209 minor (string-to-number (match-string 2 number))
3210 least (if (match-beginning 3)
3211 (string-to-number (match-string 3 number))
3212 0))
3213 (string-to-number
3214 (if (zerop major)
3215 (format "%s00%02d%02d"
3216 (if (member alpha '("(ding)" "d"))
3217 "4.99"
3218 (+ 5 (* 0.02
3219 (abs
3220 (- (mm-char-int (aref (downcase alpha) 0))
3221 (mm-char-int ?t))))
3222 -0.01))
3223 minor least)
3224 (format "%d.%02d%02d" major minor least))))))
3226 (defun gnus-info-find-node (&optional nodename)
3227 "Find Info documentation of Gnus."
3228 (interactive)
3229 ;; Enlarge info window if needed.
3230 (let (gnus-info-buffer)
3231 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3232 (setq gnus-info-buffer (current-buffer))
3233 (gnus-configure-windows 'info)))
3235 ;;;
3236 ;;; gnus-interactive
3237 ;;;
3239 (defvar gnus-current-prefix-symbol nil
3240 "Current prefix symbol.")
3242 (defvar gnus-current-prefix-symbols nil
3243 "List of current prefix symbols.")
3245 (defun gnus-interactive (string &optional params)
3246 "Return a list that can be fed to `interactive'.
3247 See `interactive' for full documentation.
3249 Adds the following specs:
3251 y -- The current symbolic prefix.
3252 Y -- A list of the current symbolic prefix(es).
3253 A -- Article number.
3254 H -- Article header.
3255 g -- Group name."
3256 (let ((i 0)
3257 out c prompt)
3258 (while (< i (length string))
3260 (setq c (aref string i))
3261 (when (match-end 1)
3262 (setq prompt (match-string 1 string)))
3263 (setq i (match-end 0))
3264 ;; We basically emulate just about everything that
3265 ;; `interactive' does, but add the specs listed above.
3266 (push
3267 (cond
3268 ((= c ?a)
3269 (completing-read prompt obarray 'fboundp t))
3270 ((= c ?b)
3271 (read-buffer prompt (current-buffer) t))
3272 ((= c ?B)
3273 (read-buffer prompt (other-buffer (current-buffer))))
3274 ((= c ?c)
3275 (read-char))
3276 ((= c ?C)
3277 (completing-read prompt obarray 'commandp t))
3278 ((= c ?d)
3279 (point))
3280 ((= c ?D)
3281 (read-file-name prompt nil default-directory 'lambda))
3282 ((= c ?f)
3283 (read-file-name prompt nil nil 'lambda))
3284 ((= c ?F)
3285 (read-file-name prompt))
3286 ((= c ?k)
3287 (read-key-sequence prompt))
3288 ((= c ?K)
3289 (error "Not implemented spec"))
3290 ((= c ?e)
3291 (error "Not implemented spec"))
3292 ((= c ?m)
3293 (mark))
3294 ((= c ?N)
3295 (error "Not implemented spec"))
3296 ((= c ?n)
3297 (string-to-number (read-from-minibuffer prompt)))
3298 ((= c ?p)
3299 (prefix-numeric-value current-prefix-arg))
3300 ((= c ?P)
3301 current-prefix-arg)
3302 ((= c ?r)
3303 'gnus-prefix-nil)
3304 ((= c ?s)
3305 (read-string prompt))
3306 ((= c ?S)
3307 (intern (read-string prompt)))
3308 ((= c ?v)
3309 (read-variable prompt))
3310 ((= c ?x)
3311 (read-minibuffer prompt))
3312 ((= c ?x)
3313 (eval-minibuffer prompt))
3314 ;; And here the new specs come.
3315 ((= c ?y)
3316 gnus-current-prefix-symbol)
3317 ((= c ?Y)
3318 gnus-current-prefix-symbols)
3319 ((= c ?g)
3320 (gnus-group-group-name))
3321 ((= c ?A)
3322 (gnus-summary-skip-intangible)
3323 (or (get-text-property (point) 'gnus-number)
3324 (gnus-summary-last-subject)))
3325 ((= c ?H)
3326 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3327 (t
3328 (error "Non-implemented spec")))
3329 out)
3330 (cond
3331 ((= c ?r)
3332 (push (if (< (point) (mark)) (point) (mark)) out)
3333 (push (if (> (point) (mark)) (point) (mark)) out))))
3334 (setq out (delq 'gnus-prefix-nil out))
3335 (nreverse out)))
3337 (defun gnus-symbolic-argument (&optional arg)
3338 "Read a symbolic argument and a command, and then execute command."
3339 (interactive "P")
3340 (let* ((in-command (this-command-keys))
3341 (command in-command)
3342 gnus-current-prefix-symbols
3343 gnus-current-prefix-symbol
3344 syms)
3345 (while (equal in-command command)
3346 (message "%s-" (key-description (this-command-keys)))
3347 (push (intern (char-to-string (read-char))) syms)
3348 (setq command (read-key-sequence nil t)))
3349 (setq gnus-current-prefix-symbols (nreverse syms)
3350 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3351 (call-interactively (key-binding command t))))
3353 ;;; More various functions.
3355 (defsubst gnus-check-backend-function (func group)
3356 "Check whether GROUP supports function FUNC.
3357 GROUP can either be a string (a group name) or a select method."
3358 (ignore-errors
3359 (let ((method (if (stringp group)
3360 (car (gnus-find-method-for-group group))
3361 group)))
3362 (unless (featurep method)
3363 (require method))
3364 (fboundp (intern (format "%s-%s" method func))))))
3366 (defun gnus-group-read-only-p (&optional group)
3367 "Check whether GROUP supports editing or not.
3368 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3369 that that variable is buffer-local to the summary buffers."
3370 (let ((group (or group gnus-newsgroup-name)))
3371 (not (gnus-check-backend-function 'request-replace-article group))))
3373 (defun gnus-virtual-group-p (group)
3374 "Say whether GROUP is virtual or not."
3375 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3376 gnus-valid-select-methods)))
3378 (defun gnus-news-group-p (group &optional article)
3379 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3380 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3381 t) ;is news of course.
3382 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3383 nil) ;must be mail then.
3384 ((vectorp article) ;Has header info.
3385 (eq (gnus-request-type group (mail-header-id article)) 'news))
3386 ((null article) ;Hasn't header info
3387 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3388 ((< article 0) ;Virtual message
3389 nil) ;we don't know, guess mail.
3390 (t ;Has positive number
3391 (eq (gnus-request-type group article) 'news)))) ;use it.
3393 ;; Returns a list of writable groups.
3394 (defun gnus-writable-groups ()
3395 (let ((alist gnus-newsrc-alist)
3396 groups group)
3397 (while (setq group (car (pop alist)))
3398 (unless (gnus-group-read-only-p group)
3399 (push group groups)))
3400 (nreverse groups)))
3402 ;; Check whether to use long file names.
3403 (defun gnus-use-long-file-name (symbol)
3404 ;; The variable has to be set...
3405 (and gnus-use-long-file-name
3406 ;; If it isn't a list, then we return t.
3407 (or (not (listp gnus-use-long-file-name))
3408 ;; If it is a list, and the list contains `symbol', we
3409 ;; return nil.
3410 (not (memq symbol gnus-use-long-file-name)))))
3412 ;; Generate a unique new group name.
3413 (defun gnus-generate-new-group-name (leaf)
3414 (let ((name leaf)
3415 (num 0))
3416 (while (gnus-gethash name gnus-newsrc-hashtb)
3417 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3418 name))
3420 (defun gnus-ephemeral-group-p (group)
3421 "Say whether GROUP is ephemeral or not."
3422 (gnus-group-get-parameter group 'quit-config t))
3424 (defun gnus-group-quit-config (group)
3425 "Return the quit-config of GROUP."
3426 (gnus-group-get-parameter group 'quit-config t))
3428 (defun gnus-kill-ephemeral-group (group)
3429 "Remove ephemeral GROUP from relevant structures."
3430 (gnus-sethash group nil gnus-newsrc-hashtb))
3432 (defun gnus-simplify-mode-line ()
3433 "Make mode lines a bit simpler."
3434 (setq mode-line-modified (cdr gnus-mode-line-modified))
3435 (when (listp mode-line-format)
3436 (make-local-variable 'mode-line-format)
3437 (setq mode-line-format (copy-sequence mode-line-format))
3438 (when (equal (nth 3 mode-line-format) " ")
3439 (setcar (nthcdr 3 mode-line-format) " "))))
3441 ;;; Servers and groups.
3443 (defsubst gnus-server-add-address (method)
3444 (let ((method-name (symbol-name (car method))))
3445 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3446 (not (assq (intern (concat method-name "-address")) method))
3447 (memq 'physical-address (assq (car method)
3448 gnus-valid-select-methods)))
3449 (append method (list (list (intern (concat method-name "-address"))
3450 (nth 1 method))))
3451 method)))
3453 (defsubst gnus-method-to-server (method)
3454 (catch 'server-name
3455 (setq method (or method gnus-select-method))
3457 ;; Perhaps it is already in the cache.
3458 (mapc (lambda (name-method)
3459 (if (equal (cdr name-method) method)
3460 (throw 'server-name (car name-method))))
3461 gnus-server-method-cache)
3463 (mapc
3464 (lambda (server-alist)
3465 (mapc (lambda (name-method)
3466 (when (gnus-methods-equal-p (cdr name-method) method)
3467 (unless (member name-method gnus-server-method-cache)
3468 (push name-method gnus-server-method-cache))
3469 (throw 'server-name (car name-method))))
3470 server-alist))
3471 (let ((alists (list gnus-server-alist
3472 gnus-predefined-server-alist)))
3473 (if gnus-select-method
3474 (push (list (cons "native" gnus-select-method)) alists))
3475 alists))
3477 (let* ((name (if (member (cadr method) '(nil ""))
3478 (format "%s" (car method))
3479 (format "%s:%s" (car method) (cadr method))))
3480 (name-method (cons name method)))
3481 (unless (member name-method gnus-server-method-cache)
3482 (push name-method gnus-server-method-cache))
3483 name)))
3485 (defsubst gnus-server-to-method (server)
3486 "Map virtual server names to select methods."
3487 (or (and server (listp server) server)
3488 (cdr (assoc server gnus-server-method-cache))
3489 (let ((result
3490 (or
3491 ;; Perhaps this is the native server?
3492 (and (equal server "native") gnus-select-method)
3493 ;; It should be in the server alist.
3494 (cdr (assoc server gnus-server-alist))
3495 ;; It could be in the predefined server alist.
3496 (cdr (assoc server gnus-predefined-server-alist))
3497 ;; If not, we look through all the opened server
3498 ;; to see whether we can find it there.
3499 (let ((opened gnus-opened-servers))
3500 (while (and opened
3501 (not (equal server (format "%s:%s" (caaar opened)
3502 (cadaar opened)))))
3503 (pop opened))
3504 (caar opened))
3505 ;; It could be a named method, search all servers
3506 (let ((servers gnus-secondary-select-methods))
3507 (while (and servers
3508 (not (equal server (format "%s:%s" (caar servers)
3509 (cadar servers)))))
3510 (pop servers))
3511 (car servers))
3512 ;; This could be some sort of foreign server that I
3513 ;; simply haven't opened (yet). Do a brute-force scan
3514 ;; of the entire gnus-newsrc-alist for the server name
3515 ;; of every method. As a side-effect, loads the
3516 ;; gnus-server-method-cache so this only happens once,
3517 ;; if at all.
3518 (let (match)
3519 (mapcar
3520 (lambda (info)
3521 (let ((info-method (gnus-info-method info)))
3522 (unless (stringp info-method)
3523 (let ((info-server (gnus-method-to-server info-method)))
3524 (when (equal server info-server)
3525 (setq match info-method))))))
3526 (cdr gnus-newsrc-alist))
3527 match))))
3528 (when result
3529 (push (cons server result) gnus-server-method-cache))
3530 result)))
3532 (defsubst gnus-server-get-method (group method)
3533 ;; Input either a server name, and extended server name, or a
3534 ;; select method, and return a select method.
3535 (cond ((stringp method)
3536 (gnus-server-to-method method))
3537 ((equal method gnus-select-method)
3538 gnus-select-method)
3539 ((and (stringp (car method))
3540 group)
3541 (gnus-server-extend-method group method))
3542 ((and method
3543 (not group)
3544 (equal (cadr method) ""))
3545 method)
3546 (t
3547 (gnus-server-add-address method))))
3549 (defmacro gnus-method-equal (ss1 ss2)
3550 "Say whether two servers are equal."
3551 `(let ((s1 ,ss1)
3552 (s2 ,ss2))
3553 (or (equal s1 s2)
3554 (and (= (length s1) (length s2))
3555 (progn
3556 (while (and s1 (member (car s1) s2))
3557 (setq s1 (cdr s1)))
3558 (null s1))))))
3560 (defun gnus-methods-equal-p (m1 m2)
3561 (let ((m1 (or m1 gnus-select-method))
3562 (m2 (or m2 gnus-select-method)))
3563 (or (equal m1 m2)
3564 (and (eq (car m1) (car m2))
3565 (or (not (memq 'address (assoc (symbol-name (car m1))
3566 gnus-valid-select-methods)))
3567 (equal (nth 1 m1) (nth 1 m2)))))))
3569 (defun gnus-server-equal (m1 m2)
3570 "Say whether two methods are equal."
3571 (let ((m1 (cond ((null m1) gnus-select-method)
3572 ((stringp m1) (gnus-server-to-method m1))
3573 (t m1)))
3574 (m2 (cond ((null m2) gnus-select-method)
3575 ((stringp m2) (gnus-server-to-method m2))
3576 (t m2))))
3577 (gnus-method-equal m1 m2)))
3579 (defun gnus-servers-using-backend (backend)
3580 "Return a list of known servers using BACKEND."
3581 (let ((opened gnus-opened-servers)
3582 out)
3583 (while opened
3584 (when (eq backend (caaar opened))
3585 (push (caar opened) out))
3586 (pop opened))
3587 out))
3589 (defun gnus-archive-server-wanted-p ()
3590 "Say whether the user wants to use the archive server."
3591 (cond
3592 ((or (not gnus-message-archive-method)
3593 (not gnus-message-archive-group))
3594 nil)
3595 ((and gnus-message-archive-method gnus-message-archive-group)
3596 t)
3597 (t
3598 (let ((active (cadr (assq 'nnfolder-active-file
3599 gnus-message-archive-method))))
3600 (and active
3601 (file-exists-p active))))))
3603 (defsubst gnus-method-to-server-name (method)
3604 (concat
3605 (format "%s" (car method))
3606 (when (and
3607 (or (assoc (format "%s" (car method))
3608 (gnus-methods-using 'address))
3609 (gnus-server-equal method gnus-message-archive-method))
3610 (nth 1 method)
3611 (not (string= (nth 1 method) "")))
3612 (concat "+" (nth 1 method)))))
3614 (defsubst gnus-method-to-full-server-name (method)
3615 (format "%s+%s" (car method) (nth 1 method)))
3617 (defun gnus-group-prefixed-name (group method &optional full)
3618 "Return the whole name from GROUP and METHOD.
3619 Call with full set to get the fully qualified group name (even if the
3620 server is native)."
3621 (when (stringp method)
3622 (setq method (gnus-server-to-method method)))
3623 (if (or (not method)
3624 (and (not full) (gnus-server-equal method "native"))
3625 ;;;!!! This might not be right. We'll see...
3626 ;(string-match ":" group)
3627 )
3628 group
3629 (concat (gnus-method-to-server-name method) ":" group)))
3631 (defun gnus-group-guess-prefixed-name (group)
3632 "Guess the whole name from GROUP and METHOD."
3633 (gnus-group-prefixed-name group (gnus-find-method-for-group
3634 group)))
3636 (defun gnus-group-full-name (group method)
3637 "Return the full name from GROUP and METHOD, even if the method is native."
3638 (gnus-group-prefixed-name group method t))
3640 (defun gnus-group-guess-full-name (group)
3641 "Guess the full name from GROUP, even if the method is native."
3642 (if (gnus-group-prefixed-p group)
3643 group
3644 (gnus-group-full-name group (gnus-find-method-for-group group))))
3646 (defun gnus-group-guess-full-name-from-command-method (group)
3647 "Guess the full name from GROUP, even if the method is native."
3648 (if (gnus-group-prefixed-p group)
3649 group
3650 (gnus-group-full-name group gnus-command-method)))
3652 (defun gnus-group-real-prefix (group)
3653 "Return the prefix of the current group name."
3654 (if (stringp group)
3655 (if (string-match "^[^:]+:" group)
3656 (substring group 0 (match-end 0))
3657 "")
3658 nil))
3660 (defun gnus-group-short-name (group)
3661 "Return the short group name."
3662 (let ((prefix (gnus-group-real-prefix group)))
3663 (if (< 0 (length prefix))
3664 (substring group (length prefix) nil)
3665 group)))
3667 (defun gnus-group-prefixed-p (group)
3668 "Return the prefix of the current group name."
3669 (< 0 (length (gnus-group-real-prefix group))))
3671 (defun gnus-summary-buffer-name (group)
3672 "Return the summary buffer name of GROUP."
3673 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3675 (defun gnus-group-method (group)
3676 "Return the server or method used for selecting GROUP.
3677 You should probably use `gnus-find-method-for-group' instead."
3678 (let ((prefix (gnus-group-real-prefix group)))
3679 (if (equal prefix "")
3680 gnus-select-method
3681 (let ((servers gnus-opened-servers)
3682 (server "")
3683 backend possible found)
3685 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3686 server (substring prefix (match-end 0) (1- (length prefix))))
3687 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3688 (while servers
3689 (when (eq (caaar servers) backend)
3690 (setq possible (caar servers))
3691 (when (equal (cadaar servers) server)
3692 (setq found (caar servers))))
3693 (pop servers))
3694 (or (car (rassoc found gnus-server-alist))
3695 found
3696 (car (rassoc possible gnus-server-alist))
3697 possible
3698 (list backend server))))))
3700 (defsubst gnus-native-method-p (method)
3701 "Return whether METHOD is the native select method."
3702 (gnus-method-equal method gnus-select-method))
3704 (defsubst gnus-secondary-method-p (method)
3705 "Return whether METHOD is a secondary select method."
3706 (let ((methods gnus-secondary-select-methods)
3707 (gmethod (inline (gnus-server-get-method nil method))))
3708 (while (and methods
3709 (not (gnus-method-equal
3710 (inline (gnus-server-get-method nil (car methods)))
3711 gmethod)))
3712 (setq methods (cdr methods)))
3713 methods))
3715 (defun gnus-method-simplify (method)
3716 "Return the shortest uniquely identifying string or method for METHOD."
3717 (cond ((stringp method)
3718 method)
3719 ((gnus-native-method-p method)
3720 nil)
3721 ((gnus-secondary-method-p method)
3722 (format "%s:%s" (nth 0 method) (nth 1 method)))
3723 (t
3724 method)))
3726 (defun gnus-groups-from-server (server)
3727 "Return a list of all groups that are fetched from SERVER."
3728 (let ((alist (cdr gnus-newsrc-alist))
3729 info groups)
3730 (while (setq info (pop alist))
3731 (when (gnus-server-equal (gnus-info-method info) server)
3732 (push (gnus-info-group info) groups)))
3733 (sort groups 'string<)))
3735 (defun gnus-group-foreign-p (group)
3736 "Say whether a group is foreign or not."
3737 (and (not (gnus-group-native-p group))
3738 (not (gnus-group-secondary-p group))))
3740 (defun gnus-group-native-p (group)
3741 "Say whether the group is native or not."
3742 (not (string-match ":" group)))
3744 (defun gnus-group-secondary-p (group)
3745 "Say whether the group is secondary or not."
3746 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3748 (defun gnus-parameters-get-parameter (group)
3749 "Return the group parameters for GROUP from `gnus-parameters'."
3750 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3751 case-fold-search
3752 gnus-parameters-case-fold-search))
3753 params-list)
3754 (dolist (elem gnus-parameters)
3755 (when (string-match (car elem) group)
3756 (setq params-list
3757 (nconc (gnus-expand-group-parameters
3758 (car elem) (cdr elem) group)
3759 params-list))))
3760 params-list))
3762 (defun gnus-expand-group-parameter (match value group)
3763 "Use MATCH to expand VALUE in GROUP."
3764 (with-temp-buffer
3765 (insert group)
3766 (goto-char (point-min))
3767 (while (re-search-forward match nil t)
3768 (replace-match value))
3769 (buffer-string)))
3771 (defun gnus-expand-group-parameters (match parameters group)
3772 "Go through PARAMETERS and expand them according to the match data."
3773 (let (new)
3774 (dolist (elem parameters)
3775 (if (and (stringp (cdr elem))
3777 (push (cons (car elem)
3778 (gnus-expand-group-parameter match (cdr elem) group))
3779 new)
3780 (push elem new)))
3781 new))
3783 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3784 "For GROUP, return the value of SYMBOL.
3786 You should call this in the `gnus-group-buffer' buffer.
3787 The function `gnus-group-find-parameter' will do that for you."
3788 ;; The speed trick: No cons'ing and quit early.
3789 (let* ((params (funcall gnus-group-get-parameter-function group))
3790 ;; Start easy, check the "real" group parameters.
3791 (simple-results
3792 (gnus-group-parameter-value params symbol allow-list t)))
3793 (if simple-results
3794 ;; Found results; return them.
3795 (car simple-results)
3796 ;; We didn't found it there, try `gnus-parameters'.
3797 (let ((result nil)
3798 (head nil)
3799 (tail gnus-parameters))
3800 ;; A good old-fashioned non-cl loop.
3801 (while tail
3802 (setq head (car tail)
3803 tail (cdr tail))
3804 ;; The car is regexp matching for matching the group name.
3805 (when (string-match (car head) group)
3806 ;; The cdr is the parameters.
3807 (setq result (gnus-group-parameter-value (cdr head)
3808 symbol allow-list))
3809 (when result
3810 ;; Expand if necessary.
3812 (setq result (gnus-expand-group-parameter (car head)
3813 result group)))
3814 ;; Exit the loop early.
3815 (setq tail nil))))
3816 ;; Done.
3817 result))))
3819 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3820 "Return the group parameters for GROUP.
3821 If SYMBOL, return the value of that symbol in the group parameters.
3823 If you call this function inside a loop, consider using the faster
3824 `gnus-group-fast-parameter' instead."
3825 (save-excursion
3826 (set-buffer gnus-group-buffer)
3827 (if symbol
3828 (gnus-group-fast-parameter group symbol allow-list)
3829 (nconc
3830 (copy-sequence
3831 (funcall gnus-group-get-parameter-function group))
3832 (gnus-parameters-get-parameter group)))))
3834 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3835 "Return the group parameters for GROUP.
3836 If SYMBOL, return the value of that symbol in the group parameters.
3837 If ALLOW-LIST, also allow list as a result.
3838 Most functions should use `gnus-group-find-parameter', which
3839 also examines the topic parameters."
3840 (let ((params (gnus-info-params (gnus-get-info group))))
3841 (if symbol
3842 (gnus-group-parameter-value params symbol allow-list)
3843 params)))
3845 (defun gnus-group-parameter-value (params symbol &optional
3846 allow-list present-p)
3847 "Return the value of SYMBOL in group PARAMS.
3848 If ALLOW-LIST, also allow list as a result."
3849 ;; We only wish to return group parameters (dotted lists) and
3850 ;; not local variables, which may have the same names.
3851 ;; But first we handle single elements...
3852 (or (car (memq symbol params))
3853 ;; Handle alist.
3854 (let (elem)
3855 (catch 'found
3856 (while (setq elem (pop params))
3857 (when (and (consp elem)
3858 (eq (car elem) symbol)
3859 (or allow-list
3860 (atom (cdr elem))))
3861 (throw 'found (if present-p (list (cdr elem))
3862 (cdr elem)))))))))
3864 (defun gnus-group-add-parameter (group param)
3865 "Add parameter PARAM to GROUP."
3866 (let ((info (gnus-get-info group)))
3867 (when info
3868 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3869 ;; Cons the new param to the old one and update.
3870 (gnus-group-set-info (cons param (gnus-info-params info))
3871 group 'params))))
3873 (defun gnus-group-set-parameter (group name value)
3874 "Set parameter NAME to VALUE in GROUP."
3875 (let ((info (gnus-get-info group)))
3876 (when info
3877 (gnus-group-remove-parameter group name)
3878 (let ((old-params (gnus-info-params info))
3879 (new-params (list (cons name value))))
3880 (while old-params
3881 (when (or (not (listp (car old-params)))
3882 (not (eq (caar old-params) name)))
3883 (setq new-params (append new-params (list (car old-params)))))
3884 (setq old-params (cdr old-params)))
3885 (gnus-group-set-info new-params group 'params)))))
3887 (defun gnus-group-remove-parameter (group name)
3888 "Remove parameter NAME from GROUP."
3889 (let ((info (gnus-get-info group)))
3890 (when info
3891 (let ((params (gnus-info-params info)))
3892 (when params
3893 (setq params (delq name params))
3894 (while (assq name params)
3895 (gnus-pull name params))
3896 (gnus-info-set-params info params))))))
3898 (defun gnus-group-add-score (group &optional score)
3899 "Add SCORE to the GROUP score.
3900 If SCORE is nil, add 1 to the score of GROUP."
3901 (let ((info (gnus-get-info group)))
3902 (when info
3903 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3905 (defun gnus-short-group-name (group &optional levels)
3906 "Collapse GROUP name LEVELS.
3907 Select methods are stripped and any remote host name is stripped down to
3908 just the host name."
3909 (let* ((name "")
3910 (foreign "")
3911 (depth 0)
3912 (skip 1)
3913 (levels (or levels
3914 gnus-group-uncollapsed-levels
3915 (progn
3917 (setq skip (match-end 0)
3918 depth (+ depth 1)))
3919 depth))))
3920 ;; Separate foreign select method from group name and collapse.
3921 ;; If method contains a server, collapse to non-domain server name,
3922 ;; otherwise collapse to select method.
3923 (let* ((colon (string-match ":" group))
3924 (server (and colon (substring group 0 colon)))
3925 (plus (and server (string-match "+" server))))
3926 (when server
3927 (if plus
3928 (setq foreign (substring server (+ 1 plus)
3930 group (substring group (+ 1 colon)))
3931 (setq foreign server
3932 group (substring group (+ 1 colon))))
3933 (setq foreign (concat foreign ":")))
3934 ;; Collapse group name leaving LEVELS uncollapsed elements
3935 (let* ((slist (split-string group "/"))
3936 (slen (length slist))
3938 (dlen (length dlist))
3939 glist
3940 glen
3941 gsep
3942 res)
3943 (if (> slen dlen)
3944 (setq glist slist
3945 glen slen
3946 gsep "/")
3947 (setq glist dlist
3948 glen dlen
3949 gsep "."))
3950 (setq levels (- glen levels))
3951 (dolist (g glist)
3952 (push (if (>= (decf levels) 0)
3953 (if (zerop (length g))
3954 ""
3955 (substring g 0 1))
3956 g)
3957 res))
3958 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3960 (defun gnus-narrow-to-body ()
3961 "Narrow to the body of an article."
3962 (narrow-to-region
3963 (progn
3964 (goto-char (point-min))
3966 (point-max)))
3967 (point-max)))
3969 \f
3970 ;;;
3971 ;;; Kill file handling.
3972 ;;;
3974 (defun gnus-apply-kill-file ()
3975 "Apply a kill file to the current newsgroup.
3976 Returns the number of articles marked as read."
3977 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3978 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3979 (gnus-apply-kill-file-internal)
3980 0))
3982 (defun gnus-kill-save-kill-buffer ()
3983 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3984 (when (get-file-buffer file)
3985 (save-excursion
3986 (set-buffer (get-file-buffer file))
3987 (when (buffer-modified-p)
3988 (save-buffer))
3989 (kill-buffer (current-buffer))))))
3991 (defcustom gnus-kill-file-name "KILL"
3992 "Suffix of the kill files."
3993 :group 'gnus-score-kill
3994 :group 'gnus-score-files
3995 :type 'string)
3997 (defun gnus-newsgroup-kill-file (newsgroup)
3998 "Return the name of a kill file name for NEWSGROUP.
3999 If NEWSGROUP is nil, return the global kill file name instead."
4000 (cond
4001 ;; The global KILL file is placed at top of the directory.
4002 ((or (null newsgroup)
4003 (string-equal newsgroup ""))
4004 (expand-file-name gnus-kill-file-name
4005 gnus-kill-files-directory))
4006 ;; Append ".KILL" to newsgroup name.
4007 ((gnus-use-long-file-name 'not-kill)
4008 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4009 "." gnus-kill-file-name)
4010 gnus-kill-files-directory))
4011 ;; Place "KILL" under the hierarchical directory.
4012 (t
4013 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4014 "/" gnus-kill-file-name)
4015 gnus-kill-files-directory))))
4017 ;;; Server things.
4019 (defun gnus-member-of-valid (symbol group)
4021 (memq symbol (assoc
4022 (symbol-name (car (gnus-find-method-for-group group)))
4023 gnus-valid-select-methods)))
4025 (defun gnus-method-option-p (method option)
4026 "Return non-nil if select METHOD has OPTION as a parameter."
4027 (when (stringp method)
4028 (setq method (gnus-server-to-method method)))
4029 (memq option (assoc (format "%s" (car method))
4030 gnus-valid-select-methods)))
4032 (defun gnus-similar-server-opened (method)
4033 (let ((opened gnus-opened-servers))
4034 (while (and method opened)
4035 (when (and (equal (cadr method) (cadaar opened))
4036 (equal (car method) (caaar opened))
4037 (not (equal method (caar opened))))
4038 (setq method nil))
4039 (pop opened))
4040 (not method)))
4042 (defun gnus-server-extend-method (group method)
4043 ;; This function "extends" a virtual server. If the server is
4044 ;; "hello", and the select method is ("hello" (my-var "something"))
4045 ;; in the group "alt.alt", this will result in a new virtual server
4046 ;; called "hello+alt.alt".
4047 (if (or (not (inline (gnus-similar-server-opened method)))
4048 (not (cddr method)))
4049 method
4050 `(,(car method) ,(concat (cadr method) "+" group)
4051 (,(intern (format "%s-address" (car method))) ,(cadr method))
4052 ,@(cddr method))))
4054 (defun gnus-server-status (method)
4055 "Return the status of METHOD."
4056 (nth 1 (assoc method gnus-opened-servers)))
4058 (defun gnus-group-name-to-method (group)
4059 "Guess a select method based on GROUP."
4060 (if (string-match ":" group)
4061 (let ((server (substring group 0 (match-beginning 0))))
4063 (list (intern (substring server 0 (match-beginning 0)))
4064 (substring server (match-end 0)))
4065 (list (intern server) "")))
4066 gnus-select-method))
4068 (defun gnus-server-string (server)
4069 "Return a readable string that describes SERVER."
4070 (let* ((server (gnus-server-to-method server))
4071 (address (nth 1 server)))
4072 (if (and address
4073 (not (zerop (length address))))
4074 (format "%s using %s" address (car server))
4075 (format "%s" (car server)))))
4077 (defun gnus-find-method-for-group (group &optional info)
4078 "Find the select method that GROUP uses."
4079 (or gnus-override-method
4080 (and (not group)
4081 gnus-select-method)
4082 (and (not (gnus-group-entry group)) ;; a new group
4083 (gnus-group-name-to-method group))
4084 (let ((info (or info (gnus-get-info group)))
4085 method)
4086 (if (or (not info)
4087 (not (setq method (gnus-info-method info)))
4088 (equal method "native"))
4089 gnus-select-method
4090 (setq method
4091 (cond ((stringp method)
4092 (inline (gnus-server-to-method method)))
4093 ((stringp (cadr method))
4094 (inline (gnus-server-extend-method group method)))
4095 (t
4096 method)))
4097 (cond ((equal (cadr method) "")
4098 method)
4099 ((null (cadr method))
4100 (list (car method) ""))
4101 (t
4102 (gnus-server-add-address method)))))))
4104 (defun gnus-methods-using (feature)
4105 "Find all methods that have FEATURE."
4106 (let ((valids gnus-valid-select-methods)
4107 outs)
4108 (while valids
4109 (when (memq feature (car valids))
4110 (push (car valids) outs))
4111 (setq valids (cdr valids)))
4112 outs))
4114 (eval-and-compile
4115 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4117 (defun gnus-read-group (prompt &optional default)
4118 "Prompt the user for a group name.
4119 Disallow invalid group names."
4120 (let ((prefix "")
4121 group)
4122 (while (not group)
4123 (when (string-match
4124 gnus-invalid-group-regexp
4125 (setq group (read-string (concat prefix prompt)
4126 (cons (or default "") 0)
4127 'gnus-group-history)))
4128 (let ((match (match-string 0 group)))
4129 ;; Might be okay (e.g. for nnimap), so ask the user:
4131 (message-y-or-n-p
4132 "Proceed and create group anyway? " t
4135 Usually, it's dangerous to create a group with this name, because it's not
4136 supported by all back ends and servers. On IMAP servers it should work,
4137 though. If you are really sure, you can proceed anyway and create the group.
4139 You may customize the variable `gnus-invalid-group-regexp', which currently is
4143 group nil)))))
4144 group))
4146 (defun gnus-read-method (prompt)
4147 "Prompt the user for a method.
4148 Allow completion over sensible values."
4149 (let* ((open-servers
4150 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4151 gnus-opened-servers))
4152 (valid-methods
4153 (let (methods)
4154 (dolist (method gnus-valid-select-methods)
4155 (if (or (memq 'prompt-address method)
4156 (not (assoc (format "%s:" (car method)) open-servers)))
4157 (push method methods)))
4158 methods))
4159 (servers
4160 (append valid-methods
4161 open-servers
4162 gnus-predefined-server-alist
4163 gnus-server-alist))
4164 (method
4165 (completing-read
4166 prompt servers
4167 nil t nil 'gnus-method-history)))
4168 (cond
4169 ((equal method "")
4170 (setq method gnus-select-method))
4171 ((assoc method gnus-valid-select-methods)
4172 (let ((address (if (memq 'prompt-address
4173 (assoc method gnus-valid-select-methods))
4174 (read-string "Address: ")
4175 "")))
4176 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4177 (list (intern method) address))))
4178 ((assoc method servers)
4179 method)
4180 (t
4181 (list (intern method) "")))))
4183 ;;; Agent functions
4185 (defun gnus-agent-method-p (method)
4186 "Say whether METHOD is covered by the agent."
4187 (or (eq (car gnus-agent-method-p-cache) method)
4188 (setq gnus-agent-method-p-cache
4189 (cons method
4190 (member (if (stringp method)
4191 method
4192 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4193 (cdr gnus-agent-method-p-cache))
4195 (defun gnus-online (method)
4196 (not
4197 (if gnus-plugged
4198 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4199 (gnus-agent-method-p method))))
4201 ;;; User-level commands.
4203 ;;;###autoload
4204 (defun gnus-slave-no-server (&optional arg)
4205 "Read network news as a slave, without connecting to the local server."
4206 (interactive "P")
4207 (gnus-no-server arg t))
4209 ;;;###autoload
4210 (defun gnus-no-server (&optional arg slave)
4211 "Read network news.
4212 If ARG is a positive number, Gnus will use that as the startup
4213 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4214 non-nil and not a positive number, Gnus will prompt the user for the
4215 name of an NNTP server to use.
4216 As opposed to `gnus', this command will not connect to the local
4217 server."
4218 (interactive "P")
4219 (gnus-no-server-1 arg slave))
4221 ;;;###autoload
4222 (defun gnus-slave (&optional arg)
4223 "Read news as a slave."
4224 (interactive "P")
4225 (gnus arg nil 'slave))
4227 ;;;###autoload
4228 (defun gnus-other-frame (&optional arg display)
4229 "Pop up a frame to read news.
4230 This will call one of the Gnus commands which is specified by the user
4231 option `gnus-other-frame-function' (default `gnus') with the argument
4232 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4233 optional second argument DISPLAY should be a standard display string
4235 omitted or the function `make-frame-on-display' is not available, the
4236 current display is used."
4237 (interactive "P")
4238 (if (fboundp 'make-frame-on-display)
4239 (unless display
4240 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4241 (setq display nil))
4242 (let ((alive (gnus-alive-p)))
4243 (unless (and alive
4244 (catch 'found
4245 (walk-windows
4246 (lambda (window)
4247 (when (and (or (not display)
4248 (equal display
4249 (gnus-frame-or-window-display-name
4250 window)))
4251 (with-current-buffer (window-buffer window)
4253 (symbol-name major-mode))))
4254 (gnus-select-frame-set-input-focus
4255 (setq gnus-other-frame-object (window-frame window)))
4256 (select-window window)
4257 (throw 'found t)))
4258 'ignore t)))
4259 (gnus-select-frame-set-input-focus
4260 (setq gnus-other-frame-object
4261 (if display
4262 (make-frame-on-display display gnus-other-frame-parameters)
4263 (make-frame gnus-other-frame-parameters))))
4264 (if alive
4265 (switch-to-buffer gnus-group-buffer)
4266 (funcall gnus-other-frame-function arg)
4267 (add-hook 'gnus-exit-gnus-hook
4268 '(lambda nil
4269 (when (and (frame-live-p gnus-other-frame-object)
4270 (cdr (frame-list)))
4271 (delete-frame gnus-other-frame-object))
4272 (setq gnus-other-frame-object nil)))))))
4274 ;;;###autoload
4275 (defun gnus (&optional arg dont-connect slave)
4276 "Read network news.
4277 If ARG is non-nil and a positive number, Gnus will use that as the
4278 startup level. If ARG is non-nil and not a positive number, Gnus will
4279 prompt the user for the name of an NNTP server to use."
4280 (interactive "P")
4281 (unless (byte-code-function-p (symbol-function 'gnus))
4282 (message "You should byte-compile Gnus")
4283 (sit-for 2))
4284 (gnus-1 arg dont-connect slave))
4286 ;; Allow redefinition of Gnus functions.
4288 (gnus-ems-redefine)
4290 (provide 'gnus)
4292 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4293 ;;; gnus.el ends here