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)
61
def has_or_had_id(self, file_id):
62
if file_id == self.inventory.root.file_id:
64
return self.inventory.has_id(file_id)
69
return iter(self.inventory)
71
def id2path(self, file_id):
72
return self.inventory.id2path(file_id)
74
def kind(self, file_id):
75
raise NotImplementedError("subclasses must implement kind")
77
def _get_inventory(self):
78
return self._inventory
80
def get_file_by_path(self, path):
81
return self.get_file(self._inventory.path2id(path))
83
inventory = property(_get_inventory,
84
doc="Inventory of this Tree")
86
def _check_retrieved(self, ie, f):
89
fp = fingerprint_file(f)
92
if ie.text_size != None:
93
if ie.text_size != fp['size']:
94
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
95
["inventory expects %d bytes" % ie.text_size,
96
"file is actually %d bytes" % fp['size'],
97
"store is probably damaged/corrupt"])
99
if ie.text_sha1 != fp['sha1']:
100
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
101
["inventory expects %s" % ie.text_sha1,
102
"file is actually %s" % fp['sha1'],
103
"store is probably damaged/corrupt"])
106
def print_file(self, file_id):
107
"""Print file with id `file_id` to stdout."""
109
sys.stdout.write(self.get_file_text(file_id))
112
def export(self, dest, format='dir', root=None):
113
"""Export this tree."""
115
exporter = exporters[format]
117
from bzrlib.errors import BzrCommandError
118
raise BzrCommandError("export format %r not supported" % format)
119
exporter(self, dest, root)
123
class RevisionTree(Tree):
124
"""Tree viewing a previous revision.
126
File text can be retrieved from the text store.
128
TODO: Some kind of `__repr__` method, but a good one
129
probably means knowing the branch and revision number,
130
or at least passing a description to the constructor.
133
def __init__(self, weave_store, inv, revision_id):
134
self._weave_store = weave_store
135
self._inventory = inv
136
self._revision_id = revision_id
138
def get_weave(self, file_id):
139
# FIXME: RevisionTree should be given a branch
140
# not a store, or the store should know the branch.
141
import bzrlib.transactions as transactions
142
return self._weave_store.get_weave(file_id,
143
transactions.PassThroughTransaction())
146
def get_file_lines(self, file_id):
147
ie = self._inventory[file_id]
148
weave = self.get_weave(file_id)
149
return weave.get(ie.revision)
152
def get_file_text(self, file_id):
153
return ''.join(self.get_file_lines(file_id))
156
def get_file(self, file_id):
157
return StringIO(self.get_file_text(file_id))
159
def get_file_size(self, file_id):
160
return self._inventory[file_id].text_size
162
def get_file_sha1(self, file_id):
163
ie = self._inventory[file_id]
164
if ie.kind == "file":
167
def is_executable(self, file_id):
168
ie = self._inventory[file_id]
169
if ie.kind != "file":
171
return self._inventory[file_id].executable
173
def has_filename(self, filename):
174
return bool(self.inventory.path2id(filename))
176
def list_files(self):
177
# The only files returned by this are those from the version
178
for path, entry in self.inventory.iter_entries():
179
yield path, 'V', entry.kind, entry.file_id, entry
181
def get_symlink_target(self, file_id):
182
ie = self._inventory[file_id]
183
return ie.symlink_target;
185
def kind(self, file_id):
186
return self._inventory[file_id].kind
189
class EmptyTree(Tree):
191
self._inventory = Inventory()
193
def get_symlink_target(self, file_id):
196
def has_filename(self, filename):
199
def kind(self, file_id):
200
assert self._inventory[file_id].kind == "root_directory"
201
return "root_directory"
203
def list_files(self):
206
def __contains__(self, file_id):
207
return file_id in self._inventory
209
def get_file_sha1(self, file_id):
210
assert self._inventory[file_id].kind == "root_directory"
214
######################################################################
217
# TODO: Merge these two functions into a single one that can operate
218
# on either a whole tree or a set of files.
220
# TODO: Return the diff in order by filename, not by category or in
221
# random order. Can probably be done by lock-stepping through the
222
# filenames from both trees.
225
def file_status(filename, old_tree, new_tree):
226
"""Return single-letter status, old and new names for a file.
228
The complexity here is in deciding how to represent renames;
229
many complex cases are possible.
231
old_inv = old_tree.inventory
232
new_inv = new_tree.inventory
233
new_id = new_inv.path2id(filename)
234
old_id = old_inv.path2id(filename)
236
if not new_id and not old_id:
237
# easy: doesn't exist in either; not versioned at all
238
if new_tree.is_ignored(filename):
239
return 'I', None, None
241
return '?', None, None
243
# There is now a file of this name, great.
246
# There is no longer a file of this name, but we can describe
247
# what happened to the file that used to have
248
# this name. There are two possibilities: either it was
249
# deleted entirely, or renamed.
251
if new_inv.has_id(old_id):
252
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
254
return 'D', old_inv.id2path(old_id), None
256
# if the file_id is new in this revision, it is added
257
if new_id and not old_inv.has_id(new_id):
260
# if there used to be a file of this name, but that ID has now
261
# disappeared, it is deleted
262
if old_id and not new_inv.has_id(old_id):
269
def find_renames(old_inv, new_inv):
270
for file_id in old_inv:
271
if file_id not in new_inv:
273
old_name = old_inv.id2path(file_id)
274
new_name = new_inv.id2path(file_id)
275
if old_name != new_name:
276
yield (old_name, new_name)
280
######################################################################
283
def dir_exporter(tree, dest, root):
284
"""Export this tree to a new directory.
286
`dest` should not exist, and will be created holding the
287
contents of this tree.
289
TODO: To handle subdirectories we need to create the
292
:note: If the export fails, the destination directory will be
293
left in a half-assed state.
297
mutter('export version %r' % tree)
299
for dp, ie in inv.iter_entries():
300
ie.put_on_disk(dest, dp, tree)
302
exporters['dir'] = dir_exporter
309
def get_root_name(dest):
310
"""Get just the root name for a tarball.
312
>>> get_root_name('mytar.tar')
314
>>> get_root_name('mytar.tar.bz2')
316
>>> get_root_name('tar.tar.tar.tgz')
318
>>> get_root_name('bzr-0.0.5.tar.gz')
320
>>> get_root_name('a/long/path/mytar.tgz')
322
>>> get_root_name('../parent/../dir/other.tbz2')
325
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
326
dest = os.path.basename(dest)
328
if dest.endswith(end):
329
return dest[:-len(end)]
331
def tar_exporter(tree, dest, root, compression=None):
332
"""Export this tree to a new tar file.
334
`dest` will be created holding the contents of this tree; if it
335
already exists, it will be clobbered, like with "tar -c".
337
from time import time
339
compression = str(compression or '')
341
root = get_root_name(dest)
343
ball = tarfile.open(dest, 'w:' + compression)
344
except tarfile.CompressionError, e:
345
raise BzrError(str(e))
346
mutter('export version %r' % tree)
348
for dp, ie in inv.iter_entries():
349
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
350
item, fileobj = ie.get_tar_item(root, dp, now, tree)
351
ball.addfile(item, fileobj)
354
exporters['tar'] = tar_exporter
356
def tgz_exporter(tree, dest, root):
357
tar_exporter(tree, dest, root, compression='gz')
358
exporters['tgz'] = tgz_exporter
360
def tbz_exporter(tree, dest, root):
361
tar_exporter(tree, dest, root, compression='bz2')
362
exporters['tbz2'] = tbz_exporter
added
removed
bzrlib/tree.py
