17
17
"""Tree classes, representing directory at point in time.
20
from osutils import pumpfile, appendpath, fingerprint_file
21
from cStringIO import StringIO
23
from bzrlib.trace import mutter, note
24
from bzrlib.errors import BzrError
24
from bzrlib.errors import BzrError, BzrCheckError
25
from bzrlib.inventory import Inventory
26
from bzrlib.osutils import fingerprint_file
27
import bzrlib.revision
28
from bzrlib.trace import mutter, note
30
30
class Tree(object):
31
31
"""Abstract file tree.
49
49
trees or versioned trees.
53
"""Get a list of the conflicts in the tree.
55
Each conflict is an instance of bzrlib.conflicts.Conflict.
59
def get_parent_ids(self):
60
"""Get the parent ids for this tree.
62
:return: a list of parent ids. [] is returned to indicate
63
a tree with no parents.
64
:raises: BzrError if the parents are not known.
66
raise NotImplementedError(self.get_parent_ids)
68
52
def has_filename(self, filename):
69
53
"""True if the tree has given filename."""
70
54
raise NotImplementedError()
85
64
def id2path(self, file_id):
86
65
return self.inventory.id2path(file_id)
88
def kind(self, file_id):
89
raise NotImplementedError("subclasses must implement kind")
91
67
def _get_inventory(self):
92
68
return self._inventory
94
def get_file_by_path(self, path):
95
return self.get_file(self._inventory.path2id(path))
97
70
inventory = property(_get_inventory,
98
71
doc="Inventory of this Tree")
100
73
def _check_retrieved(self, ie, f):
103
74
fp = fingerprint_file(f)
117
88
"store is probably damaged/corrupt"])
120
def print_file(self, file_id):
121
"""Print file with id `file_id` to stdout."""
91
def print_file(self, fileid):
92
"""Print file with id `fileid` to stdout."""
123
sys.stdout.write(self.get_file_text(file_id))
129
"""What files are present in this tree and unknown.
131
:return: an iterator over the unknown files.
138
def filter_unversioned_files(self, paths):
139
"""Filter out paths that are not versioned.
141
:return: set of paths.
143
# NB: we specifically *don't* call self.has_filename, because for
144
# WorkingTrees that can indicate files that exist on disk but that
146
pred = self.inventory.has_filename
147
return set((p for p in paths if not pred(p)))
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)
150
108
class RevisionTree(Tree):
151
109
"""Tree viewing a previous revision.
157
115
or at least passing a description to the constructor.
160
def __init__(self, branch, inv, revision_id):
161
# for compatability the 'branch' parameter has not been renamed to
162
# repository at this point. However, we should change RevisionTree's
163
# construction to always be via Repository and not via direct
164
# construction - this will mean that we can change the constructor
165
# with much less chance of breaking client code.
166
self._repository = branch
167
self._weave_store = branch.weave_store
118
def __init__(self, store, inv):
168
120
self._inventory = inv
169
self._revision_id = revision_id
171
def get_parent_ids(self):
172
"""See Tree.get_parent_ids.
174
A RevisionTree's parents match the revision graph.
176
parent_ids = self._repository.get_revision(self._revision_id).parent_ids
179
def get_revision_id(self):
180
"""Return the revision id associated with this tree."""
181
return self._revision_id
183
def get_weave(self, file_id):
184
return self._weave_store.get_weave(file_id,
185
self._repository.get_transaction())
187
def get_file_lines(self, file_id):
188
ie = self._inventory[file_id]
189
weave = self.get_weave(file_id)
190
return weave.get_lines(ie.revision)
192
def get_file_text(self, file_id):
193
return ''.join(self.get_file_lines(file_id))
195
122
def get_file(self, file_id):
196
return StringIO(self.get_file_text(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)
198
129
def get_file_size(self, file_id):
199
130
return self._inventory[file_id].text_size
201
def get_file_sha1(self, file_id, path=None):
202
ie = self._inventory[file_id]
203
if ie.kind == "file":
207
def get_file_mtime(self, file_id, path=None):
208
ie = self._inventory[file_id]
209
revision = self._repository.get_revision(ie.revision)
210
return revision.timestamp
212
def is_executable(self, file_id, path=None):
213
ie = self._inventory[file_id]
214
if ie.kind != "file":
216
return self._inventory[file_id].executable
132
def get_file_sha1(self, file_id):
133
ie = self._inventory[file_id]
218
136
def has_filename(self, filename):
219
137
return bool(self.inventory.path2id(filename))
221
139
def list_files(self):
222
140
# The only files returned by this are those from the version
223
141
for path, entry in self.inventory.iter_entries():
224
yield path, 'V', entry.kind, entry.file_id, entry
226
def get_symlink_target(self, file_id):
227
ie = self._inventory[file_id]
228
return ie.symlink_target;
230
def kind(self, file_id):
231
return self._inventory[file_id].kind
234
self._repository.lock_read()
237
self._repository.unlock()
142
yield path, 'V', entry.kind, entry.file_id
240
145
class EmptyTree(Tree):
243
self._inventory = Inventory()
245
def get_parent_ids(self):
246
"""See Tree.get_parent_ids.
248
An EmptyTree always has NULL_REVISION as the only parent.
252
def get_symlink_target(self, file_id):
146
def __init__(self, root_id):
147
from bzrlib.inventory import Inventory
148
self._inventory = Inventory(root_id)
255
150
def has_filename(self, filename):
258
def kind(self, file_id):
259
assert self._inventory[file_id].kind == "root_directory"
260
return "root_directory"
262
153
def list_files(self):
154
if False: # just to make it a generator
265
def __contains__(self, file_id):
266
return file_id in self._inventory
268
def get_file_sha1(self, file_id, path=None):
269
assert self._inventory[file_id].kind == "root_directory"
273
159
######################################################################
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
