~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
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
19
19
from stat import S_ISREG, S_IEXEC
20
20
import time
21
21
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
 
22
import bzrlib
 
23
from bzrlib import (
 
24
    errors,
 
25
    lazy_import,
 
26
    registry,
 
27
    tree,
 
28
    )
 
29
lazy_import.lazy_import(globals(), """
24
30
from bzrlib import (
25
31
    annotate,
26
32
    bencode,
32
38
    multiparent,
33
39
    osutils,
34
40
    revision as _mod_revision,
 
41
    trace,
35
42
    ui,
 
43
    urlutils,
36
44
    )
37
45
""")
38
46
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
45
53
    delete_any,
46
54
    file_kind,
47
55
    has_symlinks,
48
 
    lexists,
49
56
    pathjoin,
50
57
    sha_file,
51
58
    splitpath,
52
59
    supports_executable,
53
 
)
 
60
    )
54
61
from bzrlib.progress import ProgressPhase
55
62
from bzrlib.symbol_versioning import (
56
 
        deprecated_function,
57
 
        deprecated_in,
58
 
        )
59
 
from bzrlib.trace import mutter, warning
60
 
from bzrlib import tree
61
 
import bzrlib.ui
62
 
import bzrlib.urlutils as urlutils
 
63
    deprecated_function,
 
64
    deprecated_in,
 
65
    deprecated_method,
 
66
    )
 
67
from bzrlib.trace import warning
63
68
 
64
69
 
65
70
ROOT_PARENT = "root-parent"
66
71
 
67
 
 
68
72
def unique_add(map, key, value):
69
73
    if key in map:
70
74
        raise DuplicateKey(key=key)
71
75
    map[key] = value
72
76
 
73
77
 
 
78
 
74
79
class _TransformResults(object):
75
80
    def __init__(self, modified_paths, rename_count):
76
81
        object.__init__(self)
124
129
            self._new_root = self.trans_id_tree_file_id(root_id)
125
130
        else:
126
131
            self._new_root = None
127
 
        # Indictor of whether the transform has been applied
 
132
        # Indicator of whether the transform has been applied
128
133
        self._done = False
129
134
        # A progress bar
130
135
        self._pb = pb
522
527
        for trans_id in self._removed_id:
523
528
            file_id = self.tree_file_id(trans_id)
524
529
            if file_id is not None:
 
530
                # XXX: This seems like something that should go via a different
 
531
                #      indirection.
525
532
                if self._tree.inventory[file_id].kind == 'directory':
526
533
                    parents.append(trans_id)
527
534
            elif self.tree_kind(trans_id) == 'directory':
531
538
            # ensure that all children are registered with the transaction
532
539
            list(self.iter_tree_children(parent_id))
533
540
 
 
541
    @deprecated_method(deprecated_in((2, 3, 0)))
534
542
    def has_named_child(self, by_parent, parent_id, name):
535
 
        try:
536
 
            children = by_parent[parent_id]
537
 
        except KeyError:
538
 
            children = []
539
 
        for child in children:
 
543
        return self._has_named_child(
 
544
            name, parent_id, known_children=by_parent.get(parent_id, []))
 
545
 
 
546
    def _has_named_child(self, name, parent_id, known_children):
 
547
        """Does a parent already have a name child.
 
548
 
 
549
        :param name: The searched for name.
 
550
 
 
551
        :param parent_id: The parent for which the check is made.
 
552
 
 
553
        :param known_children: The already known children. This should have
 
554
            been recently obtained from `self.by_parent.get(parent_id)`
 
555
            (or will be if None is passed).
 
556
        """
 
557
        if known_children is None:
 
558
            known_children = self.by_parent().get(parent_id, [])
 
559
        for child in known_children:
540
560
            if self.final_name(child) == name:
541
561
                return True
542
 
        try:
543
 
            path = self._tree_id_paths[parent_id]
544
 
        except KeyError:
 
562
        parent_path = self._tree_id_paths.get(parent_id, None)
 
563
        if parent_path is None:
 
564
            # No parent... no children
545
565
            return False
546
 
        childpath = joinpath(path, name)
547
 
        child_id = self._tree_path_ids.get(childpath)
 
566
        child_path = joinpath(parent_path, name)
 
567
        child_id = self._tree_path_ids.get(child_path, None)
