~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Vincent Ladeuil
  • Date: 2010-10-08 10:50:51 UTC
  • mfrom: (5050.17.31 2.2.2-dev)
  • mto: This revision was merged to the branch mainline in revision 5474.
  • Revision ID: v.ladeuil+lp@free.fr-20101008105051-xd4knkrohzclffic
Merge 2.2 into trunk including fixes for bug #651706 and bug #646133

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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
 
import bzrlib
23
 
from bzrlib import (
24
 
    errors,
25
 
    lazy_import,
26
 
    registry,
27
 
    tree,
28
 
    )
29
 
lazy_import.lazy_import(globals(), """
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
30
24
from bzrlib import (
31
25
    annotate,
32
26
    bencode,
38
32
    multiparent,
39
33
    osutils,
40
34
    revision as _mod_revision,
41
 
    trace,
42
35
    ui,
43
 
    urlutils,
44
36
    )
45
37
""")
46
38
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
53
45
    delete_any,
54
46
    file_kind,
55
47
    has_symlinks,
 
48
    lexists,
56
49
    pathjoin,
57
50
    sha_file,
58
51
    splitpath,
59
52
    supports_executable,
60
 
    )
 
53
)
61
54
from bzrlib.progress import ProgressPhase
62
55
from bzrlib.symbol_versioning import (
63
 
    deprecated_function,
64
 
    deprecated_in,
65
 
    deprecated_method,
66
 
    )
67
 
from bzrlib.trace import warning
 
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
68
63
 
69
64
 
70
65
ROOT_PARENT = "root-parent"
71
66
 
 
67
 
72
68
def unique_add(map, key, value):
73
69
    if key in map:
74
70
        raise DuplicateKey(key=key)
75
71
    map[key] = value
76
72
 
77
73
 
78
 
 
79
74
class _TransformResults(object):
80
75
    def __init__(self, modified_paths, rename_count):
81
76
        object.__init__(self)
129
124
            self._new_root = self.trans_id_tree_file_id(root_id)
130
125
        else:
131
126
            self._new_root = None
132
 
        # Indicator of whether the transform has been applied
 
127
        # Indictor of whether the transform has been applied
133
128
        self._done = False
134
129
        # A progress bar
135
130
        self._pb = pb
527
522
        for trans_id in self._removed_id:
528
523
            file_id = self.tree_file_id(trans_id)
529
524
            if file_id is not None:
530
 
                # XXX: This seems like something that should go via a different
531
 
                #      indirection.
532
525
                if self._tree.inventory[file_id].kind == 'directory':
533
526
                    parents.append(trans_id)
534
527
            elif self.tree_kind(trans_id) == 'directory':
538
531
            # ensure that all children are registered with the transaction
539
532
            list(self.iter_tree_children(parent_id))
540
533
 
541
 
    @deprecated_method(deprecated_in((2, 3, 0)))
542
534
    def has_named_child(self, by_parent, parent_id, name):
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:
 
535
        try:
 
536
            children = by_parent[parent_id]
 
537
        except KeyError:
 
538
            children = []
 
539
        for child in children:
560
540
            if self.final_name(child) == name:
561
541
                return True
562
 
        parent_path = self._tree_id_paths.get(parent_id, None)
563
 
        if parent_path is None:
564
 
            # No parent... no children
 
542
        try:
 
543
            path = self._tree_id_paths[parent_id]
 
544
        except KeyError:
565
545
            return False
566
 
        child_path = joinpath(parent_path, name)
567
 
        child_id = self._tree_path_ids.get(child_path, None)
 
546
        childpath = joinpath(path, name)
 
547
        child_id = self._tree_path_ids.get(childpath)
568
548
        if child_id is None:
569
 
            # Not known by the tree transform yet, check the filesystem
570
 
            return osutils.lexists(self._tree.abspath(child_path))
 
549
            return lexists(self._tree.abspath(childpath))
