1
# Copyright (C) 2006-2010 Canonical Ltd
1
# Copyright (C) 2006, 2007 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(), """
28
27
from bzrlib import (
33
from bzrlib.osutils import dirname
34
from bzrlib.revisiontree import RevisionTree
35
from bzrlib.trace import mutter, warning
41
43
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
from bzrlib.osutils import splitpath
44
47
def needs_tree_write_lock(unbound):
126
129
# generic constraint checks:
127
130
if self.is_control_filename(f):
128
131
raise errors.ForbiddenControlFileError(filename=f)
129
fp = osutils.splitpath(f)
130
133
# fill out file kinds for all files [not needed when we stop
131
134
# caring about the instantaneous file kind within a uncommmitted tree
183
186
# avoid circular imports
184
187
from bzrlib import commit
185
190
possible_master_transports=[]
186
revprops = commit.Commit.update_revprops(
189
kwargs.pop('authors', None),
190
kwargs.pop('author', None),
191
if not 'branch-nick' in revprops:
192
revprops['branch-nick'] = self.branch._get_nick(
191
193
kwargs.get('local', False),
192
194
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
193
221
# args for wt.commit start at message from the Commit.commit method,
194
222
args = (message, ) + args
195
223
for hook in MutableTree.hooks['start_commit']:
198
226
revprops=revprops,
199
227
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)
204
229
return committed_id
206
231
def _gather_kinds(self, files, kinds):
208
233
raise NotImplementedError(self._gather_kinds)
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).
236
def has_changes(self, from_tree):
237
"""Quickly check that the tree contains at least one change.
217
239
:return: True if a change is found. False otherwise
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)
241
changes = self.iter_changes(from_tree)
226
243
change = changes.next()
227
244
# 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)
274
253
def last_revision(self):
275
254
"""Return the revision id of the last commit performed in this tree.
404
381
user_dirs = set()
405
conflicts_related = set()
406
# Not all mutable trees can have conflicts
407
if getattr(self, 'conflicts', None) is not None:
408
# Collect all related files without checking whether they exist or
409
# are versioned. It's cheaper to do that once for all conflicts
410
# than trying to find the relevant conflict for each added file.
411
for c in self.conflicts():
412
conflicts_related.update(c.associated_filenames())
414
383
# validate user file paths and convert all paths to tree
415
384
# relative : it's cheaper to make a tree relative path an abspath
417
386
# perform the canonicalization in bulk.
418
387
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
419
388
rf = _FastPath(filepath)
420
# validate user parameters. Our recursive code avoids adding new
421
# files that need such validation
389
# validate user parameters. Our recursive code avoids adding new files
390
# that need such validation
422
391
if self.is_control_filename(rf.raw_path):
423
392
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
431
400
if not InventoryEntry.versionable_kind(kind):
432
401
raise errors.BadFileKindError(filename=abspath, kind=kind)
433
# ensure the named path is added, so that ignore rules in the later
434
# directory walk dont skip it.
435
# we dont have a parent ie known yet.: use the relatively slower
436
# inventory probing method
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
406
versioned = inv.has_filename(rf.raw_path)
455
424
dirs_to_add.append((path, None))
456
425
prev_dir = path.raw_path
458
illegalpath_re = re.compile(r'[\r\n]')
459
427
# dirs_to_add is initialised to a list of directories, but as we scan
460
428
# directories we append files to it.
461
429
# XXX: We should determine kind of files when we scan them rather than
470
438
kind = osutils.file_kind(abspath)
472
440
if not InventoryEntry.versionable_kind(kind):
473
trace.warning("skipping %s (can't add file of kind '%s')",
476
if illegalpath_re.search(directory.raw_path):
477
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
479
if directory.raw_path in conflicts_related:
480
# If the file looks like one generated for a conflict, don't
483
'skipping %s (generated to help resolve conflicts)',
441
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
487
444
if parent_ie is not None:
511
468
# mutter("%r is already versioned", abspath)
513
# XXX: This is wrong; people *might* reasonably be trying to
514
# add subtrees as subtrees. This should probably only be done
515
# in formats which can represent subtrees, and even then
516
# perhaps only when the user asked to add subtrees. At the
517
# moment you can add them specially through 'join --reference',
518
# which is perhaps reasonable: adding a new reference is a
519
# special operation and can have a special behaviour. mbp
521
trace.mutter("%r is a nested bzr tree", 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)
523
479
_add_one(self, inv, parent_ie, directory, kind, action)
524
480
added.append(directory.raw_path)
546
502
# faster - its impossible for a non root dir to have a
548
504
if self.is_control_filename(subp):
549
trace.mutter("skip control directory %r", subp)
505
mutter("skip control directory %r", subp)
550
506
elif subf in this_ie.children:
551
507
# recurse into this already versioned subdir.
552
508
dirs_to_add.append((_FastPath(subp, subf), this_ie))
608
564
inventory = basis.inventory._get_mutable_inventory()
610
566
inventory.apply_delta(delta)
611
rev_tree = revisiontree.RevisionTree(self.branch.repository,
612
inventory, new_revid)
567
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
613
568
self.set_parent_trees([(new_revid, rev_tree)])
626
581
self.create_hook(hooks.HookPoint('start_commit',
627
582
"Called before a commit is performed on a tree. The start commit "
628
583
"hook is able to change the tree before the commit takes place. "
629
"start_commit is called with the bzrlib.mutabletree.MutableTree "
630
"that the commit is being performed on.", (1, 4), None))
631
self.create_hook(hooks.HookPoint('post_commit',
632
"Called after a commit is performed on a tree. The hook is "
633
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
634
"The mutable tree the commit was performed on is available via "
635
"the mutable_tree attribute of that object.", (2, 0), None))
584
"start_commit is called with the bzrlib.tree.MutableTree that the "
585
"commit is being performed on.", (1, 4), None))
638
588
# install the default hooks into the MutableTree class.
639
589
MutableTree.hooks = MutableTreeHooks()
642
class PostCommitHookParams(object):
643
"""Parameters for the post_commit hook.
645
To access the parameters, use the following attributes:
647
* mutable_tree - the MutableTree object
650
def __init__(self, mutable_tree):
651
"""Create the parameters for the post_commit hook."""
652
self.mutable_tree = mutable_tree
655
592
class _FastPath(object):
656
593
"""A path object with fast accessors for things like basename."""
698
635
# there are a limited number of dirs we can be nested under, it should
699
636
# generally find it very fast and not recurse after that.
700
637
added = _add_one_and_parent(tree, inv, None,
701
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
702
parent_id = inv.path2id(osutils.dirname(path.raw_path))
638
_FastPath(dirname(path.raw_path)), 'directory', action)
639
parent_id = inv.path2id(dirname(path.raw_path))
703
640
parent_ie = inv[parent_id]
704
641
_add_one(tree, inv, parent_ie, path, kind, action)
705
642
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
