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