548
568
        if child_id is None:
549
 
            return lexists(self._tree.abspath(childpath))
 
569
            # Not known by the tree transform yet, check the filesystem
 
570
            return osutils.lexists(self._tree.abspath(child_path))
550
571
        else:
551
 
            if self.final_parent(child_id) != parent_id:
552
 
                return False
553
 
            if child_id in self._removed_contents:
554
 
                # XXX What about dangling file-ids?
555
 
                return False
556
 
            else:
557
 
                return True
 
572
            raise AssertionError('child_id is missing: %s, %s, %s'
 
573
                                 % (name, parent_id, child_id))
 
574
 
 
575
    def _available_backup_name(self, name, target_id):
 
576
        """Find an available backup name.
 
577
 
 
578
        :param name: The basename of the file.
 
579
 
 
580
        :param target_id: The directory trans_id where the backup should 
 
581
            be placed.
 
582
        """
 
583
        known_children = self.by_parent().get(target_id, [])
 
584
        return osutils.available_backup_name(
 
585
            name,
 
586
            lambda base: self._has_named_child(
 
587
                base, target_id, known_children))
558
588
 
559
589
    def _parent_loops(self):
560
590
        """No entry should be its own ancestor"""
637
667
        if (self._new_name, self._new_parent) == ({}, {}):
638
668
            return conflicts
639
669
        for children in by_parent.itervalues():
640
 
            name_ids = [(self.final_name(t), t) for t in children]
641
 
            if not self._case_sensitive_target:
642
 
                name_ids = [(n.lower(), t) for n, t in name_ids]
 
670
            name_ids = []
 
671
            for child_tid in children:
 
672
                name = self.final_name(child_tid)
 
673
                if name is not None:
 
674
                    # Keep children only if they still exist in the end
 
675
                    if not self._case_sensitive_target:
 
676
                        name = name.lower()
 
677
                    name_ids.append((name, child_tid))
643
678
            name_ids.sort()
644
679
            last_name = None
645
680
            last_trans_id = None
669
704
        return conflicts
670
705
 
671
706
    def _parent_type_conflicts(self, by_parent):
672
 
        """parents must have directory 'contents'."""
 
707
        """Children must have a directory parent"""
673
708
        conflicts = []
674
709
        for parent_id, children in by_parent.iteritems():
675
710
            if parent_id is ROOT_PARENT:
676
711
                continue
677
 
            if not self._any_contents(children):
 
712
            no_children = True
 
713
            for child_id in children:
 
714
                if self.final_kind(child_id) is not None:
 
715
                    no_children = False
 
716
                    break
 
717
            if no_children:
678
718
                continue
 
719
            # There is at least a child, so we need an existing directory to
 
720
            # contain it.
679
721
            kind = self.final_kind(parent_id)
680
722
            if kind is None:
 
723
                # The directory will be deleted
681
724
                conflicts.append(('missing parent', parent_id))
682
725
            elif kind != "directory":
 
726
                # Meh, we need a *directory* to put something in it
683
727
                conflicts.append(('non-directory parent', parent_id))
684
728
        return conflicts
685
729
 
686
 
    def _any_contents(self, trans_ids):
687
 
        """Return true if any of the trans_ids, will have contents."""
688
 
        for trans_id in trans_ids:
689
 
            if self.final_kind(trans_id) is not None:
690
 
                return True
691
 
        return False
692
 
 
693
730
    def _set_executability(self, path, trans_id):
694
731
        """Set the executability of versioned files """
695
732
        if supports_executable():
759
796
        self.create_symlink(target, trans_id)
760
797
        return trans_id
761
798
 
 
799
    def new_orphan(self, trans_id, parent_id):
 
800
        """Schedule an item to be orphaned.
 
801
 
 
802
        When a directory is about to be removed, its children, if they are not
 
803
        versioned are moved out of the way: they don't have a parent anymore.
 
804
 
 
805
        :param trans_id: The trans_id of the existing item.
 
806
        :param parent_id: The parent trans_id of the item.
 
807
        """
 
808
        raise NotImplementedError(self.new_orphan)
 
809
 
 
810
    def _get_potential_orphans(self, dir_id):
 
