~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/mutabletree.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-02 16:03:51 UTC
  • mto: (4634.39.1 pdf-chm-docs)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090902160351-sxptcz3ttc1aencw
first cut at pdf docs via sphinx

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
27
26
 
28
27
from bzrlib import (
29
28
    add,
30
29
    bzrdir,
 
30
    hooks,
 
31
    symbol_versioning,
 
32
    )
 
33
from bzrlib.osutils import dirname
 
34
from bzrlib.revisiontree import RevisionTree
 
35
from bzrlib.trace import mutter, warning
 
36
""")
 
37
 
 
38
from bzrlib import (
31
39
    errors,
32
 
    hooks,
33
40
    osutils,
34
 
    revisiontree,
35
 
    symbol_versioning,
36
 
    trace,
37
41
    tree,
38
42
    )
39
 
""")
40
 
 
41
43
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
44
from bzrlib.osutils import splitpath
42
45
 
43
46
 
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)
 
132
            fp = 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
132
135
        #
223
226
            revprops=revprops,
224
227
            possible_master_transports=possible_master_transports,
225
228
            *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):
233
233
        raise NotImplementedError(self._gather_kinds)
234
234
 
235
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).
 
236
    def has_changes(self, from_tree):
 
237
        """Quickly check that the tree contains at least one change.
241
238
 
242
239
        :return: True if a change is found. False otherwise
243
240
        """
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)
 
241
        changes = self.iter_changes(from_tree)
250
242
        try:
251
243
            change = changes.next()
252
244
            # Exclude root (talk about black magic... --vila 20090629)
394
386
        # perform the canonicalization in bulk.
395
387
        for filepath in osutils.canonical_relpaths(self.basedir, file_list):
396
388
            rf = _FastPath(filepath)
397
 
            # validate user parameters. Our recursive code avoids adding new
398
 
            # files that need such validation
 
389
            # validate user parameters. Our recursive code avoids adding new files
 
390
            # that need such validation
399
391
            if self.is_control_filename(rf.raw_path):
400
392
                raise errors.ForbiddenControlFileError(filename=rf.raw_path)
401
393
 
407
399
            else:
408
400
                if not InventoryEntry.versionable_kind(kind):
409
401
                    raise errors.BadFileKindError(filename=abspath, kind=kind)
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
 
402
            # ensure the named path is added, so that ignore rules in the later directory
 
403
            # walk dont skip it.
 
404
            # we dont have a parent ie known yet.: use the relatively slower inventory
 
405
            # probing method
414
406
            versioned = inv.has_filename(rf.raw_path)
415
407
            if versioned:
416
408
                continue
432
424
                dirs_to_add.append((path, None))
433
425
            prev_dir = path.raw_path
434
426
 
435
 
        illegalpath_re = re.compile(r'[\r\n]')
436
427
        # dirs_to_add is initialised to a list of directories, but as we scan
437
428
        # directories we append files to it.
438
429
        # XXX: We should determine kind of files when we scan them rather than
447
438
            kind = osutils.file_kind(abspath)
448
439
 
449
440
            if not InventoryEntry.versionable_kind(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)
 
441
                warning("skipping %s (can't add file of kind '%s')", abspath, kind)
455
442
                continue
456
443
 
457
444
            if parent_ie is not None:
480
467
                pass
481
468
                # mutter("%r is already versioned", abspath)
482
469
            elif sub_tree:
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)
 
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)
492
478
            else:
493
479
                _add_one(self, inv, parent_ie, directory, kind, action)
494
480
                added.append(directory.raw_path)
501
487
                    # without the parent ie, use the relatively slower inventory
502
488
                    # probing method
503
489
                    this_id = inv.path2id(
504
 
                        self._fix_case_of_inventory_path(directory.raw_path))
 
490
                            self._fix_case_of_inventory_path(directory.raw_path))
505
491
                    if this_id is None:
506
492
                        this_ie = None
507
493
                    else:
516
502
                    # faster - its impossible for a non root dir to have a
517
503
                    # control file.
518
504
                    if self.is_control_filename(subp):
519
 
                        trace.mutter("skip control directory %r", subp)
 
505
                        mutter("skip control directory %r", subp)
520
506
                    elif subf in this_ie.children:
521
507
                        # recurse into this already versioned subdir.
522
508
                        dirs_to_add.append((_FastPath(subp, subf), this_ie))
578
564
        inventory = basis.inventory._get_mutable_inventory()
579
565
        basis.unlock()
580
566
        inventory.apply_delta(delta)
581
 
        rev_tree = revisiontree.RevisionTree(self.branch.repository,
582
 
                                             inventory, new_revid)
 
567
        rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
583
568
        self.set_parent_trees([(new_revid, rev_tree)])
584
569
 
585
570
 
596
581
        self.create_hook(hooks.HookPoint('start_commit',
597
582
            "Called before a commit is performed on a tree. The start commit "
598
583
            "hook is able to change the tree before the commit takes place. "
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))
 
584
            "start_commit is called with the bzrlib.tree.MutableTree that the "
 
585
            "commit is being performed on.", (1, 4), None))
606
586
 
607
587
 
608
588
# install the default hooks into the MutableTree class.
609
589
MutableTree.hooks = MutableTreeHooks()
610
590
 
611
591
 
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
 
 
625
592
class _FastPath(object):
626
593
    """A path object with fast accessors for things like basename."""
627
594
 
668
635
        # there are a limited number of dirs we can be nested under, it should
669
636
        # generally find it very fast and not recurse after that.
670
637
        added = _add_one_and_parent(tree, inv, None,
671
 
            _FastPath(osutils.dirname(path.raw_path)), 'directory', action)
672
 
        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))
673
640
        parent_ie = inv[parent_id]
674
641
    _add_one(tree, inv, parent_ie, path, kind, action)
675
642
    return added + [path.raw_path]