Debian Codegraph @

Spec.2005-07-16

raw
1 $Id: Spec.2005-07-16,v 1.1 2005-10-06 10:52:43 roderick Exp $
2
3 Replied: Fri, 15 Jul 2005 13:25:01 -0400
4 Replied: ""Alexis Manning" <[email protected]> "
5 Return-Path: [email protected]
6 Delivery-Date: Fri Jul 15 11:47:36 2005
7 Return-Path: <[email protected]>
8 Received: from junior.ibcinc.com (junior.ibcinc.com [198.22.130.72])
9 by eeyore.ibcinc.com (8.8.5/8.8.5/1.10/ey-1.6) with ESMTP id LAA29352
10 for <[email protected]>; Fri, 15 Jul 2005 11:47:35 -0400 (EDT)
11 Received: from owl.ibcinc.com (owl.ibcinc.com [198.22.130.134])
12 by junior.ibcinc.com (8.8.5/8.8.5/1.10/jr-1.45) with ESMTP id LAA25781
13 for <[email protected]>; Fri, 15 Jul 2005 11:47:34 -0400 (EDT)
14 Received: from va-65-173-91-19.sta.sprint-hsd.net
15 ([65.173.91.19] helo=jones.argon.org ident=foobar)
16 by owl.ibcinc.com with esmtp (Exim 4.34)
17 id 1DtSPW-000617-6U
18 for [email protected]; Fri, 15 Jul 2005 11:47:34 -0400
19 Received: from 81-6-246-203.dyn.gotadsl.co.uk ([81.6.246.203] helo=spooler)
20 by jones.argon.org with esmtp (Exim 4.50)
21 id 1DtSPL-0001Sg-Sy
22 for [email protected]; Fri, 15 Jul 2005 11:47:31 -0400
23 Received: from Spooler by spooler (Mercury/32 v4.01a) ID MO000004;
24 15 Jul 2005 16:47:30 +0100
25 Received: from spooler by hotpop.com (Mercury/32 v4.01a); 15 Jul 2005 16:16:44 +0100
26 Received: from fishtest (127.0.0.1) by (unauthorised access is forbidden) (Mercury/32 v4.01a) ID MG000003;
27 15 Jul 2005 16:16:43 +0100
28 Message-ID: <000701c58950$35371b00$1901a8c0@fishtest>
29 From: "Alexis Manning" <[email protected]>
30 To: "Roderick Schertler" <[email protected]>
31 Subject: Hearse updates
32 Date: Fri, 15 Jul 2005 16:16:42 +0100
33 MIME-Version: 1.0
34 Content-Type: text/plain;
35 charset="iso-8859-1"
36 Content-Transfer-Encoding: 7bit
37 X-Priority: 3
38 X-MSMail-Priority: Normal
39 X-Mailer: Microsoft Outlook Express 6.00.2800.1506
40 X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2800.1506
41 X-Spam-Score: -3.8 (---)
42 X-Spam-Report: spam=No hits=-3.8 required=8.0 autolearn=ham
43 version=3.0.2 host=jones.argon.org
44 * -3.3 ALL_TRUSTED Did not pass through any untrusted hosts
45 * -2.6 BAYES_00 BODY: Bayesian spam probability is 0 to 1%
46 * [score: 0.0000]
47 * 2.0 RCVD_IN_SORBS_DUL RBL: SORBS: sent directly from dynamic IP address
48 * [81.6.246.203 listed in dnsbl.sorbs.net]
49 * 0.1 RCVD_IN_NJABL_DUL RBL: NJABL: dialup sender did non-local SMTP
50 * [81.6.246.203 listed in combined.njabl.org]
51
52 I'm going to be releasing a new Windows Hearse client in a few days or so.
53 I've made some server-side changes to support it, but have made sure that
54 all changes are backward compatible.
55
56 I've included the list of changes below. Which, if any, of these changes
57 you choose to implement is up to you. If you see anything that looks
58 bizarre, please let me know -- there's only a couple of beta users who are
59 relying on these protocol changes so far.
60
61 Cheers,
62
63 -- A.
64 ======
65
66
67 Client side changes
68 ===================
69
70 * Match mode is now the default behaviour (renamed 'Replace mode') where a
71 bones file is uploaded then deleted, and one of the same level is downloaded
72 to replace it
73
74 * I've shifted away from storing stuff in the registry on the Windows client
75 to a configuration file, so the user has more control over what's going on.
76
77 * Windows Hearse now (finally) allows the user to have bones in a directory
78 other than the one Hearse runs in.
79
80 * Hearse updates the last-successfully-ran timestamp even if no file is
81 actually uploaded, similarly to the way the Unix client behaves.
82
83 * When the user uploads a file, a new X_NETHACKVER header is returned by the
84 server. This should be stored in the configuration file and sent when force
85 downloading files (see below). This is because the new forced downloading
86 behaviour means that the server can no longer guarantee that the type of
87 bones file the user most recently uploaded is the one they now want to
88 download (e.g. user w/ Slashem and Vanilla installations has most recently
89 uploaded a Slashem bones file, but now wants to force-download Vanilla
90 ones).
91
92 * If there is no cached X_NETHACKVER value and the user wants to force the
93 download of files, the client will call BonesCheck on the first save file it
94 can find to determine the Nethack version.
95
96 * User can choose that, if they have less than a certain number of bones
97 files (limited between 1 and 4), Hearse will advance them more bones files
98 (limited between 1 and 4).
99
100 To manage this and maintain compatibility with older clients:
101 - on uploading existing files, a count is kept of how many there are,
102 excluding those which are uploaded and then deleted
103 - this count is also maintained on downloading bones files (since a user
104 may have 4 bones files, upload them all, deleting them, but only be given
105 one back by the server)
106 - Usually, when the server runs out of files for the user an INFO error is
107 returned along with some stats (e.g. "This version (blah) has <foo> bones
108 files, you uploaded <blah> of them"). The server sends the new header
109 'X_FORCEDOWNLOAD: Y' along with that stats message. The client picks that
110 up and doesn't display the info message if it knows that we're about to try
111 to ask for extra bones files.
112 - We then go through the download loop again however many times we want to
113 get a new file, sending the header 'X_FORCEDOWNLOAD: Y' to let the server
114 know to offer the user files even if they haven't uploaded enough. The
115 server may still refuse the request if the user has hit a server-side daily
116 limit. On the final pass through this loop, we also send 'X_WANTSINFO: Y'so
117 the server knows we want to get the "This version has <foo> bones files"
118 finished-downloading stats message.
119
120 This is pretty ugly, but the simplest way I could think of to preserve the
121 existing behaviour for old clients.
122
123
124 * The user's email address is stored in the config file.
125
126 * Users may have a nickname which is also stored in the config file. This
127 is optionally used both when downloading bones files (e.g. "Downloading
128 BonD0.5, uploaded by Jim The Impaler") and may later be displayed on a stats
129 webpage. Nicknames are currently limited to 40 chars. When a new user
130 signs up (through ?act=newuser), the new X_USERNICK header is now sent as
131 well with the value set to their chosen nickname.
132
133 * A MD5 hash of their email address and nickname is kept in the config file
134 so a change to either can be detected. If it has then a GET is sent to
135 http://hearse.krollmark.com/bones.dll?act=changeuserinfo (in the same way
136 that the existing actions are handled), with the X_USERTOKEN header and the
137 new X_USEREMAIL and X_USERNICK headers set to appropriate values. Nothing
138 is returned on a successful nick/email change, so any error info should be
139 taken as an indication that there is something wrong with the nick or email.
140
141 * To handle an eventual wodge of 64-bit Nethacks / different roguelikes, the
142 version info is no longer passed as four separate header variables (X_VER1,
143 X_VER2, X_VER3, X_VER4). For backward compatibility, if these headers are
144 sent then they will be handled as before. The preferred method for clients
145 is to generate a comma-separated string of the version info (e.g.
146 "132099,3322682880,2115050273,3365241252"). No spaces should be used, and
147 each element of the version info should be treated as unsigned. A MD5 hash
148 of this string should be taken, and sent in X_VERSIONCRC. Please note that
149 version info need only be sent when calling BonesCheck, and BonesCheck
150 should no longer be called routinely before attempting to upload a bones
151 file.
152
153 * On downloading a bones file, a X_USERNICK header may be returned. This
154 may optionally be displayed to the user to tell them who uploaded the bones
155 file in the first place.
156
157 * On uploading bones files, an X_MOTD header may be returned. The value of
158 this header should be cached and displayed to the user once all the
159 uploads/downloads are finished. This allows for messages such as "Your
160 version of Hearse is very old, please update it by visiting http://foo" or
161 specific messages to users who have bad email addresses.
162
163
164 Server-side changes
165 ===================
166 NewUser will pick up and use X_USERNICK if it is present
167
168 BonesCheck now returns the X_NETHACKVER header
169
170 Upload now returns the X_NETHACKVER header
171
172 Download sends the X_FORCEDOWNLOAD header with the 'finished-downloading
173 stats' info, and will react to X_FORCEDOWNLOAD and X_WANTSINFO in the ways
174 described above.
175
176 A new action - ChangeUserInfo - takes X_TOKEN, X_USERNICK and X_USEREMAIL.