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
def get_file_by_path(self, path):
71
return self.get_file(self._inventory.path2id(path))
73
inventory = property(_get_inventory,
74
doc="Inventory of this Tree")
76
def _check_retrieved(self, ie, f):
77
fp = fingerprint_file(f)
80
if ie.text_size != None:
81
if ie.text_size != fp['size']:
82
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
83
["inventory expects %d bytes" % ie.text_size,
84
"file is actually %d bytes" % fp['size'],
85
"store is probably damaged/corrupt"])
87
if ie.text_sha1 != fp['sha1']:
88
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
89
["inventory expects %s" % ie.text_sha1,
90
"file is actually %s" % fp['sha1'],
91
"store is probably damaged/corrupt"])
94
def print_file(self, fileid):
95
"""Print file with id `fileid` to stdout."""
97
pumpfile(self.get_file(fileid), sys.stdout)
100
def export(self, dest, format='dir', root=None):
101
"""Export this tree."""
103
exporter = exporters[format]
105
from bzrlib.errors import BzrCommandError
106
raise BzrCommandError("export format %r not supported" % format)
107
exporter(self, dest, root)
111
class RevisionTree(Tree):
112
"""Tree viewing a previous revision.
114
File text can be retrieved from the text store.
116
TODO: Some kind of `__repr__` method, but a good one
117
probably means knowing the branch and revision number,
118
or at least passing a description to the constructor.
121
def __init__(self, store, inv):
123
self._inventory = inv
125
def get_file(self, file_id):
126
ie = self._inventory[file_id]
127
f = self._store[ie.text_id]
128
mutter(" get fileid{%s} from %r" % (file_id, self))
129
self._check_retrieved(ie, f)
132
def get_file_size(self, file_id):
133
return self._inventory[file_id].text_size
135
def get_file_sha1(self, file_id):
136
ie = self._inventory[file_id]
139
def has_filename(self, filename):
140
return bool(self.inventory.path2id(filename))
142
def list_files(self):
143
# The only files returned by this are those from the version
144
for path, entry in self.inventory.iter_entries():
145
yield path, 'V', entry.kind, entry.file_id
148
class EmptyTree(Tree):
149
def __init__(self, root_id):
150
from bzrlib.inventory import Inventory
151
self._inventory = Inventory(root_id)
153
def has_filename(self, filename):
156
def list_files(self):
157
if False: # just to make it a generator
162
######################################################################
165
# TODO: Merge these two functions into a single one that can operate
166
# on either a whole tree or a set of files.
168
# TODO: Return the diff in order by filename, not by category or in
169
# random order. Can probably be done by lock-stepping through the
170
# filenames from both trees.
173
def file_status(filename, old_tree, new_tree):
174
"""Return single-letter status, old and new names for a file.
176
The complexity here is in deciding how to represent renames;
177
many complex cases are possible.
179
old_inv = old_tree.inventory
180
new_inv = new_tree.inventory
181
new_id = new_inv.path2id(filename)
182
old_id = old_inv.path2id(filename)
184
if not new_id and not old_id:
185
# easy: doesn't exist in either; not versioned at all
186
if new_tree.is_ignored(filename):
187
return 'I', None, None
189
return '?', None, None
191
# There is now a file of this name, great.
194
# There is no longer a file of this name, but we can describe
195
# what happened to the file that used to have
196
# this name. There are two possibilities: either it was
197
# deleted entirely, or renamed.
199
if new_inv.has_id(old_id):
200
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
202
return 'D', old_inv.id2path(old_id), None
204
# if the file_id is new in this revision, it is added
205
if new_id and not old_inv.has_id(new_id):
208
# if there used to be a file of this name, but that ID has now
209
# disappeared, it is deleted
210
if old_id and not new_inv.has_id(old_id):
217
def find_renames(old_inv, new_inv):
218
for file_id in old_inv:
219
if file_id not in new_inv:
221
old_name = old_inv.id2path(file_id)
222
new_name = new_inv.id2path(file_id)
223
if old_name != new_name:
224
yield (old_name, new_name)
228
######################################################################
231
def dir_exporter(tree, dest, root):
232
"""Export this tree to a new directory.
234
`dest` should not exist, and will be created holding the
235
contents of this tree.
237
TODO: To handle subdirectories we need to create the
240
:note: If the export fails, the destination directory will be
241
left in a half-assed state.
245
mutter('export version %r' % tree)
247
for dp, ie in inv.iter_entries():
249
fullpath = appendpath(dest, dp)
250
if kind == 'directory':
253
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
255
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
256
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
257
exporters['dir'] = dir_exporter
264
def get_root_name(dest):
265
"""Get just the root name for a tarball.
267
>>> get_root_name('mytar.tar')
269
>>> get_root_name('mytar.tar.bz2')
271
>>> get_root_name('tar.tar.tar.tgz')
273
>>> get_root_name('bzr-0.0.5.tar.gz')
275
>>> get_root_name('a/long/path/mytar.tgz')
277
>>> get_root_name('../parent/../dir/other.tbz2')
280
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
281
dest = os.path.basename(dest)
283
if dest.endswith(end):
284
return dest[:-len(end)]
286
def tar_exporter(tree, dest, root, compression=None):
287
"""Export this tree to a new tar file.
289
`dest` will be created holding the contents of this tree; if it
290
already exists, it will be clobbered, like with "tar -c".
292
from time import time
294
compression = str(compression or '')
296
root = get_root_name(dest)
298
ball = tarfile.open(dest, 'w:' + compression)
299
except tarfile.CompressionError, e:
300
raise BzrError(str(e))
301
mutter('export version %r' % tree)
303
for dp, ie in inv.iter_entries():
304
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
305
item = tarfile.TarInfo(os.path.join(root, dp))
306
# TODO: would be cool to actually set it to the timestamp of the
307
# revision it was last changed
309
if ie.kind == 'directory':
310
item.type = tarfile.DIRTYPE
315
elif ie.kind == 'file':
316
item.type = tarfile.REGTYPE
317
fileobj = tree.get_file(ie.file_id)
318
item.size = _find_file_size(fileobj)
321
raise BzrError("don't know how to export {%s} of kind %r" %
322
(ie.file_id, ie.kind))
324
ball.addfile(item, fileobj)
326
exporters['tar'] = tar_exporter
328
def tgz_exporter(tree, dest, root):
329
tar_exporter(tree, dest, root, compression='gz')
330
exporters['tgz'] = tgz_exporter
332
def tbz_exporter(tree, dest, root):
333
tar_exporter(tree, dest, root, compression='bz2')
334
exporters['tbz2'] = tbz_exporter
337
def _find_file_size(fileobj):
338
offset = fileobj.tell()
341
size = fileobj.tell()
343
# gzip doesn't accept second argument to seek()
347
nread = len(fileobj.read())
added
removed
bzrlib/tree.py
