130
106
self._gather_kinds(files, kinds)
131
107
self._add(files, ids, kinds)
133
def add_reference(self, sub_tree):
134
"""Add a TreeReference to the tree, pointing at sub_tree"""
135
raise errors.UnsupportedOperation(self.add_reference, self)
137
def _add_reference(self, sub_tree):
138
"""Standard add_reference implementation, for use by subclasses"""
140
sub_tree_path = self.relpath(sub_tree.basedir)
141
except errors.PathNotChild:
142
raise errors.BadReferenceTarget(self, sub_tree,
143
'Target not inside tree.')
144
sub_tree_id = sub_tree.get_root_id()
145
if sub_tree_id == self.get_root_id():
146
raise errors.BadReferenceTarget(self, sub_tree,
147
'Trees have the same root id.')
148
if sub_tree_id in self.inventory:
149
raise errors.BadReferenceTarget(self, sub_tree,
150
'Root id already present in tree')
151
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
153
109
def _add(self, files, ids, kinds):
154
"""Helper function for add - updates the inventory.
156
:param files: sequence of pathnames, relative to the tree root
157
:param ids: sequence of suggested ids for the files (may be None)
158
:param kinds: sequence of inventory kinds of the files (i.e. may
159
contain "tree-reference")
110
"""Helper function for add - updates the inventory."""
161
111
raise NotImplementedError(self._add)
163
@needs_tree_write_lock
164
def apply_inventory_delta(self, changes):
165
"""Apply changes to the inventory as an atomic operation.
167
:param changes: An inventory delta to apply to the working tree's
170
:seealso Inventory.apply_delta: For details on the changes parameter.
174
inv.apply_delta(changes)
175
self._write_inventory(inv)
177
113
@needs_write_lock
178
def commit(self, message=None, revprops=None, *args,
114
def commit(self, message=None, revprops=None, *args, **kwargs):
180
115
# avoid circular imports
181
116
from bzrlib import commit
182
117
if revprops is None:
184
119
if not 'branch-nick' in revprops:
185
120
revprops['branch-nick'] = self.branch.nick
186
author = kwargs.pop('author', None)
187
if author is not None:
188
if 'author' in revprops:
189
# XXX: maybe we should just accept one of them?
190
raise AssertionError('author property given twice')
191
revprops['author'] = author
192
121
# args for wt.commit start at message from the Commit.commit method,
193
args = (message, ) + args
194
for hook in MutableTree.hooks['start_commit']:
122
# but with branch a kwarg now, passing in args as is results in the
123
#message being used for the branch
124
args = (DEPRECATED_PARAMETER, message, ) + args
196
125
committed_id = commit.Commit().commit(working_tree=self,
197
126
revprops=revprops, *args, **kwargs)
198
127
return committed_id
275
184
parent tree - i.e. a ghost.
277
186
raise NotImplementedError(self.set_parent_trees)
279
@needs_tree_write_lock
280
def smart_add(self, file_list, recurse=True, action=None, save=True):
281
"""Version file_list, optionally recursing into directories.
283
This is designed more towards DWIM for humans than API clarity.
284
For the specific behaviour see the help for cmd_add().
286
:param action: A reporter to be called with the inventory, parent_ie,
287
path and kind of the path being added. It may return a file_id if
288
a specific one should be used.
289
:param save: Save the inventory after completing the adds. If False
290
this provides dry-run functionality by doing the add and not saving
292
:return: A tuple - files_added, ignored_files. files_added is the count
293
of added files, and ignored_files is a dict mapping files that were
294
ignored to the rule that caused them to be ignored.
296
# not in an inner loop; and we want to remove direct use of this,
297
# so here as a reminder for now. RBC 20070703
298
from bzrlib.inventory import InventoryEntry
300
action = add.AddAction()
303
# no paths supplied: add the entire tree.
305
# mutter("smart add of %r")
312
# validate user file paths and convert all paths to tree
313
# relative : it's cheaper to make a tree relative path an abspath
314
# than to convert an abspath to tree relative.
315
for filepath in file_list:
316
rf = _FastPath(self.relpath(filepath))
317
# validate user parameters. Our recursive code avoids adding new files
318
# that need such validation
319
if self.is_control_filename(rf.raw_path):
320
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
322
abspath = self.abspath(rf.raw_path)
323
kind = osutils.file_kind(abspath)
324
if kind == 'directory':
325
# schedule the dir for scanning
328
if not InventoryEntry.versionable_kind(kind):
329
raise errors.BadFileKindError(filename=abspath, kind=kind)
330
# ensure the named path is added, so that ignore rules in the later directory
332
# we dont have a parent ie known yet.: use the relatively slower inventory
334
versioned = inv.has_filename(rf.raw_path)
337
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
340
# no need to walk any directories at all.
341
if len(added) > 0 and save:
342
self._write_inventory(inv)
343
return added, ignored
345
# only walk the minimal parents needed: we have user_dirs to override
349
is_inside = osutils.is_inside_or_parent_of_any
350
for path in sorted(user_dirs):
351
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
352
dirs_to_add.append((path, None))
353
prev_dir = path.raw_path
355
# dirs_to_add is initialised to a list of directories, but as we scan
356
# directories we append files to it.
357
# XXX: We should determine kind of files when we scan them rather than
358
# adding to this list. RBC 20070703
359
for directory, parent_ie in dirs_to_add:
360
# directory is tree-relative
361
abspath = self.abspath(directory.raw_path)
363
# get the contents of this directory.
365
# find the kind of the path being added.
366
kind = osutils.file_kind(abspath)
368
if not InventoryEntry.versionable_kind(kind):
369
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
372
if parent_ie is not None:
373
versioned = directory.base_path in parent_ie.children
375
# without the parent ie, use the relatively slower inventory
377
versioned = inv.has_filename(directory.raw_path)
379
if kind == 'directory':
381
sub_branch = bzrdir.BzrDir.open(abspath)
383
except errors.NotBranchError:
385
except errors.UnsupportedFormatError:
390
if directory.raw_path == '':
391
# mutter("tree root doesn't need to be added")
395
# mutter("%r is already versioned", abspath)
397
# XXX: This is wrong; people *might* reasonably be trying to add
398
# subtrees as subtrees. This should probably only be done in formats
399
# which can represent subtrees, and even then perhaps only when
400
# the user asked to add subtrees. At the moment you can add them
401
# specially through 'join --reference', which is perhaps
402
# reasonable: adding a new reference is a special operation and
403
# can have a special behaviour. mbp 20070306
404
mutter("%r is a nested bzr tree", abspath)
406
_add_one(self, inv, parent_ie, directory, kind, action)
407
added.append(directory.raw_path)
409
if kind == 'directory' and not sub_tree:
410
if parent_ie is not None:
412
this_ie = parent_ie.children[directory.base_path]
414
# without the parent ie, use the relatively slower inventory
416
this_id = inv.path2id(directory.raw_path)
420
this_ie = inv[this_id]
422
for subf in sorted(os.listdir(abspath)):
423
# here we could use TreeDirectory rather than
424
# string concatenation.
425
subp = osutils.pathjoin(directory.raw_path, subf)
426
# TODO: is_control_filename is very slow. Make it faster.
427
# TreeDirectory.is_control_filename could also make this
428
# faster - its impossible for a non root dir to have a
430
if self.is_control_filename(subp):
431
mutter("skip control directory %r", subp)
432
elif subf in this_ie.children:
433
# recurse into this already versioned subdir.
434
dirs_to_add.append((_FastPath(subp, subf), this_ie))
436
# user selection overrides ignoes
437
# ignore while selecting files - if we globbed in the
438
# outer loop we would ignore user files.
439
ignore_glob = self.is_ignored(subp)
440
if ignore_glob is not None:
441
# mutter("skip ignored sub-file %r", subp)
442
ignored.setdefault(ignore_glob, []).append(subp)
444
#mutter("queue to add sub-file %r", subp)
445
dirs_to_add.append((_FastPath(subp, subf), this_ie))
449
self._write_inventory(inv)
451
self.read_working_inventory()
452
return added, ignored
454
def update_basis_by_delta(self, new_revid, delta):
455
"""Update the parents of this tree after a commit.
457
This gives the tree one parent, with revision id new_revid. The
458
inventory delta is applied to the current basis tree to generate the
459
inventory for the parent new_revid, and all other parent trees are
462
All the changes in the delta should be changes synchronising the basis
463
tree with some or all of the working tree, with a change to a directory
464
requiring that its contents have been recursively included. That is,
465
this is not a general purpose tree modification routine, but a helper
466
for commit which is not required to handle situations that do not arise
469
:param new_revid: The new revision id for the trees parent.
470
:param delta: An inventory delta (see apply_inventory_delta) describing
471
the changes from the current left most parent revision to new_revid.
473
# if the tree is updated by a pull to the branch, as happens in
474
# WorkingTree2, when there was no separation between branch and tree,
475
# then just clear merges, efficiency is not a concern for now as this
476
# is legacy environments only, and they are slow regardless.
477
if self.last_revision() == new_revid:
478
self.set_parent_ids([new_revid])
480
# generic implementation based on Inventory manipulation. See
481
# WorkingTree classes for optimised versions for specific format trees.
482
basis = self.basis_tree()
484
inventory = basis.inventory
486
inventory.apply_delta(delta)
487
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
488
self.set_parent_trees([(new_revid, rev_tree)])
491
class MutableTreeHooks(hooks.Hooks):
492
"""A dictionary mapping a hook name to a list of callables for mutabletree
497
"""Create the default hooks.
500
hooks.Hooks.__init__(self)
501
# Invoked before a commit is done in a tree. New in 1.4
502
self['start_commit'] = []
505
# install the default hooks into the MutableTree class.
506
MutableTree.hooks = MutableTreeHooks()
509
class _FastPath(object):
510
"""A path object with fast accessors for things like basename."""
512
__slots__ = ['raw_path', 'base_path']
514
def __init__(self, path, base_path=None):
515
"""Construct a FastPath from path."""
516
if base_path is None:
517
self.base_path = osutils.basename(path)
519
self.base_path = base_path
522
def __cmp__(self, other):
523
return cmp(self.raw_path, other.raw_path)
526
return hash(self.raw_path)
529
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
530
"""Add a new entry to the inventory and automatically add unversioned parents.
532
:param inv: Inventory which will receive the new entry.
533
:param parent_ie: Parent inventory entry if known, or None. If
534
None, the parent is looked up by name and used if present, otherwise it
535
is recursively added.
536
:param kind: Kind of new entry (file, directory, etc)
537
:param action: callback(inv, parent_ie, path, kind); return ignored.
538
:return: A list of paths which have been added.
540
# Nothing to do if path is already versioned.
541
# This is safe from infinite recursion because the tree root is
543
if parent_ie is not None:
544
# we have a parent ie already
547
# slower but does not need parent_ie
548
if inv.has_filename(path.raw_path):
550
# its really not there : add the parent
551
# note that the dirname use leads to some extra str copying etc but as
552
# there are a limited number of dirs we can be nested under, it should
553
# generally find it very fast and not recurse after that.
554
added = _add_one_and_parent(tree, inv, None,
555
_FastPath(dirname(path.raw_path)), 'directory', action)
556
parent_id = inv.path2id(dirname(path.raw_path))
557
parent_ie = inv[parent_id]
558
_add_one(tree, inv, parent_ie, path, kind, action)
559
return added + [path.raw_path]
562
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
563
"""Add a new entry to the inventory.
565
:param inv: Inventory which will receive the new entry.
566
:param parent_ie: Parent inventory entry.
567
:param kind: Kind of new entry (file, directory, etc)
568
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
569
file_id or None to generate a new file id
572
file_id = file_id_callback(inv, parent_ie, path, kind)
573
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
