| blob | b9b259e0d18c252d2503d74ca027f89e9cc859ce |
1 ;;; gnus-start.el --- startup functions for Gnus
3 ;; Copyright (C) 1996-2014 Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;;; Code:
46 "Your `.newsrc' file.
47 `.newsrc-SERVER' will be used instead if that exists."
52 "Control use of version numbers for backups of `gnus-startup-file'.
53 This variable takes the same values as the `version-control'
54 variable."
62 "Whether to write the startup file contents to a buffer then save
63 the buffer or write directly to the file. The buffer is faster
64 because all of the contents are written at once. The direct write
65 uses considerably less memory."
72 "Your Gnus Emacs-Lisp startup file name.
73 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
83 "The site-wide Gnus Emacs-Lisp startup file name, or nil if none.
84 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
89 "*Non-nil means that Gnus will use a dribble file to store user updates.
90 If Emacs should crash without saving the .newsrc files, complete
91 information can be restored from the dribble file."
96 "*The directory where dribble files will be saved.
97 If this variable is nil, the directory where the .newsrc files are
98 saved will be used."
103 "*Non-nil means that Gnus will run `gnus-find-new-newsgroups' at startup.
104 This normally finds new newsgroups by comparing the active groups the
105 servers have already reported with those Gnus already knows, either alive
106 or killed.
108 When any of the following are true, `gnus-find-new-newsgroups' will instead
109 ask the servers (primary, secondary, and archive servers) to list new
110 groups since the last time it checked:
111 1. This variable is `ask-server'.
112 2. This variable is a list of select methods (see below).
113 3. Option `gnus-read-active-file' is nil or `some'.
114 4. A prefix argument is given to `gnus-find-new-newsgroups' interactively.
116 Thus, if this variable is `ask-server' or a list of select methods or
117 `gnus-read-active-file' is nil or `some', then the killed list is no
118 longer necessary, so you could safely set `gnus-save-killed-list' to nil.
120 This variable can be a list of select methods which Gnus will query with
121 the `ask-server' method in addition to the primary, secondary, and archive
122 servers.
124 E.g.:
125 (setq gnus-check-new-newsgroups
128 If this variable is nil, then you have to tell Gnus explicitly to
140 "*Non-nil means that Gnus will check and remove bogus newsgroup at startup.
141 If this variable is nil, then you have to tell Gnus explicitly to
147 "*Non-nil means that Gnus will read the entire active file at startup.
148 If this variable is nil, Gnus will only know about the groups in your
149 `.newsrc' file.
151 If this variable is `some', Gnus will try to only read the relevant
152 parts of the active file from the server. Not all servers support
153 this, and it might be quite slow with other servers, but this should
154 generally be faster than both the t and nil value.
156 If you set this variable to nil or `some', you probably still want to
157 be told about new newsgroups that arrive. To do that, set
158 `gnus-check-new-newsgroups' to `ask-server'. This may not work
159 properly with all servers."
169 "Groups with levels less than or equal to this variable are unsubscribed.
171 Groups with levels less than `gnus-level-subscribed', which
172 should be less than this variable, are subscribed. Groups with
173 levels from `gnus-level-subscribed' (exclusive) upto this
174 variable (inclusive) are unsubscribed. See also
175 `gnus-level-zombie', `gnus-level-killed' and the Info node `(gnus)Group
185 "*New subscribed groups will be subscribed at this level."
190 "*New unsubscribed groups will be unsubscribed at this level."
195 "*Groups higher than this level won't be activated on startup.
196 Setting this variable to something low might save lots of time when
197 you have many groups that you aren't interested in."
202 "*If nil, Gnus will not check foreign newsgroups at startup.
203 If it is non-nil, it should be a number between one and nine. Foreign
204 newsgroups that have a level lower or equal to this number will be
205 activated on startup. For instance, if you want to active all
206 subscribed newsgroups, but not the rest, you'd set this variable to
207 `gnus-level-subscribed'.
209 If you subscribe to lots of newsgroups from different servers, startup
210 might take a while. By setting this variable to nil, you'll save time,
211 but you won't be told how many unread articles there are in the
212 groups."
218 "*Non-nil means that Gnus will read the `.newsrc' file.
219 Gnus always reads its own startup file, which is called
221 be readily understood by other newsreaders. If you don't plan on
222 using other newsreaders, set this variable to nil to save some time on
223 entry."
229 "*Non-nil means that Gnus will save the `.newsrc' file.
230 Gnus always saves its own startup file, which is called
232 be readily understood by other newsreaders. If you don't plan on
233 using other newsreaders, set this variable to nil to save some time on
234 exit."
239 "*If non-nil, save the list of killed groups to the startup file.
240 If you set this variable to nil, you'll save both time (when starting
241 and quitting) and space (both memory and disk), but it will also mean
242 that Gnus has no record of which groups are new and which are old, so
243 the automatic new newsgroups subscription methods become meaningless.
245 You should always set `gnus-check-new-newsgroups' to `ask-server' or
246 nil if you set this variable to nil.
248 This variable can also be a regexp. In that case, all groups that do
249 not match this regexp will be removed before saving the list."
256 regexp))
263 )
265 "*A regexp to match uninteresting newsgroups in the active file.
266 Any lines in the active file matching this regular expression are
267 removed from the newsgroup list before anything else is done to it,
268 thus making them effectively non-existent."
273 "*Function(s) called with a group name when new group is detected.
274 A few pre-made functions are supplied: `gnus-subscribe-randomly'
275 inserts new groups at the beginning of the list of groups;
276 `gnus-subscribe-alphabetically' inserts new groups in strict
277 alphabetic order; `gnus-subscribe-hierarchically' inserts new groups
278 in hierarchical newsgroup order; `gnus-subscribe-interactively' asks
279 for your decision; `gnus-subscribe-killed' kills all new groups;
280 `gnus-subscribe-zombies' will make all new groups into zombies;
281 `gnus-subscribe-topics' will enter groups into the topics that
282 claim them."
291 function
297 "*Hooks run after you subscribe to a new group.
298 The hooks will be called with new group's name as argument."
304 'gnus-subscribe-alphabetically
306 If, for instance, you want to subscribe to all newsgroups in the
308 .newsrc file:
310 options -n no.all alt.all
312 Gnus will then subscribe all new newsgroups in these hierarchies
313 with the subscription method in this variable."
322 function
326 "*If non-nil, Gnus will offer to subscribe hierarchically.
327 When a new hierarchy appears, Gnus will ask the user:
329 'alt.binaries': Do you want to subscribe to this hierarchy? ([d]ys):
331 If the user pressed `d', Gnus will descend the hierarchy, `y' will
332 subscribe to all newsgroups in the hierarchy and `s' will skip this
333 hierarchy in its entirety."
338 "*New groups from methods of these categories will be subscribed automatically.
339 Note that this variable only deals with new groups. It has no
340 effect whatsoever on old groups. The default is to automatically
341 subscribe all groups from mail-like backends."
348 "*All new groups that match this regexp will be subscribed automatically.
349 Note that this variable only deals with new groups. It has no effect
350 whatsoever on old groups.
352 New groups that match this regexp will not be handled by
353 `gnus-subscribe-newsgroup-method'. Instead, they will
354 be subscribed using `gnus-subscribe-options-newsgroup-method'."
359 "*All new groups matching this regexp will be subscribed unconditionally.
360 Note that this variable deals only with new newsgroups. This variable
361 does not affect old newsgroups.
363 New groups that match this regexp will not be handled by
364 `gnus-subscribe-newsgroup-method'. Instead, they will
365 be subscribed using `gnus-subscribe-options-newsgroup-method'."
371 "*All new groups matching this regexp will be ignored.
372 Note that this variable deals only with new newsgroups. This variable
373 does not affect old (already subscribed) newsgroups."
379 "*Non-nil means .newsrc should be deleted prior to save.
380 Its use is due to the bogus appearance that .newsrc was modified on
381 disc."
386 "A hook run after removing bogus groups."
391 "A hook called at startup.
392 This hook is called after Gnus is connected to the NNTP server."
397 "A hook called before startup.
398 This hook is called as the first thing when Gnus is started.
399 See also `gnus-before-resume-hook'."
404 "A hook called before resuming Gnus after suspend.
405 This hook is called as the first thing when Gnus is resumed after a suspend.
406 See also `gnus-before-startup-hook'."
412 "A hook called as the last thing after startup."
417 "A hook after reading the .newsrc file, but before generating the buffer."
422 "A hook run just before Gnus checks for new news globally."
428 "A hook run just before Gnus checks for new news."
434 "*A hook run after Gnus checks for new news when Gnus is already running."
440 "A hook called after reading the newsrc.eld? file."
445 "A hook called before saving any of the newsrc files."
450 "A hook called just before saving the quick newsrc file.
451 Can be used to turn version control on or off."
456 "A hook called just before saving the standard newsrc file.
457 Can be used to turn version control on or off."
462 "Hook for Gnus group mode."
468 "Unconditionally read the dribble file."
472 ;;; Internal variables
474 ;; Fixme: deal with old emacs-mule when mm-universal-coding-system is
475 ;; utf-8-emacs.
494 ;; Byte-compiler warning.
497 ;; Suggested by Brian Edmonds <edmonds@cs.ubc.ca>.
500 ;; Don't load .gnus if the -q option was used.
515 ;; For subscribing new newsgroup
519 prefixes prefix start ans group starts real-group)
529 start)
591 "Subscribe new NEWSGROUP by making it the first newsgroup."
595 "Subscribe new NEWGROUP and insert it in alphabetical order."
597 before)
605 "Subscribe new NEWGROUP and insert it in hierarchical newsgroup order."
606 ;; Basic ideas by mike-w@cs.aukuni.ac.nz (Mike Williams)
618 ;; Remove tail of newsgroup name (eg. a.b.c -> a.b)
626 "Subscribe the new GROUP interactively.
627 It is inserted in hierarchical newsgroup order if subscribed. If not,
628 it is killed."
634 "Make the new GROUP into a zombie group."
638 "Make the new GROUP a killed group."
642 "Subscribe new NEWSGROUP.
643 If NEXT is non-nil, it is inserted before NEXT. Otherwise it is made
644 the first newsgroup."
647 ;; We subscribe the group by changing its level to `subscribed'.
649 newsgroup gnus-level-default-subscribed
654 t))
657 "Say whether the active file has been read from `gnus-select-method'."
660 ;;; General various misc type functions.
662 ;; Silence byte-compiler.
679 "Close all servers."
685 "Clear all variables and buffers."
686 ;; Clear Gnus variables.
691 ;; Clear other internal variables.
693 gnus-have-read-active-file nil
694 gnus-agent-covered-methods nil
695 gnus-agent-file-loading-local nil
696 gnus-agent-file-loading-cache nil
697 gnus-server-method-cache nil
698 gnus-newsrc-alist nil
699 gnus-newsrc-hashtb nil
700 gnus-killed-list nil
701 gnus-zombie-list nil
702 gnus-killed-hashtb nil
703 gnus-active-hashtb nil
704 gnus-moderated-hashtb nil
705 gnus-description-hashtb nil
706 gnus-current-headers nil
707 gnus-thread-indent-array nil
708 gnus-newsgroup-headers nil
709 gnus-newsgroup-name nil
710 gnus-server-alist nil
711 gnus-group-list-mode nil
712 gnus-opened-servers nil
713 gnus-group-mark-positions nil
714 gnus-newsgroup-data nil
715 gnus-newsgroup-unreads nil
716 nnoo-state-alist nil
717 gnus-current-select-method nil
718 nnmail-split-history nil
719 gnus-extended-servers nil
720 gnus-ephemeral-servers nil)
722 ;; Kill the startup file.
726 ;; Clear the dribble buffer.
728 ;; Kill global KILL file buffer.
732 ;; Kill Gnus buffers.
735 ;; Remove Gnus frames.
739 "Read network news.
740 If ARG is a positive number, Gnus will use that as the startup
741 level. If ARG is nil, Gnus will be started at level 2
742 \(`gnus-level-default-subscribed' minus one). If ARG is non-nil
743 and not a positive number, Gnus will prompt the user for the name
745 will not connect to the local server."
753 "Read network news.
754 If ARG is non-nil and a positive number, Gnus will use that as the
755 startup level. If ARG is non-nil and not a positive number, Gnus will
756 prompt the user for the name of an NNTP server to use."
775 ;; Add "native" to gnus-predefined-server-alist just to have a
776 ;; name for the native select method.
785 did-connect)
793 ;; Couldn't connect to the server, so bail out.
796 ;; Find the current startup file name.
800 ;; Read the dribble file.
804 ;; Do the actual startup.
810 ;; Generate the group buffer.
818 "Make sure the draft group exists."
830 \f
831 ;;;
832 ;;; Dribble file
833 ;;;
839 "Return the dribble file for the current .newsrc."
844 gnus-current-startup-file)
848 "Enter STRING into the dribble buffer.
849 If REGEXP is given, lines that match it will be deleted."
851 gnus-dribble-buffer
865 ;; This has been commented by Josh Huber <huber@alum.wpi.edu>
866 ;; It causes problems with both XEmacs and Emacs 21, and doesn't
867 ;; seem to be of much value. (FIXME: remove this after we make sure
868 ;; it's not needed).
869 ;; (set-window-point (get-buffer-window (current-buffer)) (point-max))
876 "Touch the dribble buffer."
880 "Read the dribble file from disk."
898 modes)
900 ;; Load whichever file is newest -- the auto save file
901 ;; or the "real" file.
907 ;; Set the file modes to reflect the .newsrc file modes.
916 ;; Possibly eval the file later.
920 "Gnus exited on purpose without saving; read auto-save file anyway? "
957 \f
958 ;;;
959 ;;; Active & Newsrc File Handling
960 ;;;
963 "Setup news information.
964 If RAWFILE is non-nil, the .newsrc file will also be read.
965 If LEVEL is non-nil, the news will be set up at level LEVEL."
968 ;; Binding this variable will inhibit multiple fetchings
969 ;; of the same mail source.
973 ;; Clear some variables to re-initialize news information.
975 gnus-active-hashtb nil)
976 ;; Read the newsrc file and create `gnus-newsrc-hashtb'.
979 ;; Make sure the archive server is available to all and sundry.
982 gnus-message-archive-method))
983 gnus-message-archive-method)))
984 ;; Check whether the archive method is writable.
988 gnus-valid-select-methods)))
992 ,method
1005 gnus-server-alist))))
1009 ;; If we don't read the complete active file, we fill in the
1010 ;; hashtb here.
1016 ;; Initialize the cache.
1020 ;; Possibly eval the dribble file.
1025 ;; Slave Gnusii should then clear the dribble buffer.
1031 ;; See whether we need to read the description file.
1038 gnus-read-active-file)
1041 ;; Find new newsgroups and treat them.
1045 gnus-plugged)
1048 ;; Check and remove bogus newsgroups.
1054 ;; Read any slave files.
1057 ;; Find the number of unread articles in each non-dead group.
1062 "Call METHOD to subscribe GROUP.
1063 If no function returns `non-nil', call `gnus-subscribe-zombies'."
1072 nil))
1077 "Search for new newsgroups and add them.
1078 Each new newsgroup will be treated with `gnus-subscribe-newsgroup-method'.
1079 The `-n' option line from .newsrc is respected.
1081 With 1 C-u, use the `ask-server' method to query the server for new
1082 groups.
1083 With 2 C-u's, use most complete method possible to query the server
1084 for new groups, and subscribe the new groups as zombies."
1087 gnus-subscribe-newsgroup-method)
1097 t)
1101 ;; Ask the server for new groups.
1103 ;; Go through the active hashtb and look for new groups.
1105 group new-newsgroups)
1112 ;; Go though every newsgroup in `gnus-active-hashtb' and compare
1113 ;; with `gnus-newsrc-hashtb' and `gnus-killed-hashtb'.
1121 ()
1128 gnus-subscribe-options-newsgroup-method group))
1130 nil)
1137 gnus-subscribe-newsgroup-method group)))))))
1138 gnus-active-hashtb)
1145 groups))))
1148 ;; Returns `subscribe' if the group is to be unconditionally
1149 ;; subscribed, `ignore' if it is to be ignored, and nil if there is
1150 ;; no match for the group.
1152 ;; First we check the two user variables.
1161 do-subscribe)
1169 ;; Then we go through the list that was retrieved from the .newsrc
1170 ;; file. This list has elements on the form
1171 ;; `(REGEXP . {ignore,subscribe})'. The first match found (the list
1172 ;; is in the reverse order of the options line) is returned.
1189 gnus-check-new-newsgroups)
1190 gnus-secondary-select-methods))))
1192 group new-newsgroups got-new method hashtb
1193 gnus-override-subscribe-method)
1196 ;; Go through both primary and secondary select methods and
1197 ;; request new newsgroups.
1200 gnus-override-subscribe-method method)
1207 ;; Enter all the new groups into a hashtable.
1209 ;; Now all new groups from `method' are in `hashtb'.
1218 ;; The group is already known.
1219 ()
1220 ;; Make this group active.
1223 ;; Check whether we want it or not.
1230 gnus-subscribe-options-newsgroup-method group))
1232 nil)
1239 gnus-subscribe-newsgroup-method group)))))))
1240 hashtb))
1249 new-newsgroups))
1252 "Subscribe GROUP and put it after PREVIOUS."
1256 group)
1257 gnus-level-default-subscribed gnus-level-killed previous t)
1258 t)
1260 ;; `gnus-group-change-level' is the fundamental function for changing
1261 ;; subscription levels of newsgroups. This might mean just changing
1262 ;; from level 1 to 2, which is pretty trivial, from 2 to 6 or back
1263 ;; again, which subscribes/unsubscribes a group, which is equally
1264 ;; trivial. Changing from 1-7 to 8-9 means that you kill a group, and
1265 ;; from 8-9 to 1-7 means that you remove the group from the list of
1266 ;; killed (or zombie) groups and add them to the (kinda) subscribed
1267 ;; groups. And last but not least, moving from 8 to 9 and 9 to 8,
1268 ;; which is trivial.
1269 ;; ENTRY can either be a string (newsgroup name) or a list (if
1270 ;; FROMKILLED is t, it's a list on the format (NUM INFO-LIST),
1271 ;; otherwise it's a list in the format of the `gnus-newsrc-hashtb'
1272 ;; entries.
1273 ;; LEVEL is the new level of the group, OLDLEVEL is the old level and
1274 ;; PREVIOUS is the group (in hashtb entry format) to insert this group
1275 ;; after.
1277 previous fromkilled)
1279 ;; Glean what info we can from the arguments
1285 oldlevel
1297 ;; We are trying to subscribe a group that is already
1298 ;; subscribed.
1306 ;; Then we remove the newgroup from any old structures, if needed.
1307 ;; If the group was killed, we remove it from the killed or zombie
1308 ;; list. If not, and it is in fact going to be killed, we remove
1309 ;; it from the newsrc hash table and assoc.
1312 ;; oldlevel could be wrong.
1317 entry)
1324 ;; Finally we enter (if needed) the list where it is supposed to
1325 ;; go, and change the subscription level. If it is to be killed,
1326 ;; we enter it into the killed or zombie list.
1329 ;; Remove from the hash table.
1334 ;; Remove from active hashtb.
1336 ;; Don't add it into killed-list if it was killed.
1339 ;; If the list is to be entered into the newsrc assoc, and
1340 ;; it was killed, we have to create an entry in the newsrc
1341 ;; hashtb format and fix the pointers in the newsrc assoc.
1343 ;; It was alive, and it is going to stay alive, so we
1344 ;; just change the level and don't change any pointers or
1345 ;; hash table entries.
1353 ;; Shorten the select method if possible, if we need to
1354 ;; store it at all (native groups).
1366 p)))
1372 gnus-newsrc-hashtb))
1375 gnus-newsrc-hashtb))
1383 group level oldlevel previous)))))
1386 "Remove bogus newsgroups.
1387 If CONFIRM is non-nil, the user has to confirm the deletion of every
1388 newsgroup."
1390 bogus group entry info)
1395 ;; Find all bogus newsgroup that are subscribed.
1403 ;; Found a bogus newsgroup.
1409 ;; Remove all bogus subscribed groups by first killing them, and
1410 ;; then removing them from the list of killed groups.
1416 ;; Remove all bogus subscribed groups by first killing them, and
1417 ;; then removing them from the list of killed groups.
1421 ;; Then we remove all bogus groups from the list of killed and
1422 ;; zombie groups. They are removed without confirmation.
1424 killed)
1429 ;; The group is bogus.
1430 ;; !!!Slow as hell.
1438 "Remove duplicates from the list of killed groups."
1446 ;; We want to inline a function from gnus-cache, so we cheat here:
1450 "Alter the ACTIVE info for GROUP to reflect the articles in the cache."
1460 dont-sub-check)
1461 "Check whether a group has been activated or not.
1462 If SCAN, request a scan of that group as well. If METHOD, use
1463 that select method instead of determining the method based on the
1464 group name. If DONT-CHECK, don't check check whether the group
1465 actually exists. If DONT-SUB-CHECK or DONT-CHECK, don't let the
1466 backend check whether the group actually exists."
1468 active)
1470 ;; We escape all bugs and quit here to make it possible to
1471 ;; continue if a group is so out-there that it reports bugs
1472 ;; and stuff.
1477 t)
1480 method
1484 method
1490 nil)))
1493 ;; If there are no articles in the group, the GROUP
1494 ;; command may have responded with the `(0 . 0)'. We
1495 ;; ignore this if we already have an active entry
1496 ;; for the group.
1502 ;; If a cache is present, we may have to alter the active info.
1505 group active)))
1507 ;; If the agent is enabled, we may have to alter the active info.
1512 ;; Return the new active info.
1513 active)))))
1517 ;; Allow the backend to update the info in the group.
1527 ;; These checks are present in gnus-activate-group but skipped
1528 ;; due to setting dont-check in the preceding call.
1530 ;; If a cache is present, we may have to alter the active info.
1535 ;; If the agent is enabled, we may have to alter the active info.
1539 ;; Modify the list of read articles according to what articles
1540 ;; are available; then tally the unread articles and add the
1541 ;; number to the group hash table entry.
1548 ;; Fix a single (num . num) range according to the
1549 ;; active hash table.
1550 ;; Fix by Carsten Bormann <cabo@Informatik.Uni-Bremen.DE>.
1553 ;; Compute number of unread articles.
1556 ;; The read list is a list of ranges. Fix them according to
1557 ;; the active hash table.
1558 ;; First peel off any elements that are below the lower
1559 ;; active limit.
1574 ;; Adjust the first element to be the same as the lower limit.
1578 ;; Then we want to peel off any elements that are higher
1579 ;; than the upper active limit.
1581 ;; Go past all valid elements.
1589 ;; Nuke all remaining invalid elements.
1592 ;; Adjust the final element.
1596 ;; Compute the number of unread articles.
1604 ;; Set the number of unread articles.
1608 num)))
1610 ;; Go though `gnus-newsrc-alist' and compare with `gnus-active-hashtb'
1611 ;; and compute how many unread articles there are in each group.
1619 level
1625 gnus-activate-foreign-newsgroups)
1627 alevel)))
1632 infos info group active method cmethod
1633 method-type method-group-list entry)
1639 ;; First go through all the groups, see what select methods they
1640 ;; belong to, and then collect them into lists per unique select
1641 ;; method.
1644 ;; There may be several similar methods. Possibly extend the
1645 ;; method.
1667 type-cache))
1668 ;; Only add groups that need updating.
1671 foreign-level
1672 alevel))
1675 ;; The group is inactive, so we nix out the number of unread articles.
1676 ;; It leads `(gnus-group-unread group)' to return t. See also
1677 ;; `gnus-group-prepare-flat'.
1682 ;; Sort the methods based so that the primary and secondary
1683 ;; methods come first. This is done for legacy reasons to try to
1684 ;; ensure that side-effect behavior doesn't change from previous
1685 ;; Gnus versions.
1691 ;; Go through the list of servers and possibly extend methods that
1692 ;; aren't equal (and that need extension; i.e., they are async).
1702 method))
1706 ;; If we have primary/secondary select methods, but no groups from
1707 ;; them, we still want to issue a retrieval request from them.
1710 gnus-secondary-select-methods))
1716 ;; Clear out all the early methods.
1720 infos
1728 ;; Just mark this server as "cleared".
1731 ;; Start early async retrieval of data.
1733 sanity-spec)
1739 ;; If the open-server method doesn't exist, then the method
1740 ;; itself doesn't exist, so we ignore it.
1746 ;; This is a sanity check, so that we never
1747 ;; attempt to start two async requests to the
1748 ;; same server, because that will fail. This
1749 ;; should never happen, since the methods should
1750 ;; be unique at this point, but apparently it
1751 ;; does happen in the wild with some setups.
1759 ;; Store the token we get back from -early so that we
1760 ;; can pass it to -finish later.
1764 ;; Do the rest of the retrieval.
1771 ;; See if any of the groups from this method require updating.
1776 updatep)))))))
1781 ;; Get info for virtual groups last.
1786 ;; Compute the rank of the secondary methods based on where they
1787 ;; are in the secondary select list.
1795 i)))
1796 ;; Just say that all foreign groups have the same rank.
1803 ;; Finish up getting the data from the methods that have -early
1804 ;; methods.
1806 early-data
1811 ;; We may have altered the data now, so mark the dribble buffer
1812 ;; as dirty so that it gets saved.
1815 ;; Most backends have -retrieve-groups.
1823 method)))
1824 ;; Virtually all backends have -request-list.
1827 ;; Except nnvirtual and friends, where we request each group, one
1828 ;; by one.
1833 ;; Create a hash table out of the newsrc alist. The `car's of the
1834 ;; alist elements are used as keys.
1838 prev info method rest methods)
1844 gnus-newsrc-alist
1848 ;; Make the same select-methods identical Lisp objects.
1853 ;; Check for duplicates.
1855 ;; Remove this entry from the alist.
1859 ;; Preserve number of unread articles in groups.
1861 prev)
1862 gnus-newsrc-hashtb)
1865 ;; Make the same select-methods in `gnus-server-alist' identical
1866 ;; as well.
1873 "Create a hash table from the killed and zombie lists."
1875 list)
1885 "Parse active info in the nntp server buffer."
1888 ;; Parse the result we got from `gnus-request-group'.
1895 "Mark ARTICLES in GROUP as unread."
1900 news article)
1906 ;; Enter this list into the group info.
1910 ;; Set the number of unread articles in gnus-newsrc-hashtb.
1913 ;; Insert the change into the group buffer and the dribble file.
1917 "Mark ascending ARTICLES in GROUP as unread."
1923 modified)
1930 ;; the articles extend past the end of the ranges
1931 ;; OK - I'm done
1934 ;; this range precedes the article. Leave the range unmodified.
1936 ranges)
1938 ;; this range exactly matches the article; REMOVE THE RANGE.
1939 ;; NOTE: When the range being removed is the last range, the list is corrupted by inserting null at its end.
1943 nil))
1946 ;; I have a min/max range to consider
1951 ranges)
1953 ;; replace min/max range with a single-value range
1955 ranges)
1957 ;; this range precedes the article. Leave the range unmodified.
1959 ranges)
1961 ;; this article precedes the range. Return null to move to the
1962 ;; next article
1963 nil)
1965 ;; this article splits the range into two parts
1969 ranges))))))))
1974 ;; Enter this list into the group info.
1977 ;; Set the number of unread articles in gnus-newsrc-hashtb.
1980 ;; Insert the change into the group buffer and the dribble file.
1983 ;; Enter all dead groups into the hashtb.
1987 killed)
1996 "Go through the active hashtb and mark all unknown groups as killed."
1997 ;; First make sure active file has been read.
2003 ;; Go through all newsgroups that are known to Gnus - enlarge kill list.
2011 ()
2014 ()
2018 gnus-active-hashtb)
2021 ;; Get the active file(s) from the backend(s).
2030 ;; The native server is available.
2032 ;; The native server is down, so we just do the
2033 ;; secondary ones.
2034 gnus-secondary-select-methods)
2035 ;; Also read from the archive server.
2038 method)
2042 ;; Only do each method once, in case the methods appear more
2043 ;; than once in this list.
2045 ;; Check whether the backend exists.
2051 ;; We catch C-g so that we can continue past servers
2052 ;; that do not respond.
2057 nil))))))))
2068 ;; Request that the backend scan its incoming messages.
2080 groups info)
2087 gmethod))
2089 groups)))
2092 t)
2100 ;; We mark this active file as read.
2105 "Read an active file for GROUPS in METHOD using `gnus-retrieve-groups'."
2119 ;; Read an active file and place the results in `gnus-active-hashtb'.
2121 real-active)
2128 gnus-active-hashtb
2134 group max min)
2135 ;; Delete unnecessary lines.
2145 ;; Make the group names readable as a lisp expression even if they
2146 ;; contain special characters.
2151 ;; Let the Gnus agent save the active file.
2155 ;; If these are groups from a foreign select method, we insert the
2156 ;; group prefix in front of the group names.
2168 ;; Store the active file in a hash table.
2169 ;; Use a unibyte buffer in order to make `read' read non-ASCII
2170 ;; group names (which have been encoded) as unibyte strings.
2179 ;; group gets set to a symbol interned in the hash table
2180 ;; (what a hack!!) - jwz
2182 ;; ### The extended group name scheme makes
2183 ;; the previous optimization strategy sort of pointless...
2196 ;; if group is moderated, stick in moderation table
2201 gnus-moderated-hashtb)))
2215 ;; Parse a "groups" active file.
2219 gnus-active-hashtb
2229 ;; Let the Gnus agent save the active file.
2231 real-active
2239 ;; We split this into to separate loops, one with the prefix
2240 ;; and one without to speed the reading up somewhat.
2270 "Read startup file.
2271 If FORCE is non-nil, the .newsrc file is read."
2272 ;; Reset variables that might be defined in the .newsrc.eld file.
2280 ;; We always load the .newsrc.eld file. If always contains
2281 ;; much information that can not be gotten from the .newsrc
2282 ;; file (ticked articles, killed groups, foreign methods, etc.)
2292 ;; We read the .newsrc file. Note that if there if a
2293 ;; .newsrc.eld file exists, it has already been read, and
2294 ;; the `gnus-newsrc-hashtb' has been created. While reading
2295 ;; the .newsrc file, Gnus will only use the information it
2296 ;; can find there for changing the data already read -
2297 ;; i. e., reading the .newsrc file will not trash the data
2298 ;; already read (except for read articles).
2307 ;; Convert old to new.
2312 ;; Currently no cleanups.
2313 )
2316 "Convert old newsrc formats into the current format, if needed."
2321 ;; A newsrc file was loaded.
2327 date-func))
2328 ;; This is a list of converters that must be run
2329 ;; to bring the newsrc file up to the current
2330 ;; version. If you create an incompatibility
2331 ;; with older versions, you should create an
2332 ;; entry here. The entry should consist of the
2333 ;; current gnus version (hardcoded so that it
2334 ;; doesn't change with each release) and the
2335 ;; function that must be applied to convert the
2336 ;; previous version into the current version.
2338 gnus-convert-old-ticks)
2340 gnus-agent-convert-to-compressed-agentview)
2342 gnus-agent-unlist-expire-days)
2344 gnus-agent-unhook-expire-days)))
2346 ;; Skip converters older than the file version
2350 ;; Perform converters to bring older version up to date.
2367 gnus-newsrc-file-version gnus-version)
2374 nil)
2379 t)
2383 t)))))
2388 gnus-newsrc-file-version gnus-version)))))))
2391 "Indicate whether CONVERTER requires gnus-convert-old-newsrc to
2392 display the conversion prompt. NO-PROMPT may be nil (prompt),
2393 t (no prompt), or any form that can be called as a function.
2394 The form should return either t or nil."
2400 no-prompt
2405 marks info dormant ticked)
2412 info
2419 "Load FILE, but in such a way that read errors can be reported."
2437 ;; We always, always read the .eld file.
2441 ;; Older versions of `gnus-format-specs' are no longer valid
2442 ;; in Oort Gnus 0.01.
2452 ;; Protect against broken .newsrc.el files.
2457 ;; Old format quick file
2459 ;; The .el file is newer than the .eld file, so we read that one
2460 ;; as well.
2464 ;; Parse the old-style quick startup file
2469 gnus-marked-assoc gnus-newsrc-alist gnus-newsrc-assoc)
2474 killed gnus-killed-assoc
2475 marked gnus-marked-assoc)))
2483 gnus-level-default-unsubscribed))
2488 gnus-level-default-unsubscribed)
2490 gnus-newsrc-alist))
2491 ;; Copy marks into info.
2503 ;; The .el file version of this variable does not begin with
2504 ;; "options", while the .eld version does, so we just add it if it
2505 ;; isn't there.
2507 gnus-newsrc-options
2512 ;; Finally, if we read some options lines, we parse them.
2520 "Make server dependent file name by catenating FILE and server host name."
2526 real-file
2527 file)))
2537 group subscribed options-symbol newsrc Options-symbol
2538 symbol reads num1)
2540 ;; We intern the symbol `options' in the active hashtb so that we
2541 ;; can `eq' against it later.
2546 ;; We first read the first word on the line by narrowing and
2547 ;; then reading into `gnus-active-hashtb'. Most groups will
2548 ;; already exist in that hashtb, so this will save some string
2549 ;; space.
2558 ;; Now, the symbol we have read is either `options' or a group
2559 ;; name. If it is an options line, we just add it to a string.
2564 ;; This concatting is quite inefficient, but since our
2565 ;; thorough studies show that approx 99.37% of all
2566 ;; .newsrc files only contain a single options line, we
2567 ;; don't give a damn, frankly, my dear.
2571 ;; Options may continue on the next line.
2577 ;; Group names can be just numbers.
2582 ;; It was a group name.
2585 reads nil)
2587 ;; If the line ends here, this is clearly a buggy line, so
2588 ;; we put point a the beginning of line and let the cond
2589 ;; below do the error handling.
2591 ;; We skip to the beginning of the ranges.
2593 ;; We are now at the beginning of the list of read articles.
2594 ;; We read them range by range.
2598 ;; We narrow and read a number instead of buffer-substring/
2599 ;; string-to-number because it's faster. narrow/widen is
2600 ;; faster than save-restriction/narrow, and save-restriction
2601 ;; produces a garbage object.
2606 ;; If the next character is a dash, then this is a range.
2609 ;; We read the upper bound of the range.
2612 ;; This is a buggy line, by we pretend that
2613 ;; it's kinda OK. Perhaps the user should be
2614 ;; dinged?
2622 reads)
2624 ;; It was just a simple number, so we add it to the
2625 ;; list of ranges.
2627 ;; If the next char in ?\n, then we have reached the end
2628 ;; of the line and return nil.
2631 ;; End of line, so we end.
2632 nil)
2634 ;; Not numbers and not eol, so this might be a buggy
2635 ;; line...
2637 ;; If it was eob instead of ?\n, we allow it.
2638 ;; The line was buggy.
2643 nil))
2644 ;; Skip past ", ". Spaces are invalid in these ranges, but
2645 ;; we allow them, because it's a common mistake to put a
2646 ;; space after the comma.
2649 ;; We have already read .newsrc.eld, so we gently update the
2650 ;; data in the hash table with the information we have just
2651 ;; read.
2654 level)
2656 ;; There is an entry for this file in the alist.
2659 ;; We update the level very gently. In fact, we
2660 ;; only change it if there's been a status change
2661 ;; from subscribed to unsubscribed, or vice versa.
2666 gnus-level-default-unsubscribed
2671 ;; This is a new group.
2674 gnus-level-default-subscribed
2677 gnus-level-default-unsubscribed))
2685 ()
2686 ;; We now have two newsrc lists - `newsrc', which is what we
2687 ;; have read from .newsrc, and `gnus-newsrc-alist', which is
2688 ;; what we've read from .newsrc.eld. We have to merge these
2689 ;; lists. We do this by "attaching" any (foreign) groups in the
2690 ;; gnus-newsrc-alist to the (native) group that precedes them.
2693 entry mentry)
2705 ;; We make the newsrc hashtb.
2708 ;; Finally, if we read some options lines, we parse them.
2712 ;; Parse options lines to find "options -n !all rec.all" and stuff.
2713 ;; The return value will be a list on the form
2714 ;; ((regexp1 . ignore)
2715 ;; (regexp2 . subscribe)...)
2716 ;; When handling new newsgroups, groups that match a `ignore' regexp
2717 ;; will be ignored, and groups that match a `subscribe' regexp will be
2718 ;; subscribed. A line like
2719 ;; options -n !all rec.all
2720 ;; will lead to a list that looks like
2721 ;; (("^rec\\..+" . subscribe)
2722 ;; ("^.+" . ignore))
2723 ;; So all "rec.*" groups will be subscribed, while all the other
2724 ;; groups will be ignored. Note that "options -n !all rec.all" is very
2725 ;; different from "options -n rec.all !all".
2731 ;; First we treat all continuation lines.
2735 ;; Then we transform all "all"s into ".+"s.
2740 ;; We remove all other options than the "-n" ones.
2746 ;; We are only interested in "options -n" lines - we
2747 ;; ignore the other option lines.
2754 ;; Search for all "words"...
2757 ;; If the word begins with a bang (!), this is a "not"
2758 ;; spec. We put this spec (minus the bang) and the
2759 ;; symbol `ignore' into the list.
2766 out)
2767 ;; There was no bang, so this is a "yes" spec.
2770 out))))
2777 'msdos-long-file-names
2781 "Save .newsrc file."
2782 ;; Note: We cannot save .newsrc file if all newsgroups are removed
2783 ;; from the variable gnus-newsrc-alist.
2785 gnus-current-startup-file)
2786 ;; Save agent range limits for the currently active method.
2801 ;; Save .newsrc.
2807 ;; Save .newsrc.eld.
2828 working-file
2830 ;; Generate the name of a non-existent file.
2846 ;; These bindings will mislead the current buffer
2847 ;; into thinking that it is visiting the startup
2848 ;; file.
2853 ;; Backup the current version of the startup file.
2856 ;; Replace the existing startup file with the temp file.
2870 "Print Gnus variables such as `gnus-newsrc-alist' in Lisp format."
2872 gnus-ding-file-coding-system))
2879 ;; Never delete this file -- if you want to force Gnus to read the
2897 gnus-killed-list))
2901 ;; Remove the `gnus-killed-list' from the list of variables
2902 ;; to be saved, if required.
2904 ;; Peel off the "dummy" group.
2906 variable)
2907 ;; Insert the variables into the file.
2918 "Return the killed list minus the groups that match `gnus-save-killed-list'."
2920 olist)
2929 ;; Generate and save the .newsrc file.
2933 info ranges range method)
2938 ;; Use a unibyte buffer since group names are unibyte strings;
2939 ;; in particular, non-ASCII group names are the ones encoded by
2940 ;; a certain coding system.
2942 ;; Write options.
2945 ;; Write subscribed and unsubscribed.
2947 ;; Don't write foreign groups to .newsrc.
2951 foreign-ok)
2974 ;; It has been reported that sometime the modtime on the .newsrc
2975 ;; file seems to be off. We really do want to overwrite it, so
2976 ;; we clear the modtime here before saving. It's a bit odd,
2977 ;; though...
2978 ;; sometimes the modtime clear isn't sufficient. most brute force:
2979 ;; delete the silly thing entirely first. but this fails to provide
2980 ;; such niceties as .newsrc~ creation.
2989 \f
2990 ;;;
2991 ;;; Slave functions.
2992 ;;;
2997 "Minor mode for slave Gnusae."
2998 ;; FIXME: gnus-slave-mode appears to never be set (i.e. it'll always be nil):
2999 ;; Remove, or fix and use define-minor-mode.
3023 t))
3024 file)
3032 slave-files)
3043 t)
3046 nil))
3054 \f
3055 ;;;
3056 ;;; Group description.
3057 ;;;
3064 gnus-secondary-select-methods))))
3068 t))
3072 group)
3075 ;; We create the hashtable whether we manage to read the desc file
3076 ;; to avoid trying to re-read after a failed read.
3080 ;; Mark this method's desc file as read.
3082 gnus-description-hashtb)
3087 t)
3090 nil)
3093 nil)
3096 ;; FIXME: Shouldn't save-restriction be done after set-buffer?
3104 ;; If these are groups from a foreign select method, we insert the
3105 ;; group prefix in front of the group names.
3110 nil gnus-select-method))))
3118 ;; If we get an error, we set group to 0, which is not a
3119 ;; symbol...
3123 ;; Group is set to a symbol interned in this
3124 ;; hash table.
3128 ;; ... which leads to this line being effectively ignored.
3136 gnus-default-charset)))
3137 ;; Fixme: Don't decode in unibyte mode.
3143 t))))
3146 "Get the description of a group by sending XGTITLE to the server."
3153 ;;;###autoload
3155 "Declare back end NAME with ABILITIES as a Gnus back end."
3162 "Set the default directory in the current buffer to `gnus-default-directory'.
3163 If this variable is nil, don't do anything."
3168 default-directory)))
3176 ;; Check whether nnml and nnfolder share a directory.
3179 'display-warning
3191 window
3196 method active actives match)
3213 ;;; gnus-start.el ends here