100
78
TODO: Perhaps callback with the ids and paths as they're added.
102
80
if isinstance(files, basestring):
103
# XXX: Passing a single string is inconsistent and should be
105
if not (ids is None or isinstance(ids, basestring)):
106
raise AssertionError()
107
if not (kinds is None or isinstance(kinds, basestring)):
108
raise AssertionError()
81
assert(ids is None or isinstance(ids, basestring))
82
assert(kinds is None or isinstance(kinds, basestring))
110
84
if ids is not None:
112
86
if kinds is not None:
115
files = [path.strip('/') for path in files]
118
90
ids = [None] * len(files)
120
if not (len(ids) == len(files)):
121
raise AssertionError()
92
assert(len(ids) == len(files))
123
95
kinds = [None] * len(files)
124
elif not len(kinds) == len(files):
125
raise AssertionError()
97
assert(len(kinds) == len(files))
127
99
# generic constraint checks:
128
100
if self.is_control_filename(f):
129
101
raise errors.ForbiddenControlFileError(filename=f)
130
fp = osutils.splitpath(f)
131
# 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
132
106
# caring about the instantaneous file kind within a uncommmitted tree
134
108
self._gather_kinds(files, kinds)
135
109
self._add(files, ids, kinds)
137
def add_reference(self, sub_tree):
138
"""Add a TreeReference to the tree, pointing at sub_tree"""
139
raise errors.UnsupportedOperation(self.add_reference, self)
141
def _add_reference(self, sub_tree):
142
"""Standard add_reference implementation, for use by subclasses"""
144
sub_tree_path = self.relpath(sub_tree.basedir)
145
except errors.PathNotChild:
146
raise errors.BadReferenceTarget(self, sub_tree,
147
'Target not inside tree.')
148
sub_tree_id = sub_tree.get_root_id()
149
if sub_tree_id == self.get_root_id():
150
raise errors.BadReferenceTarget(self, sub_tree,
151
'Trees have the same root id.')
152
if sub_tree_id in self.inventory:
153
raise errors.BadReferenceTarget(self, sub_tree,
154
'Root id already present in tree')
155
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
157
111
def _add(self, files, ids, kinds):
158
"""Helper function for add - updates the inventory.
160
:param files: sequence of pathnames, relative to the tree root
161
:param ids: sequence of suggested ids for the files (may be None)
162
:param kinds: sequence of inventory kinds of the files (i.e. may
163
contain "tree-reference")
112
"""Helper function for add - updates the inventory."""
165
113
raise NotImplementedError(self._add)
167
@needs_tree_write_lock
168
def apply_inventory_delta(self, changes):
169
"""Apply changes to the inventory as an atomic operation.
171
:param changes: An inventory delta to apply to the working tree's
174
:seealso Inventory.apply_delta: For details on the changes parameter.
178
inv.apply_delta(changes)
179
self._write_inventory(inv)
181
115
@needs_write_lock
182
def commit(self, message=None, revprops=None, *args,
116
def commit(self, message=None, revprops=None, *args, **kwargs):
184
117
# avoid circular imports
185
118
from bzrlib import commit
186
possible_master_transports=[]
187
revprops = commit.Commit.update_revprops(
190
kwargs.pop('authors', None),
191
kwargs.pop('author', None),
192
kwargs.get('local', False),
193
possible_master_transports)
121
if not 'branch-nick' in revprops:
122
revprops['branch-nick'] = self.branch.nick
194
123
# args for wt.commit start at message from the Commit.commit method,
195
args = (message, ) + args
196
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
198
127
committed_id = commit.Commit().commit(working_tree=self,
200
possible_master_transports=possible_master_transports,
202
post_hook_params = PostCommitHookParams(self)
203
for hook in MutableTree.hooks['post_commit']:
204
hook(post_hook_params)
128
revprops=revprops, *args, **kwargs)
205
129
return committed_id
207
131
def _gather_kinds(self, files, kinds):
318
179
raise NotImplementedError(self.mkdir)
320
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
321
"""Tell the tree we have observed a paths sha1.
323
The intent of this function is to allow trees that have a hashcache to
324
update the hashcache during commit. If the observed file is too new
325
(based on the stat_value) to be safely hash-cached the tree will ignore
328
The default implementation does nothing.
330
:param file_id: The file id
331
:param path: The file path
332
:param sha1: The sha 1 that was observed.
333
:param stat_value: A stat result for the file the sha1 was read from.
337
def _fix_case_of_inventory_path(self, path):
338
"""If our tree isn't case sensitive, return the canonical path"""
339
if not self.case_sensitive:
340
path = self.get_canonical_inventory_path(path)
344
def put_file_bytes_non_atomic(self, file_id, bytes):
345
"""Update the content of a file in the tree.
347
Note that the file is written in-place rather than being
348
written to a temporary location and renamed. As a consequence,
349
readers can potentially see the file half-written.
351
:param file_id: file-id of the file
352
:param bytes: the new file contents
354
raise NotImplementedError(self.put_file_bytes_non_atomic)
356
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
357
"""Set the parents ids of the working tree.
359
:param revision_ids: A list of revision_ids.
361
raise NotImplementedError(self.set_parent_ids)
363
181
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
364
182
"""Set the parents of the working tree.
366
:param parents_list: A list of (revision_id, tree) tuples.
184
:param parents_list: A list of (revision_id, tree) tuples.
367
185
If tree is None, then that element is treated as an unreachable
368
186
parent tree - i.e. a ghost.
370
188
raise NotImplementedError(self.set_parent_trees)
372
@needs_tree_write_lock
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
# not in an inner loop; and we want to remove direct use of this,
394
# so here as a reminder for now. RBC 20070703
395
from bzrlib.inventory import InventoryEntry
397
action = add.AddAction()
400
# no paths supplied: add the entire tree.
401
# FIXME: this assumes we are running in a working tree subdir :-/
404
# mutter("smart add of %r")
410
conflicts_related = set()
411
# Not all mutable trees can have conflicts
412
if getattr(self, 'conflicts', None) is not None:
413
# Collect all related files without checking whether they exist or
414
# are versioned. It's cheaper to do that once for all conflicts
415
# than trying to find the relevant conflict for each added file.
416
for c in self.conflicts():
417
conflicts_related.update(c.associated_filenames())
419
# expand any symlinks in the directory part, while leaving the
421
file_list = map(osutils.normalizepath, file_list)
423
# validate user file paths and convert all paths to tree
424
# relative : it's cheaper to make a tree relative path an abspath
425
# than to convert an abspath to tree relative, and it's cheaper to
426
# perform the canonicalization in bulk.
427
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
428
rf = _FastPath(filepath)
429
# validate user parameters. Our recursive code avoids adding new
430
# files that need such validation
431
if self.is_control_filename(rf.raw_path):
432
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
434
abspath = self.abspath(rf.raw_path)
435
kind = osutils.file_kind(abspath)
436
if kind == 'directory':
437
# schedule the dir for scanning
440
if not InventoryEntry.versionable_kind(kind):
441
raise errors.BadFileKindError(filename=abspath, kind=kind)
442
# ensure the named path is added, so that ignore rules in the later
443
# directory walk dont skip it.
444
# we dont have a parent ie known yet.: use the relatively slower
445
# inventory probing method
446
versioned = inv.has_filename(rf.raw_path)
449
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
452
# no need to walk any directories at all.
453
if len(added) > 0 and save:
454
self._write_inventory(inv)
455
return added, ignored
457
# only walk the minimal parents needed: we have user_dirs to override
461
is_inside = osutils.is_inside_or_parent_of_any
462
for path in sorted(user_dirs):
463
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
464
dirs_to_add.append((path, None))
465
prev_dir = path.raw_path
467
illegalpath_re = re.compile(r'[\r\n]')
468
# dirs_to_add is initialised to a list of directories, but as we scan
469
# directories we append files to it.
470
# XXX: We should determine kind of files when we scan them rather than
471
# adding to this list. RBC 20070703
472
for directory, parent_ie in dirs_to_add:
473
# directory is tree-relative
474
abspath = self.abspath(directory.raw_path)
476
# get the contents of this directory.
478
# find the kind of the path being added.
479
kind = osutils.file_kind(abspath)
481
if not InventoryEntry.versionable_kind(kind):
482
trace.warning("skipping %s (can't add file of kind '%s')",
485
if illegalpath_re.search(directory.raw_path):
486
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
488
if directory.raw_path in conflicts_related:
489
# If the file looks like one generated for a conflict, don't
492
'skipping %s (generated to help resolve conflicts)',
496
if parent_ie is not None:
497
versioned = directory.base_path in parent_ie.children
499
# without the parent ie, use the relatively slower inventory
501
versioned = inv.has_filename(
502
self._fix_case_of_inventory_path(directory.raw_path))
504
if kind == 'directory':
506
sub_branch = bzrdir.BzrDir.open(abspath)
508
except errors.NotBranchError:
510
except errors.UnsupportedFormatError:
515
if directory.raw_path == '':
516
# mutter("tree root doesn't need to be added")
520
# mutter("%r is already versioned", abspath)
522
# XXX: This is wrong; people *might* reasonably be trying to
523
# add subtrees as subtrees. This should probably only be done
524
# in formats which can represent subtrees, and even then
525
# perhaps only when the user asked to add subtrees. At the
526
# moment you can add them specially through 'join --reference',
527
# which is perhaps reasonable: adding a new reference is a
528
# special operation and can have a special behaviour. mbp
530
trace.mutter("%r is a nested bzr tree", abspath)
532
_add_one(self, inv, parent_ie, directory, kind, action)
533
added.append(directory.raw_path)
535
if kind == 'directory' and not sub_tree:
536
if parent_ie is not None:
538
this_ie = parent_ie.children[directory.base_path]
540
# without the parent ie, use the relatively slower inventory
542
this_id = inv.path2id(
543
self._fix_case_of_inventory_path(directory.raw_path))
547
this_ie = inv[this_id]
549
for subf in sorted(os.listdir(abspath)):
550
# here we could use TreeDirectory rather than
551
# string concatenation.
552
subp = osutils.pathjoin(directory.raw_path, subf)
553
# TODO: is_control_filename is very slow. Make it faster.
554
# TreeDirectory.is_control_filename could also make this
555
# faster - its impossible for a non root dir to have a
557
if self.is_control_filename(subp):
558
trace.mutter("skip control directory %r", subp)
559
elif subf in this_ie.children:
560
# recurse into this already versioned subdir.
561
dirs_to_add.append((_FastPath(subp, subf), this_ie))
563
# user selection overrides ignoes
564
# ignore while selecting files - if we globbed in the
565
# outer loop we would ignore user files.
566
ignore_glob = self.is_ignored(subp)
567
if ignore_glob is not None:
568
# mutter("skip ignored sub-file %r", subp)
569
ignored.setdefault(ignore_glob, []).append(subp)
571
#mutter("queue to add sub-file %r", subp)
572
dirs_to_add.append((_FastPath(subp, subf), this_ie))
576
self._write_inventory(inv)
578
self.read_working_inventory()
579
return added, ignored
581
def update_basis_by_delta(self, new_revid, delta):
582
"""Update the parents of this tree after a commit.
584
This gives the tree one parent, with revision id new_revid. The
585
inventory delta is applied to the current basis tree to generate the
586
inventory for the parent new_revid, and all other parent trees are
589
All the changes in the delta should be changes synchronising the basis
590
tree with some or all of the working tree, with a change to a directory
591
requiring that its contents have been recursively included. That is,
592
this is not a general purpose tree modification routine, but a helper
593
for commit which is not required to handle situations that do not arise
596
See the inventory developers documentation for the theory behind
599
:param new_revid: The new revision id for the trees parent.
600
:param delta: An inventory delta (see apply_inventory_delta) describing
601
the changes from the current left most parent revision to new_revid.
603
# if the tree is updated by a pull to the branch, as happens in
604
# WorkingTree2, when there was no separation between branch and tree,
605
# then just clear merges, efficiency is not a concern for now as this
606
# is legacy environments only, and they are slow regardless.
607
if self.last_revision() == new_revid:
608
self.set_parent_ids([new_revid])
610
# generic implementation based on Inventory manipulation. See
611
# WorkingTree classes for optimised versions for specific format trees.
612
basis = self.basis_tree()
614
# TODO: Consider re-evaluating the need for this with CHKInventory
615
# we don't strictly need to mutate an inventory for this
616
# it only makes sense when apply_delta is cheaper than get_inventory()
617
inventory = basis.inventory._get_mutable_inventory()
619
inventory.apply_delta(delta)
620
rev_tree = revisiontree.RevisionTree(self.branch.repository,
621
inventory, new_revid)
622
self.set_parent_trees([(new_revid, rev_tree)])
625
class MutableTreeHooks(hooks.Hooks):
626
"""A dictionary mapping a hook name to a list of callables for mutabletree
631
"""Create the default hooks.
634
hooks.Hooks.__init__(self)
635
self.create_hook(hooks.HookPoint('start_commit',
636
"Called before a commit is performed on a tree. The start commit "
637
"hook is able to change the tree before the commit takes place. "
638
"start_commit is called with the bzrlib.mutabletree.MutableTree "
639
"that the commit is being performed on.", (1, 4), None))
640
self.create_hook(hooks.HookPoint('post_commit',
641
"Called after a commit is performed on a tree. The hook is "
642
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
643
"The mutable tree the commit was performed on is available via "
644
"the mutable_tree attribute of that object.", (2, 0), None))
647
# install the default hooks into the MutableTree class.
648
MutableTree.hooks = MutableTreeHooks()
651
class PostCommitHookParams(object):
652
"""Parameters for the post_commit hook.
654
To access the parameters, use the following attributes:
656
* mutable_tree - the MutableTree object
659
def __init__(self, mutable_tree):
660
"""Create the parameters for the post_commit hook."""
661
self.mutable_tree = mutable_tree
664
class _FastPath(object):
665
"""A path object with fast accessors for things like basename."""
667
__slots__ = ['raw_path', 'base_path']
669
def __init__(self, path, base_path=None):
670
"""Construct a FastPath from path."""
671
if base_path is None:
672
self.base_path = osutils.basename(path)
674
self.base_path = base_path
677
def __cmp__(self, other):
678
return cmp(self.raw_path, other.raw_path)
681
return hash(self.raw_path)
684
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
685
"""Add a new entry to the inventory and automatically add unversioned parents.
687
:param inv: Inventory which will receive the new entry.
688
:param parent_ie: Parent inventory entry if known, or None. If
689
None, the parent is looked up by name and used if present, otherwise it
690
is recursively added.
691
:param kind: Kind of new entry (file, directory, etc)
692
:param action: callback(inv, parent_ie, path, kind); return ignored.
693
:return: A list of paths which have been added.
695
# Nothing to do if path is already versioned.
696
# This is safe from infinite recursion because the tree root is
698
if parent_ie is not None:
699
# we have a parent ie already
702
# slower but does not need parent_ie
703
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
705
# its really not there : add the parent
706
# note that the dirname use leads to some extra str copying etc but as
707
# there are a limited number of dirs we can be nested under, it should
708
# generally find it very fast and not recurse after that.
709
added = _add_one_and_parent(tree, inv, None,
710
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
711
parent_id = inv.path2id(osutils.dirname(path.raw_path))
712
parent_ie = inv[parent_id]
713
_add_one(tree, inv, parent_ie, path, kind, action)
714
return added + [path.raw_path]
717
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
718
"""Add a new entry to the inventory.
720
:param inv: Inventory which will receive the new entry.
721
:param parent_ie: Parent inventory entry.
722
:param kind: Kind of new entry (file, directory, etc)
723
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
724
file_id or None to generate a new file id
727
# if the parent exists, but isn't a directory, we have to do the
728
# kind change now -- really the inventory shouldn't pretend to know
729
# the kind of wt files, but it does.
730
if parent_ie.kind != 'directory':
731
# nb: this relies on someone else checking that the path we're using
732
# doesn't contain symlinks.
733
new_parent_ie = inventory.make_entry('directory', parent_ie.name,
734
parent_ie.parent_id, parent_ie.file_id)
735
del inv[parent_ie.file_id]
736
inv.add(new_parent_ie)
737
parent_ie = new_parent_ie
738
file_id = file_id_callback(inv, parent_ie, path, kind)
739
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