571
550
        else:
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))
 
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
588
558
 
589
559
    def _parent_loops(self):
590
560
        """No entry should be its own ancestor"""
667
637
        if (self._new_name, self._new_parent) == ({}, {}):
668
638
            return conflicts
669
639
        for children in by_parent.itervalues():
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))
 
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]
678
643
            name_ids.sort()
679
644
            last_name = None
680
645
            last_trans_id = None
704
669
        return conflicts
705
670
 
706
671
    def _parent_type_conflicts(self, by_parent):
707
 
        """Children must have a directory parent"""
 
672
        """parents must have directory 'contents'."""
708
673
        conflicts = []
709
674
        for parent_id, children in by_parent.iteritems():
710
675
            if parent_id is ROOT_PARENT:
711
676
                continue
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:
 
677
            if not self._any_contents(children):
718
678
                continue
719
 
            # There is at least a child, so we need an existing directory to
720
 
            # contain it.
721
679
            kind = self.final_kind(parent_id)
722
680
            if kind is None:
723
 
                # The directory will be deleted
724
681
                conflicts.append(('missing parent', parent_id))
725
682
            elif kind != "directory":
726
 
                # Meh, we need a *directory* to put something in it
727
683
                conflicts.append(('non-directory parent', parent_id))
728
684
        return conflicts
729
685
 
 
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
 
730
693
    def _set_executability(self, path, trans_id):
731
694
        """Set the executability of versioned files """
732
695
        if supports_executable():
796
759
        self.create_symlink(target, trans_id)
797
760
        return trans_id
798
761
 
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
 
 
841
762
    def _affected_ids(self):
842
763
        """Return the set of transform ids affected by the transform"""
843
764
        trans_ids = set(self._removed_id)
1350
1271
            del self._limbo_children_names[trans_id]
1351
1272
        delete_any(self._limbo_name(trans_id))
1352
1273
 
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
 
 
1436
1274
 
1437
1275
class TreeTransform(DiskTreeTransform):
1438
1276
    """Represent a tree transformation.
1676
1514
        """
1677
1515
        if not no_conflicts:
1678
1516
            self._check_malformed()
1679
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1517
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1680
1518
        try:
1681
1519
            if precomputed_delta is None:
1682
1520
                child_pb.update('Apply phase', 0, 2)
1709
1547
    def _generate_inventory_delta(self):
1710
1548
        """Generate an inventory delta for the current transform."""
1711
1549
        inventory_delta = []
1712
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1550
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1713
1551
        new_paths = self._inventory_altered()
1714
1552
        total_entries = len(new_paths) + len(self._removed_id)
1715
1553
        try:
