~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/mutabletree.py

  • Committer: Gordon Tyler
  • Date: 2010-02-02 06:30:43 UTC
  • mto: (5037.3.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5046.
  • Revision ID: gordon@doxxx.net-20100202063043-3ygr1114d25m3f7m
Added cmdline.split function, which replaces commands.shlex_split_unicode.

Show diffs side-by-side

added added

removed removed

Lines of Context:
23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
25
25
import os
 
26
import re
26
27
 
27
28
from bzrlib import (
28
29
    add,
29
30
    bzrdir,
 
31
    errors,
30
32
    hooks,
 
33
    osutils,
 
34
    revisiontree,
31
35
    symbol_versioning,
 
36
    trace,
 
37
    tree,
32
38
    )
33
 
from bzrlib.osutils import dirname
34
 
from bzrlib.revisiontree import RevisionTree
35
 
from bzrlib.trace import mutter, warning
36
39
""")
37
40
 
38
 
from bzrlib import (
39
 
    errors,
40
 
    osutils,
41
 
    tree,
42
 
    )
43
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
 
from bzrlib.osutils import splitpath
45
42
 
46
43
 
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)
132
 
            fp = splitpath(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
135
132
        #
226
223
            revprops=revprops,
227
224
            possible_master_transports=possible_master_transports,
228
225
            *args, **kwargs)
 
226
        post_hook_params = PostCommitHookParams(self)
 
227
        for hook in MutableTree.hooks['post_commit']:
 
228
            hook(post_hook_params)
229
229
        return committed_id
230
230
 
231
231
    def _gather_kinds(self, files, kinds):
232
232
        """Helper function for add - sets the entries of kinds."""
233
233
        raise NotImplementedError(self._gather_kinds)
234
234
 
235
 
    def get_file_with_stat(self, file_id, path=None):
236
 
        """Get a file handle and stat object for file_id.
237
 
 
238
 
        The default implementation returns (self.get_file, None) for backwards
239
 
        compatibility.
240
 
 
241
 
        :param file_id: The file id to read.
242
 
        :param path: The path of the file, if it is known.
243
 
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
244
 
            no stat facility, or need for a stat cache feedback during commit,
245
 
            it may return None for the second element of the tuple.
 
235
    @needs_read_lock
 
236
    def has_changes(self, _from_tree=None):
 
237
        """Quickly check that the tree contains at least one commitable change.
 
238
 
 
239
        :param _from_tree: tree to compare against to find changes (default to
 
240
            the basis tree and is intended to be used by tests).
 
241
 
 
242
        :return: True if a change is found. False otherwise
246
243
        """
247
 
        return (self.get_file(file_id, path), None)
 
244
        # Check pending merges
 
245
        if len(self.get_parent_ids()) > 1:
 
246
            return True
 
247
        if _from_tree is None:
 
248
            _from_tree = self.basis_tree()
 
249
        changes = self.iter_changes(_from_tree)
 
250
        try:
 
251
            change = changes.next()
 
252
            # Exclude root (talk about black magic... --vila 20090629)
 
253
            if change[4] == (None, None):
 
254
                change = changes.next()
 
255
            return True
 
256
        except StopIteration:
 
257
            # No changes
 
258
            return False
248
259
 
249
260
    @needs_read_lock
250
261
    def last_revision(self):
383
394
        # perform the canonicalization in bulk.
384
395
        for filepath in osutils.canonical_relpaths(self.basedir, file_list):
385
396
            rf = _FastPath(filepath)
386
 
            # validate user parameters. Our recursive code avoids adding new files
387
 
            # that need such validation
 
397
            # validate user parameters. Our recursive code avoids adding new
 
398
            # files that need such validation
388
399
            if self.is_control_filename(rf.raw_path):
389
400
                raise errors.ForbiddenControlFileError(filename=rf.raw_path)
390
401
 
396
407
            else:
397
408
                if not InventoryEntry.versionable_kind(kind):
398
409
                    raise errors.BadFileKindError(filename=abspath, kind=kind)
399
 
            # ensure the named path is added, so that ignore rules in the later directory
400
 
            # walk dont skip it.
401
 
            # we dont have a parent ie known yet.: use the relatively slower inventory
402
 
            # probing method
 
410
            # ensure the named path is added, so that ignore rules in the later
 
411
            # directory walk dont skip it.
 
412
            # we dont have a parent ie known yet.: use the relatively slower
 
413
            # inventory probing method
403
414
            versioned = inv.has_filename(rf.raw_path)
404
415
            if versioned:
405
416
                continue
421
432
                dirs_to_add.append((path, None))
422
433
            prev_dir = path.raw_path
423
434
 
 
435
        illegalpath_re = re.compile(r'[\r\n]')
424
436
        # dirs_to_add is initialised to a list of directories, but as we scan
425
437
        # directories we append files to it.
426
438
        # XXX: We should determine kind of files when we scan them rather than
435
447
            kind = osutils.file_kind(abspath)
436
448
 
437
449
            if not InventoryEntry.versionable_kind(kind):
438
 
                warning("skipping %s (can't add file of kind '%s')", abspath, kind)
 
450
                trace.warning("skipping %s (can't add file of kind '%s')",
 
451
                              abspath, kind)
 
452
                continue
 
453
            if illegalpath_re.search(directory.raw_path):
 
454
                trace.warning("skipping %r (contains \\n or \\r)" % abspath)
439
455
                continue
440
456
 
441
457
            if parent_ie is not None:
464
480
                pass
465
481
                # mutter("%r is already versioned", abspath)
466
482
            elif sub_tree:
467
 
                # XXX: This is wrong; people *might* reasonably be trying to add
468
 
                # subtrees as subtrees.  This should probably only be done in formats
469
 
                # which can represent subtrees, and even then perhaps only when
470
 
                # the user asked to add subtrees.  At the moment you can add them
471
 
                # specially through 'join --reference', which is perhaps
472
 
                # reasonable: adding a new reference is a special operation and
473
 
                # can have a special behaviour.  mbp 20070306
474
 
                mutter("%r is a nested bzr tree", abspath)
 
483
                # XXX: This is wrong; people *might* reasonably be trying to
 
484
                # add subtrees as subtrees.  This should probably only be done
 
485
                # in formats which can represent subtrees, and even then
 
486
                # perhaps only when the user asked to add subtrees.  At the
 
487
                # moment you can add them specially through 'join --reference',
 
488
                # which is perhaps reasonable: adding a new reference is a
 
489
                # special operation and can have a special behaviour.  mbp
 
490
                # 20070306
 
491
                trace.mutter("%r is a nested bzr tree", abspath)
475
492
            else:
476
493
                _add_one(self, inv, parent_ie, directory, kind, action)
477
494
                added.append(directory.raw_path)
484
501
                    # without the parent ie, use the relatively slower inventory
485
502
                    # probing method
486
503
                    this_id = inv.path2id(
487
 
                            self._fix_case_of_inventory_path(directory.raw_path))
 
504
                        self._fix_case_of_inventory_path(directory.raw_path))