811
        """Find the potential orphans in a directory.
 
812
 
 
813
        A directory can't be safely deleted if there are versioned files in it.
 
814
        If all the contained files are unversioned then they can be orphaned.
 
815
 
 
816
        The 'None' return value means that the directory contains at least one
 
817
        versioned file and should not be deleted.
 
818
 
 
819
        :param dir_id: The directory trans id.
 
820
 
 
821
        :return: A list of the orphan trans ids or None if at least one
 
822
             versioned file is present.
 
823
        """
 
824
        orphans = []
 
825
        # Find the potential orphans, stop if one item should be kept
 
826
        for child_tid in self.by_parent()[dir_id]:
 
827
            if child_tid in self._removed_contents:
 
828
                # The child is removed as part of the transform. Since it was
 
829
                # versioned before, it's not an orphan
 
830
                continue
 
831
            elif self.final_file_id(child_tid) is None:
 
832
                # The child is not versioned
 
833
                orphans.append(child_tid)
 
834
            else:
 
835
                # We have a versioned file here, searching for orphans is
 
836
                # meaningless.
 
837
                orphans = None
 
838
                break
 
839
        return orphans
 
840
 
762
841
    def _affected_ids(self):
763
842
        """Return the set of transform ids affected by the transform"""
764
843
        trans_ids = set(self._removed_id)
1271
1350
            del self._limbo_children_names[trans_id]
1272
1351
        delete_any(self._limbo_name(trans_id))
1273
1352
 
 
1353
    def new_orphan(self, trans_id, parent_id):
 
1354
        # FIXME: There is no tree config, so we use the branch one (it's weird
 
1355
        # to define it this way as orphaning can only occur in a working tree,
 
1356
        # but that's all we have (for now). It will find the option in
 
1357
        # locations.conf or bazaar.conf though) -- vila 20100916
 
1358
        conf = self._tree.branch.get_config()
 
1359
        conf_var_name = 'bzr.transform.orphan_policy'
 
1360
        orphan_policy = conf.get_user_option(conf_var_name)
 
1361
        default_policy = orphaning_registry.default_key
 
1362
        if orphan_policy is None:
 
1363
            orphan_policy = default_policy
 
1364
        if orphan_policy not in orphaning_registry:
 
1365
            trace.warning('%s (from %s) is not a known policy, defaulting to %s'
 
1366
                          % (orphan_policy, conf_var_name, default_policy))
 
1367
            orphan_policy = default_policy
 
1368
        handle_orphan = orphaning_registry.get(orphan_policy)
 
1369
        handle_orphan(self, trans_id, parent_id)
 
1370
 
 
1371
 
 
1372
class OrphaningError(errors.BzrError):
 
1373
 
 
1374
    # Only bugs could lead to such exception being seen by the user
 
1375
    internal_error = True
 
1376
    _fmt = "Error while orphaning %s in %s directory"
 
1377
 
 
1378
    def __init__(self, orphan, parent):
 
1379
        errors.BzrError.__init__(self)
 
1380
        self.orphan = orphan
 
1381
        self.parent = parent
 
1382
 
 
1383
 
 
1384
class OrphaningForbidden(OrphaningError):
 
1385
 
 
1386
    _fmt = "Policy: %s doesn't allow creating orphans."
 
1387
 
 
1388
    def __init__(self, policy):
 
1389
        errors.BzrError.__init__(self)
 
1390
        self.policy = policy
 
1391
 
 
1392
 
 
1393
def move_orphan(tt, orphan_id, parent_id):
 
1394
    """See TreeTransformBase.new_orphan.
 
1395
 
 
1396
    This creates a new orphan in the `bzr-orphans` dir at the root of the
 
1397
    `TreeTransform`.
 
1398
 
 
1399
    :param tt: The TreeTransform orphaning `trans_id`.
 
1400
 
 
1401
    :param orphan_id: The trans id that should be orphaned.
 
1402
 
 
1403
    :param parent_id: The orphan parent trans id.
 
1404
    """
 
1405
    # Add the orphan dir if it doesn't exist
 
1406
    orphan_dir_basename = 'bzr-orphans'
 
1407
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
 
1408
    if tt.final_kind(od_id) is None:
 
1409
        tt.create_directory(od_id)
 
1410
    parent_path = tt._tree_id_paths[parent_id]
 
1411
    # Find a name that doesn't exist yet in the orphan dir
 
