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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
|
# 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
from cStringIO import StringIO
from warnings import warn
import bzrlib
from bzrlib.errors import BzrError, BzrCheckError
from bzrlib import errors
from bzrlib.inventory import Inventory
from bzrlib.osutils import fingerprint_file
import bzrlib.revision
from bzrlib.trace import mutter, note
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.
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 conflicts(self):
"""Get a list of the conflicts in the tree.
Each conflict is an instance of bzrlib.conflicts.Conflict.
"""
return []
def get_parent_ids(self):
"""Get the parent ids for this tree.
:return: a list of parent ids. [] is returned to indicate
a tree with no parents.
:raises: BzrError if the parents are not known.
"""
raise NotImplementedError(self.get_parent_ids)
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)
def has_or_had_id(self, file_id):
if file_id == self.inventory.root.file_id:
return True
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 kind(self, file_id):
raise NotImplementedError("subclasses must implement kind")
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):
if not __debug__:
return
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, file_id):
"""Print file with id `file_id` to stdout."""
import sys
sys.stdout.write(self.get_file_text(file_id))
def lock_read(self):
pass
def unknowns(self):
"""What files are present in this tree and unknown.
:return: an iterator over the unknown files.
"""
return iter([])
def unlock(self):
pass
def filter_unversioned_files(self, paths):
"""Filter out paths that are not versioned.
:return: set of paths.
"""
# NB: we specifically *don't* call self.has_filename, because for
# WorkingTrees that can indicate files that exist on disk but that
# are not versioned.
pred = self.inventory.has_filename
return set((p for p in paths if not pred(p)))
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, branch, inv, revision_id):
# for compatability the 'branch' parameter has not been renamed to
# repository at this point. However, we should change RevisionTree's
# construction to always be via Repository and not via direct
# construction - this will mean that we can change the constructor
# with much less chance of breaking client code.
self._repository = branch
self._weave_store = branch.weave_store
self._inventory = inv
self._revision_id = revision_id
def get_parent_ids(self):
"""See Tree.get_parent_ids.
A RevisionTree's parents match the revision graph.
"""
parent_ids = self._repository.get_revision(self._revision_id).parent_ids
return parent_ids
def get_revision_id(self):
"""Return the revision id associated with this tree."""
return self._revision_id
def get_weave(self, file_id):
return self._weave_store.get_weave(file_id,
self._repository.get_transaction())
def get_file_lines(self, file_id):
ie = self._inventory[file_id]
weave = self.get_weave(file_id)
return weave.get_lines(ie.revision)
def get_file_text(self, file_id):
return ''.join(self.get_file_lines(file_id))
def get_file(self, file_id):
return StringIO(self.get_file_text(file_id))
def get_file_size(self, file_id):
return self._inventory[file_id].text_size
def get_file_sha1(self, file_id, path=None):
ie = self._inventory[file_id]
if ie.kind == "file":
return ie.text_sha1
return None
def get_file_mtime(self, file_id, path=None):
ie = self._inventory[file_id]
revision = self._repository.get_revision(ie.revision)
return revision.timestamp
def is_executable(self, file_id, path=None):
ie = self._inventory[file_id]
if ie.kind != "file":
return None
return self._inventory[file_id].executable
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
entries = self.inventory.iter_entries()
# skip the root for compatability with the current apis.
entries.next()
for path, entry in entries:
yield path, 'V', entry.kind, entry.file_id, entry
def get_symlink_target(self, file_id):
ie = self._inventory[file_id]
return ie.symlink_target;
def kind(self, file_id):
return self._inventory[file_id].kind
def lock_read(self):
self._repository.lock_read()
def unlock(self):
self._repository.unlock()
class EmptyTree(Tree):
def __init__(self):
self._inventory = Inventory()
warn('EmptyTree is deprecated as of bzr 0.9 please use '
'repository.revision_tree instead.',
DeprecationWarning, stacklevel=2)
def get_parent_ids(self):
return []
def get_symlink_target(self, file_id):
return None
def has_filename(self, filename):
return False
def kind(self, file_id):
assert self._inventory[file_id].kind == "root_directory"
return "root_directory"
def list_files(self):
return iter([])
def __contains__(self, file_id):
return file_id in self._inventory
def get_file_sha1(self, file_id, path=None):
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)
def find_ids_across_trees(filenames, trees, require_versioned=True):
"""Find the ids corresponding to specified filenames.
All matches in all trees will be used, and all children of matched
directories will be used.
:param filenames: The filenames to find file_ids for
:param trees: The trees to find file_ids within
:param require_versioned: if true, all specified filenames must occur in
at least one tree.
:return: a set of file ids for the specified filenames and their children.
"""
if not filenames:
return None
specified_ids = _find_filename_ids_across_trees(filenames, trees,
require_versioned)
return _find_children_across_trees(specified_ids, trees)
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
"""Find the ids corresponding to specified filenames.
All matches in all trees will be used.
:param filenames: The filenames to find file_ids for
:param trees: The trees to find file_ids within
:param require_versioned: if true, all specified filenames must occur in
at least one tree.
:return: a set of file ids for the specified filenames
"""
not_versioned = []
interesting_ids = set()
for tree_path in filenames:
not_found = True
for tree in trees:
file_id = tree.inventory.path2id(tree_path)
if file_id is not None:
interesting_ids.add(file_id)
not_found = False
if not_found:
not_versioned.append(tree_path)
if len(not_versioned) > 0 and require_versioned:
raise errors.PathsNotVersionedError(not_versioned)
return interesting_ids
def _find_children_across_trees(specified_ids, trees):
"""Return a set including specified ids and their children
All matches in all trees will be used.
:param trees: The trees to find file_ids within
:return: a set containing all specified ids and their children
"""
interesting_ids = set(specified_ids)
pending = interesting_ids
# now handle children of interesting ids
# we loop so that we handle all children of each id in both trees
while len(pending) > 0:
new_pending = set()
for file_id in pending:
for tree in trees:
if file_id not in tree:
continue
entry = tree.inventory[file_id]
for child in getattr(entry, 'children', {}).itervalues():
if child.file_id not in interesting_ids:
new_pending.add(child.file_id)
interesting_ids.update(new_pending)
pending = new_pending
return interesting_ids
|