23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
27
28
from bzrlib import (
33
from bzrlib.osutils import dirname
34
from bzrlib.revisiontree import RevisionTree
35
from bzrlib.trace import mutter, warning
43
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
from bzrlib.osutils import splitpath
47
45
def needs_tree_write_lock(unbound):
129
127
# generic constraint checks:
130
128
if self.is_control_filename(f):
131
129
raise errors.ForbiddenControlFileError(filename=f)
130
fp = osutils.splitpath(f)
133
131
# fill out file kinds for all files [not needed when we stop
134
132
# caring about the instantaneous file kind within a uncommmitted tree
186
184
# avoid circular imports
187
185
from bzrlib import commit
190
186
possible_master_transports=[]
191
if not 'branch-nick' in revprops:
192
revprops['branch-nick'] = self.branch._get_nick(
187
revprops = commit.Commit.update_revprops(
190
kwargs.pop('authors', None),
191
kwargs.pop('author', None),
193
192
kwargs.get('local', False),
194
193
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
221
194
# args for wt.commit start at message from the Commit.commit method,
222
195
args = (message, ) + args
223
196
for hook in MutableTree.hooks['start_commit']:
226
199
revprops=revprops,
227
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)
229
205
return committed_id
231
207
def _gather_kinds(self, files, kinds):
233
209
raise NotImplementedError(self._gather_kinds)
212
def has_changes(self, _from_tree=None):
213
"""Quickly check that the tree contains at least one commitable change.
215
:param _from_tree: tree to compare against to find changes (default to
216
the basis tree and is intended to be used by tests).
218
:return: True if a change is found. False otherwise
220
# Check pending merges
221
if len(self.get_parent_ids()) > 1:
223
if _from_tree is None:
224
_from_tree = self.basis_tree()
225
changes = self.iter_changes(_from_tree)
227
change = changes.next()
228
# Exclude root (talk about black magic... --vila 20090629)
229
if change[4] == (None, None):
230
change = changes.next()
232
except StopIteration:
237
def check_changed_or_out_of_date(self, strict, opt_name,
238
more_error, more_warning):
239
"""Check the tree for uncommitted changes and branch synchronization.
241
If strict is None and not set in the config files, a warning is issued.
242
If strict is True, an error is raised.
243
If strict is False, no checks are done and no warning is issued.
245
:param strict: True, False or None, searched in branch config if None.
247
:param opt_name: strict option name to search in config file.
249
:param more_error: Details about how to avoid the check.
251
:param more_warning: Details about what is happening.
254
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
255
if strict is not False:
257
if (self.has_changes()):
258
err_class = errors.UncommittedChanges
259
elif self.last_revision() != self.branch.last_revision():
260
# The tree has lost sync with its branch, there is little
261
# chance that the user is aware of it but he can still force
262
# the action with --no-strict
263
err_class = errors.OutOfDateTree
264
if err_class is not None:
266
err = err_class(self, more=more_warning)
267
# We don't want to interrupt the user if he expressed no
268
# preference about strict.
269
trace.warning('%s', err._format())
271
err = err_class(self, more=more_error)
236
275
def last_revision(self):
237
276
"""Return the revision id of the last commit performed in this tree.
337
376
This is designed more towards DWIM for humans than API clarity.
338
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
340
383
:param action: A reporter to be called with the inventory, parent_ie,
341
384
path and kind of the path being added. It may return a file_id if
342
385
a specific one should be used.
364
409
user_dirs = set()
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)
366
423
# validate user file paths and convert all paths to tree
367
424
# relative : it's cheaper to make a tree relative path an abspath
369
426
# perform the canonicalization in bulk.
370
427
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
371
428
rf = _FastPath(filepath)
372
# validate user parameters. Our recursive code avoids adding new files
373
# that need such validation
429
# validate user parameters. Our recursive code avoids adding new
430
# files that need such validation
374
431
if self.is_control_filename(rf.raw_path):
375
432
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
383
440
if not InventoryEntry.versionable_kind(kind):
384
441
raise errors.BadFileKindError(filename=abspath, kind=kind)
385
# ensure the named path is added, so that ignore rules in the later directory
387
# we dont have a parent ie known yet.: use the relatively slower inventory
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
389
446
versioned = inv.has_filename(rf.raw_path)
407
464
dirs_to_add.append((path, None))
408
465
prev_dir = path.raw_path
467
illegalpath_re = re.compile(r'[\r\n]')
410
468
# dirs_to_add is initialised to a list of directories, but as we scan
411
469
# directories we append files to it.
412
470
# XXX: We should determine kind of files when we scan them rather than
421
479
kind = osutils.file_kind(abspath)
423
481
if not InventoryEntry.versionable_kind(kind):
424
warning("skipping %s (can't add file of kind '%s')", abspath, 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)',
427
496
if parent_ie is not None:
451
520
# mutter("%r is already versioned", abspath)
453
# XXX: This is wrong; people *might* reasonably be trying to add
454
# subtrees as subtrees. This should probably only be done in formats
455
# which can represent subtrees, and even then perhaps only when
456
# the user asked to add subtrees. At the moment you can add them
457
# specially through 'join --reference', which is perhaps
458
# reasonable: adding a new reference is a special operation and
459
# can have a special behaviour. mbp 20070306
460
mutter("%r is a nested bzr tree", 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)
462
532
_add_one(self, inv, parent_ie, directory, kind, action)
463
533
added.append(directory.raw_path)
485
555
# faster - its impossible for a non root dir to have a
487
557
if self.is_control_filename(subp):
488
mutter("skip control directory %r", subp)
558
trace.mutter("skip control directory %r", subp)
489
559
elif subf in this_ie.children:
490
560
# recurse into this already versioned subdir.
491
561
dirs_to_add.append((_FastPath(subp, subf), this_ie))
523
593
for commit which is not required to handle situations that do not arise
524
594
outside of commit.
596
See the inventory developers documentation for the theory behind
526
599
:param new_revid: The new revision id for the trees parent.
527
600
:param delta: An inventory delta (see apply_inventory_delta) describing
528
601
the changes from the current left most parent revision to new_revid.
544
617
inventory = basis.inventory._get_mutable_inventory()
546
619
inventory.apply_delta(delta)
547
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
620
rev_tree = revisiontree.RevisionTree(self.branch.repository,
621
inventory, new_revid)
548
622
self.set_parent_trees([(new_revid, rev_tree)])
561
635
self.create_hook(hooks.HookPoint('start_commit',
562
636
"Called before a commit is performed on a tree. The start commit "
563
637
"hook is able to change the tree before the commit takes place. "
564
"start_commit is called with the bzrlib.tree.MutableTree that the "
565
"commit is being performed on.", (1, 4), None))
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))
568
647
# install the default hooks into the MutableTree class.
569
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
572
664
class _FastPath(object):
573
665
"""A path object with fast accessors for things like basename."""
615
707
# there are a limited number of dirs we can be nested under, it should
616
708
# generally find it very fast and not recurse after that.
617
709
added = _add_one_and_parent(tree, inv, None,
618
_FastPath(dirname(path.raw_path)), 'directory', action)
619
parent_id = inv.path2id(dirname(path.raw_path))
710
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
711
parent_id = inv.path2id(osutils.dirname(path.raw_path))
620
712
parent_ie = inv[parent_id]
621
713
_add_one(tree, inv, parent_ie, path, kind, action)
622
714
return added + [path.raw_path]
632
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
635
738
file_id = file_id_callback(inv, parent_ie, path, kind)
636
739
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
