~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

Merge bzr.dev to resolve news conflict

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
from bzrlib import (
 
23
    errors,
 
24
    lazy_import,
 
25
    registry,
 
26
    )
 
27
lazy_import.lazy_import(globals(), """
24
28
from bzrlib import (
25
29
    annotate,
26
30
    bencode,
32
36
    multiparent,
33
37
    osutils,
34
38
    revision as _mod_revision,
 
39
    trace,
35
40
    ui,
36
41
    )
37
42
""")
55
60
from bzrlib.symbol_versioning import (
56
61
        deprecated_function,
57
62
        deprecated_in,
 
63
        deprecated_method,
58
64
        )
59
65
from bzrlib.trace import mutter, warning
60
66
from bzrlib import tree
64
70
 
65
71
ROOT_PARENT = "root-parent"
66
72
 
67
 
 
68
73
def unique_add(map, key, value):
69
74
    if key in map:
70
75
        raise DuplicateKey(key=key)
71
76
    map[key] = value
72
77
 
73
78
 
 
79
 
74
80
class _TransformResults(object):
75
81
    def __init__(self, modified_paths, rename_count):
76
82
        object.__init__(self)
531
537
            # ensure that all children are registered with the transaction
532
538
            list(self.iter_tree_children(parent_id))
533
539
 
 
540
    @deprecated_method(deprecated_in((2, 3, 0)))
534
541
    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:
 
542
        return self._has_named_child(
 
543
            name, parent_id, known_children=by_parent.get(parent_id, []))
 
544
 
 
545
    def _has_named_child(self, name, parent_id, known_children):
 
546
        """Does a parent already have a name child.
 
547
 
 
548
        :param name: The searched for name.
 
549
 
 
550
        :param parent_id: The parent for which the check is made.
 
551
 
 
552
        :param known_children: The already known children. This should have
 
553
            been recently obtained from `self.by_parent.get(parent_id)`
 
554
            (or will be if None is passed).
 
555
        """
 
556
        if known_children is None:
 
557
            known_children = self.by_parent().get(parent_id, [])
 
558
        for child in known_children:
540
559
            if self.final_name(child) == name:
541
560
                return True
542
 
        try:
543
 
            path = self._tree_id_paths[parent_id]
544
 
        except KeyError:
 
561
        parent_path = self._tree_id_paths.get(parent_id, None)
 
562
        if parent_path is None:
 
563
            # No parent... no children
545
564
            return False
546
 
        childpath = joinpath(path, name)
547
 
        child_id = self._tree_path_ids.get(childpath)
 
565
        child_path = joinpath(parent_path, name)
 
566
        child_id = self._tree_path_ids.get(child_path, None)
548
567
        if child_id is None:
549
 
            return lexists(self._tree.abspath(childpath))
 
568
            # Not known by the tree transform yet, check the filesystem
 
569
            return osutils.lexists(self._tree.abspath(child_path))
550
570
        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
 
571
            raise AssertionError('child_id is missing: %s, %s, %s'
 
572
                                 % (name, parent_id, child_id))
 
573
 
 
574
    def _available_backup_name(self, name, target_id):
 
575
        """Find an available backup name.
 
576
 
 
577
        :param name: The basename of the file.
 
578
 
 
579
        :param target_id: The directory trans_id where the backup should 
 
580
            be placed.
 
581
        """
 
582
        known_children = self.by_parent().get(target_id, [])
 
583
        return osutils.available_backup_name(
 
584
            name,
 
585
            lambda base: self._has_named_child(
 
586
                base, target_id, known_children))
558
587
 
559
588
    def _parent_loops(self):
560
589
        """No entry should be its own ancestor"""
637
666
        if (self._new_name, self._new_parent) == ({}, {}):
638
667
            return conflicts
639
668
        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]
 
669
            name_ids = []
 
670
            for child_tid in children:
 
671
                name = self.final_name(child_tid)
 
672
                if name is not None:
 
673
                    # Keep children only if they still exist in the end
 
674
                    if not self._case_sensitive_target:
 
675
                        name = name.lower()
 
676
                    name_ids.append((name, child_tid))
643
677
            name_ids.sort()
644
678
            last_name = None
645
679
            last_trans_id = None
669
703
        return conflicts
670
704
 
671
705
    def _parent_type_conflicts(self, by_parent):
672
 
        """parents must have directory 'contents'."""
 
706
        """Children must have a directory parent"""
673
707
        conflicts = []
674
708
        for parent_id, children in by_parent.iteritems():
675
709
            if parent_id is ROOT_PARENT:
676
710
                continue
677
 
            if not self._any_contents(children):
 
711
            no_children = True
 
712
            for child_id in children:
 
713
                if self.final_kind(child_id) is not None:
 
714
                    no_children = False
 
715
                    break
 
716
            if no_children:
678
717
                continue
 
718
            # There is at least a child, so we need an existing directory to
 
719
            # contain it.
679
720
            kind = self.final_kind(parent_id)
680
721
            if kind is None:
 
722
                # The directory will be deleted
