[Zodb-checkins] CVS: ZODB3/ZEO - ClientCache.py:1.27

[Guido van Rossum]

Update of /cvs-repository/ZODB3/ZEO
In directory cvs.zope.org:/tmp/cvs-serv27595

Modified Files:
	ClientCache.py 
Log Message:
Fix the most egregious bugs:

- Document the correct persistent filenames and the presence of a
  magic number at the start of the file.  (Also document the
  conditions under which the cache is persistent.)

- In __init__(), seek to the correct position to read the first
  record's serialno.  It was reading the last byte of dlen plus the
  first 7 bytes of the serialno.

- In invalidate(), fix the seek call after the read(8) to actually
  seek to the status byte.  It was seeking 8 bytes too far, causing it
  to overwrite the 2nd byte of dlen instead of the status byte.


=== ZODB3/ZEO/ClientCache.py 1.26 => 1.27 ===
--- ZODB3/ZEO/ClientCache.py:1.26	Thu Aug  1 15:28:18 2002
+++ ZODB3/ZEO/ClientCache.py	Tue Aug 27 14:33:05 2002
@@ -13,9 +13,24 @@
 ##############################################################################
 """Implement a client cache
 
-The cache is managed as two files, var/c0.zec and var/c1.zec.
+The cache is managed as two files.
 
-Each cache file is a sequence of records of the form:
+The cache can be persistent (meaning it is survives a process restart)
+or temporary.  It is persistent if the client argument is not None.
+
+Persistent cache files live in the var directory and are named
+'c<storage>-<client>-<digit>.zec' where <storage> is the storage
+argument (default ''), <client> is the client argument, and <digit> is
+0 or 1.  Temporary cache files are unnamed files in the standard
+temporary directory as determined by the tempfile module.
+
+The ClientStorage overrides some of the defaults; in particular, its
+storage name defaults to '1' and its client name defaults to the value
+of the environment variable ZEO_CLIENT, if it exists, otherwise to
+None.
+
+Each cache file has a 4-byte magic number followed by a sequence of
+records of the form:
 
   oid -- 8-byte object id
 
@@ -122,7 +137,8 @@
                     if fi.read(4) == magic: # Minimal sanity
                         fi.seek(0, 2)
                         if fi.tell() > 30:
-                            fi.seek(22)
+                            # First serial is at offset 19 + 4 for magic
+                            fi.seek(23)
                             s[i] = fi.read(8)
                     # If we found a non-zero serial, then use the file
                     if s[i] != '\0\0\0\0\0\0\0\0':
@@ -201,7 +217,7 @@
             h = f.read(8)
             if h != oid:
                 return
-            f.seek(8, 1) # Dang, we shouldn't have to do this. Bad Solaris & NT
+            f.seek(p+8) # Switch from reading to writing
             if version:
                 f.write('n')
             else: