1
# Copyright (C) 2005 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Tree classes, representing directory at point in time.
21
from cStringIO import StringIO
24
from bzrlib.trace import mutter, note
25
from bzrlib.errors import BzrError, BzrCheckError
26
from bzrlib.inventory import Inventory
27
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
33
"""Abstract file tree.
35
There are several subclasses:
37
* `WorkingTree` exists as files on disk editable by the user.
39
* `RevisionTree` is a tree as recorded at some point in the past.
43
Trees contain an `Inventory` object, and also know how to retrieve
44
file texts mentioned in the inventory, either from a working
45
directory or from a store.
47
It is possible for trees to contain files that are not described
48
in their inventory or vice versa; for this use `filenames()`.
50
Trees can be compared, etc, regardless of whether they are working
51
trees or versioned trees.
54
def has_filename(self, filename):
55
"""True if the tree has given filename."""
56
raise NotImplementedError()
58
def has_id(self, file_id):
59
return self.inventory.has_id(file_id)
64
return iter(self.inventory)
66
def id2path(self, file_id):
67
return self.inventory.id2path(file_id)
69
def _get_inventory(self):
70
return self._inventory
72
def get_file_by_path(self, path):
73
return self.get_file(self._inventory.path2id(path))
75
inventory = property(_get_inventory,
76
doc="Inventory of this Tree")
78
def _check_retrieved(self, ie, f):
81
fp = fingerprint_file(f)
84
if ie.text_size != None:
85
if ie.text_size != fp['size']:
86
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
87
["inventory expects %d bytes" % ie.text_size,
88
"file is actually %d bytes" % fp['size'],
89
"store is probably damaged/corrupt"])
91
if ie.text_sha1 != fp['sha1']:
92
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
93
["inventory expects %s" % ie.text_sha1,
94
"file is actually %s" % fp['sha1'],
95
"store is probably damaged/corrupt"])
98
def print_file(self, file_id):
99
"""Print file with id `file_id` to stdout."""
101
sys.stdout.write(self.get_file_text(file_id))
104
def export(self, dest, format='dir', root=None):
105
"""Export this tree."""
107
exporter = exporters[format]
109
from bzrlib.errors import BzrCommandError
110
raise BzrCommandError("export format %r not supported" % format)
111
exporter(self, dest, root)
115
class RevisionTree(Tree):
116
"""Tree viewing a previous revision.
118
File text can be retrieved from the text store.
120
TODO: Some kind of `__repr__` method, but a good one
121
probably means knowing the branch and revision number,
122
or at least passing a description to the constructor.
125
def __init__(self, weave_store, inv, revision_id):
126
self._weave_store = weave_store
127
self._inventory = inv
128
self._revision_id = revision_id
130
def get_weave(self, file_id):
131
return self._weave_store.get_weave(file_id)
134
def get_file_lines(self, file_id):
135
ie = self._inventory[file_id]
136
weave = self.get_weave(file_id)
137
return weave.get(ie.revision)
140
def get_file_text(self, file_id):
141
return ''.join(self.get_file_lines(file_id))
144
def get_file(self, file_id):
145
return StringIO(self.get_file_text(file_id))
147
def get_file_size(self, file_id):
148
return self._inventory[file_id].text_size
150
def get_file_sha1(self, file_id):
151
ie = self._inventory[file_id]
152
if ie.kind == "file":
155
def is_executable(self, file_id):
156
return self._inventory[file_id].executable
158
def has_filename(self, filename):
159
return bool(self.inventory.path2id(filename))
161
def list_files(self):
162
# The only files returned by this are those from the version
163
for path, entry in self.inventory.iter_entries():
164
yield path, 'V', entry.kind, entry.file_id
166
def get_symlink_target(self, file_id):
167
ie = self._inventory[file_id]
168
return ie.symlink_target;
170
class EmptyTree(Tree):
172
self._inventory = Inventory()
174
def get_symlink_target(self, file_id):
177
def has_filename(self, filename):
180
def list_files(self):
181
if False: # just to make it a generator
184
def __contains__(self, file_id):
185
return file_id in self._inventory
187
def get_file_sha1(self, file_id):
188
assert self._inventory[file_id].kind == "root_directory"
194
######################################################################
197
# TODO: Merge these two functions into a single one that can operate
198
# on either a whole tree or a set of files.
200
# TODO: Return the diff in order by filename, not by category or in
201
# random order. Can probably be done by lock-stepping through the
202
# filenames from both trees.
205
def file_status(filename, old_tree, new_tree):
206
"""Return single-letter status, old and new names for a file.
208
The complexity here is in deciding how to represent renames;
209
many complex cases are possible.
211
old_inv = old_tree.inventory
212
new_inv = new_tree.inventory
213
new_id = new_inv.path2id(filename)
214
old_id = old_inv.path2id(filename)
216
if not new_id and not old_id:
217
# easy: doesn't exist in either; not versioned at all
218
if new_tree.is_ignored(filename):
219
return 'I', None, None
221
return '?', None, None
223
# There is now a file of this name, great.
226
# There is no longer a file of this name, but we can describe
227
# what happened to the file that used to have
228
# this name. There are two possibilities: either it was
229
# deleted entirely, or renamed.
231
if new_inv.has_id(old_id):
232
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
234
return 'D', old_inv.id2path(old_id), None
236
# if the file_id is new in this revision, it is added
237
if new_id and not old_inv.has_id(new_id):
240
# if there used to be a file of this name, but that ID has now
241
# disappeared, it is deleted
242
if old_id and not new_inv.has_id(old_id):
249
def find_renames(old_inv, new_inv):
250
for file_id in old_inv:
251
if file_id not in new_inv:
253
old_name = old_inv.id2path(file_id)
254
new_name = new_inv.id2path(file_id)
255
if old_name != new_name:
256
yield (old_name, new_name)
260
######################################################################
263
def dir_exporter(tree, dest, root):
264
"""Export this tree to a new directory.
266
`dest` should not exist, and will be created holding the
267
contents of this tree.
269
TODO: To handle subdirectories we need to create the
272
:note: If the export fails, the destination directory will be
273
left in a half-assed state.
277
mutter('export version %r' % tree)
279
for dp, ie in inv.iter_entries():
281
fullpath = appendpath(dest, dp)
282
if kind == 'directory':
285
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
286
if tree.is_executable(ie.file_id):
287
os.chmod(fullpath, 0755)
288
elif kind == 'symlink':
290
os.symlink(ie.symlink_target, fullpath)
292
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, ie.symlink_target, e))
294
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
295
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
296
exporters['dir'] = dir_exporter
303
def get_root_name(dest):
304
"""Get just the root name for a tarball.
306
>>> get_root_name('mytar.tar')
308
>>> get_root_name('mytar.tar.bz2')
310
>>> get_root_name('tar.tar.tar.tgz')
312
>>> get_root_name('bzr-0.0.5.tar.gz')
314
>>> get_root_name('a/long/path/mytar.tgz')
316
>>> get_root_name('../parent/../dir/other.tbz2')
319
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
320
dest = os.path.basename(dest)
322
if dest.endswith(end):
323
return dest[:-len(end)]
325
def tar_exporter(tree, dest, root, compression=None):
326
"""Export this tree to a new tar file.
328
`dest` will be created holding the contents of this tree; if it
329
already exists, it will be clobbered, like with "tar -c".
331
from time import time
333
compression = str(compression or '')
335
root = get_root_name(dest)
337
ball = tarfile.open(dest, 'w:' + compression)
338
except tarfile.CompressionError, e:
339
raise BzrError(str(e))
340
mutter('export version %r' % tree)
342
for dp, ie in inv.iter_entries():
343
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
344
item = tarfile.TarInfo(os.path.join(root, dp))
345
# TODO: would be cool to actually set it to the timestamp of the
346
# revision it was last changed
348
if ie.kind == 'directory':
349
item.type = tarfile.DIRTYPE
354
elif ie.kind == 'file':
355
item.type = tarfile.REGTYPE
356
fileobj = tree.get_file(ie.file_id)
357
item.size = _find_file_size(fileobj)
358
if tree.is_executable(ie.file_id):
363
raise BzrError("don't know how to export {%s} of kind %r" %
364
(ie.file_id, ie.kind))
366
ball.addfile(item, fileobj)
368
exporters['tar'] = tar_exporter
370
def tgz_exporter(tree, dest, root):
371
tar_exporter(tree, dest, root, compression='gz')
372
exporters['tgz'] = tgz_exporter
374
def tbz_exporter(tree, dest, root):
375
tar_exporter(tree, dest, root, compression='bz2')
376
exporters['tbz2'] = tbz_exporter
379
def _find_file_size(fileobj):
380
offset = fileobj.tell()
383
size = fileobj.tell()
385
# gzip doesn't accept second argument to seek()
389
nread = len(fileobj.read())
added
removed
bzrlib/tree.py
