17
17
"""Tree classes, representing directory at point in time.
20
from osutils import pumpfile, appendpath, fingerprint_file
21
from cStringIO import StringIO
23
24
from bzrlib.trace import mutter, note
24
from bzrlib.errors import BzrError
25
from bzrlib.errors import BzrError, BzrCheckError
26
from bzrlib.inventory import Inventory
27
from bzrlib.osutils import appendpath, fingerprint_file
30
29
class Tree(object):
31
30
"""Abstract file tree.
64
68
def id2path(self, file_id):
65
69
return self.inventory.id2path(file_id)
71
def kind(self, file_id):
72
raise NotImplementedError("subclasses must implement kind")
67
74
def _get_inventory(self):
68
75
return self._inventory
77
def get_file_by_path(self, path):
78
return self.get_file(self._inventory.path2id(path))
70
80
inventory = property(_get_inventory,
71
81
doc="Inventory of this Tree")
73
83
def _check_retrieved(self, ie, f):
74
86
fp = fingerprint_file(f)
88
100
"store is probably damaged/corrupt"])
91
def print_file(self, fileid):
92
"""Print file with id `fileid` to stdout."""
103
def print_file(self, file_id):
104
"""Print file with id `file_id` to stdout."""
94
pumpfile(self.get_file(fileid), sys.stdout)
97
def export(self, dest, format='dir', root=None):
98
"""Export this tree."""
100
exporter = exporters[format]
102
from bzrlib.errors import BzrCommandError
103
raise BzrCommandError("export format %r not supported" % format)
104
exporter(self, dest, root)
106
sys.stdout.write(self.get_file_text(file_id))
108
115
class RevisionTree(Tree):
109
116
"""Tree viewing a previous revision.
115
122
or at least passing a description to the constructor.
118
def __init__(self, store, inv):
125
def __init__(self, branch, inv, revision_id):
126
self._branch = branch
127
self._weave_store = branch.weave_store
120
128
self._inventory = inv
129
self._revision_id = revision_id
131
def get_weave(self, file_id):
132
import bzrlib.transactions as transactions
133
return self._weave_store.get_weave(file_id,
134
self._branch.get_transaction())
136
def get_weave_prelude(self, file_id):
137
import bzrlib.transactions as transactions
138
return self._weave_store.get_weave_prelude(file_id,
139
self._branch.get_transaction())
141
def get_file_lines(self, file_id):
142
ie = self._inventory[file_id]
143
weave = self.get_weave(file_id)
144
return weave.get(ie.revision)
146
def get_file_text(self, file_id):
147
return ''.join(self.get_file_lines(file_id))
122
149
def get_file(self, file_id):
123
ie = self._inventory[file_id]
124
f = self._store[ie.text_id]
125
mutter(" get fileid{%s} from %r" % (file_id, self))
126
self._check_retrieved(ie, f)
150
return StringIO(self.get_file_text(file_id))
129
152
def get_file_size(self, file_id):
130
153
return self._inventory[file_id].text_size
132
155
def get_file_sha1(self, file_id):
133
156
ie = self._inventory[file_id]
157
if ie.kind == "file":
160
def is_executable(self, file_id):
161
ie = self._inventory[file_id]
162
if ie.kind != "file":
164
return self._inventory[file_id].executable
136
166
def has_filename(self, filename):
137
167
return bool(self.inventory.path2id(filename))
139
169
def list_files(self):
140
170
# The only files returned by this are those from the version
141
171
for path, entry in self.inventory.iter_entries():
142
yield path, 'V', entry.kind, entry.file_id
172
yield path, 'V', entry.kind, entry.file_id, entry
174
def get_symlink_target(self, file_id):
175
ie = self._inventory[file_id]
176
return ie.symlink_target;
178
def kind(self, file_id):
179
return self._inventory[file_id].kind
182
self._branch.lock_read()
185
self._branch.unlock()
145
188
class EmptyTree(Tree):
146
def __init__(self, root_id):
147
from bzrlib.inventory import Inventory
148
self._inventory = Inventory(root_id)
190
self._inventory = Inventory()
192
def get_symlink_target(self, file_id):
150
195
def has_filename(self, filename):
198
def kind(self, file_id):
199
assert self._inventory[file_id].kind == "root_directory"
200
return "root_directory"
153
202
def list_files(self):
154
if False: # just to make it a generator
205
def __contains__(self, file_id):
206
return file_id in self._inventory
208
def get_file_sha1(self, file_id):
209
assert self._inventory[file_id].kind == "root_directory"
159
213
######################################################################
225
######################################################################
228
def dir_exporter(tree, dest, root):
229
"""Export this tree to a new directory.
231
`dest` should not exist, and will be created holding the
232
contents of this tree.
234
TODO: To handle subdirectories we need to create the
237
:note: If the export fails, the destination directory will be
238
left in a half-assed state.
242
mutter('export version %r' % tree)
244
for dp, ie in inv.iter_entries():
246
fullpath = appendpath(dest, dp)
247
if kind == 'directory':
250
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
252
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
253
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
254
exporters['dir'] = dir_exporter
261
def get_root_name(dest):
262
"""Get just the root name for a tarball.
264
>>> get_root_name('mytar.tar')
266
>>> get_root_name('mytar.tar.bz2')
268
>>> get_root_name('tar.tar.tar.tgz')
270
>>> get_root_name('bzr-0.0.5.tar.gz')
272
>>> get_root_name('a/long/path/mytar.tgz')
274
>>> get_root_name('../parent/../dir/other.tbz2')
277
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
278
dest = os.path.basename(dest)
280
if dest.endswith(end):
281
return dest[:-len(end)]
283
def tar_exporter(tree, dest, root, compression=None):
284
"""Export this tree to a new tar file.
286
`dest` will be created holding the contents of this tree; if it
287
already exists, it will be clobbered, like with "tar -c".
289
from time import time
291
compression = str(compression or '')
293
root = get_root_name(dest)
295
ball = tarfile.open(dest, 'w:' + compression)
296
except tarfile.CompressionError, e:
297
raise BzrError(str(e))
298
mutter('export version %r' % tree)
300
for dp, ie in inv.iter_entries():
301
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
302
item = tarfile.TarInfo(os.path.join(root, dp))
303
# TODO: would be cool to actually set it to the timestamp of the
304
# revision it was last changed
306
if ie.kind == 'directory':
307
item.type = tarfile.DIRTYPE
312
elif ie.kind == 'file':
313
item.type = tarfile.REGTYPE
314
fileobj = tree.get_file(ie.file_id)
315
item.size = _find_file_size(fileobj)
318
raise BzrError("don't know how to export {%s} of kind %r" %
319
(ie.file_id, ie.kind))
321
ball.addfile(item, fileobj)
323
exporters['tar'] = tar_exporter
325
def tgz_exporter(tree, dest, root):
326
tar_exporter(tree, dest, root, compression='gz')
327
exporters['tgz'] = tgz_exporter
329
def tbz_exporter(tree, dest, root):
330
tar_exporter(tree, dest, root, compression='bz2')
331
exporters['tbz2'] = tbz_exporter
334
def _find_file_size(fileobj):
335
offset = fileobj.tell()
338
size = fileobj.tell()
340
# gzip doesn't accept second argument to seek()
344
nread = len(fileobj.read())
added
removed
bzrlib/tree.py