1412
    actual_name = tt.final_name(orphan_id)
 
1413
    new_name = tt._available_backup_name(actual_name, od_id)
 
1414
    tt.adjust_path(new_name, od_id, orphan_id)
 
1415
    trace.warning('%s has been orphaned in %s'
 
1416
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
 
1417
 
 
1418
 
 
1419
def refuse_orphan(tt, orphan_id, parent_id):
 
1420
    """See TreeTransformBase.new_orphan.
 
1421
 
 
1422
    This refuses to create orphan, letting the caller handle the conflict.
 
1423
    """
 
1424
    raise OrphaningForbidden('never')
 
1425
 
 
1426
 
 
1427
orphaning_registry = registry.Registry()
 
1428
orphaning_registry.register(
 
1429
    'conflict', refuse_orphan,
 
1430
    'Leave orphans in place and create a conflict on the directory.')
 
1431
orphaning_registry.register(
 
1432
    'move', move_orphan,
 
1433
    'Move orphans into the bzr-orphans directory.')
 
1434
orphaning_registry._set_default_key('conflict')
 
1435
 
1274
1436
 
1275
1437
class TreeTransform(DiskTreeTransform):
1276
1438
    """Represent a tree transformation.
1514
1676
        """
1515
1677
        if not no_conflicts:
1516
1678
            self._check_malformed()
1517
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1679
        child_pb = ui.ui_factory.nested_progress_bar()
1518
1680
        try:
1519
1681
            if precomputed_delta is None:
1520
1682
                child_pb.update('Apply phase', 0, 2)
1547
1709
    def _generate_inventory_delta(self):
1548
1710
        """Generate an inventory delta for the current transform."""
1549
1711
        inventory_delta = []
1550
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1712
        child_pb = ui.ui_factory.nested_progress_bar()
1551
1713
        new_paths = self._inventory_altered()
1552
1714
        total_entries = len(new_paths) + len(self._removed_id)
1553
1715
        try:
1615
1777
        """
1616
1778
        tree_paths = list(self._tree_path_ids.iteritems())
1617
1779
        tree_paths.sort(reverse=True)
1618
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1780
        child_pb = ui.ui_factory.nested_progress_bar()
1619
1781
        try:
1620
1782
            for num, data in enumerate(tree_paths):
1621
1783
                path, trans_id = data
1650
1812
        modified_paths = []
1651
1813
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1652
1814
                                 new_paths)
1653
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1815
        child_pb = ui.ui_factory.nested_progress_bar()
1654
1816
        try:
1655
1817
            for num, (path, trans_id) in enumerate(new_paths):
1656
1818
                if (num % 10) == 0:
1727
1889
            childpath = joinpath(path, child)
1728
1890
            yield self.trans_id_tree_path(childpath)
1729
1891
 
 
1892
    def new_orphan(self, trans_id, parent_id):
 
1893
        raise NotImplementedError(self.new_orphan)
 
1894
 
1730
1895
 
1731
1896
class _PreviewTree(tree.Tree):
1732
1897
    """Partial implementation of Tree to support show_diff_trees"""
2265
2430
        if num > 0:  # more than just a root
2266
2431
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2267
2432
    file_trans_id = {}
2268
 
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2433
    top_pb = ui.ui_factory.nested_progress_bar()
2269
2434
    pp = ProgressPhase("Build phase", 2, top_pb)
2270
2435
    if tree.inventory.root is not None:
2271
2436
        # This is kind of a hack: we should be altering the root
2284
2449
        pp.next_phase()
2285
2450
        file_trans_id[wt.get_root_id()] = \
2286
2451
            tt.trans_id_tree_file_id(wt.get_root_id())
2287
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2452
        pb = ui.ui_factory.nested_progress_bar()
2288
2453
        try:
2289
2454
            deferred_contents = []
2290
2455
            num = 0
2427
2592
    for child in tt.iter_tree_children(old_parent):
2428
2593
        tt.adjust_path(tt.final_name(child), new_parent, child)
2429
2594
 
 
2595
 
2430
2596
def _reparent_transform_children(tt, old_parent, new_parent):
2431
2597
    by_parent = tt.by_parent()
2432
2598
    for child in by_parent[old_parent]:
2433
2599
        tt.adjust_path(tt.final_name(child), new_parent, child)
2434
2600
    return by_parent[old_parent]
2435
2601
 
 
2602
 
2436
2603
def _content_match(tree, entry, file_id, kind, target_path):
2437
2604
    if entry.kind != kind:
2438
2605
        return False
2538
2705
        tt.set_executability(entry.executable, trans_id)
2539
2706
 
2540
2707
 
 
2708
@deprecated_function(deprecated_in((2, 3, 0)))
2541
2709
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2542
2710
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2543
2711
 
2544
2712
 
 
2713
@deprecated_function(deprecated_in((2, 3, 0)))
2545
2714
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2546
2715
    """Produce a backup-style name that appears to be available"""
2547
2716
    def name_gen():
2610
2779
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2611
2780
                              backups, pp, basis_tree=None,
2612
2781
                              merge_modified=None):
2613
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2782
    child_pb = ui.ui_factory.nested_progress_bar()
2614
2783
    try:
2615
2784
        if merge_modified is None:
2616
2785
            merge_modified = working_tree.merge_modified()
2619
2788
                                      merge_modified, basis_tree)
2620
2789
    finally:
2621
2790
        child_pb.finished()
2622
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2791
    child_pb = ui.ui_factory.nested_progress_bar()
2623
2792
    try:
2624
2793
        raw_conflicts = resolve_conflicts(tt, child_pb,
2625
2794
            lambda t, c: conflict_pass(t, c, target_tree))
2668
2837
                        tt.delete_contents(trans_id)
2669
2838
                    elif kind[1] is not None:
2670
2839
                        parent_trans_id = tt.trans_id_file_id(parent[0])
2671
 
                        by_parent = tt.by_parent()
2672
 
                        backup_name = _get_backup_name(name[0], by_parent,
2673
 
                                                       parent_trans_id, tt)
 
2840
                        backup_name = tt._available_backup_name(
 
2841
                            name[0], parent_trans_id)
2674
2842
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2675
2843
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
2676
2844
                        if versioned == (True, True):
2799
2967
 
2800
2968
        elif c_type == 'missing parent':
2801
2969
            trans_id = conflict[1]
2802
 
            try:
2803
 
                tt.cancel_deletion(trans_id)
2804
 
                new_conflicts.add(('deleting parent', 'Not deleting',
2805
 
                                   trans_id))
2806
 
            except KeyError:
 
2970
            if trans_id in tt._removed_contents:
 
2971
                cancel_deletion = True
 
2972
                orphans = tt._get_potential_orphans(trans_id)
 
2973
                if orphans:
 
2974
                    cancel_deletion = False
 
2975
                    # All children are orphans
 
2976
                    for o in orphans:
 
2977
                        try:
 
2978
                            tt.new_orphan(o, trans_id)
 
2979
                        except OrphaningError:
 
2980
                            # Something bad happened so we cancel the directory
 
2981
                            # deletion which will leave it in place with a
 
2982
                            # conflict. The user can deal with it from there.
 
2983
                            # Note that this also catch the case where we don't
 
2984
                            # want to create orphans and leave the directory in
 
2985
                            # place.
 
2986
                            cancel_deletion = True
 
2987
                            break
 
2988
                if cancel_deletion:
 
2989
                    # Cancel the directory deletion
 
2990
                    tt.cancel_deletion(trans_id)
 
2991
                    new_conflicts.add(('deleting parent', 'Not deleting',
 
2992
                                       trans_id))
 
2993
            else:
2807
2994
                create = True
2808
2995
                try:
2809
2996
                    tt.final_name(trans_id)
2834
3021
            file_id = tt.inactive_file_id(conflict[1])
2835
3022
            # special-case the other tree root (move its children instead)
2836
3023
            if path_tree and file_id in path_tree:
2837
 
                if path_tree.inventory[file_id].parent_id is None:
 
3024
                if path_tree.path2id('') == file_id:
 
3025
                    # This is the root entry, skip it
2838
3026
                    continue
2839
3027
            tt.version_file(file_id, conflict[1])
2840
3028
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2917
3105
            try:
2918
3106
                os.rename(to, from_)
2919
3107
            except OSError, e:
2920
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)                
 
3108
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
2921
3109
        # after rollback, don't reuse _FileMover
2922
3110
        past_renames = None
2923
3111
        pending_deletions = None