~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-26 21:20:28 UTC
  • mfrom: (5444.1.1 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20100926212028-5i2y4k4yusao7umb
(jameinel) Update bug url for squid (Martin Pool)

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 import (
23
 
    errors,
24
 
    lazy_import,
25
 
    registry,
26
 
    )
27
 
lazy_import.lazy_import(globals(), """
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
28
24
from bzrlib import (
29
25
    annotate,
30
26
    bencode,
36
32
    multiparent,
37
33
    osutils,
38
34
    revision as _mod_revision,
39
 
    trace,
40
35
    ui,
41
36
    )
42
37
""")
60
55
from bzrlib.symbol_versioning import (
61
56
        deprecated_function,
62
57
        deprecated_in,
63
 
        deprecated_method,
64
58
        )
65
59
from bzrlib.trace import mutter, warning
66
60
from bzrlib import tree
70
64
 
71
65
ROOT_PARENT = "root-parent"
72
66
 
 
67
 
73
68
def unique_add(map, key, value):
74
69
    if key in map:
75
70
        raise DuplicateKey(key=key)
76
71
    map[key] = value
77
72
 
78
73
 
79
 
 
80
74
class _TransformResults(object):
81
75
    def __init__(self, modified_paths, rename_count):
82
76
        object.__init__(self)
130
124
            self._new_root = self.trans_id_tree_file_id(root_id)
131
125
        else:
132
126
            self._new_root = None
133
 
        # Indicator of whether the transform has been applied
 
127
        # Indictor of whether the transform has been applied
134
128
        self._done = False
135
129
        # A progress bar
136
130
        self._pb = pb
537
531
            # ensure that all children are registered with the transaction
538
532
            list(self.iter_tree_children(parent_id))
539
533
 
540
 
    @deprecated_method(deprecated_in((2, 3, 0)))
541
534
    def has_named_child(self, by_parent, parent_id, name):
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:
 
535
        try:
 
536
            children = by_parent[parent_id]
 
537
        except KeyError:
 
538
            children = []
 
539
        for child in children:
559
540
            if self.final_name(child) == name:
560
541
                return True
561
 
        parent_path = self._tree_id_paths.get(parent_id, None)
562
 
        if parent_path is None:
563
 
            # No parent... no children
 
542
        try:
 
543
            path = self._tree_id_paths[parent_id]
 
544
        except KeyError:
564
545
            return False
565
 
        child_path = joinpath(parent_path, name)
566
 
        child_id = self._tree_path_ids.get(child_path, None)
 
546
        childpath = joinpath(path, name)
 
547
        child_id = self._tree_path_ids.get(childpath)
567
548
        if child_id is None:
568
 
            # Not known by the tree transform yet, check the filesystem
569
 
            return osutils.lexists(self._tree.abspath(child_path))
 
549
            return lexists(self._tree.abspath(childpath))
570
550
        else:
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))
 
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
587
558
 
588
559
    def _parent_loops(self):
589
560
        """No entry should be its own ancestor"""
666
637
        if (self._new_name, self._new_parent) == ({}, {}):
667
638
            return conflicts
668
639
        for children in by_parent.itervalues():
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))
 
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]
677
643
            name_ids.sort()
678
644
            last_name = None
679
645
            last_trans_id = None
703
669
        return conflicts
704
670
 
705
671
    def _parent_type_conflicts(self, by_parent):
706
 
        """Children must have a directory parent"""
 
672
        """parents must have directory 'contents'."""
707
673
        conflicts = []
708
674
        for parent_id, children in by_parent.iteritems():
709
675
            if parent_id is ROOT_PARENT:
710
676
                continue
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:
 
677
            if not self._any_contents(children):
717
678
                continue
718
 
            # There is at least a child, so we need an existing directory to
719
 
            # contain it.
720
679
            kind = self.final_kind(parent_id)
721
680
            if kind is None:
722
 
                # The directory will be deleted
723
681
                conflicts.append(('missing parent', parent_id))
724
682
            elif kind != "directory":
725
 
                # Meh, we need a *directory* to put something in it
726
683
                conflicts.append(('non-directory parent', parent_id))
727
684
        return conflicts
728
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
 
729
693
    def _set_executability(self, path, trans_id):
730
694
        """Set the executability of versioned files """
731
695
        if supports_executable():
795
759
        self.create_symlink(target, trans_id)
796
760
        return trans_id
797
761
 
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
 
 
840
762
    def _affected_ids(self):
841
763
        """Return the set of transform ids affected by the transform"""
842
764
        trans_ids = set(self._removed_id)
1349
1271
            del self._limbo_children_names[trans_id]
1350
1272
        delete_any(self._limbo_name(trans_id))
1351
1273
 
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
 
 
1435
1274
 
1436
1275
class TreeTransform(DiskTreeTransform):
1437
1276
    """Represent a tree transformation.
1888
1727
            childpath = joinpath(path, child)
1889
1728
            yield self.trans_id_tree_path(childpath)
1890
1729
 
1891
 
    def new_orphan(self, trans_id, parent_id):
1892
 
        raise NotImplementedError(self.new_orphan)
1893
 
 
1894
1730
 
1895
1731
class _PreviewTree(tree.Tree):
1896
1732
    """Partial implementation of Tree to support show_diff_trees"""
2591
2427
    for child in tt.iter_tree_children(old_parent):
2592
2428
        tt.adjust_path(tt.final_name(child), new_parent, child)
2593
2429
 
2594
 
 
2595
2430
def _reparent_transform_children(tt, old_parent, new_parent):
2596
2431
    by_parent = tt.by_parent()
2597
2432
    for child in by_parent[old_parent]:
2598
2433
        tt.adjust_path(tt.final_name(child), new_parent, child)
2599
2434
    return by_parent[old_parent]
2600
2435
 
2601
 
 
2602
2436
def _content_match(tree, entry, file_id, kind, target_path):
2603
2437
    if entry.kind != kind:
2604
2438
        return False
2704
2538
        tt.set_executability(entry.executable, trans_id)
2705
2539
 
2706
2540
 
2707
 
@deprecated_function(deprecated_in((2, 3, 0)))
2708
2541
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2709
2542
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2710
2543
 
2711
2544
 
2712
 
@deprecated_function(deprecated_in((2, 3, 0)))
2713
2545
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2714
2546
    """Produce a backup-style name that appears to be available"""
2715
2547
    def name_gen():
2836
2668
                        tt.delete_contents(trans_id)
2837
2669
                    elif kind[1] is not None:
2838
2670
                        parent_trans_id = tt.trans_id_file_id(parent[0])
2839
 
                        backup_name = tt._available_backup_name(
2840
 
                            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)
2841
2674
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2842
2675
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
2843
2676
                        if versioned == (True, True):
2966
2799
 
2967
2800
        elif c_type == 'missing parent':
2968
2801
            trans_id = conflict[1]
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:
 
2802
            try:
 
2803
                tt.cancel_deletion(trans_id)
 
2804
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2805
                                   trans_id))
 
2806
            except KeyError:
2993
2807
                create = True
2994
2808
                try:
2995
2809
                    tt.final_name(trans_id)
3103
2917
            try:
3104
2918
                os.rename(to, from_)
3105
2919
            except OSError, e:
3106
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
 
2920
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)                
3107
2921
        # after rollback, don't reuse _FileMover
3108
2922
        past_renames = None
3109
2923
        pending_deletions = None