1
# Copyright (C) 2006, 2007 Canonical Ltd
1
# Copyright (C) 2006-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
from bzrlib.osutils import splitpath
47
44
def needs_tree_write_lock(unbound):
129
126
# generic constraint checks:
130
127
if self.is_control_filename(f):
131
128
raise errors.ForbiddenControlFileError(filename=f)
129
fp = osutils.splitpath(f)
133
130
# fill out file kinds for all files [not needed when we stop
134
131
# caring about the instantaneous file kind within a uncommmitted tree
186
183
# avoid circular imports
187
184
from bzrlib import commit
190
185
possible_master_transports=[]
191
if not 'branch-nick' in revprops:
192
revprops['branch-nick'] = self.branch._get_nick(
186
revprops = commit.Commit.update_revprops(
189
kwargs.pop('authors', None),
190
kwargs.pop('author', None),
193
191
kwargs.get('local', False),
194
192
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
193
# args for wt.commit start at message from the Commit.commit method,
222
194
args = (message, ) + args
223
195
for hook in MutableTree.hooks['start_commit']:
226
198
revprops=revprops,
227
199
possible_master_transports=possible_master_transports,
201
post_hook_params = PostCommitHookParams(self)
202
for hook in MutableTree.hooks['post_commit']:
203
hook(post_hook_params)
229
204
return committed_id
231
206
def _gather_kinds(self, files, kinds):
233
208
raise NotImplementedError(self._gather_kinds)
236
def has_changes(self, from_tree):
237
"""Quickly check that the tree contains at least one change.
211
def has_changes(self, _from_tree=None):
212
"""Quickly check that the tree contains at least one commitable change.
214
:param _from_tree: tree to compare against to find changes (default to
215
the basis tree and is intended to be used by tests).
239
217
:return: True if a change is found. False otherwise
241
changes = self.iter_changes(from_tree)
219
# Check pending merges
220
if len(self.get_parent_ids()) > 1:
222
if _from_tree is None:
223
_from_tree = self.basis_tree()
224
changes = self.iter_changes(_from_tree)
243
226
change = changes.next()
244
227
# Exclude root (talk about black magic... --vila 20090629)
236
def check_changed_or_out_of_date(self, strict, opt_name,
237
more_error, more_warning):
238
"""Check the tree for uncommitted changes and branch synchronization.
240
If strict is None and not set in the config files, a warning is issued.
241
If strict is True, an error is raised.
242
If strict is False, no checks are done and no warning is issued.
244
:param strict: True, False or None, searched in branch config if None.
246
:param opt_name: strict option name to search in config file.
248
:param more_error: Details about how to avoid the check.
250
:param more_warning: Details about what is happening.
253
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
254
if strict is not False:
256
if (self.has_changes()):
257
err_class = errors.UncommittedChanges
258
elif self.last_revision() != self.branch.last_revision():
259
# The tree has lost sync with its branch, there is little
260
# chance that the user is aware of it but he can still force
261
# the action with --no-strict
262
err_class = errors.OutOfDateTree
263
if err_class is not None:
265
err = err_class(self, more=more_warning)
266
# We don't want to interrupt the user if he expressed no
267
# preference about strict.
268
trace.warning('%s', err._format())
270
err = err_class(self, more=more_error)
253
274
def last_revision(self):
254
275
"""Return the revision id of the last commit performed in this tree.
354
375
This is designed more towards DWIM for humans than API clarity.
355
376
For the specific behaviour see the help for cmd_add().
378
:param file_list: List of zero or more paths. *NB: these are
379
interpreted relative to the process cwd, not relative to the
380
tree.* (Add and most other tree methods use tree-relative
357
382
:param action: A reporter to be called with the inventory, parent_ie,
358
383
path and kind of the path being added. It may return a file_id if
359
384
a specific one should be used.
381
408
user_dirs = set()
409
conflicts_related = set()
410
# Not all mutable trees can have conflicts
411
if getattr(self, 'conflicts', None) is not None:
412
# Collect all related files without checking whether they exist or
413
# are versioned. It's cheaper to do that once for all conflicts
414
# than trying to find the relevant conflict for each added file.
415
for c in self.conflicts():
416
conflicts_related.update(c.associated_filenames())
383
418
# validate user file paths and convert all paths to tree
384
419
# relative : it's cheaper to make a tree relative path an abspath
386
421
# perform the canonicalization in bulk.
387
422
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
388
423
rf = _FastPath(filepath)
389
# validate user parameters. Our recursive code avoids adding new files
390
# that need such validation
424
# validate user parameters. Our recursive code avoids adding new
425
# files that need such validation
391
426
if self.is_control_filename(rf.raw_path):
392
427
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
400
435
if not InventoryEntry.versionable_kind(kind):
401
436
raise errors.BadFileKindError(filename=abspath, kind=kind)
402
# ensure the named path is added, so that ignore rules in the later directory
404
# we dont have a parent ie known yet.: use the relatively slower inventory
437
# ensure the named path is added, so that ignore rules in the later
438
# directory walk dont skip it.
439
# we dont have a parent ie known yet.: use the relatively slower
440
# inventory probing method
406
441
versioned = inv.has_filename(rf.raw_path)
424
459
dirs_to_add.append((path, None))
425
460
prev_dir = path.raw_path
462
illegalpath_re = re.compile(r'[\r\n]')
427
463
# dirs_to_add is initialised to a list of directories, but as we scan
428
464
# directories we append files to it.
429
465
# XXX: We should determine kind of files when we scan them rather than
438
474
kind = osutils.file_kind(abspath)
440
476
if not InventoryEntry.versionable_kind(kind):
441
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
477
trace.warning("skipping %s (can't add file of kind '%s')",
480
if illegalpath_re.search(directory.raw_path):
481
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
483
if directory.raw_path in conflicts_related:
484
# If the file looks like one generated for a conflict, don't
487
'skipping %s (generated to help resolve conflicts)',
444
491
if parent_ie is not None:
468
515
# mutter("%r is already versioned", abspath)
470
# XXX: This is wrong; people *might* reasonably be trying to add
471
# subtrees as subtrees. This should probably only be done in formats
472
# which can represent subtrees, and even then perhaps only when
473
# the user asked to add subtrees. At the moment you can add them
474
# specially through 'join --reference', which is perhaps
475
# reasonable: adding a new reference is a special operation and
476
# can have a special behaviour. mbp 20070306
477
mutter("%r is a nested bzr tree", abspath)
517
# XXX: This is wrong; people *might* reasonably be trying to
518
# add subtrees as subtrees. This should probably only be done
519
# in formats which can represent subtrees, and even then
520
# perhaps only when the user asked to add subtrees. At the
521
# moment you can add them specially through 'join --reference',
522
# which is perhaps reasonable: adding a new reference is a
523
# special operation and can have a special behaviour. mbp
525
trace.mutter("%r is a nested bzr tree", abspath)
479
527
_add_one(self, inv, parent_ie, directory, kind, action)
480
528
added.append(directory.raw_path)
502
550
# faster - its impossible for a non root dir to have a
504
552
if self.is_control_filename(subp):
505
mutter("skip control directory %r", subp)
553
trace.mutter("skip control directory %r", subp)
506
554
elif subf in this_ie.children:
507
555
# recurse into this already versioned subdir.
508
556
dirs_to_add.append((_FastPath(subp, subf), this_ie))
564
612
inventory = basis.inventory._get_mutable_inventory()
566
614
inventory.apply_delta(delta)
567
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
615
rev_tree = revisiontree.RevisionTree(self.branch.repository,
616
inventory, new_revid)
568
617
self.set_parent_trees([(new_revid, rev_tree)])
581
630
self.create_hook(hooks.HookPoint('start_commit',
582
631
"Called before a commit is performed on a tree. The start commit "
583
632
"hook is able to change the tree before the commit takes place. "
584
"start_commit is called with the bzrlib.tree.MutableTree that the "
585
"commit is being performed on.", (1, 4), None))
633
"start_commit is called with the bzrlib.mutabletree.MutableTree "
634
"that the commit is being performed on.", (1, 4), None))
635
self.create_hook(hooks.HookPoint('post_commit',
636
"Called after a commit is performed on a tree. The hook is "
637
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
638
"The mutable tree the commit was performed on is available via "
639
"the mutable_tree attribute of that object.", (2, 0), None))
588
642
# install the default hooks into the MutableTree class.
589
643
MutableTree.hooks = MutableTreeHooks()
646
class PostCommitHookParams(object):
647
"""Parameters for the post_commit hook.
649
To access the parameters, use the following attributes:
651
* mutable_tree - the MutableTree object
654
def __init__(self, mutable_tree):
655
"""Create the parameters for the post_commit hook."""
656
self.mutable_tree = mutable_tree
592
659
class _FastPath(object):
593
660
"""A path object with fast accessors for things like basename."""
635
702
# there are a limited number of dirs we can be nested under, it should
636
703
# generally find it very fast and not recurse after that.
637
704
added = _add_one_and_parent(tree, inv, None,
638
_FastPath(dirname(path.raw_path)), 'directory', action)
639
parent_id = inv.path2id(dirname(path.raw_path))
705
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
706
parent_id = inv.path2id(osutils.dirname(path.raw_path))
640
707
parent_ie = inv[parent_id]
641
708
_add_one(tree, inv, parent_ie, path, kind, action)
642
709
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
