1 import os, stat, struct, tempfile
2 from bup.helpers import *
6 INDEX_HDR = 'BUPI\0\0\0\2'
8 # FIXME: guess I should have used 64-bit integers to store the mtime/ctime.
9 # NTFS mtime=0 corresponds to the year 1600, which can't be stored in a 32-bit
10 # time_t. Next time we update the bupindex format, keep that in mind.
11 INDEX_SIG = '!IIIIIQII20sHII'
13 ENTLEN = struct.calcsize(INDEX_SIG)
15 FOOTLEN = struct.calcsize(FOOTER_SIG)
17 IX_EXISTS = 0x8000 # file exists on filesystem
18 IX_HASHVALID = 0x4000 # the stored sha1 matches the filesystem
19 IX_SHAMISSING = 0x2000 # the stored sha1 object doesn't seem to exist
21 class Error(Exception):
26 def __init__(self, ename, parent):
33 (ofs,n) = (f.tell(), len(self.list))
35 count = len(self.list)
36 #log('popping %r with %d entries\n'
37 # % (''.join(self.ename), count))
41 self.parent.count += count + self.count
45 def _golevel(level, f, ename, newentry):
46 # close nodes back up the tree
48 while ename[:len(level.ename)] != level.ename:
49 n = BlankNewEntry(level.ename[-1])
51 (n.children_ofs,n.children_n) = level.write(f)
52 level.parent.list.append(n)
55 # create nodes down the tree
56 while len(level.ename) < len(ename):
57 level = Level(ename[:len(level.ename)+1], level)
59 # are we in precisely the right place?
60 assert(ename == level.ename)
61 n = newentry or BlankNewEntry(ename and level.ename[-1] or None)
62 (n.children_ofs,n.children_n) = level.write(f)
64 level.parent.list.append(n)
71 def __init__(self, basename, name):
72 self.basename = str(basename)
78 return ("(%s,0x%04x,%d,%d,%d,%d,%d,%s/%s,0x%04x,0x%08x/%d)"
79 % (self.name, self.dev,
80 self.ctime, self.mtime, self.uid, self.gid,
81 self.size, oct(self.mode), oct(self.gitmode),
82 self.flags, self.children_ofs, self.children_n))
86 return struct.pack(INDEX_SIG,
87 self.dev, self.ctime, self.mtime,
88 self.uid, self.gid, self.size, self.mode,
89 self.gitmode, self.sha, self.flags,
90 self.children_ofs, self.children_n)
91 except DeprecationWarning, e:
92 log('pack error: %s (%r)\n' % (e, self))
95 def from_stat(self, st, tstart):
96 old = (self.dev, self.ctime, self.mtime,
97 self.uid, self.gid, self.size, self.flags & IX_EXISTS)
98 new = (st.st_dev, int(st.st_ctime), int(st.st_mtime),
99 st.st_uid, st.st_gid, st.st_size, IX_EXISTS)
101 self.ctime = int(st.st_ctime)
102 self.mtime = int(st.st_mtime)
105 self.size = st.st_size
106 self.mode = st.st_mode
107 self.flags |= IX_EXISTS
108 if int(st.st_ctime) >= tstart or old != new \
109 or self.sha == EMPTY_SHA or not self.gitmode:
115 self.uid += 0x100000000
117 self.gid += 0x100000000
118 assert(self.uid >= 0)
119 assert(self.gid >= 0)
120 if self.mtime < -0x80000000: # can happen in NTFS on 64-bit linux
122 if self.ctime < -0x80000000:
124 if self.mtime > 0x7fffffff:
125 self.mtime = 0x7fffffff
126 if self.ctime > 0x7fffffff:
127 self.ctime = 0x7fffffff
130 f = IX_HASHVALID|IX_EXISTS
131 return (self.flags & f) == f
133 def invalidate(self):
134 self.flags &= ~IX_HASHVALID
136 def validate(self, gitmode, sha):
139 self.gitmode = gitmode
141 self.flags |= IX_HASHVALID|IX_EXISTS
144 return not self.is_deleted()
146 def sha_missing(self):
147 return (self.flags & IX_SHAMISSING) or not (self.flags & IX_HASHVALID)
149 def is_deleted(self):
150 return (self.flags & IX_EXISTS) == 0
152 def set_deleted(self):
153 if self.flags & IX_EXISTS:
154 self.flags &= ~(IX_EXISTS | IX_HASHVALID)
157 return not self.is_fake()
160 return not self.ctime
163 return (cmp(a.name, b.name)
164 or -cmp(a.is_valid(), b.is_valid())
165 or -cmp(a.is_fake(), b.is_fake()))
168 f.write(self.basename + '\0' + self.packed())
171 class NewEntry(Entry):
172 def __init__(self, basename, name, dev, ctime, mtime, uid, gid,
173 size, mode, gitmode, sha, flags, children_ofs, children_n):
174 Entry.__init__(self, basename, name)
175 (self.dev, self.ctime, self.mtime, self.uid, self.gid,
176 self.size, self.mode, self.gitmode, self.sha,
177 self.flags, self.children_ofs, self.children_n
178 ) = (dev, int(ctime), int(mtime), uid, gid,
179 size, mode, gitmode, sha, flags, children_ofs, children_n)
183 class BlankNewEntry(NewEntry):
184 def __init__(self, basename):
185 NewEntry.__init__(self, basename, basename,
187 0, EMPTY_SHA, 0, 0, 0)
190 class ExistingEntry(Entry):
191 def __init__(self, parent, basename, name, m, ofs):
192 Entry.__init__(self, basename, name)
196 (self.dev, self.ctime, self.mtime, self.uid, self.gid,
197 self.size, self.mode, self.gitmode, self.sha,
198 self.flags, self.children_ofs, self.children_n
199 ) = struct.unpack(INDEX_SIG, str(buffer(m, ofs, ENTLEN)))
201 # effectively, we don't bother messing with IX_SHAMISSING if
202 # not IX_HASHVALID, since it's redundant, and repacking is more
203 # expensive than not repacking.
204 # This is implemented by having sha_missing() check IX_HASHVALID too.
205 def set_sha_missing(self, val):
207 oldval = self.sha_missing() and 1 or 0
209 flag = val and IX_SHAMISSING or 0
210 newflags = (self.flags & (~IX_SHAMISSING)) | flag
211 self.flags = newflags
214 def unset_sha_missing(self, flag):
215 if self.flags & IX_SHAMISSING:
216 self.flags &= ~IX_SHAMISSING
220 self._m[self._ofs:self._ofs+ENTLEN] = self.packed()
221 if self.parent and not self.is_valid():
222 self.parent.invalidate()
225 def iter(self, name=None, wantrecurse=None):
227 if dname and not dname.endswith('/'):
229 ofs = self.children_ofs
230 assert(ofs <= len(self._m))
231 assert(self.children_n < 1000000)
232 for i in xrange(self.children_n):
233 eon = self._m.find('\0', ofs)
237 basename = str(buffer(self._m, ofs, eon-ofs))
238 child = ExistingEntry(self, basename, self.name + basename,
241 or child.name.startswith(dname)
242 or child.name.endswith('/') and dname.startswith(child.name)):
243 if not wantrecurse or wantrecurse(child):
244 for e in child.iter(name=name, wantrecurse=wantrecurse):
246 if not name or child.name == name or child.name.startswith(dname):
248 ofs = eon + 1 + ENTLEN
255 def __init__(self, filename):
256 self.filename = filename
258 self.writable = False
262 f = open(filename, 'r+')
264 if e.errno == errno.ENOENT:
269 b = f.read(len(INDEX_HDR))
271 log('warning: %s: header: expected %r, got %r'
272 % (filename, INDEX_HDR, b))
274 st = os.fstat(f.fileno())
276 self.m = mmap_readwrite(f)
278 self.count = struct.unpack(FOOTER_SIG,
279 str(buffer(self.m, st.st_size-FOOTLEN, FOOTLEN)))[0]
285 return int(self.count)
287 def forward_iter(self):
289 while ofs+ENTLEN <= len(self.m)-FOOTLEN:
290 eon = self.m.find('\0', ofs)
294 basename = str(buffer(self.m, ofs, eon-ofs))
295 yield ExistingEntry(None, basename, basename, self.m, eon+1)
296 ofs = eon + 1 + ENTLEN
298 def iter(self, name=None, wantrecurse=None):
299 if len(self.m) > len(INDEX_HDR)+ENTLEN:
301 if dname and not dname.endswith('/'):
303 root = ExistingEntry(None, '/', '/',
304 self.m, len(self.m)-FOOTLEN-ENTLEN)
305 for sub in root.iter(name=name, wantrecurse=wantrecurse):
307 if not dname or dname == root.name:
317 if self.writable and self.m:
322 if self.writable and self.m:
325 self.writable = False
327 def filter(self, prefixes, wantrecurse=None):
328 for (rp, path) in reduce_paths(prefixes):
329 for e in self.iter(rp, wantrecurse=wantrecurse):
330 assert(e.name.startswith(rp))
331 name = path + e.name[len(rp):]
335 # FIXME: this function isn't very generic, because it splits the filename
336 # in an odd way and depends on a terminating '/' to indicate directories.
338 """Split a path into a list of elements of the file system hierarchy."""
340 l = [i+'/' for i in l[:-1]] + l[-1:]
342 l.pop() # extra blank caused by terminating '/'
347 def __init__(self, filename):
348 self.rootlevel = self.level = Level([], None)
353 self.filename = filename = realpath(filename)
354 (dir,name) = os.path.split(filename)
355 (ffd,self.tmpname) = tempfile.mkstemp('.tmp', filename, dir)
356 self.f = os.fdopen(ffd, 'wb', 65536)
357 self.f.write(INDEX_HDR)
367 os.unlink(self.tmpname)
371 self.level = _golevel(self.level, self.f, [], None)
372 self.count = self.rootlevel.count
375 self.f.write(struct.pack(FOOTER_SIG, self.count))
377 assert(self.level == None)
385 os.rename(self.tmpname, self.filename)
387 def _add(self, ename, entry):
388 if self.lastfile and self.lastfile <= ename:
389 raise Error('%r must come before %r'
390 % (''.join(e.name), ''.join(self.lastfile)))
391 self.lastfile = e.name
392 self.level = _golevel(self.level, self.f, ename, entry)
394 def add(self, name, st, hashgen = None):
395 endswith = name.endswith('/')
396 ename = pathsplit(name)
398 #log('add: %r %r\n' % (basename, name))
402 (gitmode, sha) = hashgen(name)
403 flags |= IX_HASHVALID
405 (gitmode, sha) = (0, EMPTY_SHA)
407 isdir = stat.S_ISDIR(st.st_mode)
408 assert(isdir == endswith)
409 e = NewEntry(basename, name, st.st_dev, int(st.st_ctime),
410 int(st.st_mtime), st.st_uid, st.st_gid,
411 st.st_size, st.st_mode, gitmode, sha, flags,
415 e = BlankNewEntry(basename)
421 def add_ixentry(self, e):
422 e.children_ofs = e.children_n = 0
423 self._add(pathsplit(e.name), e)
425 def new_reader(self):
427 return Reader(self.tmpname)
430 def reduce_paths(paths):
436 if stat.S_ISDIR(st.st_mode):
439 xpaths.append((rp, p))
441 add_error('reduce_paths: %s' % e)
446 for (rp, p) in xpaths:
447 if prev and (prev == rp
448 or (prev.endswith('/') and rp.startswith(prev))):
449 continue # already superceded by previous path
450 paths.append((rp, p))
452 paths.sort(reverse=True)
457 def __init__(self, iters):
461 # FIXME: doesn't remove duplicated entries between iters.
462 # That only happens for parent directories, but will mean the
463 # actual iteration returns fewer entries than this function counts.
464 return sum(len(it) for it in self.iters)
468 l = [iter(it) for it in self.iters]
469 l = [(next(it),it) for it in l]
470 l = filter(lambda x: x[0], l)
474 if not (count % 1024):
475 progress('bup: merging indexes (%d/%d)\r' % (count, total))
480 if e.name != lastname:
487 log('bup: merging indexes (%d/%d), done.\n' % (count, total))