| blob | 48bb99bfbcefe677f9cdfc026b03738e0980c994 |
1 ;;; gnus-start.el --- startup functions for Gnus
3 ;; Copyright (C) 1996-2013 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? "
956 \f
957 ;;;
958 ;;; Active & Newsrc File Handling
959 ;;;
962 "Setup news information.
963 If RAWFILE is non-nil, the .newsrc file will also be read.
964 If LEVEL is non-nil, the news will be set up at level LEVEL."
967 ;; Binding this variable will inhibit multiple fetchings
968 ;; of the same mail source.
972 ;; Clear some variables to re-initialize news information.
974 gnus-active-hashtb nil)
975 ;; Read the newsrc file and create `gnus-newsrc-hashtb'.
978 ;; Make sure the archive server is available to all and sundry.
981 gnus-message-archive-method))
982 gnus-message-archive-method)))
983 ;; Check whether the archive method is writable.
987 gnus-valid-select-methods)))
991 ,method
1004 gnus-server-alist))))
1008 ;; If we don't read the complete active file, we fill in the
1009 ;; hashtb here.
1015 ;; Initialize the cache.
1019 ;; Possibly eval the dribble file.
1024 ;; Slave Gnusii should then clear the dribble buffer.
1030 ;; See whether we need to read the description file.
1037 gnus-read-active-file)
1040 ;; Find new newsgroups and treat them.
1044 gnus-plugged)
1047 ;; Check and remove bogus newsgroups.
1053 ;; Read any slave files.
1056 ;; Find the number of unread articles in each non-dead group.
1061 "Call METHOD to subscribe GROUP.
1062 If no function returns `non-nil', call `gnus-subscribe-zombies'."
1071 nil))
1076 "Search for new newsgroups and add them.
1077 Each new newsgroup will be treated with `gnus-subscribe-newsgroup-method'.
1078 The `-n' option line from .newsrc is respected.
1080 With 1 C-u, use the `ask-server' method to query the server for new
1081 groups.
1082 With 2 C-u's, use most complete method possible to query the server
1083 for new groups, and subscribe the new groups as zombies."
1086 gnus-subscribe-newsgroup-method)
1096 t)
1100 ;; Ask the server for new groups.
1102 ;; Go through the active hashtb and look for new groups.
1104 group new-newsgroups)
1111 ;; Go though every newsgroup in `gnus-active-hashtb' and compare
1112 ;; with `gnus-newsrc-hashtb' and `gnus-killed-hashtb'.
1120 ()
1127 gnus-subscribe-options-newsgroup-method group))
1129 nil)
1136 gnus-subscribe-newsgroup-method group)))))))
1137 gnus-active-hashtb)
1144 groups))))
1147 ;; Returns `subscribe' if the group is to be unconditionally
1148 ;; subscribed, `ignore' if it is to be ignored, and nil if there is
1149 ;; no match for the group.
1151 ;; First we check the two user variables.
1160 do-subscribe)
1168 ;; Then we go through the list that was retrieved from the .newsrc
1169 ;; file. This list has elements on the form
1170 ;; `(REGEXP . {ignore,subscribe})'. The first match found (the list
1171 ;; is in the reverse order of the options line) is returned.
1188 gnus-check-new-newsgroups)
1189 gnus-secondary-select-methods))))
1191 group new-newsgroups got-new method hashtb
1192 gnus-override-subscribe-method)
1195 ;; Go through both primary and secondary select methods and
1196 ;; request new newsgroups.
1199 gnus-override-subscribe-method method)
1206 ;; Enter all the new groups into a hashtable.
1208 ;; Now all new groups from `method' are in `hashtb'.
1217 ;; The group is already known.
1218 ()
1219 ;; Make this group active.
1222 ;; Check whether we want it or not.
1229 gnus-subscribe-options-newsgroup-method group))
1231 nil)
1238 gnus-subscribe-newsgroup-method group)))))))
1239 hashtb))
1248 new-newsgroups))
1251 "Subscribe GROUP and put it after PREVIOUS."
1255 group)
1256 gnus-level-default-subscribed gnus-level-killed previous t)
1257 t)
1259 ;; `gnus-group-change-level' is the fundamental function for changing
1260 ;; subscription levels of newsgroups. This might mean just changing
1261 ;; from level 1 to 2, which is pretty trivial, from 2 to 6 or back
1262 ;; again, which subscribes/unsubscribes a group, which is equally
1263 ;; trivial. Changing from 1-7 to 8-9 means that you kill a group, and
1264 ;; from 8-9 to 1-7 means that you remove the group from the list of
1265 ;; killed (or zombie) groups and add them to the (kinda) subscribed
1266 ;; groups. And last but not least, moving from 8 to 9 and 9 to 8,
1267 ;; which is trivial.
1268 ;; ENTRY can either be a string (newsgroup name) or a list (if
1269 ;; FROMKILLED is t, it's a list on the format (NUM INFO-LIST),
1270 ;; otherwise it's a list in the format of the `gnus-newsrc-hashtb'
1271 ;; entries.
1272 ;; LEVEL is the new level of the group, OLDLEVEL is the old level and
1273 ;; PREVIOUS is the group (in hashtb entry format) to insert this group
1274 ;; after.
1276 previous fromkilled)
1278 ;; Glean what info we can from the arguments
1284 oldlevel
1296 ;; We are trying to subscribe a group that is already
1297 ;; subscribed.
1305 ;; Then we remove the newgroup from any old structures, if needed.
1306 ;; If the group was killed, we remove it from the killed or zombie
1307 ;; list. If not, and it is in fact going to be killed, we remove
1308 ;; it from the newsrc hash table and assoc.
1311 ;; oldlevel could be wrong.
1316 entry)
1323 ;; Finally we enter (if needed) the list where it is supposed to
1324 ;; go, and change the subscription level. If it is to be killed,
1325 ;; we enter it into the killed or zombie list.
1328 ;; Remove from the hash table.
1333 ;; Remove from active hashtb.
1335 ;; Don't add it into killed-list if it was killed.
1338 ;; If the list is to be entered into the newsrc assoc, and
1339 ;; it was killed, we have to create an entry in the newsrc
1340 ;; hashtb format and fix the pointers in the newsrc assoc.
1342 ;; It was alive, and it is going to stay alive, so we
1343 ;; just change the level and don't change any pointers or
1344 ;; hash table entries.
1352 ;; Shorten the select method if possible, if we need to
1353 ;; store it at all (native groups).
1365 p)))
1371 gnus-newsrc-hashtb))
1374 gnus-newsrc-hashtb))
1382 group level oldlevel previous)))))
1385 "Remove bogus newsgroups.
1386 If CONFIRM is non-nil, the user has to confirm the deletion of every
1387 newsgroup."
1389 bogus group entry info)
1394 ;; Find all bogus newsgroup that are subscribed.
1402 ;; Found a bogus newsgroup.
1408 ;; Remove all bogus subscribed groups by first killing them, and
1409 ;; then removing them from the list of killed groups.
1415 ;; Remove all bogus subscribed groups by first killing them, and
1416 ;; then removing them from the list of killed groups.
1420 ;; Then we remove all bogus groups from the list of killed and
1421 ;; zombie groups. They are removed without confirmation.
1423 killed)
1428 ;; The group is bogus.
1429 ;; !!!Slow as hell.
1437 "Remove duplicates from the list of killed groups."
1445 ;; We want to inline a function from gnus-cache, so we cheat here:
1449 "Alter the ACTIVE info for GROUP to reflect the articles in the cache."
1459 dont-sub-check)
1460 "Check whether a group has been activated or not.
1461 If SCAN, request a scan of that group as well. If METHOD, use
1462 that select method instead of determining the method based on the
1463 group name. If DONT-CHECK, don't check check whether the group
1464 actually exists. If DONT-SUB-CHECK or DONT-CHECK, don't let the
1465 backend check whether the group actually exists."
1467 active)
1469 ;; We escape all bugs and quit here to make it possible to
1470 ;; continue if a group is so out-there that it reports bugs
1471 ;; and stuff.
1476 t)
1479 method
1483 method
1489 nil)))
1492 ;; If there are no articles in the group, the GROUP
1493 ;; command may have responded with the `(0 . 0)'. We
1494 ;; ignore this if we already have an active entry
1495 ;; for the group.
1501 ;; If a cache is present, we may have to alter the active info.
1504 group active)))
1506 ;; If the agent is enabled, we may have to alter the active info.
1511 ;; Return the new active info.
1512 active)))))
1516 ;; Allow the backend to update the info in the group.
1526 ;; These checks are present in gnus-activate-group but skipped
1527 ;; due to setting dont-check in the preceding call.
1529 ;; If a cache is present, we may have to alter the active info.
1534 ;; If the agent is enabled, we may have to alter the active info.
1538 ;; Modify the list of read articles according to what articles
1539 ;; are available; then tally the unread articles and add the
1540 ;; number to the group hash table entry.
1547 ;; Fix a single (num . num) range according to the
1548 ;; active hash table.
1549 ;; Fix by Carsten Bormann <cabo@Informatik.Uni-Bremen.DE>.
1552 ;; Compute number of unread articles.
1555 ;; The read list is a list of ranges. Fix them according to
1556 ;; the active hash table.
1557 ;; First peel off any elements that are below the lower
1558 ;; active limit.
1573 ;; Adjust the first element to be the same as the lower limit.
1577 ;; Then we want to peel off any elements that are higher
1578 ;; than the upper active limit.
1580 ;; Go past all valid elements.
1588 ;; Nuke all remaining invalid elements.
1591 ;; Adjust the final element.
1595 ;; Compute the number of unread articles.
1603 ;; Set the number of unread articles.
1607 num)))
1609 ;; Go though `gnus-newsrc-alist' and compare with `gnus-active-hashtb'
1610 ;; and compute how many unread articles there are in each group.
1618 level
1624 gnus-activate-foreign-newsgroups)
1626 alevel)))
1631 infos info group active method cmethod
1632 method-type method-group-list entry)
1638 ;; First go through all the groups, see what select methods they
1639 ;; belong to, and then collect them into lists per unique select
1640 ;; method.
1643 ;; There may be several similar methods. Possibly extend the
1644 ;; method.
1666 type-cache))
1667 ;; Only add groups that need updating.
1670 foreign-level
1671 alevel))
1674 ;; The group is inactive, so we nix out the number of unread articles.
1675 ;; It leads `(gnus-group-unread group)' to return t. See also
1676 ;; `gnus-group-prepare-flat'.
1681 ;; Sort the methods based so that the primary and secondary
1682 ;; methods come first. This is done for legacy reasons to try to
1683 ;; ensure that side-effect behavior doesn't change from previous
1684 ;; Gnus versions.
1690 ;; Go through the list of servers and possibly extend methods that
1691 ;; aren't equal (and that need extension; i.e., they are async).
1701 method))
1705 ;; If we have primary/secondary select methods, but no groups from
1706 ;; them, we still want to issue a retrieval request from them.
1709 gnus-secondary-select-methods))
1715 ;; Clear out all the early methods.
1719 infos
1727 ;; Just mark this server as "cleared".
1730 ;; Start early async retrieval of data.
1732 sanity-spec)
1738 ;; If the open-server method doesn't exist, then the method
1739 ;; itself doesn't exist, so we ignore it.
1745 ;; This is a sanity check, so that we never
1746 ;; attempt to start two async requests to the
1747 ;; same server, because that will fail. This
1748 ;; should never happen, since the methods should
1749 ;; be unique at this point, but apparently it
1750 ;; does happen in the wild with some setups.
1758 ;; Store the token we get back from -early so that we
1759 ;; can pass it to -finish later.
1763 ;; Do the rest of the retrieval.
1770 ;; See if any of the groups from this method require updating.
1775 updatep)))))))
1780 ;; Get info for virtual groups last.
1785 ;; Compute the rank of the secondary methods based on where they
1786 ;; are in the secondary select list.
1794 i)))
1795 ;; Just say that all foreign groups have the same rank.
1802 ;; Finish up getting the data from the methods that have -early
1803 ;; methods.
1805 early-data
1811 ;; Most backends have -retrieve-groups.
1819 method)))
1820 ;; Virtually all backends have -request-list.
1823 ;; Except nnvirtual and friends, where we request each group, one
1824 ;; by one.
1829 ;; Create a hash table out of the newsrc alist. The `car's of the
1830 ;; alist elements are used as keys.
1834 prev info method rest methods)
1840 gnus-newsrc-alist
1844 ;; Make the same select-methods identical Lisp objects.
1849 ;; Check for duplicates.
1851 ;; Remove this entry from the alist.
1855 ;; Preserve number of unread articles in groups.
1857 prev)
1858 gnus-newsrc-hashtb)
1861 ;; Make the same select-methods in `gnus-server-alist' identical
1862 ;; as well.
1869 "Create a hash table from the killed and zombie lists."
1871 list)
1881 "Parse active info in the nntp server buffer."
1884 ;; Parse the result we got from `gnus-request-group'.
1891 "Mark ARTICLES in GROUP as unread."
1896 news article)
1902 ;; Enter this list into the group info.
1906 ;; Set the number of unread articles in gnus-newsrc-hashtb.
1909 ;; Insert the change into the group buffer and the dribble file.
1913 "Mark ascending ARTICLES in GROUP as unread."
1919 modified)
1926 ;; the articles extend past the end of the ranges
1927 ;; OK - I'm done
1930 ;; this range precedes the article. Leave the range unmodified.
1932 ranges)
1934 ;; this range exactly matches the article; REMOVE THE RANGE.
1935 ;; NOTE: When the range being removed is the last range, the list is corrupted by inserting null at its end.
1939 nil))
1942 ;; I have a min/max range to consider
1947 ranges)
1949 ;; replace min/max range with a single-value range
1951 ranges)
1953 ;; this range precedes the article. Leave the range unmodified.
1955 ranges)
1957 ;; this article precedes the range. Return null to move to the
1958 ;; next article
1959 nil)
1961 ;; this article splits the range into two parts
1965 ranges))))))))
1970 ;; Enter this list into the group info.
1973 ;; Set the number of unread articles in gnus-newsrc-hashtb.
1976 ;; Insert the change into the group buffer and the dribble file.
1979 ;; Enter all dead groups into the hashtb.
1983 killed)
1992 "Go through the active hashtb and mark all unknown groups as killed."
1993 ;; First make sure active file has been read.
1999 ;; Go through all newsgroups that are known to Gnus - enlarge kill list.
2007 ()
2010 ()
2014 gnus-active-hashtb)
2017 ;; Get the active file(s) from the backend(s).
2026 ;; The native server is available.
2028 ;; The native server is down, so we just do the
2029 ;; secondary ones.
2030 gnus-secondary-select-methods)
2031 ;; Also read from the archive server.
2034 method)
2038 ;; Only do each method once, in case the methods appear more
2039 ;; than once in this list.
2041 ;; Check whether the backend exists.
2047 ;; We catch C-g so that we can continue past servers
2048 ;; that do not respond.
2053 nil))))))))
2064 ;; Request that the backend scan its incoming messages.
2076 groups info)
2083 gmethod))
2085 groups)))
2088 t)
2096 ;; We mark this active file as read.
2101 "Read an active file for GROUPS in METHOD using `gnus-retrieve-groups'."
2115 ;; Read an active file and place the results in `gnus-active-hashtb'.
2117 real-active)
2124 gnus-active-hashtb
2130 group max min)
2131 ;; Delete unnecessary lines.
2141 ;; Make the group names readable as a lisp expression even if they
2142 ;; contain special characters.
2147 ;; Let the Gnus agent save the active file.
2151 ;; If these are groups from a foreign select method, we insert the
2152 ;; group prefix in front of the group names.
2164 ;; Store the active file in a hash table.
2165 ;; Use a unibyte buffer in order to make `read' read non-ASCII
2166 ;; group names (which have been encoded) as unibyte strings.
2175 ;; group gets set to a symbol interned in the hash table
2176 ;; (what a hack!!) - jwz
2178 ;; ### The extended group name scheme makes
2179 ;; the previous optimization strategy sort of pointless...
2192 ;; if group is moderated, stick in moderation table
2197 gnus-moderated-hashtb)))
2211 ;; Parse a "groups" active file.
2215 gnus-active-hashtb
2225 ;; Let the Gnus agent save the active file.
2227 real-active
2235 ;; We split this into to separate loops, one with the prefix
2236 ;; and one without to speed the reading up somewhat.
2266 "Read startup file.
2267 If FORCE is non-nil, the .newsrc file is read."
2268 ;; Reset variables that might be defined in the .newsrc.eld file.
2276 ;; We always load the .newsrc.eld file. If always contains
2277 ;; much information that can not be gotten from the .newsrc
2278 ;; file (ticked articles, killed groups, foreign methods, etc.)
2288 ;; We read the .newsrc file. Note that if there if a
2289 ;; .newsrc.eld file exists, it has already been read, and
2290 ;; the `gnus-newsrc-hashtb' has been created. While reading
2291 ;; the .newsrc file, Gnus will only use the information it
2292 ;; can find there for changing the data already read -
2293 ;; i. e., reading the .newsrc file will not trash the data
2294 ;; already read (except for read articles).
2303 ;; Convert old to new.
2307 "Convert old newsrc formats into the current format, if needed."
2312 ;; A newsrc file was loaded.
2318 date-func))
2319 ;; This is a list of converters that must be run
2320 ;; to bring the newsrc file up to the current
2321 ;; version. If you create an incompatibility
2322 ;; with older versions, you should create an
2323 ;; entry here. The entry should consist of the
2324 ;; current gnus version (hardcoded so that it
2325 ;; doesn't change with each release) and the
2326 ;; function that must be applied to convert the
2327 ;; previous version into the current version.
2329 gnus-convert-old-ticks)
2331 gnus-agent-convert-to-compressed-agentview)
2333 gnus-agent-unlist-expire-days)
2335 gnus-agent-unhook-expire-days)))
2337 ;; Skip converters older than the file version
2341 ;; Perform converters to bring older version up to date.
2358 gnus-newsrc-file-version gnus-version)
2365 nil)
2370 t)
2374 t)))))
2379 gnus-newsrc-file-version gnus-version)))))))
2382 "Indicate whether CONVERTER requires gnus-convert-old-newsrc to
2383 display the conversion prompt. NO-PROMPT may be nil (prompt),
2384 t (no prompt), or any form that can be called as a function.
2385 The form should return either t or nil."
2391 no-prompt
2396 marks info dormant ticked)
2403 info
2410 "Load FILE, but in such a way that read errors can be reported."
2428 ;; We always, always read the .eld file.
2432 ;; Older versions of `gnus-format-specs' are no longer valid
2433 ;; in Oort Gnus 0.01.
2443 ;; Protect against broken .newsrc.el files.
2448 ;; Old format quick file
2450 ;; The .el file is newer than the .eld file, so we read that one
2451 ;; as well.
2455 ;; Parse the old-style quick startup file
2460 gnus-marked-assoc gnus-newsrc-alist gnus-newsrc-assoc)
2465 killed gnus-killed-assoc
2466 marked gnus-marked-assoc)))
2474 gnus-level-default-unsubscribed))
2479 gnus-level-default-unsubscribed)
2481 gnus-newsrc-alist))
2482 ;; Copy marks into info.
2494 ;; The .el file version of this variable does not begin with
2495 ;; "options", while the .eld version does, so we just add it if it
2496 ;; isn't there.
2498 gnus-newsrc-options
2503 ;; Finally, if we read some options lines, we parse them.
2511 "Make server dependent file name by catenating FILE and server host name."
2517 real-file
2518 file)))
2528 group subscribed options-symbol newsrc Options-symbol
2529 symbol reads num1)
2531 ;; We intern the symbol `options' in the active hashtb so that we
2532 ;; can `eq' against it later.
2537 ;; We first read the first word on the line by narrowing and
2538 ;; then reading into `gnus-active-hashtb'. Most groups will
2539 ;; already exist in that hashtb, so this will save some string
2540 ;; space.
2549 ;; Now, the symbol we have read is either `options' or a group
2550 ;; name. If it is an options line, we just add it to a string.
2555 ;; This concatting is quite inefficient, but since our
2556 ;; thorough studies show that approx 99.37% of all
2557 ;; .newsrc files only contain a single options line, we
2558 ;; don't give a damn, frankly, my dear.
2562 ;; Options may continue on the next line.
2568 ;; Group names can be just numbers.
2573 ;; It was a group name.
2576 reads nil)
2578 ;; If the line ends here, this is clearly a buggy line, so
2579 ;; we put point a the beginning of line and let the cond
2580 ;; below do the error handling.
2582 ;; We skip to the beginning of the ranges.
2584 ;; We are now at the beginning of the list of read articles.
2585 ;; We read them range by range.
2589 ;; We narrow and read a number instead of buffer-substring/
2590 ;; string-to-number because it's faster. narrow/widen is
2591 ;; faster than save-restriction/narrow, and save-restriction
2592 ;; produces a garbage object.
2597 ;; If the next character is a dash, then this is a range.
2600 ;; We read the upper bound of the range.
2603 ;; This is a buggy line, by we pretend that
2604 ;; it's kinda OK. Perhaps the user should be
2605 ;; dinged?
2613 reads)
2615 ;; It was just a simple number, so we add it to the
2616 ;; list of ranges.
2618 ;; If the next char in ?\n, then we have reached the end
2619 ;; of the line and return nil.
2622 ;; End of line, so we end.
2623 nil)
2625 ;; Not numbers and not eol, so this might be a buggy
2626 ;; line...
2628 ;; If it was eob instead of ?\n, we allow it.
2629 ;; The line was buggy.
2634 nil))
2635 ;; Skip past ", ". Spaces are invalid in these ranges, but
2636 ;; we allow them, because it's a common mistake to put a
2637 ;; space after the comma.
2640 ;; We have already read .newsrc.eld, so we gently update the
2641 ;; data in the hash table with the information we have just
2642 ;; read.
2645 level)
2647 ;; There is an entry for this file in the alist.
2650 ;; We update the level very gently. In fact, we
2651 ;; only change it if there's been a status change
2652 ;; from subscribed to unsubscribed, or vice versa.
2657 gnus-level-default-unsubscribed
2662 ;; This is a new group.
2665 gnus-level-default-subscribed
2668 gnus-level-default-unsubscribed))
2676 ()
2677 ;; We now have two newsrc lists - `newsrc', which is what we
2678 ;; have read from .newsrc, and `gnus-newsrc-alist', which is
2679 ;; what we've read from .newsrc.eld. We have to merge these
2680 ;; lists. We do this by "attaching" any (foreign) groups in the
2681 ;; gnus-newsrc-alist to the (native) group that precedes them.
2684 entry mentry)
2696 ;; We make the newsrc hashtb.
2699 ;; Finally, if we read some options lines, we parse them.
2703 ;; Parse options lines to find "options -n !all rec.all" and stuff.
2704 ;; The return value will be a list on the form
2705 ;; ((regexp1 . ignore)
2706 ;; (regexp2 . subscribe)...)
2707 ;; When handling new newsgroups, groups that match a `ignore' regexp
2708 ;; will be ignored, and groups that match a `subscribe' regexp will be
2709 ;; subscribed. A line like
2710 ;; options -n !all rec.all
2711 ;; will lead to a list that looks like
2712 ;; (("^rec\\..+" . subscribe)
2713 ;; ("^.+" . ignore))
2714 ;; So all "rec.*" groups will be subscribed, while all the other
2715 ;; groups will be ignored. Note that "options -n !all rec.all" is very
2716 ;; different from "options -n rec.all !all".
2722 ;; First we treat all continuation lines.
2726 ;; Then we transform all "all"s into ".+"s.
2731 ;; We remove all other options than the "-n" ones.
2737 ;; We are only interested in "options -n" lines - we
2738 ;; ignore the other option lines.
2745 ;; Search for all "words"...
2748 ;; If the word begins with a bang (!), this is a "not"
2749 ;; spec. We put this spec (minus the bang) and the
2750 ;; symbol `ignore' into the list.
2757 out)
2758 ;; There was no bang, so this is a "yes" spec.
2761 out))))
2768 'msdos-long-file-names
2772 "Save .newsrc file."
2773 ;; Note: We cannot save .newsrc file if all newsgroups are removed
2774 ;; from the variable gnus-newsrc-alist.
2776 gnus-current-startup-file)
2777 ;; Save agent range limits for the currently active method.
2792 ;; Save .newsrc.
2798 ;; Save .newsrc.eld.
2819 working-file
2821 ;; Generate the name of a non-existent file.
2837 ;; These bindings will mislead the current buffer
2838 ;; into thinking that it is visiting the startup
2839 ;; file.
2844 ;; Backup the current version of the startup file.
2847 ;; Replace the existing startup file with the temp file.
2861 "Print Gnus variables such as `gnus-newsrc-alist' in Lisp format."
2863 gnus-ding-file-coding-system))
2870 ;; Never delete this file -- if you want to force Gnus to read the
2888 gnus-killed-list))
2892 ;; Remove the `gnus-killed-list' from the list of variables
2893 ;; to be saved, if required.
2895 ;; Peel off the "dummy" group.
2897 variable)
2898 ;; Insert the variables into the file.
2909 "Return the killed list minus the groups that match `gnus-save-killed-list'."
2911 olist)
2920 ;; Generate and save the .newsrc file.
2924 info ranges range method)
2929 ;; Use a unibyte buffer since group names are unibyte strings;
2930 ;; in particular, non-ASCII group names are the ones encoded by
2931 ;; a certain coding system.
2933 ;; Write options.
2936 ;; Write subscribed and unsubscribed.
2938 ;; Don't write foreign groups to .newsrc.
2942 foreign-ok)
2965 ;; It has been reported that sometime the modtime on the .newsrc
2966 ;; file seems to be off. We really do want to overwrite it, so
2967 ;; we clear the modtime here before saving. It's a bit odd,
2968 ;; though...
2969 ;; sometimes the modtime clear isn't sufficient. most brute force:
2970 ;; delete the silly thing entirely first. but this fails to provide
2971 ;; such niceties as .newsrc~ creation.
2980 \f
2981 ;;;
2982 ;;; Slave functions.
2983 ;;;
2988 "Minor mode for slave Gnusae."
2989 ;; FIXME: gnus-slave-mode appears to never be set (i.e. it'll always be nil):
2990 ;; Remove, or fix and use define-minor-mode.
3014 t))
3015 file)
3023 slave-files)
3034 t)
3037 nil))
3045 \f
3046 ;;;
3047 ;;; Group description.
3048 ;;;
3055 gnus-secondary-select-methods))))
3059 t))
3063 group)
3066 ;; We create the hashtable whether we manage to read the desc file
3067 ;; to avoid trying to re-read after a failed read.
3071 ;; Mark this method's desc file as read.
3073 gnus-description-hashtb)
3078 t)
3081 nil)
3084 nil)
3087 ;; FIXME: Shouldn't save-restriction be done after set-buffer?
3095 ;; If these are groups from a foreign select method, we insert the
3096 ;; group prefix in front of the group names.
3101 nil gnus-select-method))))
3109 ;; If we get an error, we set group to 0, which is not a
3110 ;; symbol...
3114 ;; Group is set to a symbol interned in this
3115 ;; hash table.
3119 ;; ... which leads to this line being effectively ignored.
3127 gnus-default-charset)))
3128 ;; Fixme: Don't decode in unibyte mode.
3134 t))))
3137 "Get the description of a group by sending XGTITLE to the server."
3144 ;;;###autoload
3146 "Declare back end NAME with ABILITIES as a Gnus back end."
3153 "Set the default directory in the current buffer to `gnus-default-directory'.
3154 If this variable is nil, don't do anything."
3159 default-directory)))
3167 ;; Check whether nnml and nnfolder share a directory.
3170 'display-warning
3182 window
3187 method active actives match)
3204 ;;; gnus-start.el ends here