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.
23
from bzrlib.trace import mutter, note
24
from bzrlib.errors import BzrError
25
from bzrlib.inventory import Inventory
26
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
32
"""Abstract file tree.
34
There are several subclasses:
36
* `WorkingTree` exists as files on disk editable by the user.
38
* `RevisionTree` is a tree as recorded at some point in the past.
42
Trees contain an `Inventory` object, and also know how to retrieve
43
file texts mentioned in the inventory, either from a working
44
directory or from a store.
46
It is possible for trees to contain files that are not described
47
in their inventory or vice versa; for this use `filenames()`.
49
Trees can be compared, etc, regardless of whether they are working
50
trees or versioned trees.
53
def has_filename(self, filename):
54
"""True if the tree has given filename."""
55
raise NotImplementedError()
57
def has_id(self, file_id):
58
return self.inventory.has_id(file_id)
63
return iter(self.inventory)
65
def id2path(self, file_id):
66
return self.inventory.id2path(file_id)
68
def _get_inventory(self):
69
return self._inventory
71
def get_file_by_path(self, path):
72
return self.get_file(self._inventory.path2id(path))
74
inventory = property(_get_inventory,
75
doc="Inventory of this Tree")
77
def _check_retrieved(self, ie, f):
78
fp = fingerprint_file(f)
81
if ie.text_size != None:
82
if ie.text_size != fp['size']:
83
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
84
["inventory expects %d bytes" % ie.text_size,
85
"file is actually %d bytes" % fp['size'],
86
"store is probably damaged/corrupt"])
88
if ie.text_sha1 != fp['sha1']:
89
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
90
["inventory expects %s" % ie.text_sha1,
91
"file is actually %s" % fp['sha1'],
92
"store is probably damaged/corrupt"])
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
98
pumpfile(self.get_file(fileid), sys.stdout)
101
def export(self, dest, format='dir', root=None):
102
"""Export this tree."""
104
exporter = exporters[format]
106
from bzrlib.errors import BzrCommandError
107
raise BzrCommandError("export format %r not supported" % format)
108
exporter(self, dest, root)
112
class RevisionTree(Tree):
113
"""Tree viewing a previous revision.
115
File text can be retrieved from the text store.
117
TODO: Some kind of `__repr__` method, but a good one
118
probably means knowing the branch and revision number,
119
or at least passing a description to the constructor.
122
def __init__(self, store, inv):
124
self._inventory = inv
126
def get_file(self, file_id):
127
ie = self._inventory[file_id]
128
f = self._store[ie.text_id]
129
mutter(" get fileid{%s} from %r" % (file_id, self))
130
self._check_retrieved(ie, f)
133
def get_file_size(self, file_id):
134
return self._inventory[file_id].text_size
136
def get_file_sha1(self, file_id):
137
ie = self._inventory[file_id]
138
if ie.kind == "file":
141
def has_filename(self, filename):
142
return bool(self.inventory.path2id(filename))
144
def list_files(self):
145
# The only files returned by this are those from the version
146
for path, entry in self.inventory.iter_entries():
147
yield path, 'V', entry.kind, entry.file_id
150
class EmptyTree(Tree):
152
self._inventory = Inventory()
154
def has_filename(self, filename):
157
def list_files(self):
158
if False: # just to make it a generator
161
def __contains__(self, file_id):
162
return file_id in self._inventory
166
######################################################################
169
# TODO: Merge these two functions into a single one that can operate
170
# on either a whole tree or a set of files.
172
# TODO: Return the diff in order by filename, not by category or in
173
# random order. Can probably be done by lock-stepping through the
174
# filenames from both trees.
177
def file_status(filename, old_tree, new_tree):
178
"""Return single-letter status, old and new names for a file.
180
The complexity here is in deciding how to represent renames;
181
many complex cases are possible.
183
old_inv = old_tree.inventory
184
new_inv = new_tree.inventory
185
new_id = new_inv.path2id(filename)
186
old_id = old_inv.path2id(filename)
188
if not new_id and not old_id:
189
# easy: doesn't exist in either; not versioned at all
190
if new_tree.is_ignored(filename):
191
return 'I', None, None
193
return '?', None, None
195
# There is now a file of this name, great.
198
# There is no longer a file of this name, but we can describe
199
# what happened to the file that used to have
200
# this name. There are two possibilities: either it was
201
# deleted entirely, or renamed.
203
if new_inv.has_id(old_id):
204
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
206
return 'D', old_inv.id2path(old_id), None
208
# if the file_id is new in this revision, it is added
209
if new_id and not old_inv.has_id(new_id):
212
# if there used to be a file of this name, but that ID has now
213
# disappeared, it is deleted
214
if old_id and not new_inv.has_id(old_id):
221
def find_renames(old_inv, new_inv):
222
for file_id in old_inv:
223
if file_id not in new_inv:
225
old_name = old_inv.id2path(file_id)
226
new_name = new_inv.id2path(file_id)
227
if old_name != new_name:
228
yield (old_name, new_name)
232
######################################################################
235
def dir_exporter(tree, dest, root):
236
"""Export this tree to a new directory.
238
`dest` should not exist, and will be created holding the
239
contents of this tree.
241
TODO: To handle subdirectories we need to create the
244
:note: If the export fails, the destination directory will be
245
left in a half-assed state.
249
mutter('export version %r' % tree)
251
for dp, ie in inv.iter_entries():
253
fullpath = appendpath(dest, dp)
254
if kind == 'directory':
257
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
259
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
260
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
261
exporters['dir'] = dir_exporter
268
def get_root_name(dest):
269
"""Get just the root name for a tarball.
271
>>> get_root_name('mytar.tar')
273
>>> get_root_name('mytar.tar.bz2')
275
>>> get_root_name('tar.tar.tar.tgz')
277
>>> get_root_name('bzr-0.0.5.tar.gz')
279
>>> get_root_name('a/long/path/mytar.tgz')
281
>>> get_root_name('../parent/../dir/other.tbz2')
284
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
285
dest = os.path.basename(dest)
287
if dest.endswith(end):
288
return dest[:-len(end)]
290
def tar_exporter(tree, dest, root, compression=None):
291
"""Export this tree to a new tar file.
293
`dest` will be created holding the contents of this tree; if it
294
already exists, it will be clobbered, like with "tar -c".
296
from time import time
298
compression = str(compression or '')
300
root = get_root_name(dest)
302
ball = tarfile.open(dest, 'w:' + compression)
303
except tarfile.CompressionError, e:
304
raise BzrError(str(e))
305
mutter('export version %r' % tree)
307
for dp, ie in inv.iter_entries():
308
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
309
item = tarfile.TarInfo(os.path.join(root, dp))
310
# TODO: would be cool to actually set it to the timestamp of the
311
# revision it was last changed
313
if ie.kind == 'directory':
314
item.type = tarfile.DIRTYPE
319
elif ie.kind == 'file':
320
item.type = tarfile.REGTYPE
321
fileobj = tree.get_file(ie.file_id)
322
item.size = _find_file_size(fileobj)
325
raise BzrError("don't know how to export {%s} of kind %r" %
326
(ie.file_id, ie.kind))
328
ball.addfile(item, fileobj)
330
exporters['tar'] = tar_exporter
332
def tgz_exporter(tree, dest, root):
333
tar_exporter(tree, dest, root, compression='gz')
334
exporters['tgz'] = tgz_exporter
336
def tbz_exporter(tree, dest, root):
337
tar_exporter(tree, dest, root, compression='bz2')
338
exporters['tbz2'] = tbz_exporter
341
def _find_file_size(fileobj):
342
offset = fileobj.tell()
345
size = fileobj.tell()
347
# gzip doesn't accept second argument to seek()
351
nread = len(fileobj.read())
added
removed
bzrlib/tree.py
