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.
20
from osutils import pumpfile, appendpath, fingerprint_file
23
from bzrlib.trace import mutter, note
24
from bzrlib.errors import BzrError
31
"""Abstract file tree.
33
There are several subclasses:
35
* `WorkingTree` exists as files on disk editable by the user.
37
* `RevisionTree` is a tree as recorded at some point in the past.
41
Trees contain an `Inventory` object, and also know how to retrieve
42
file texts mentioned in the inventory, either from a working
43
directory or from a store.
45
It is possible for trees to contain files that are not described
46
in their inventory or vice versa; for this use `filenames()`.
48
Trees can be compared, etc, regardless of whether they are working
49
trees or versioned trees.
52
def has_filename(self, filename):
53
"""True if the tree has given filename."""
54
raise NotImplementedError()
56
def has_id(self, file_id):
57
return self.inventory.has_id(file_id)
62
return iter(self.inventory)
64
def id2path(self, file_id):
65
return self.inventory.id2path(file_id)
67
def _get_inventory(self):
68
return self._inventory
70
inventory = property(_get_inventory,
71
doc="Inventory of this Tree")
73
def _check_retrieved(self, ie, f):
74
fp = fingerprint_file(f)
77
if ie.text_size != None:
78
if ie.text_size != fp['size']:
79
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
80
["inventory expects %d bytes" % ie.text_size,
81
"file is actually %d bytes" % fp['size'],
82
"store is probably damaged/corrupt"])
84
if ie.text_sha1 != fp['sha1']:
85
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
86
["inventory expects %s" % ie.text_sha1,
87
"file is actually %s" % fp['sha1'],
88
"store is probably damaged/corrupt"])
91
def print_file(self, fileid):
92
"""Print file with id `fileid` 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)
108
class RevisionTree(Tree):
109
"""Tree viewing a previous revision.
111
File text can be retrieved from the text store.
113
TODO: Some kind of `__repr__` method, but a good one
114
probably means knowing the branch and revision number,
115
or at least passing a description to the constructor.
118
def __init__(self, store, inv):
120
self._inventory = inv
122
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)
129
def get_file_size(self, file_id):
130
return self._inventory[file_id].text_size
132
def get_file_sha1(self, file_id):
133
ie = self._inventory[file_id]
134
if ie.kind == "file":
137
def has_filename(self, filename):
138
return bool(self.inventory.path2id(filename))
140
def list_files(self):
141
# The only files returned by this are those from the version
142
for path, entry in self.inventory.iter_entries():
143
yield path, 'V', entry.kind, entry.file_id
146
class EmptyTree(Tree):
147
def __init__(self, root_id):
148
from bzrlib.inventory import Inventory
149
self._inventory = Inventory(root_id)
151
def has_filename(self, filename):
154
def list_files(self):
155
if False: # just to make it a generator
158
def __contains__(self, file_id):
159
return file_id in self._inventory
161
def get_file_sha1(self, file_id):
162
assert self._inventory[file_id].kind == "root_directory"
168
######################################################################
171
# TODO: Merge these two functions into a single one that can operate
172
# on either a whole tree or a set of files.
174
# TODO: Return the diff in order by filename, not by category or in
175
# random order. Can probably be done by lock-stepping through the
176
# filenames from both trees.
179
def file_status(filename, old_tree, new_tree):
180
"""Return single-letter status, old and new names for a file.
182
The complexity here is in deciding how to represent renames;
183
many complex cases are possible.
185
old_inv = old_tree.inventory
186
new_inv = new_tree.inventory
187
new_id = new_inv.path2id(filename)
188
old_id = old_inv.path2id(filename)
190
if not new_id and not old_id:
191
# easy: doesn't exist in either; not versioned at all
192
if new_tree.is_ignored(filename):
193
return 'I', None, None
195
return '?', None, None
197
# There is now a file of this name, great.
200
# There is no longer a file of this name, but we can describe
201
# what happened to the file that used to have
202
# this name. There are two possibilities: either it was
203
# deleted entirely, or renamed.
205
if new_inv.has_id(old_id):
206
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
208
return 'D', old_inv.id2path(old_id), None
210
# if the file_id is new in this revision, it is added
211
if new_id and not old_inv.has_id(new_id):
214
# if there used to be a file of this name, but that ID has now
215
# disappeared, it is deleted
216
if old_id and not new_inv.has_id(old_id):
223
def find_renames(old_inv, new_inv):
224
for file_id in old_inv:
225
if file_id not in new_inv:
227
old_name = old_inv.id2path(file_id)
228
new_name = new_inv.id2path(file_id)
229
if old_name != new_name:
230
yield (old_name, new_name)
234
######################################################################
237
def dir_exporter(tree, dest, root):
238
"""Export this tree to a new directory.
240
`dest` should not exist, and will be created holding the
241
contents of this tree.
243
TODO: To handle subdirectories we need to create the
246
:note: If the export fails, the destination directory will be
247
left in a half-assed state.
251
mutter('export version %r' % tree)
253
for dp, ie in inv.iter_entries():
255
fullpath = appendpath(dest, dp)
256
if kind == 'directory':
259
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
261
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
262
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
263
exporters['dir'] = dir_exporter
270
def get_root_name(dest):
271
"""Get just the root name for a tarball.
273
>>> get_root_name('mytar.tar')
275
>>> get_root_name('mytar.tar.bz2')
277
>>> get_root_name('tar.tar.tar.tgz')
279
>>> get_root_name('bzr-0.0.5.tar.gz')
281
>>> get_root_name('a/long/path/mytar.tgz')
283
>>> get_root_name('../parent/../dir/other.tbz2')
286
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
287
dest = os.path.basename(dest)
289
if dest.endswith(end):
290
return dest[:-len(end)]
292
def tar_exporter(tree, dest, root, compression=None):
293
"""Export this tree to a new tar file.
295
`dest` will be created holding the contents of this tree; if it
296
already exists, it will be clobbered, like with "tar -c".
298
from time import time
300
compression = str(compression or '')
302
root = get_root_name(dest)
304
ball = tarfile.open(dest, 'w:' + compression)
305
except tarfile.CompressionError, e:
306
raise BzrError(str(e))
307
mutter('export version %r' % tree)
309
for dp, ie in inv.iter_entries():
310
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
311
item = tarfile.TarInfo(os.path.join(root, dp))
312
# TODO: would be cool to actually set it to the timestamp of the
313
# revision it was last changed
315
if ie.kind == 'directory':
316
item.type = tarfile.DIRTYPE
321
elif ie.kind == 'file':
322
item.type = tarfile.REGTYPE
323
fileobj = tree.get_file(ie.file_id)
324
item.size = _find_file_size(fileobj)
327
raise BzrError("don't know how to export {%s} of kind %r" %
328
(ie.file_id, ie.kind))
330
ball.addfile(item, fileobj)
332
exporters['tar'] = tar_exporter
334
def tgz_exporter(tree, dest, root):
335
tar_exporter(tree, dest, root, compression='gz')
336
exporters['tgz'] = tgz_exporter
338
def tbz_exporter(tree, dest, root):
339
tar_exporter(tree, dest, root, compression='bz2')
340
exporters['tbz2'] = tbz_exporter
343
def _find_file_size(fileobj):
344
offset = fileobj.tell()
347
size = fileobj.tell()
349
# gzip doesn't accept second argument to seek()
353
nread = len(fileobj.read())
added
removed
bzrlib/tree.py