681
723
                conflicts.append(('missing parent', parent_id))
682
724
            elif kind != "directory":
 
725
                # Meh, we need a *directory* to put something in it
683
726
                conflicts.append(('non-directory parent', parent_id))
684
727
        return conflicts
685
728
 
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
729
    def _set_executability(self, path, trans_id):
694
730
        """Set the executability of versioned files """
695
731
        if supports_executable():
759
795
        self.create_symlink(target, trans_id)
760
796
        return trans_id
761
797
 
 
798
    def new_orphan(self, trans_id, parent_id):
 
799
        """Schedule an item to be orphaned.
 
800
 
 
801
        When a directory is about to be removed, its children, if they are not
 
802
        versioned are moved out of the way: they don't have a parent anymore.
 
803
 
 
804
        :param trans_id: The trans_id of the existing item.
 
805
        :param parent_id: The parent trans_id of the item.
 
806
        """
 
807
        raise NotImplementedError(self.new_orphan)
 
808
 
 
809
    def _get_potential_orphans(self, dir_id):
 
810
        """Find the potential orphans in a directory.
 
811
 
 
812
        A directory can't be safely deleted if there are versioned files in it.
 
813
        If all the contained files are unversioned then they can be orphaned.
 
814
 
 
815
        The 'None' return value means that the directory contains at least one
 
816
        versioned file and should not be deleted.
 
817
 
 
818
        :param dir_id: The directory trans id.
 
819
 
 
820
        :return: A list of the orphan trans ids or None if at least one
 
821
             versioned file is present.
 
822
        """
 
823
        orphans = []
 
824
        # Find the potential orphans, stop if one item should be kept
 
825
        for child_tid in self.by_parent()[dir_id]:
 
826
            if child_tid in self._removed_contents:
 
827
                # The child is removed as part of the transform. Since it was
 
828
                # versioned before, it's not an orphan
 
829
                continue
 
830
            elif self.final_file_id(child_tid) is None:
 
831
                # The child is not versioned
 
832
                orphans.append(child_tid)
 
833
            else:
 
834
                # We have a versioned file here, searching for orphans is
 
835
                # meaningless.
 
836
                orphans = None
 
837
                break
 
838
        return orphans
 
839
 
762
840
    def _affected_ids(self):
763
841
        """Return the set of transform ids affected by the transform"""
764
842
        trans_ids = set(self._removed_id)
1271
1349
            del self._limbo_children_names[trans_id]
1272
1350
        delete_any(self._limbo_name(trans_id))
1273
1351
 
 
1352
    def new_orphan(self, trans_id, parent_id):
 
1353
        # FIXME: There is no tree config, so we use the branch one (it's weird
 
1354
        # to define it this way as orphaning can only occur in a working tree,
 
1355
        # but that's all we have (for now). It will find the option in
 
1356
        # locations.conf or bazaar.conf though) -- vila 20100916
 
1357
        conf = self._tree.branch.get_config()
 
1358
        conf_var_name = 'bzr.transform.orphan_policy'
 
1359
        orphan_policy = conf.get_user_option(conf_var_name)
 
1360
        default_policy = orphaning_registry.default_key
 
1361
        if orphan_policy is None:
 
1362
            orphan_policy = default_policy
 
1363
        if orphan_policy not in orphaning_registry:
 
1364
            trace.warning('%s (from %s) is not a known policy, defaulting to %s'
 
1365
                          % (orphan_policy, conf_var_name, default_policy))
 
1366
            orphan_policy = default_policy
 
1367
        handle_orphan = orphaning_registry.get(orphan_policy)
 
1368
        handle_orphan(self, trans_id, parent_id)
 
1369
 
 
1370
 
 
1371
class OrphaningError(errors.BzrError):
 
1372
 
 
1373
    # Only bugs could lead to such exception being seen by the user
 
1374
    internal_error = True
 
1375
    _fmt = "Error while orphaning %s in %s directory"
 
1376
 
 
1377
    def __init__(self, orphan, parent):
 
1378
        errors.BzrError.__init__(self)
 
1379
        self.orphan = orphan
 
1380
        self.parent = parent
 
1381
 
 
1382
 
 
1383
class OrphaningForbidden(OrphaningError):
 
1384
 
 
1385
    _fmt = "Policy: %s doesn't allow creating orphans."
 
1386
 
 
1387
    def __init__(self, policy):
 
1388
        errors.BzrError.__init__(self)
 
1389
        self.policy = policy
 
1390
 
 
1391
 
 
1392
def move_orphan(tt, orphan_id, parent_id):
 
1393
    """See TreeTransformBase.new_orphan.
 
1394
 
 
1395
    This creates a new orphan in the `bzr-orphans` dir at the root of the
 
1396
    `TreeTransform`.
 
1397
 
 
1398
    :param tt: The TreeTransform orphaning `trans_id`.
 
1399
 
 
1400
    :param orphan_id: The trans id that should be orphaned.
 
1401
 
 
1402
    :param parent_id: The orphan parent trans id.
 
1403
    """
 
1404
    # Add the orphan dir if it doesn't exist
 