488
505
                    if this_id is None:
489
506
                        this_ie = None
490
507
                    else:
499
516
                    # faster - its impossible for a non root dir to have a
500
517
                    # control file.
501
518
                    if self.is_control_filename(subp):
502
 
                        mutter("skip control directory %r", subp)
 
519
                        trace.mutter("skip control directory %r", subp)
503
520
                    elif subf in this_ie.children:
504
521
                        # recurse into this already versioned subdir.
505
522
                        dirs_to_add.append((_FastPath(subp, subf), this_ie))
537
554
        for commit which is not required to handle situations that do not arise
538
555
        outside of commit.
539
556
 
 
557
        See the inventory developers documentation for the theory behind
 
558
        inventory deltas.
 
559
 
540
560
        :param new_revid: The new revision id for the trees parent.
541
561
        :param delta: An inventory delta (see apply_inventory_delta) describing
542
562
            the changes from the current left most parent revision to new_revid.
558
578
        inventory = basis.inventory._get_mutable_inventory()
559
579
        basis.unlock()
560
580
        inventory.apply_delta(delta)
561
 
        rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
 
581
        rev_tree = revisiontree.RevisionTree(self.branch.repository,
 
582
                                             inventory, new_revid)
562
583
        self.set_parent_trees([(new_revid, rev_tree)])
563
584
 
564
585
 
575
596
        self.create_hook(hooks.HookPoint('start_commit',
576
597
            "Called before a commit is performed on a tree. The start commit "
577
598
            "hook is able to change the tree before the commit takes place. "
578
 
            "start_commit is called with the bzrlib.tree.MutableTree that the "
579
 
            "commit is being performed on.", (1, 4), None))
 
599
            "start_commit is called with the bzrlib.mutabletree.MutableTree "
 
600
            "that the commit is being performed on.", (1, 4), None))
 
601
        self.create_hook(hooks.HookPoint('post_commit',
 
602
            "Called after a commit is performed on a tree. The hook is "
 
603
            "called with a bzrlib.mutabletree.PostCommitHookParams object. "
 
604
            "The mutable tree the commit was performed on is available via "
 
605
            "the mutable_tree attribute of that object.", (2, 0), None))
580
606
 
581
607
 
582
608
# install the default hooks into the MutableTree class.
583
609
MutableTree.hooks = MutableTreeHooks()
584
610
 
585
611
 
 
612
class PostCommitHookParams(object):
 
613
    """Parameters for the post_commit hook.
 
614
 
 
615
    To access the parameters, use the following attributes:
 
616
 
 
617
    * mutable_tree - the MutableTree object
 
618
    """
 
619
 
 
620
    def __init__(self, mutable_tree):
 
621
        """Create the parameters for the post_commit hook."""
 
622
        self.mutable_tree = mutable_tree
 
623
 
 
624
 
586
625
class _FastPath(object):
587
626
    """A path object with fast accessors for things like basename."""
588
627
 
629
668
        # there are a limited number of dirs we can be nested under, it should
630
669
        # generally find it very fast and not recurse after that.
631
670
        added = _add_one_and_parent(tree, inv, None,
632
 
            _FastPath(dirname(path.raw_path)), 'directory', action)
633
 
        parent_id = inv.path2id(dirname(path.raw_path))
 
671
            _FastPath(osutils.dirname(path.raw_path)), 'directory', action)
 
672
        parent_id = inv.path2id(osutils.dirname(path.raw_path))
634
673
        parent_ie = inv[parent_id]
635
674
    _add_one(tree, inv, parent_ie, path, kind, action)
636
675
    return added + [path.raw_path]