1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
# Copyright (C) 2005 Canonical Ltd
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Tree classes, representing directory at point in time.
"""
import os
import bzrlib
from bzrlib.trace import mutter, note
from bzrlib.errors import BzrError
from bzrlib.inventory import Inventory
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
exporters = {}
class Tree(object):
"""Abstract file tree.
There are several subclasses:
* `WorkingTree` exists as files on disk editable by the user.
* `RevisionTree` is a tree as recorded at some point in the past.
* `EmptyTree`
Trees contain an `Inventory` object, and also know how to retrieve
file texts mentioned in the inventory, either from a working
directory or from a store.
It is possible for trees to contain files that are not described
in their inventory or vice versa; for this use `filenames()`.
Trees can be compared, etc, regardless of whether they are working
trees or versioned trees.
"""
def has_filename(self, filename):
"""True if the tree has given filename."""
raise NotImplementedError()
def has_id(self, file_id):
return self.inventory.has_id(file_id)
__contains__ = has_id
def __iter__(self):
return iter(self.inventory)
def id2path(self, file_id):
return self.inventory.id2path(file_id)
def _get_inventory(self):
return self._inventory
def get_file_by_path(self, path):
return self.get_file(self._inventory.path2id(path))
inventory = property(_get_inventory,
doc="Inventory of this Tree")
def _check_retrieved(self, ie, f):
fp = fingerprint_file(f)
f.seek(0)
if ie.text_size != None:
if ie.text_size != fp['size']:
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
["inventory expects %d bytes" % ie.text_size,
"file is actually %d bytes" % fp['size'],
"store is probably damaged/corrupt"])
if ie.text_sha1 != fp['sha1']:
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
["inventory expects %s" % ie.text_sha1,
"file is actually %s" % fp['sha1'],
"store is probably damaged/corrupt"])
def print_file(self, fileid):
"""Print file with id `fileid` to stdout."""
import sys
pumpfile(self.get_file(fileid), sys.stdout)
def export(self, dest, format='dir', root=None):
"""Export this tree."""
try:
exporter = exporters[format]
except KeyError:
from bzrlib.errors import BzrCommandError
raise BzrCommandError("export format %r not supported" % format)
exporter(self, dest, root)
class RevisionTree(Tree):
"""Tree viewing a previous revision.
File text can be retrieved from the text store.
TODO: Some kind of `__repr__` method, but a good one
probably means knowing the branch and revision number,
or at least passing a description to the constructor.
"""
def __init__(self, store, inv):
self._store = store
self._inventory = inv
def get_file(self, file_id):
ie = self._inventory[file_id]
f = self._store[ie.text_id]
mutter(" get fileid{%s} from %r" % (file_id, self))
self._check_retrieved(ie, f)
return f
def get_file_size(self, file_id):
return self._inventory[file_id].text_size
def get_file_sha1(self, file_id):
ie = self._inventory[file_id]
if ie.kind == "file":
return ie.text_sha1
def has_filename(self, filename):
return bool(self.inventory.path2id(filename))
def list_files(self):
# The only files returned by this are those from the version
for path, entry in self.inventory.iter_entries():
yield path, 'V', entry.kind, entry.file_id
class EmptyTree(Tree):
def __init__(self):
self._inventory = Inventory()
def has_filename(self, filename):
return False
def list_files(self):
if False: # just to make it a generator
yield None
def __contains__(self, file_id):
return file_id in self._inventory
def get_file_sha1(self, file_id):
assert self._inventory[file_id].kind == "root_directory"
return None
######################################################################
# diff
# TODO: Merge these two functions into a single one that can operate
# on either a whole tree or a set of files.
# TODO: Return the diff in order by filename, not by category or in
# random order. Can probably be done by lock-stepping through the
# filenames from both trees.
def file_status(filename, old_tree, new_tree):
"""Return single-letter status, old and new names for a file.
The complexity here is in deciding how to represent renames;
many complex cases are possible.
"""
old_inv = old_tree.inventory
new_inv = new_tree.inventory
new_id = new_inv.path2id(filename)
old_id = old_inv.path2id(filename)
if not new_id and not old_id:
# easy: doesn't exist in either; not versioned at all
if new_tree.is_ignored(filename):
return 'I', None, None
else:
return '?', None, None
elif new_id:
# There is now a file of this name, great.
pass
else:
# There is no longer a file of this name, but we can describe
# what happened to the file that used to have
# this name. There are two possibilities: either it was
# deleted entirely, or renamed.
assert old_id
if new_inv.has_id(old_id):
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
else:
return 'D', old_inv.id2path(old_id), None
# if the file_id is new in this revision, it is added
if new_id and not old_inv.has_id(new_id):
return 'A'
# if there used to be a file of this name, but that ID has now
# disappeared, it is deleted
if old_id and not new_inv.has_id(old_id):
return 'D'
return 'wtf?'
def find_renames(old_inv, new_inv):
for file_id in old_inv:
if file_id not in new_inv:
continue
old_name = old_inv.id2path(file_id)
new_name = new_inv.id2path(file_id)
if old_name != new_name:
yield (old_name, new_name)
######################################################################
# export
def dir_exporter(tree, dest, root):
"""Export this tree to a new directory.
`dest` should not exist, and will be created holding the
contents of this tree.
TODO: To handle subdirectories we need to create the
directories first.
:note: If the export fails, the destination directory will be
left in a half-assed state.
"""
import os
os.mkdir(dest)
mutter('export version %r' % tree)
inv = tree.inventory
for dp, ie in inv.iter_entries():
kind = ie.kind
fullpath = appendpath(dest, dp)
if kind == 'directory':
os.mkdir(fullpath)
elif kind == 'file':
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
else:
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
exporters['dir'] = dir_exporter
try:
import tarfile
except ImportError:
pass
else:
def get_root_name(dest):
"""Get just the root name for a tarball.
>>> get_root_name('mytar.tar')
'mytar'
>>> get_root_name('mytar.tar.bz2')
'mytar'
>>> get_root_name('tar.tar.tar.tgz')
'tar.tar.tar'
>>> get_root_name('bzr-0.0.5.tar.gz')
'bzr-0.0.5'
>>> get_root_name('a/long/path/mytar.tgz')
'mytar'
>>> get_root_name('../parent/../dir/other.tbz2')
'other'
"""
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
dest = os.path.basename(dest)
for end in endings:
if dest.endswith(end):
return dest[:-len(end)]
def tar_exporter(tree, dest, root, compression=None):
"""Export this tree to a new tar file.
`dest` will be created holding the contents of this tree; if it
already exists, it will be clobbered, like with "tar -c".
"""
from time import time
now = time()
compression = str(compression or '')
if root is None:
root = get_root_name(dest)
try:
ball = tarfile.open(dest, 'w:' + compression)
except tarfile.CompressionError, e:
raise BzrError(str(e))
mutter('export version %r' % tree)
inv = tree.inventory
for dp, ie in inv.iter_entries():
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
item = tarfile.TarInfo(os.path.join(root, dp))
# TODO: would be cool to actually set it to the timestamp of the
# revision it was last changed
item.mtime = now
if ie.kind == 'directory':
item.type = tarfile.DIRTYPE
fileobj = None
item.name += '/'
item.size = 0
item.mode = 0755
elif ie.kind == 'file':
item.type = tarfile.REGTYPE
fileobj = tree.get_file(ie.file_id)
item.size = _find_file_size(fileobj)
item.mode = 0644
else:
raise BzrError("don't know how to export {%s} of kind %r" %
(ie.file_id, ie.kind))
ball.addfile(item, fileobj)
ball.close()
exporters['tar'] = tar_exporter
def tgz_exporter(tree, dest, root):
tar_exporter(tree, dest, root, compression='gz')
exporters['tgz'] = tgz_exporter
def tbz_exporter(tree, dest, root):
tar_exporter(tree, dest, root, compression='bz2')
exporters['tbz2'] = tbz_exporter
def _find_file_size(fileobj):
offset = fileobj.tell()
try:
fileobj.seek(0, 2)
size = fileobj.tell()
except TypeError:
# gzip doesn't accept second argument to seek()
fileobj.seek(0)
size = 0
while True:
nread = len(fileobj.read())
if nread == 0:
break
size += nread
fileobj.seek(offset)
return size
|