1405
    orphan_dir_basename = 'bzr-orphans'
 
1406
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
 
1407
    if tt.final_kind(od_id) is None:
 
1408
        tt.create_directory(od_id)
 
1409
    parent_path = tt._tree_id_paths[parent_id]
 
1410
    # Find a name that doesn't exist yet in the orphan dir
 
1411
    actual_name = tt.final_name(orphan_id)
 
1412
    new_name = tt._available_backup_name(actual_name, od_id)
 
1413
    tt.adjust_path(new_name, od_id, orphan_id)
 
1414
    trace.warning('%s has been orphaned in %s'
 
1415
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
 
1416
 
 
1417
 
 
1418
def refuse_orphan(tt, orphan_id, parent_id):
 
1419
    """See TreeTransformBase.new_orphan.
 
1420
 
 
1421
    This refuses to create orphan, letting the caller handle the conflict.
 
1422
    """
 
1423
    raise OrphaningForbidden('never')
 
1424
 
 
1425
 
 
1426
orphaning_registry = registry.Registry()
 
1427
orphaning_registry.register(
 
1428
    'conflict', refuse_orphan,
 
1429
    'Leave orphans in place and create a conflict on the directory.')
 
1430
orphaning_registry.register(
 
1431
    'move', move_orphan,
 
1432
    'Move orphans into the bzr-orphans directory.')
 
1433
orphaning_registry._set_default_key('conflict')
 
1434
 
1274
1435
 
1275
1436
class TreeTransform(DiskTreeTransform):
1276
1437
    """Represent a tree transformation.
1727
1888
            childpath = joinpath(path, child)
1728
1889
            yield self.trans_id_tree_path(childpath)
1729
1890
 
 
1891
    def new_orphan(self, trans_id, parent_id):
 
1892
        raise NotImplementedError(self.new_orphan)
 
1893
 
1730
1894
 
1731
1895
class _PreviewTree(tree.Tree):
1732
1896
    """Partial implementation of Tree to support show_diff_trees"""
2427
2591
    for child in tt.iter_tree_children(old_parent):
2428
2592
        tt.adjust_path(tt.final_name(child), new_parent, child)
2429
2593
 
 
2594
 
2430
2595
def _reparent_transform_children(tt, old_parent, new_parent):
2431
2596
    by_parent = tt.by_parent()
2432
2597
    for child in by_parent[old_parent]:
2433
2598
        tt.adjust_path(tt.final_name(child), new_parent, child)
2434
2599
    return by_parent[old_parent]
2435
2600
 
 
2601
 
2436
2602
def _content_match(tree, entry, file_id, kind, target_path):
2437
2603
    if entry.kind != kind:
2438
2604
        return False
2538
2704
        tt.set_executability(entry.executable, trans_id)
2539
2705
 
2540
2706
 
 
2707
@deprecated_function(deprecated_in((2, 3, 0)))
2541
2708
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2542
2709
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2543
2710
 
2544
2711
 
 
2712
@deprecated_function(deprecated_in((2, 3, 0)))
2545
2713
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2546
2714
    """Produce a backup-style name that appears to be available"""
2547
2715
    def name_gen():
2668
2836
                        tt.delete_contents(trans_id)
2669
2837
                    elif kind[1] is not None:
2670
2838
                        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)
 
2839
                        backup_name = tt._available_backup_name(
 
2840
                            name[0], parent_trans_id)
2674
2841
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2675
2842
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
2676
2843
                        if versioned == (True, True):
2799
2966
 
2800
2967
        elif c_type == 'missing parent':
2801
2968
            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:
 
2969
            if trans_id in tt._removed_contents:
 
2970
                cancel_deletion = True
 
2971
                orphans = tt._get_potential_orphans(trans_id)
 
2972
                if orphans:
 
2973
                    cancel_deletion = False
 
2974
                    # All children are orphans
 
2975
                    for o in orphans:
 
2976
                        try:
 
2977
                            tt.new_orphan(o, trans_id)
 
2978
                        except OrphaningError:
 
2979
                            # Something bad happened so we cancel the directory
 
2980
                            # deletion which will leave it in place with a
 
2981
                            # conflict. The user can deal with it from there.
 
2982
                            # Note that this also catch the case where we don't
 
2983
                            # want to create orphans and leave the directory in
 
2984
                            # place.
 
2985
                            cancel_deletion = True
 
2986
                            break
 
2987
                if cancel_deletion:
 
2988
                    # Cancel the directory deletion
 
2989
                    tt.cancel_deletion(trans_id)
 
2990
                    new_conflicts.add(('deleting parent', 'Not deleting',
 
2991
                                       trans_id))
 
2992
            else:
2807
2993
                create = True
2808
2994
                try:
2809
2995
                    tt.final_name(trans_id)
2917
3103
            try:
2918
3104
                os.rename(to, from_)
2919
3105
            except OSError, e:
2920
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)                
 
3106
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
2921
3107
        # after rollback, don't reuse _FileMover
2922
3108
        past_renames = None
2923
3109
        pending_deletions = None