111
78
TODO: Perhaps callback with the ids and paths as they're added.
113
80
if isinstance(files, basestring):
114
# XXX: Passing a single string is inconsistent and should be
116
if not (ids is None or isinstance(ids, basestring)):
117
raise AssertionError()
118
if not (kinds is None or isinstance(kinds, basestring)):
119
raise AssertionError()
81
assert(ids is None or isinstance(ids, basestring))
82
assert(kinds is None or isinstance(kinds, basestring))
121
84
if ids is not None:
123
86
if kinds is not None:
126
files = [path.strip('/') for path in files]
129
90
ids = [None] * len(files)
131
if not (len(ids) == len(files)):
132
raise AssertionError()
92
assert(len(ids) == len(files))
134
95
kinds = [None] * len(files)
135
elif not len(kinds) == len(files):
136
raise AssertionError()
97
assert(len(kinds) == len(files))
138
99
# generic constraint checks:
139
100
if self.is_control_filename(f):
140
101
raise errors.ForbiddenControlFileError(filename=f)
141
fp = osutils.splitpath(f)
142
# fill out file kinds for all files [not needed when we stop
104
raise BzrError("cannot add top-level %r" % f)
105
# fill out file kinds for all files [not needed when we stop
143
106
# caring about the instantaneous file kind within a uncommmitted tree
145
108
self._gather_kinds(files, kinds)
146
109
self._add(files, ids, kinds)
148
def add_reference(self, sub_tree):
149
"""Add a TreeReference to the tree, pointing at sub_tree"""
150
raise errors.UnsupportedOperation(self.add_reference, self)
152
def _add_reference(self, sub_tree):
153
"""Standard add_reference implementation, for use by subclasses"""
155
sub_tree_path = self.relpath(sub_tree.basedir)
156
except errors.PathNotChild:
157
raise errors.BadReferenceTarget(self, sub_tree,
158
'Target not inside tree.')
159
sub_tree_id = sub_tree.get_root_id()
160
if sub_tree_id == self.get_root_id():
161
raise errors.BadReferenceTarget(self, sub_tree,
162
'Trees have the same root id.')
163
if sub_tree_id in self:
164
raise errors.BadReferenceTarget(self, sub_tree,
165
'Root id already present in tree')
166
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
168
111
def _add(self, files, ids, kinds):
169
"""Helper function for add - updates the inventory.
171
:param files: sequence of pathnames, relative to the tree root
172
:param ids: sequence of suggested ids for the files (may be None)
173
:param kinds: sequence of inventory kinds of the files (i.e. may
174
contain "tree-reference")
112
"""Helper function for add - updates the inventory."""
176
113
raise NotImplementedError(self._add)
178
def apply_inventory_delta(self, changes):
179
"""Apply changes to the inventory as an atomic operation.
181
:param changes: An inventory delta to apply to the working tree's
184
:seealso Inventory.apply_delta: For details on the changes parameter.
186
raise NotImplementedError(self.apply_inventory_delta)
188
115
@needs_write_lock
189
def commit(self, message=None, revprops=None, *args,
116
def commit(self, message=None, revprops=None, *args, **kwargs):
191
117
# avoid circular imports
192
118
from bzrlib import commit
193
possible_master_transports=[]
194
revprops = commit.Commit.update_revprops(
197
kwargs.pop('authors', None),
198
kwargs.pop('author', None),
199
kwargs.get('local', False),
200
possible_master_transports)
121
if not 'branch-nick' in revprops:
122
revprops['branch-nick'] = self.branch.nick
201
123
# args for wt.commit start at message from the Commit.commit method,
202
args = (message, ) + args
203
for hook in MutableTree.hooks['start_commit']:
124
# but with branch a kwarg now, passing in args as is results in the
125
#message being used for the branch
126
args = (DEPRECATED_PARAMETER, message, ) + args
205
127
committed_id = commit.Commit().commit(working_tree=self,
207
possible_master_transports=possible_master_transports,
209
post_hook_params = PostCommitHookParams(self)
210
for hook in MutableTree.hooks['post_commit']:
211
hook(post_hook_params)
128
revprops=revprops, *args, **kwargs)
212
129
return committed_id
214
131
def _gather_kinds(self, files, kinds):
325
179
raise NotImplementedError(self.mkdir)
327
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
328
"""Tell the tree we have observed a paths sha1.
330
The intent of this function is to allow trees that have a hashcache to
331
update the hashcache during commit. If the observed file is too new
332
(based on the stat_value) to be safely hash-cached the tree will ignore
335
The default implementation does nothing.
337
:param file_id: The file id
338
:param path: The file path
339
:param sha1: The sha 1 that was observed.
340
:param stat_value: A stat result for the file the sha1 was read from.
345
def put_file_bytes_non_atomic(self, file_id, bytes):
346
"""Update the content of a file in the tree.
348
Note that the file is written in-place rather than being
349
written to a temporary location and renamed. As a consequence,
350
readers can potentially see the file half-written.
352
:param file_id: file-id of the file
353
:param bytes: the new file contents
355
raise NotImplementedError(self.put_file_bytes_non_atomic)
357
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
358
"""Set the parents ids of the working tree.
360
:param revision_ids: A list of revision_ids.
362
raise NotImplementedError(self.set_parent_ids)
364
181
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
365
182
"""Set the parents of the working tree.
367
:param parents_list: A list of (revision_id, tree) tuples.
184
:param parents_list: A list of (revision_id, tree) tuples.
368
185
If tree is None, then that element is treated as an unreachable
369
186
parent tree - i.e. a ghost.
371
188
raise NotImplementedError(self.set_parent_trees)
373
def smart_add(self, file_list, recurse=True, action=None, save=True):
374
"""Version file_list, optionally recursing into directories.
376
This is designed more towards DWIM for humans than API clarity.
377
For the specific behaviour see the help for cmd_add().
379
:param file_list: List of zero or more paths. *NB: these are
380
interpreted relative to the process cwd, not relative to the
381
tree.* (Add and most other tree methods use tree-relative
383
:param action: A reporter to be called with the inventory, parent_ie,
384
path and kind of the path being added. It may return a file_id if
385
a specific one should be used.
386
:param save: Save the inventory after completing the adds. If False
387
this provides dry-run functionality by doing the add and not saving
389
:return: A tuple - files_added, ignored_files. files_added is the count
390
of added files, and ignored_files is a dict mapping files that were
391
ignored to the rule that caused them to be ignored.
393
raise NotImplementedError(self.smart_add)
395
def update_basis_by_delta(self, new_revid, delta):
396
"""Update the parents of this tree after a commit.
398
This gives the tree one parent, with revision id new_revid. The
399
inventory delta is applied to the current basis tree to generate the
400
inventory for the parent new_revid, and all other parent trees are
403
All the changes in the delta should be changes synchronising the basis
404
tree with some or all of the working tree, with a change to a directory
405
requiring that its contents have been recursively included. That is,
406
this is not a general purpose tree modification routine, but a helper
407
for commit which is not required to handle situations that do not arise
410
See the inventory developers documentation for the theory behind
413
:param new_revid: The new revision id for the trees parent.
414
:param delta: An inventory delta (see apply_inventory_delta) describing
415
the changes from the current left most parent revision to new_revid.
417
raise NotImplementedError(self.update_basis_by_delta)
420
class MutableInventoryTree(MutableTree,tree.InventoryTree):
422
@needs_tree_write_lock
423
def apply_inventory_delta(self, changes):
424
"""Apply changes to the inventory as an atomic operation.
426
:param changes: An inventory delta to apply to the working tree's
429
:seealso Inventory.apply_delta: For details on the changes parameter.
433
inv.apply_delta(changes)
434
self._write_inventory(inv)
436
def _fix_case_of_inventory_path(self, path):
437
"""If our tree isn't case sensitive, return the canonical path"""
438
if not self.case_sensitive:
439
path = self.get_canonical_inventory_path(path)
442
@needs_tree_write_lock
443
def smart_add(self, file_list, recurse=True, action=None, save=True):
444
"""Version file_list, optionally recursing into directories.
446
This is designed more towards DWIM for humans than API clarity.
447
For the specific behaviour see the help for cmd_add().
449
:param file_list: List of zero or more paths. *NB: these are
450
interpreted relative to the process cwd, not relative to the
451
tree.* (Add and most other tree methods use tree-relative
453
:param action: A reporter to be called with the inventory, parent_ie,
454
path and kind of the path being added. It may return a file_id if
455
a specific one should be used.
456
:param save: Save the inventory after completing the adds. If False
457
this provides dry-run functionality by doing the add and not saving
459
:return: A tuple - files_added, ignored_files. files_added is the count
460
of added files, and ignored_files is a dict mapping files that were
461
ignored to the rule that caused them to be ignored.
463
# not in an inner loop; and we want to remove direct use of this,
464
# so here as a reminder for now. RBC 20070703
465
from bzrlib.inventory import InventoryEntry
467
action = add.AddAction()
470
# no paths supplied: add the entire tree.
471
# FIXME: this assumes we are running in a working tree subdir :-/
474
# mutter("smart add of %r")
480
conflicts_related = set()
481
# Not all mutable trees can have conflicts
482
if getattr(self, 'conflicts', None) is not None:
483
# Collect all related files without checking whether they exist or
484
# are versioned. It's cheaper to do that once for all conflicts
485
# than trying to find the relevant conflict for each added file.
486
for c in self.conflicts():
487
conflicts_related.update(c.associated_filenames())
489
# expand any symlinks in the directory part, while leaving the
491
# only expanding if symlinks are supported avoids windows path bugs
492
if osutils.has_symlinks():
493
file_list = map(osutils.normalizepath, file_list)
495
# validate user file paths and convert all paths to tree
496
# relative : it's cheaper to make a tree relative path an abspath
497
# than to convert an abspath to tree relative, and it's cheaper to
498
# perform the canonicalization in bulk.
499
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
500
rf = _FastPath(filepath)
501
# validate user parameters. Our recursive code avoids adding new
502
# files that need such validation
503
if self.is_control_filename(rf.raw_path):
504
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
506
abspath = self.abspath(rf.raw_path)
507
kind = osutils.file_kind(abspath)
508
if kind == 'directory':
509
# schedule the dir for scanning
512
if not InventoryEntry.versionable_kind(kind):
513
raise errors.BadFileKindError(filename=abspath, kind=kind)
514
# ensure the named path is added, so that ignore rules in the later
515
# directory walk dont skip it.
516
# we dont have a parent ie known yet.: use the relatively slower
517
# inventory probing method
518
versioned = inv.has_filename(rf.raw_path)
521
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
524
# no need to walk any directories at all.
525
if len(added) > 0 and save:
526
self._write_inventory(inv)
527
return added, ignored
529
# only walk the minimal parents needed: we have user_dirs to override
533
is_inside = osutils.is_inside_or_parent_of_any
534
for path in sorted(user_dirs):
535
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
536
dirs_to_add.append((path, None))
537
prev_dir = path.raw_path
539
illegalpath_re = re.compile(r'[\r\n]')
540
# dirs_to_add is initialised to a list of directories, but as we scan
541
# directories we append files to it.
542
# XXX: We should determine kind of files when we scan them rather than
543
# adding to this list. RBC 20070703
544
for directory, parent_ie in dirs_to_add:
545
# directory is tree-relative
546
abspath = self.abspath(directory.raw_path)
548
# get the contents of this directory.
550
# find the kind of the path being added.
551
kind = osutils.file_kind(abspath)
553
if not InventoryEntry.versionable_kind(kind):
554
trace.warning("skipping %s (can't add file of kind '%s')",
557
if illegalpath_re.search(directory.raw_path):
558
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
560
if directory.raw_path in conflicts_related:
561
# If the file looks like one generated for a conflict, don't
564
'skipping %s (generated to help resolve conflicts)',
568
if parent_ie is not None:
569
versioned = directory.base_path in parent_ie.children
571
# without the parent ie, use the relatively slower inventory
573
versioned = inv.has_filename(
574
self._fix_case_of_inventory_path(directory.raw_path))
576
if kind == 'directory':
578
sub_branch = bzrdir.BzrDir.open(abspath)
580
except errors.NotBranchError:
582
except errors.UnsupportedFormatError:
587
if directory.raw_path == '':
588
# mutter("tree root doesn't need to be added")
592
# mutter("%r is already versioned", abspath)
594
# XXX: This is wrong; people *might* reasonably be trying to
595
# add subtrees as subtrees. This should probably only be done
596
# in formats which can represent subtrees, and even then
597
# perhaps only when the user asked to add subtrees. At the
598
# moment you can add them specially through 'join --reference',
599
# which is perhaps reasonable: adding a new reference is a
600
# special operation and can have a special behaviour. mbp
602
trace.mutter("%r is a nested bzr tree", abspath)
604
_add_one(self, inv, parent_ie, directory, kind, action)
605
added.append(directory.raw_path)
607
if kind == 'directory' and not sub_tree:
608
if parent_ie is not None:
610
this_ie = parent_ie.children[directory.base_path]
612
# without the parent ie, use the relatively slower inventory
614
this_id = inv.path2id(
615
self._fix_case_of_inventory_path(directory.raw_path))
619
this_ie = inv[this_id]
620
# Same as in _add_one below, if the inventory doesn't
621
# think this is a directory, update the inventory
622
if this_ie.kind != 'directory':
623
this_ie = _mod_inventory.make_entry('directory',
624
this_ie.name, this_ie.parent_id, this_id)
628
for subf in sorted(os.listdir(abspath)):
629
# here we could use TreeDirectory rather than
630
# string concatenation.
631
subp = osutils.pathjoin(directory.raw_path, subf)
632
# TODO: is_control_filename is very slow. Make it faster.
633
# TreeDirectory.is_control_filename could also make this
634
# faster - its impossible for a non root dir to have a
636
if self.is_control_filename(subp):
637
trace.mutter("skip control directory %r", subp)
638
elif subf in this_ie.children:
639
# recurse into this already versioned subdir.
640
dirs_to_add.append((_FastPath(subp, subf), this_ie))
642
# user selection overrides ignoes
643
# ignore while selecting files - if we globbed in the
644
# outer loop we would ignore user files.
645
ignore_glob = self.is_ignored(subp)
646
if ignore_glob is not None:
647
# mutter("skip ignored sub-file %r", subp)
648
ignored.setdefault(ignore_glob, []).append(subp)
650
#mutter("queue to add sub-file %r", subp)
651
dirs_to_add.append((_FastPath(subp, subf), this_ie))
655
self._write_inventory(inv)
657
self.read_working_inventory()
658
return added, ignored
660
def update_basis_by_delta(self, new_revid, delta):
661
"""Update the parents of this tree after a commit.
663
This gives the tree one parent, with revision id new_revid. The
664
inventory delta is applied to the current basis tree to generate the
665
inventory for the parent new_revid, and all other parent trees are
668
All the changes in the delta should be changes synchronising the basis
669
tree with some or all of the working tree, with a change to a directory
670
requiring that its contents have been recursively included. That is,
671
this is not a general purpose tree modification routine, but a helper
672
for commit which is not required to handle situations that do not arise
675
See the inventory developers documentation for the theory behind
678
:param new_revid: The new revision id for the trees parent.
679
:param delta: An inventory delta (see apply_inventory_delta) describing
680
the changes from the current left most parent revision to new_revid.
682
# if the tree is updated by a pull to the branch, as happens in
683
# WorkingTree2, when there was no separation between branch and tree,
684
# then just clear merges, efficiency is not a concern for now as this
685
# is legacy environments only, and they are slow regardless.
686
if self.last_revision() == new_revid:
687
self.set_parent_ids([new_revid])
689
# generic implementation based on Inventory manipulation. See
690
# WorkingTree classes for optimised versions for specific format trees.
691
basis = self.basis_tree()
693
# TODO: Consider re-evaluating the need for this with CHKInventory
694
# we don't strictly need to mutate an inventory for this
695
# it only makes sense when apply_delta is cheaper than get_inventory()
696
inventory = _mod_inventory.mutable_inventory_from_tree(basis)
698
inventory.apply_delta(delta)
699
rev_tree = revisiontree.InventoryRevisionTree(self.branch.repository,
700
inventory, new_revid)
701
self.set_parent_trees([(new_revid, rev_tree)])
704
class MutableTreeHooks(hooks.Hooks):
705
"""A dictionary mapping a hook name to a list of callables for mutabletree
710
"""Create the default hooks.
713
hooks.Hooks.__init__(self, "bzrlib.mutabletree", "MutableTree.hooks")
714
self.add_hook('start_commit',
715
"Called before a commit is performed on a tree. The start commit "
716
"hook is able to change the tree before the commit takes place. "
717
"start_commit is called with the bzrlib.mutabletree.MutableTree "
718
"that the commit is being performed on.", (1, 4))
719
self.add_hook('post_commit',
720
"Called after a commit is performed on a tree. The hook is "
721
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
722
"The mutable tree the commit was performed on is available via "
723
"the mutable_tree attribute of that object.", (2, 0))
726
# install the default hooks into the MutableTree class.
727
MutableTree.hooks = MutableTreeHooks()
730
class PostCommitHookParams(object):
731
"""Parameters for the post_commit hook.
733
To access the parameters, use the following attributes:
735
* mutable_tree - the MutableTree object
738
def __init__(self, mutable_tree):
739
"""Create the parameters for the post_commit hook."""
740
self.mutable_tree = mutable_tree
743
class _FastPath(object):
744
"""A path object with fast accessors for things like basename."""
746
__slots__ = ['raw_path', 'base_path']
748
def __init__(self, path, base_path=None):
749
"""Construct a FastPath from path."""
750
if base_path is None:
751
self.base_path = osutils.basename(path)
753
self.base_path = base_path
756
def __cmp__(self, other):
757
return cmp(self.raw_path, other.raw_path)
760
return hash(self.raw_path)
763
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
764
"""Add a new entry to the inventory and automatically add unversioned parents.
766
:param inv: Inventory which will receive the new entry.
767
:param parent_ie: Parent inventory entry if known, or None. If
768
None, the parent is looked up by name and used if present, otherwise it
769
is recursively added.
770
:param kind: Kind of new entry (file, directory, etc)
771
:param action: callback(inv, parent_ie, path, kind); return ignored.
772
:return: A list of paths which have been added.
774
# Nothing to do if path is already versioned.
775
# This is safe from infinite recursion because the tree root is
777
if parent_ie is not None:
778
# we have a parent ie already
781
# slower but does not need parent_ie
782
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
784
# its really not there : add the parent
785
# note that the dirname use leads to some extra str copying etc but as
786
# there are a limited number of dirs we can be nested under, it should
787
# generally find it very fast and not recurse after that.
788
added = _add_one_and_parent(tree, inv, None,
789
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
790
parent_id = inv.path2id(osutils.dirname(path.raw_path))
791
parent_ie = inv[parent_id]
792
_add_one(tree, inv, parent_ie, path, kind, action)
793
return added + [path.raw_path]
796
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
797
"""Add a new entry to the inventory.
799
:param inv: Inventory which will receive the new entry.
800
:param parent_ie: Parent inventory entry.
801
:param kind: Kind of new entry (file, directory, etc)
802
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
803
file_id or None to generate a new file id
806
# if the parent exists, but isn't a directory, we have to do the
807
# kind change now -- really the inventory shouldn't pretend to know
808
# the kind of wt files, but it does.
809
if parent_ie.kind != 'directory':
810
# nb: this relies on someone else checking that the path we're using
811
# doesn't contain symlinks.
812
new_parent_ie = _mod_inventory.make_entry('directory', parent_ie.name,
813
parent_ie.parent_id, parent_ie.file_id)
814
del inv[parent_ie.file_id]
815
inv.add(new_parent_ie)
816
parent_ie = new_parent_ie
817
file_id = file_id_callback(inv, parent_ie, path, kind)
818
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
