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 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
# FIXME: RevisionTree should be given a branch
132
# not a store, or the store should know the branch.
133
import bzrlib.transactions as transactions
134
return self._weave_store.get_weave(file_id,
135
transactions.PassThroughTransaction())
138
def get_file_lines(self, file_id):
139
ie = self._inventory[file_id]
140
weave = self.get_weave(file_id)
141
return weave.get(ie.revision)
144
def get_file_text(self, file_id):
145
return ''.join(self.get_file_lines(file_id))
148
def get_file(self, file_id):
149
return StringIO(self.get_file_text(file_id))
151
def get_file_size(self, file_id):
152
return self._inventory[file_id].text_size
154
def get_file_sha1(self, file_id):
155
ie = self._inventory[file_id]
156
if ie.kind == "file":
159
def is_executable(self, file_id):
160
return self._inventory[file_id].executable
162
def has_filename(self, filename):
163
return bool(self.inventory.path2id(filename))
165
def list_files(self):
166
# The only files returned by this are those from the version
167
for path, entry in self.inventory.iter_entries():
168
yield path, 'V', entry.kind, entry.file_id, entry
170
def get_symlink_target(self, file_id):
171
ie = self._inventory[file_id]
172
return ie.symlink_target;
175
class EmptyTree(Tree):
177
self._inventory = Inventory()
179
def get_symlink_target(self, file_id):
182
def has_filename(self, filename):
185
def list_files(self):
188
def __contains__(self, file_id):
189
return file_id in self._inventory
191
def get_file_sha1(self, file_id):
192
assert self._inventory[file_id].kind == "root_directory"
196
######################################################################
199
# TODO: Merge these two functions into a single one that can operate
200
# on either a whole tree or a set of files.
202
# TODO: Return the diff in order by filename, not by category or in
203
# random order. Can probably be done by lock-stepping through the
204
# filenames from both trees.
207
def file_status(filename, old_tree, new_tree):
208
"""Return single-letter status, old and new names for a file.
210
The complexity here is in deciding how to represent renames;
211
many complex cases are possible.
213
old_inv = old_tree.inventory
214
new_inv = new_tree.inventory
215
new_id = new_inv.path2id(filename)
216
old_id = old_inv.path2id(filename)
218
if not new_id and not old_id:
219
# easy: doesn't exist in either; not versioned at all
220
if new_tree.is_ignored(filename):
221
return 'I', None, None
223
return '?', None, None
225
# There is now a file of this name, great.
228
# There is no longer a file of this name, but we can describe
229
# what happened to the file that used to have
230
# this name. There are two possibilities: either it was
231
# deleted entirely, or renamed.
233
if new_inv.has_id(old_id):
234
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
236
return 'D', old_inv.id2path(old_id), None
238
# if the file_id is new in this revision, it is added
239
if new_id and not old_inv.has_id(new_id):
242
# if there used to be a file of this name, but that ID has now
243
# disappeared, it is deleted
244
if old_id and not new_inv.has_id(old_id):
251
def find_renames(old_inv, new_inv):
252
for file_id in old_inv:
253
if file_id not in new_inv:
255
old_name = old_inv.id2path(file_id)
256
new_name = new_inv.id2path(file_id)
257
if old_name != new_name:
258
yield (old_name, new_name)
262
######################################################################
265
def dir_exporter(tree, dest, root):
266
"""Export this tree to a new directory.
268
`dest` should not exist, and will be created holding the
269
contents of this tree.
271
TODO: To handle subdirectories we need to create the
274
:note: If the export fails, the destination directory will be
275
left in a half-assed state.
279
mutter('export version %r' % tree)
281
for dp, ie in inv.iter_entries():
282
ie.put_on_disk(dest, dp, tree)
284
exporters['dir'] = dir_exporter
291
def get_root_name(dest):
292
"""Get just the root name for a tarball.
294
>>> get_root_name('mytar.tar')
296
>>> get_root_name('mytar.tar.bz2')
298
>>> get_root_name('tar.tar.tar.tgz')
300
>>> get_root_name('bzr-0.0.5.tar.gz')
302
>>> get_root_name('a/long/path/mytar.tgz')
304
>>> get_root_name('../parent/../dir/other.tbz2')
307
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
308
dest = os.path.basename(dest)
310
if dest.endswith(end):
311
return dest[:-len(end)]
313
def tar_exporter(tree, dest, root, compression=None):
314
"""Export this tree to a new tar file.
316
`dest` will be created holding the contents of this tree; if it
317
already exists, it will be clobbered, like with "tar -c".
319
from time import time
321
compression = str(compression or '')
323
root = get_root_name(dest)
325
ball = tarfile.open(dest, 'w:' + compression)
326
except tarfile.CompressionError, e:
327
raise BzrError(str(e))
328
mutter('export version %r' % tree)
330
for dp, ie in inv.iter_entries():
331
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
332
item, fileobj = ie.get_tar_item(root, dp, now, tree)
333
ball.addfile(item, fileobj)
336
exporters['tar'] = tar_exporter
338
def tgz_exporter(tree, dest, root):
339
tar_exporter(tree, dest, root, compression='gz')
340
exporters['tgz'] = tgz_exporter
342
def tbz_exporter(tree, dest, root):
343
tar_exporter(tree, dest, root, compression='bz2')
344
exporters['tbz2'] = tbz_exporter
added
removed
bzrlib/tree.py