1777
1615
        """
1778
1616
        tree_paths = list(self._tree_path_ids.iteritems())
1779
1617
        tree_paths.sort(reverse=True)
1780
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1618
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1781
1619
        try:
1782
1620
            for num, data in enumerate(tree_paths):
1783
1621
                path, trans_id = data
1812
1650
        modified_paths = []
1813
1651
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1814
1652
                                 new_paths)
1815
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1653
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1816
1654
        try:
1817
1655
            for num, (path, trans_id) in enumerate(new_paths):
1818
1656
                if (num % 10) == 0:
1889
1727
            childpath = joinpath(path, child)
1890
1728
            yield self.trans_id_tree_path(childpath)
1891
1729
 
1892
 
    def new_orphan(self, trans_id, parent_id):
1893
 
        raise NotImplementedError(self.new_orphan)
1894
 
 
1895
1730
 
1896
1731
class _PreviewTree(tree.Tree):
1897
1732
    """Partial implementation of Tree to support show_diff_trees"""
2430
2265
        if num > 0:  # more than just a root
2431
2266
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2432
2267
    file_trans_id = {}
2433
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
2268
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2434
2269
    pp = ProgressPhase("Build phase", 2, top_pb)
2435
2270
    if tree.inventory.root is not None:
2436
2271
        # This is kind of a hack: we should be altering the root
2449
2284
        pp.next_phase()
2450
2285
        file_trans_id[wt.get_root_id()] = \
2451
2286
            tt.trans_id_tree_file_id(wt.get_root_id())
2452
 
        pb = ui.ui_factory.nested_progress_bar()
 
2287
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2453
2288
        try:
2454
2289
            deferred_contents = []
2455
2290
            num = 0
2592
2427
    for child in tt.iter_tree_children(old_parent):
2593
2428
        tt.adjust_path(tt.final_name(child), new_parent, child)
2594
2429
 
2595
 
 
2596
2430
def _reparent_transform_children(tt, old_parent, new_parent):
2597
2431
    by_parent = tt.by_parent()
2598
2432
    for child in by_parent[old_parent]:
2599
2433
        tt.adjust_path(tt.final_name(child), new_parent, child)
2600
2434
    return by_parent[old_parent]
2601
2435
 
2602
 
 
2603
2436
def _content_match(tree, entry, file_id, kind, target_path):
2604
2437
    if entry.kind != kind:
2605
2438
        return False
2705
2538
        tt.set_executability(entry.executable, trans_id)
2706
2539
 
2707
2540
 
2708
 
@deprecated_function(deprecated_in((2, 3, 0)))
2709
2541
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2710
2542
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2711
2543
 
2712
2544
 
2713
 
@deprecated_function(deprecated_in((2, 3, 0)))
2714
2545
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2715
2546
    """Produce a backup-style name that appears to be available"""
2716
2547
    def name_gen():
2779
2610
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2780
2611
                              backups, pp, basis_tree=None,
2781
2612
                              merge_modified=None):
2782
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2613
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2783
2614
    try:
2784
2615
        if merge_modified is None:
2785
2616
            merge_modified = working_tree.merge_modified()
2788
2619
                                      merge_modified, basis_tree)
2789
2620
    finally:
2790
2621
        child_pb.finished()
2791
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2622
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2792
2623
    try:
2793
2624
        raw_conflicts = resolve_conflicts(tt, child_pb,
2794
2625
            lambda t, c: conflict_pass(t, c, target_tree))
2837
2668
                        tt.delete_contents(trans_id)
2838
2669
                    elif kind[1] is not None:
2839
2670
                        parent_trans_id = tt.trans_id_file_id(parent[0])
2840
 
                        backup_name = tt._available_backup_name(
2841
 
                            name[0], parent_trans_id)
 
2671
                        by_parent = tt.by_parent()
 
2672
                        backup_name = _get_backup_name(name[0], by_parent,
 
2673
                                                       parent_trans_id, tt)
2842
2674
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2843
2675
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
2844
2676
                        if versioned == (True, True):
2967
2799
 
2968
2800
        elif c_type == 'missing parent':
2969
2801
            trans_id = conflict[1]
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:
 
2802
            try:
 
2803
                tt.cancel_deletion(trans_id)
 
2804
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2805
                                   trans_id))
 
2806
            except KeyError:
2994
2807
                create = True
2995
2808
                try:
2996
2809
                    tt.final_name(trans_id)
3021
2834
            file_id = tt.inactive_file_id(conflict[1])
3022
2835
            # special-case the other tree root (move its children instead)
3023
2836
            if path_tree and file_id in path_tree:
3024
 
                if path_tree.path2id('') == file_id:
3025
 
                    # This is the root entry, skip it
 
2837
                if path_tree.inventory[file_id].parent_id is None:
3026
2838
                    continue
3027
2839
            tt.version_file(file_id, conflict[1])
3028
2840
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3105
2917
            try:
3106
2918
                os.rename(to, from_)
3107
2919
            except OSError, e:
3108
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
 
2920
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)                
3109
2921
        # after rollback, don't reuse _FileMover
3110
2922
        past_renames = None
3111
2923
        pending_deletions = None