13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""MutableTree object.
69
67
entirely in memory.
71
69
For now, we are not treating MutableTree as an interface to provide
72
conformance tests for - rather we are testing MemoryTree specifically, and
70
conformance tests for - rather we are testing MemoryTree specifically, and
73
71
interface testing implementations of WorkingTree.
75
73
A mutable tree always has an associated Branch and BzrDir object - the
76
74
branch and bzrdir attributes.
78
def __init__(self, *args, **kw):
79
super(MutableTree, self).__init__(*args, **kw)
80
# Is this tree on a case-insensitive or case-preserving file-system?
81
# Sub-classes may initialize to False if they detect they are being
82
# used on media which doesn't differentiate the case of names.
83
self.case_sensitive = True
85
77
@needs_tree_write_lock
86
78
def add(self, files, ids=None, kinds=None):
102
94
TODO: Perhaps callback with the ids and paths as they're added.
104
96
if isinstance(files, basestring):
105
# XXX: Passing a single string is inconsistent and should be
107
if not (ids is None or isinstance(ids, basestring)):
108
raise AssertionError()
109
if not (kinds is None or isinstance(kinds, basestring)):
110
raise AssertionError()
97
assert(ids is None or isinstance(ids, basestring))
98
assert(kinds is None or isinstance(kinds, basestring))
112
100
if ids is not None:
120
108
ids = [None] * len(files)
122
if not (len(ids) == len(files)):
123
raise AssertionError()
110
assert(len(ids) == len(files))
111
ids = [osutils.safe_file_id(file_id) for file_id in ids]
124
113
if kinds is None:
125
114
kinds = [None] * len(files)
126
elif not len(kinds) == len(files):
127
raise AssertionError()
116
assert(len(kinds) == len(files))
129
118
# generic constraint checks:
130
119
if self.is_control_filename(f):
131
120
raise errors.ForbiddenControlFileError(filename=f)
132
121
fp = splitpath(f)
133
# fill out file kinds for all files [not needed when we stop
122
# fill out file kinds for all files [not needed when we stop
134
123
# caring about the instantaneous file kind within a uncommmitted tree
136
125
self._gather_kinds(files, kinds)
170
159
def apply_inventory_delta(self, changes):
171
160
"""Apply changes to the inventory as an atomic operation.
173
:param changes: An inventory delta to apply to the working tree's
176
:seealso Inventory.apply_delta: For details on the changes parameter.
162
The argument is a set of changes to apply. It must describe a
163
valid result, but the order is not important. Specifically,
164
intermediate stages *may* be invalid, such as when two files
167
The changes should be structured as a list of tuples, of the form
168
(old_path, new_path, file_id, new_entry). For creation, old_path
169
must be None. For deletion, new_path and new_entry must be None.
170
file_id is always non-None. For renames and other mutations, all
171
values must be non-None.
173
If the new_entry is a directory, its children should be an empty
174
dict. Children are handled by apply_inventory_delta itself.
176
:param changes: A list of tuples for the change to apply:
177
[(old_path, new_path, file_id, new_inventory_entry), ...]
179
180
inv = self.inventory
180
inv.apply_delta(changes)
182
for old_path, file_id in sorted(((op, f) for op, np, f, e in changes
183
if op is not None), reverse=True):
184
if file_id not in inv:
186
children[file_id] = getattr(inv[file_id], 'children', {})
187
inv.remove_recursive_id(file_id)
188
for new_path, new_entry in sorted((np, e) for op, np, f, e in
189
changes if np is not None):
190
if getattr(new_entry, 'children', None) is not None:
191
new_entry.children = children.get(new_entry.file_id, {})
181
193
self._write_inventory(inv)
183
195
@needs_write_lock
187
199
from bzrlib import commit
188
200
if revprops is None:
190
possible_master_transports=[]
191
202
if not 'branch-nick' in revprops:
192
revprops['branch-nick'] = self.branch._get_nick(
193
kwargs.get('local', False),
194
possible_master_transports)
195
authors = kwargs.pop('authors', None)
196
author = kwargs.pop('author', None)
197
if authors is not None:
198
if author is not None:
199
raise AssertionError('Specifying both author and authors '
200
'is not allowed. Specify just authors instead')
201
if 'author' in revprops or 'authors' in revprops:
202
# XXX: maybe we should just accept one of them?
203
raise AssertionError('author property given twice')
205
for individual in authors:
206
if '\n' in individual:
207
raise AssertionError('\\n is not a valid character '
208
'in an author identity')
209
revprops['authors'] = '\n'.join(authors)
210
if author is not None:
211
symbol_versioning.warn('The parameter author was deprecated'
212
' in version 1.13. Use authors instead',
214
if 'author' in revprops or 'authors' in revprops:
215
# XXX: maybe we should just accept one of them?
216
raise AssertionError('author property given twice')
218
raise AssertionError('\\n is not a valid character '
219
'in an author identity')
220
revprops['authors'] = author
203
revprops['branch-nick'] = self.branch.nick
221
204
# args for wt.commit start at message from the Commit.commit method,
222
205
args = (message, ) + args
223
for hook in MutableTree.hooks['start_commit']:
225
206
committed_id = commit.Commit().commit(working_tree=self,
227
possible_master_transports=possible_master_transports,
207
revprops=revprops, *args, **kwargs)
229
208
return committed_id
231
210
def _gather_kinds(self, files, kinds):
232
211
"""Helper function for add - sets the entries of kinds."""
233
212
raise NotImplementedError(self._gather_kinds)
235
def get_file_with_stat(self, file_id, path=None):
236
"""Get a file handle and stat object for file_id.
238
The default implementation returns (self.get_file, None) for backwards
241
:param file_id: The file id to read.
242
:param path: The path of the file, if it is known.
243
:return: A tuple (file_handle, stat_value_or_None). If the tree has
244
no stat facility, or need for a stat cache feedback during commit,
245
it may return None for the second element of the tuple.
247
return (self.get_file(file_id, path), None)
250
215
def last_revision(self):
251
216
"""Return the revision id of the last commit performed in this tree.
293
258
raise NotImplementedError(self.mkdir)
295
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
296
"""Tell the tree we have observed a paths sha1.
298
The intent of this function is to allow trees that have a hashcache to
299
update the hashcache during commit. If the observed file is too new
300
(based on the stat_value) to be safely hash-cached the tree will ignore
303
The default implementation does nothing.
305
:param file_id: The file id
306
:param path: The file path
307
:param sha1: The sha 1 that was observed.
308
:param stat_value: A stat result for the file the sha1 was read from.
312
def _fix_case_of_inventory_path(self, path):
313
"""If our tree isn't case sensitive, return the canonical path"""
314
if not self.case_sensitive:
315
path = self.get_canonical_inventory_path(path)
319
def put_file_bytes_non_atomic(self, file_id, bytes):
320
"""Update the content of a file in the tree.
322
Note that the file is written in-place rather than being
323
written to a temporary location and renamed. As a consequence,
324
readers can potentially see the file half-written.
326
:param file_id: file-id of the file
327
:param bytes: the new file contents
329
raise NotImplementedError(self.put_file_bytes_non_atomic)
331
260
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
332
261
"""Set the parents ids of the working tree.
338
267
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
339
268
"""Set the parents of the working tree.
341
:param parents_list: A list of (revision_id, tree) tuples.
270
:param parents_list: A list of (revision_id, tree) tuples.
342
271
If tree is None, then that element is treated as an unreachable
343
272
parent tree - i.e. a ghost.
352
281
For the specific behaviour see the help for cmd_add().
354
283
:param action: A reporter to be called with the inventory, parent_ie,
355
path and kind of the path being added. It may return a file_id if
284
path and kind of the path being added. It may return a file_id if
356
285
a specific one should be used.
357
286
:param save: Save the inventory after completing the adds. If False
358
287
this provides dry-run functionality by doing the add and not saving
378
308
user_dirs = set()
380
# validate user file paths and convert all paths to tree
310
# validate user file paths and convert all paths to tree
381
311
# relative : it's cheaper to make a tree relative path an abspath
382
# than to convert an abspath to tree relative, and it's cheaper to
383
# perform the canonicalization in bulk.
384
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
385
rf = _FastPath(filepath)
312
# than to convert an abspath to tree relative.
313
for filepath in file_list:
314
rf = _FastPath(self.relpath(filepath))
386
315
# validate user parameters. Our recursive code avoids adding new files
387
# that need such validation
316
# that need such validation
388
317
if self.is_control_filename(rf.raw_path):
389
318
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
391
320
abspath = self.abspath(rf.raw_path)
392
321
kind = osutils.file_kind(abspath)
393
322
if kind == 'directory':
441
370
if parent_ie is not None:
442
371
versioned = directory.base_path in parent_ie.children
444
# without the parent ie, use the relatively slower inventory
373
# without the parent ie, use the relatively slower inventory
446
versioned = inv.has_filename(
447
self._fix_case_of_inventory_path(directory.raw_path))
375
versioned = inv.has_filename(directory.raw_path)
449
377
if kind == 'directory':
465
393
# mutter("%r is already versioned", abspath)
467
395
# XXX: This is wrong; people *might* reasonably be trying to add
468
# subtrees as subtrees. This should probably only be done in formats
396
# subtrees as subtrees. This should probably only be done in formats
469
397
# which can represent subtrees, and even then perhaps only when
470
398
# the user asked to add subtrees. At the moment you can add them
471
399
# specially through 'join --reference', which is perhaps
481
409
# must be present:
482
410
this_ie = parent_ie.children[directory.base_path]
484
# without the parent ie, use the relatively slower inventory
412
# without the parent ie, use the relatively slower inventory
486
this_id = inv.path2id(
487
self._fix_case_of_inventory_path(directory.raw_path))
414
this_id = inv.path2id(directory.raw_path)
488
415
if this_id is None:
491
418
this_ie = inv[this_id]
493
420
for subf in sorted(os.listdir(abspath)):
494
# here we could use TreeDirectory rather than
421
# here we could use TreeDirectory rather than
495
422
# string concatenation.
496
423
subp = osutils.pathjoin(directory.raw_path, subf)
497
# TODO: is_control_filename is very slow. Make it faster.
498
# TreeDirectory.is_control_filename could also make this
499
# faster - its impossible for a non root dir to have a
424
# TODO: is_control_filename is very slow. Make it faster.
425
# TreeDirectory.is_control_filename could also make this
426
# faster - its impossible for a non root dir to have a
501
428
if self.is_control_filename(subp):
502
429
mutter("skip control directory %r", subp)
522
449
self.read_working_inventory()
523
450
return added, ignored
525
def update_basis_by_delta(self, new_revid, delta):
526
"""Update the parents of this tree after a commit.
528
This gives the tree one parent, with revision id new_revid. The
529
inventory delta is applied to the current basis tree to generate the
530
inventory for the parent new_revid, and all other parent trees are
533
All the changes in the delta should be changes synchronising the basis
534
tree with some or all of the working tree, with a change to a directory
535
requiring that its contents have been recursively included. That is,
536
this is not a general purpose tree modification routine, but a helper
537
for commit which is not required to handle situations that do not arise
540
:param new_revid: The new revision id for the trees parent.
541
:param delta: An inventory delta (see apply_inventory_delta) describing
542
the changes from the current left most parent revision to new_revid.
544
# if the tree is updated by a pull to the branch, as happens in
545
# WorkingTree2, when there was no separation between branch and tree,
546
# then just clear merges, efficiency is not a concern for now as this
547
# is legacy environments only, and they are slow regardless.
548
if self.last_revision() == new_revid:
549
self.set_parent_ids([new_revid])
551
# generic implementation based on Inventory manipulation. See
552
# WorkingTree classes for optimised versions for specific format trees.
553
basis = self.basis_tree()
555
# TODO: Consider re-evaluating the need for this with CHKInventory
556
# we don't strictly need to mutate an inventory for this
557
# it only makes sense when apply_delta is cheaper than get_inventory()
558
inventory = basis.inventory._get_mutable_inventory()
560
inventory.apply_delta(delta)
561
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
562
self.set_parent_trees([(new_revid, rev_tree)])
565
class MutableTreeHooks(hooks.Hooks):
566
"""A dictionary mapping a hook name to a list of callables for mutabletree
571
"""Create the default hooks.
574
hooks.Hooks.__init__(self)
575
self.create_hook(hooks.HookPoint('start_commit',
576
"Called before a commit is performed on a tree. The start commit "
577
"hook is able to change the tree before the commit takes place. "
578
"start_commit is called with the bzrlib.tree.MutableTree that the "
579
"commit is being performed on.", (1, 4), None))
582
# install the default hooks into the MutableTree class.
583
MutableTree.hooks = MutableTreeHooks()
586
453
class _FastPath(object):
587
454
"""A path object with fast accessors for things like basename."""
added
removed
bzrlib/mutabletree.py
