/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2018-11-16 18:15:40 UTC
  • mto: (7143.16.20 even-more-cleanups)
  • mto: This revision was merged to the branch mainline in revision 7175.
  • Revision ID: jelmer@jelmer.uk-20181116181540-7y2wbhqzjk067mqy
Fix repo acquisition.

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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import os
18
20
import errno
19
21
from stat import S_ISREG, S_IEXEC
20
22
import time
21
23
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
from bzrlib import (
 
24
from . import (
 
25
    config as _mod_config,
 
26
    errors,
 
27
    lazy_import,
 
28
    registry,
 
29
    trace,
 
30
    tree,
 
31
    )
 
32
lazy_import.lazy_import(globals(), """
 
33
from breezy import (
25
34
    annotate,
26
35
    bencode,
27
 
    bzrdir,
 
36
    controldir,
 
37
    commit,
 
38
    conflicts,
28
39
    delta,
29
 
    errors,
30
 
    inventory,
 
40
    lock,
31
41
    multiparent,
32
42
    osutils,
33
43
    revision as _mod_revision,
34
44
    ui,
35
 
    )
 
45
    urlutils,
 
46
    )
 
47
from breezy.bzr import (
 
48
    inventory,
 
49
    inventorytree,
 
50
    )
 
51
from breezy.i18n import gettext
36
52
""")
37
 
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
38
 
                           ReusingTransform, CantMoveRoot,
39
 
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
40
 
                           UnableCreateSymlink)
41
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
42
 
from bzrlib.inventory import InventoryEntry
43
 
from bzrlib.osutils import (
 
53
from .errors import (DuplicateKey, MalformedTransform,
 
54
                     ReusingTransform, CantMoveRoot,
 
55
                     ImmortalLimbo, NoFinalPath,
 
56
                     UnableCreateSymlink)
 
57
from .filters import filtered_output_bytes, ContentFilterContext
 
58
from .mutabletree import MutableTree
 
59
from .osutils import (
44
60
    delete_any,
45
61
    file_kind,
46
62
    has_symlinks,
47
 
    lexists,
48
63
    pathjoin,
49
64
    sha_file,
50
65
    splitpath,
51
 
    supports_executable,
52
 
)
53
 
from bzrlib.progress import ProgressPhase
54
 
from bzrlib.symbol_versioning import (
55
 
        deprecated_function,
56
 
        deprecated_in,
57
 
        )
58
 
from bzrlib.trace import mutter, warning
59
 
from bzrlib import tree
60
 
import bzrlib.ui
61
 
import bzrlib.urlutils as urlutils
 
66
    )
 
67
from .progress import ProgressPhase
 
68
from .sixish import (
 
69
    text_type,
 
70
    viewitems,
 
71
    viewvalues,
 
72
    )
 
73
from .tree import (
 
74
    find_previous_path,
 
75
    )
62
76
 
63
77
 
64
78
ROOT_PARENT = "root-parent"
80
94
class TreeTransformBase(object):
81
95
    """The base class for TreeTransform and its kin."""
82
96
 
83
 
    def __init__(self, tree, pb=None,
84
 
                 case_sensitive=True):
 
97
    def __init__(self, tree, pb=None, case_sensitive=True):
85
98
        """Constructor.
86
99
 
87
100
        :param tree: The tree that will be transformed, but not necessarily
99
112
        self._new_parent = {}
100
113
        # mapping of trans_id with new contents -> new file_kind
101
114
        self._new_contents = {}
 
115
        # mapping of trans_id => (sha1 of content, stat_value)
 
116
        self._observed_sha1s = {}
102
117
        # Set of trans_ids whose contents will be removed
103
118
        self._removed_contents = set()
104
119
        # Mapping of trans_id -> new execute-bit value
118
133
        # Mapping trans_id -> path in old tree
119
134
        self._tree_id_paths = {}
120
135
        # The trans_id that will be used as the tree root
121
 
        root_id = tree.get_root_id()
122
 
        if root_id is not None:
123
 
            self._new_root = self.trans_id_tree_file_id(root_id)
 
136
        if tree.is_versioned(''):
 
137
            self._new_root = self.trans_id_tree_path('')
124
138
        else:
125
139
            self._new_root = None
126
 
        # Indictor of whether the transform has been applied
 
140
        # Indicator of whether the transform has been applied
127
141
        self._done = False
128
142
        # A progress bar
129
143
        self._pb = pb
132
146
        # A counter of how many files have been renamed
133
147
        self.rename_count = 0
134
148
 
 
149
    def __enter__(self):
 
150
        """Support Context Manager API."""
 
151
        return self
 
152
 
 
153
    def __exit__(self, exc_type, exc_val, exc_tb):
 
154
        """Support Context Manager API."""
 
155
        self.finalize()
 
156
 
135
157
    def finalize(self):
136
158
        """Release the working tree lock, if held.
137
159
 
140
162
        """
141
163
        if self._tree is None:
142
164
            return
 
165
        for hook in MutableTree.hooks['post_transform']:
 
166
            hook(self._tree, self)
143
167
        self._tree.unlock()
144
168
        self._tree = None
145
169
 
151
175
    def _assign_id(self):
152
176
        """Produce a new tranform id"""
153
177
        new_id = "new-%s" % self._id_number
154
 
        self._id_number +=1
 
178
        self._id_number += 1
155
179
        return new_id
156
180
 
157
181
    def create_path(self, name, parent):
194
218
        # the physical root needs a new transaction id
195
219
        self._tree_path_ids.pop("")
196
220
        self._tree_id_paths.pop(old_root)
197
 
        self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
 
221
        self._new_root = self.trans_id_tree_path('')
198
222
        if parent == old_root:
199
223
            parent = self._new_root
200
224
        self.adjust_path(name, parent, old_root)
212
236
        This means that the old root trans-id becomes obsolete, so it is
213
237
        recommended only to invoke this after the root trans-id has become
214
238
        irrelevant.
 
239
 
215
240
        """
216
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
217
 
                     ROOT_PARENT]
 
241
        new_roots = [k for k, v in viewitems(self._new_parent)
 
242
                     if v == ROOT_PARENT]
218
243
        if len(new_roots) < 1:
219
244
            return
220
245
        if len(new_roots) != 1:
223
248
            self._new_root = new_roots[0]
224
249
            return
225
250
        old_new_root = new_roots[0]
226
 
        # TODO: What to do if a old_new_root is present, but self._new_root is
227
 
        #       not listed as being removed? This code explicitly unversions
228
 
        #       the old root and versions it with the new file_id. Though that
229
 
        #       seems like an incomplete delta
230
 
 
231
251
        # unversion the new root's directory.
232
 
        file_id = self.final_file_id(old_new_root)
 
252
        if self.final_kind(self._new_root) is None:
 
253
            file_id = self.final_file_id(old_new_root)
 
254
        else:
 
255
            file_id = self.final_file_id(self._new_root)
233
256
        if old_new_root in self._new_id:
234
257
            self.cancel_versioning(old_new_root)
235
258
        else:
236
259
            self.unversion_file(old_new_root)
237
260
        # if, at this stage, root still has an old file_id, zap it so we can
238
261
        # stick a new one in.
239
 
        if (self.tree_file_id(self._new_root) is not None and
240
 
            self._new_root not in self._removed_id):
 
262
        if (self.tree_file_id(self._new_root) is not None
 
263
                and self._new_root not in self._removed_id):
241
264
            self.unversion_file(self._new_root)
242
 
        self.version_file(file_id, self._new_root)
 
265
        if file_id is not None:
 
266
            self.version_file(file_id, self._new_root)
243
267
 
244
268
        # Now move children of new root into old root directory.
245
269
        # Ensure all children are registered with the transaction, but don't
263
287
        del self._new_parent[old_new_root]
264
288
        del self._new_name[old_new_root]
265
289
 
266
 
    def trans_id_tree_file_id(self, inventory_id):
267
 
        """Determine the transaction id of a working tree file.
268
 
 
269
 
        This reflects only files that already exist, not ones that will be
270
 
        added by transactions.
271
 
        """
272
 
        if inventory_id is None:
273
 
            raise ValueError('None is not a valid file id')
274
 
        path = self._tree.id2path(inventory_id)
275
 
        return self.trans_id_tree_path(path)
276
 
 
277
290
    def trans_id_file_id(self, file_id):
278
291
        """Determine or set the transaction id associated with a file ID.
279
292
        A new id is only created for file_ids that were never present.  If
286
299
            return self._r_new_id[file_id]
287
300
        else:
288
301
            try:
289
 
                self._tree.iter_entries_by_dir([file_id]).next()
290
 
            except StopIteration:
 
302
                path = self._tree.id2path(file_id)
 
303
            except errors.NoSuchId:
291
304
                if file_id in self._non_present_ids:
292
305
                    return self._non_present_ids[file_id]
293
306
                else:
295
308
                    self._non_present_ids[file_id] = trans_id
296
309
                    return trans_id
297
310
            else:
298
 
                return self.trans_id_tree_file_id(file_id)
 
311
                return self.trans_id_tree_path(path)
299
312
 
300
313
    def trans_id_tree_path(self, path):
301
314
        """Determine (and maybe set) the transaction ID for a tree path."""
314
327
 
315
328
    def delete_contents(self, trans_id):
316
329
        """Schedule the contents of a path entry for deletion"""
317
 
        # Ensure that the object exists in the WorkingTree, this will raise an
318
 
        # exception if there is a problem
319
 
        self.tree_kind(trans_id)
320
 
        self._removed_contents.add(trans_id)
 
330
        kind = self.tree_kind(trans_id)
 
331
        if kind is not None:
 
332
            self._removed_contents.add(trans_id)
321
333
 
322
334
    def cancel_deletion(self, trans_id):
323
335
        """Cancel a scheduled deletion"""
380
392
        return sorted(FinalPaths(self).get_paths(new_ids))
381
393
 
382
394
    def _inventory_altered(self):
383
 
        """Get the trans_ids and paths of files needing new inv entries."""
384
 
        new_ids = set()
385
 
        for id_set in [self._new_name, self._new_parent, self._new_id,
 
395
        """Determine which trans_ids need new Inventory entries.
 
396
 
 
397
        An new entry is needed when anything that would be reflected by an
 
398
        inventory entry changes, including file name, file_id, parent file_id,
 
399
        file kind, and the execute bit.
 
400
 
 
401
        Some care is taken to return entries with real changes, not cases
 
402
        where the value is deleted and then restored to its original value,
 
403
        but some actually unchanged values may be returned.
 
404
 
 
405
        :returns: A list of (path, trans_id) for all items requiring an
 
406
            inventory change. Ordered by path.
 
407
        """
 
408
        changed_ids = set()
 
409
        # Find entries whose file_ids are new (or changed).
 
410
        new_file_id = set(t for t in self._new_id
 
411
                          if self._new_id[t] != self.tree_file_id(t))
 
412
        for id_set in [self._new_name, self._new_parent, new_file_id,
386
413
                       self._new_executability]:
387
 
            new_ids.update(id_set)
 
414
            changed_ids.update(id_set)
 
415
        # removing implies a kind change
388
416
        changed_kind = set(self._removed_contents)
 
417
        # so does adding
389
418
        changed_kind.intersection_update(self._new_contents)
390
 
        changed_kind.difference_update(new_ids)
391
 
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
392
 
                        self.final_kind(t))
393
 
        new_ids.update(changed_kind)
394
 
        return sorted(FinalPaths(self).get_paths(new_ids))
 
419
        # Ignore entries that are already known to have changed.
 
420
        changed_kind.difference_update(changed_ids)
 
421
        #  to keep only the truly changed ones
 
422
        changed_kind = (t for t in changed_kind
 
423
                        if self.tree_kind(t) != self.final_kind(t))
 
424
        # all kind changes will alter the inventory
 
425
        changed_ids.update(changed_kind)
 
426
        # To find entries with changed parent_ids, find parents which existed,
 
427
        # but changed file_id.
 
428
        # Now add all their children to the set.
 
429
        for parent_trans_id in new_file_id:
 
430
            changed_ids.update(self.iter_tree_children(parent_trans_id))
 
431
        return sorted(FinalPaths(self).get_paths(changed_ids))
395
432
 
396
433
    def final_kind(self, trans_id):
397
434
        """Determine the final file kind, after any changes applied.
398
435
 
399
 
        Raises NoSuchFile if the file does not exist/has no contents.
400
 
        (It is conceivable that a path would be created without the
401
 
        corresponding contents insertion command)
 
436
        :return: None if the file does not exist/has no contents.  (It is
 
437
            conceivable that a path would be created without the corresponding
 
438
            contents insertion command)
402
439
        """
403
440
        if trans_id in self._new_contents:
404
441
            return self._new_contents[trans_id]
405
442
        elif trans_id in self._removed_contents:
406
 
            raise NoSuchFile(None)
 
443
            return None
407
444
        else:
408
445
            return self.tree_kind(trans_id)
409
446
 
 
447
    def tree_path(self, trans_id):
 
448
        """Determine the tree path associated with the trans_id."""
 
449
        return self._tree_id_paths.get(trans_id)
 
450
 
410
451
    def tree_file_id(self, trans_id):
411
452
        """Determine the file id associated with the trans_id in the tree"""
412
 
        try:
413
 
            path = self._tree_id_paths[trans_id]
414
 
        except KeyError:
415
 
            # the file is a new, unversioned file, or invalid trans_id
 
453
        path = self.tree_path(trans_id)
 
454
        if path is None:
416
455
            return None
417
456
        # the file is old; the old id is still valid
418
457
        if self._new_root == trans_id:
440
479
        file_id = self.tree_file_id(trans_id)
441
480
        if file_id is not None:
442
481
            return file_id
443
 
        for key, value in self._non_present_ids.iteritems():
 
482
        for key, value in viewitems(self._non_present_ids):
444
483
            if value == trans_id:
445
484
                return key
446
485
 
470
509
        Only new paths and parents of tree files with assigned ids are used.
471
510
        """
472
511
        by_parent = {}
473
 
        items = list(self._new_parent.iteritems())
474
 
        items.extend((t, self.final_parent(t)) for t in
475
 
                      self._tree_id_paths.keys())
 
512
        items = list(viewitems(self._new_parent))
 
513
        items.extend((t, self.final_parent(t))
 
514
                     for t in list(self._tree_id_paths))
476
515
        for trans_id, parent_id in items:
477
516
            if parent_id not in by_parent:
478
517
                by_parent[parent_id] = set()
516
555
        Active parents are those which gain children, and those which are
517
556
        removed.  This is a necessary first step in detecting conflicts.
518
557
        """
519
 
        parents = self.by_parent().keys()
 
558
        parents = list(self.by_parent())
520
559
        parents.extend([t for t in self._removed_contents if
521
560
                        self.tree_kind(t) == 'directory'])
522
561
        for trans_id in self._removed_id:
523
 
            file_id = self.tree_file_id(trans_id)
524
 
            if file_id is not None:
525
 
                if self._tree.inventory[file_id].kind == 'directory':
 
562
            path = self.tree_path(trans_id)
 
563
            if path is not None:
 
564
                if self._tree.stored_kind(path) == 'directory':
526
565
                    parents.append(trans_id)
527
566
            elif self.tree_kind(trans_id) == 'directory':
528
567
                parents.append(trans_id)
531
570
            # ensure that all children are registered with the transaction
532
571
            list(self.iter_tree_children(parent_id))
533
572
 
534
 
    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:
 
573
    def _has_named_child(self, name, parent_id, known_children):
 
574
        """Does a parent already have a name child.
 
575
 
 
576
        :param name: The searched for name.
 
577
 
 
578
        :param parent_id: The parent for which the check is made.
 
579
 
 
580
        :param known_children: The already known children. This should have
 
581
            been recently obtained from `self.by_parent.get(parent_id)`
 
582
            (or will be if None is passed).
 
583
        """
 
584
        if known_children is None:
 
585
            known_children = self.by_parent().get(parent_id, [])
 
586
        for child in known_children:
540
587
            if self.final_name(child) == name:
541
588
                return True
542
 
        try:
543
 
            path = self._tree_id_paths[parent_id]
544
 
        except KeyError:
 
589
        parent_path = self._tree_id_paths.get(parent_id, None)
 
590
        if parent_path is None:
 
591
            # No parent... no children
545
592
            return False
546
 
        childpath = joinpath(path, name)
547
 
        child_id = self._tree_path_ids.get(childpath)
 
593
        child_path = joinpath(parent_path, name)
 
594
        child_id = self._tree_path_ids.get(child_path, None)
548
595
        if child_id is None:
549
 
            return lexists(self._tree.abspath(childpath))
 
596
            # Not known by the tree transform yet, check the filesystem
 
597
            return osutils.lexists(self._tree.abspath(child_path))
550
598
        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
 
599
            raise AssertionError('child_id is missing: %s, %s, %s'
 
600
                                 % (name, parent_id, child_id))
 
601
 
 
602
    def _available_backup_name(self, name, target_id):
 
603
        """Find an available backup name.
 
604
 
 
605
        :param name: The basename of the file.
 
606
 
 
607
        :param target_id: The directory trans_id where the backup should 
 
608
            be placed.
 
609
        """
 
610
        known_children = self.by_parent().get(target_id, [])
 
611
        return osutils.available_backup_name(
 
612
            name,
 
613
            lambda base: self._has_named_child(
 
614
                base, target_id, known_children))
558
615
 
559
616
    def _parent_loops(self):
560
617
        """No entry should be its own ancestor"""
562
619
        for trans_id in self._new_parent:
563
620
            seen = set()
564
621
            parent_id = trans_id
565
 
            while parent_id is not ROOT_PARENT:
 
622
            while parent_id != ROOT_PARENT:
566
623
                seen.add(parent_id)
567
624
                try:
568
625
                    parent_id = self.final_parent(parent_id)
577
634
    def _unversioned_parents(self, by_parent):
578
635
        """If parent directories are versioned, children must be versioned."""
579
636
        conflicts = []
580
 
        for parent_id, children in by_parent.iteritems():
581
 
            if parent_id is ROOT_PARENT:
 
637
        for parent_id, children in viewitems(by_parent):
 
638
            if parent_id == ROOT_PARENT:
582
639
                continue
583
640
            if self.final_file_id(parent_id) is not None:
584
641
                continue
585
642
            for child_id in children:
586
643
                if self.final_file_id(child_id) is not None:
587
644
                    conflicts.append(('unversioned parent', parent_id))
588
 
                    break;
 
645
                    break
589
646
        return conflicts
590
647
 
591
648
    def _improper_versioning(self):
594
651
        However, existing entries with no contents are okay.
595
652
        """
596
653
        conflicts = []
597
 
        for trans_id in self._new_id.iterkeys():
598
 
            try:
599
 
                kind = self.final_kind(trans_id)
600
 
            except NoSuchFile:
 
654
        for trans_id in self._new_id:
 
655
            kind = self.final_kind(trans_id)
 
656
            if kind is None:
601
657
                conflicts.append(('versioning no contents', trans_id))
602
658
                continue
603
 
            if not InventoryEntry.versionable_kind(kind):
 
659
            if not self._tree.versionable_kind(kind):
604
660
                conflicts.append(('versioning bad kind', trans_id, kind))
605
661
        return conflicts
606
662
 
617
673
            if self.final_file_id(trans_id) is None:
618
674
                conflicts.append(('unversioned executability', trans_id))
619
675
            else:
620
 
                try:
621
 
                    non_file = self.final_kind(trans_id) != "file"
622
 
                except NoSuchFile:
623
 
                    non_file = True
624
 
                if non_file is True:
 
676
                if self.final_kind(trans_id) != "file":
625
677
                    conflicts.append(('non-file executability', trans_id))
626
678
        return conflicts
627
679
 
629
681
        """Check for overwrites (not permitted on Win32)"""
630
682
        conflicts = []
631
683
        for trans_id in self._new_contents:
632
 
            try:
633
 
                self.tree_kind(trans_id)
634
 
            except NoSuchFile:
 
684
            if self.tree_kind(trans_id) is None:
635
685
                continue
636
686
            if trans_id not in self._removed_contents:
637
687
                conflicts.append(('overwrite', trans_id,
638
 
                                 self.final_name(trans_id)))
 
688
                                  self.final_name(trans_id)))
639
689
        return conflicts
640
690
 
641
691
    def _duplicate_entries(self, by_parent):
643
693
        conflicts = []
644
694
        if (self._new_name, self._new_parent) == ({}, {}):
645
695
            return conflicts
646
 
        for children in by_parent.itervalues():
647
 
            name_ids = [(self.final_name(t), t) for t in children]
648
 
            if not self._case_sensitive_target:
649
 
                name_ids = [(n.lower(), t) for n, t in name_ids]
 
696
        for children in viewvalues(by_parent):
 
697
            name_ids = []
 
698
            for child_tid in children:
 
699
                name = self.final_name(child_tid)
 
700
                if name is not None:
 
701
                    # Keep children only if they still exist in the end
 
702
                    if not self._case_sensitive_target:
 
703
                        name = name.lower()
 
704
                    name_ids.append((name, child_tid))
650
705
            name_ids.sort()
651
706
            last_name = None
652
707
            last_trans_id = None
653
708
            for name, trans_id in name_ids:
654
 
                try:
655
 
                    kind = self.final_kind(trans_id)
656
 
                except NoSuchFile:
657
 
                    kind = None
 
709
                kind = self.final_kind(trans_id)
658
710
                file_id = self.final_file_id(trans_id)
659
711
                if kind is None and file_id is None:
660
712
                    continue
661
713
                if name == last_name:
662
714
                    conflicts.append(('duplicate', last_trans_id, trans_id,
663
 
                    name))
 
715
                                      name))
664
716
                last_name = name
665
717
                last_trans_id = trans_id
666
718
        return conflicts
672
724
                                self._removed_id))
673
725
        all_ids = self._tree.all_file_ids()
674
726
        active_tree_ids = all_ids.difference(removed_tree_ids)
675
 
        for trans_id, file_id in self._new_id.iteritems():
 
727
        for trans_id, file_id in viewitems(self._new_id):
676
728
            if file_id in active_tree_ids:
677
 
                old_trans_id = self.trans_id_tree_file_id(file_id)
 
729
                path = self._tree.id2path(file_id)
 
730
                old_trans_id = self.trans_id_tree_path(path)
678
731
                conflicts.append(('duplicate id', old_trans_id, trans_id))
679
732
        return conflicts
680
733
 
681
734
    def _parent_type_conflicts(self, by_parent):
682
 
        """parents must have directory 'contents'."""
 
735
        """Children must have a directory parent"""
683
736
        conflicts = []
684
 
        for parent_id, children in by_parent.iteritems():
685
 
            if parent_id is ROOT_PARENT:
686
 
                continue
687
 
            if not self._any_contents(children):
688
 
                continue
689
 
            for child in children:
690
 
                try:
691
 
                    self.final_kind(child)
692
 
                except NoSuchFile:
693
 
                    continue
694
 
            try:
695
 
                kind = self.final_kind(parent_id)
696
 
            except NoSuchFile:
697
 
                kind = None
 
737
        for parent_id, children in viewitems(by_parent):
 
738
            if parent_id == ROOT_PARENT:
 
739
                continue
 
740
            no_children = True
 
741
            for child_id in children:
 
742
                if self.final_kind(child_id) is not None:
 
743
                    no_children = False
 
744
                    break
 
745
            if no_children:
 
746
                continue
 
747
            # There is at least a child, so we need an existing directory to
 
748
            # contain it.
 
749
            kind = self.final_kind(parent_id)
698
750
            if kind is None:
 
751
                # The directory will be deleted
699
752
                conflicts.append(('missing parent', parent_id))
700
753
            elif kind != "directory":
 
754
                # Meh, we need a *directory* to put something in it
701
755
                conflicts.append(('non-directory parent', parent_id))
702
756
        return conflicts
703
757
 
704
 
    def _any_contents(self, trans_ids):
705
 
        """Return true if any of the trans_ids, will have contents."""
706
 
        for trans_id in trans_ids:
707
 
            try:
708
 
                kind = self.final_kind(trans_id)
709
 
            except NoSuchFile:
710
 
                continue
711
 
            return True
712
 
        return False
713
 
 
714
758
    def _set_executability(self, path, trans_id):
715
759
        """Set the executability of versioned files """
716
 
        if supports_executable():
 
760
        if self._tree._supports_executable():
717
761
            new_executability = self._new_executability[trans_id]
718
762
            abspath = self._tree.abspath(path)
719
763
            current_mode = os.stat(abspath).st_mode
720
764
            if new_executability:
721
765
                umask = os.umask(0)
722
766
                os.umask(umask)
723
 
                to_mode = current_mode | (0100 & ~umask)
 
767
                to_mode = current_mode | (0o100 & ~umask)
724
768
                # Enable x-bit for others only if they can read it.
725
 
                if current_mode & 0004:
726
 
                    to_mode |= 0001 & ~umask
727
 
                if current_mode & 0040:
728
 
                    to_mode |= 0010 & ~umask
 
769
                if current_mode & 0o004:
 
770
                    to_mode |= 0o001 & ~umask
 
771
                if current_mode & 0o040:
 
772
                    to_mode |= 0o010 & ~umask
729
773
            else:
730
 
                to_mode = current_mode & ~0111
731
 
            os.chmod(abspath, to_mode)
 
774
                to_mode = current_mode & ~0o111
 
775
            osutils.chmod_if_possible(abspath, to_mode)
732
776
 
733
777
    def _new_entry(self, name, parent_id, file_id):
734
778
        """Helper function to create a new filesystem entry."""
738
782
        return trans_id
739
783
 
740
784
    def new_file(self, name, parent_id, contents, file_id=None,
741
 
                 executable=None):
 
785
                 executable=None, sha1=None):
742
786
        """Convenience method to create files.
743
787
 
744
788
        name is the name of the file to create.
751
795
        trans_id = self._new_entry(name, parent_id, file_id)
752
796
        # TODO: rather than scheduling a set_executable call,
753
797
        # have create_file create the file with the right mode.
754
 
        self.create_file(contents, trans_id)
 
798
        self.create_file(contents, trans_id, sha1=sha1)
755
799
        if executable is not None:
756
800
            self.set_executability(executable, trans_id)
757
801
        return trans_id
780
824
        self.create_symlink(target, trans_id)
781
825
        return trans_id
782
826
 
 
827
    def new_orphan(self, trans_id, parent_id):
 
828
        """Schedule an item to be orphaned.
 
829
 
 
830
        When a directory is about to be removed, its children, if they are not
 
831
        versioned are moved out of the way: they don't have a parent anymore.
 
832
 
 
833
        :param trans_id: The trans_id of the existing item.
 
834
        :param parent_id: The parent trans_id of the item.
 
835
        """
 
836
        raise NotImplementedError(self.new_orphan)
 
837
 
 
838
    def _get_potential_orphans(self, dir_id):
 
839
        """Find the potential orphans in a directory.
 
840
 
 
841
        A directory can't be safely deleted if there are versioned files in it.
 
842
        If all the contained files are unversioned then they can be orphaned.
 
843
 
 
844
        The 'None' return value means that the directory contains at least one
 
845
        versioned file and should not be deleted.
 
846
 
 
847
        :param dir_id: The directory trans id.
 
848
 
 
849
        :return: A list of the orphan trans ids or None if at least one
 
850
             versioned file is present.
 
851
        """
 
852
        orphans = []
 
853
        # Find the potential orphans, stop if one item should be kept
 
854
        for child_tid in self.by_parent()[dir_id]:
 
855
            if child_tid in self._removed_contents:
 
856
                # The child is removed as part of the transform. Since it was
 
857
                # versioned before, it's not an orphan
 
858
                continue
 
859
            elif self.final_file_id(child_tid) is None:
 
860
                # The child is not versioned
 
861
                orphans.append(child_tid)
 
862
            else:
 
863
                # We have a versioned file here, searching for orphans is
 
864
                # meaningless.
 
865
                orphans = None
 
866
                break
 
867
        return orphans
 
868
 
783
869
    def _affected_ids(self):
784
870
        """Return the set of transform ids affected by the transform"""
785
871
        trans_ids = set(self._removed_id)
786
 
        trans_ids.update(self._new_id.keys())
 
872
        trans_ids.update(self._new_id)
787
873
        trans_ids.update(self._removed_contents)
788
 
        trans_ids.update(self._new_contents.keys())
789
 
        trans_ids.update(self._new_executability.keys())
790
 
        trans_ids.update(self._new_name.keys())
791
 
        trans_ids.update(self._new_parent.keys())
 
874
        trans_ids.update(self._new_contents)
 
875
        trans_ids.update(self._new_executability)
 
876
        trans_ids.update(self._new_name)
 
877
        trans_ids.update(self._new_parent)
792
878
        return trans_ids
793
879
 
794
880
    def _get_file_id_maps(self):
807
893
                to_trans_ids[to_file_id] = trans_id
808
894
        return from_trans_ids, to_trans_ids
809
895
 
810
 
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
 
896
    def _from_file_data(self, from_trans_id, from_versioned, from_path):
811
897
        """Get data about a file in the from (tree) state
812
898
 
813
899
        Return a (name, parent, kind, executable) tuple
815
901
        from_path = self._tree_id_paths.get(from_trans_id)
816
902
        if from_versioned:
817
903
            # get data from working tree if versioned
818
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
904
            from_entry = next(self._tree.iter_entries_by_dir(
 
905
                specific_files=[from_path]))[1]
819
906
            from_name = from_entry.name
820
907
            from_parent = from_entry.parent_id
821
908
        else:
844
931
        Return a (name, parent, kind, executable) tuple
845
932
        """
846
933
        to_name = self.final_name(to_trans_id)
847
 
        try:
848
 
            to_kind = self.final_kind(to_trans_id)
849
 
        except NoSuchFile:
850
 
            to_kind = None
 
934
        to_kind = self.final_kind(to_trans_id)
851
935
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
852
936
        if to_trans_id in self._new_executability:
853
937
            to_executable = self._new_executability[to_trans_id]
871
955
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
872
956
        results = []
873
957
        # Now iterate through all active file_ids
874
 
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
 
958
        for file_id in set(from_trans_ids).union(to_trans_ids):
875
959
            modified = False
876
960
            from_trans_id = from_trans_ids.get(file_id)
877
961
            # find file ids, and determine versioning state
887
971
            else:
888
972
                to_versioned = True
889
973
 
890
 
            from_name, from_parent, from_kind, from_executable = \
891
 
                self._from_file_data(from_trans_id, from_versioned, file_id)
892
 
 
893
 
            to_name, to_parent, to_kind, to_executable = \
894
 
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
895
 
 
896
974
            if not from_versioned:
897
975
                from_path = None
898
976
            else:
901
979
                to_path = None
902
980
            else:
903
981
                to_path = final_paths.get_path(to_trans_id)
 
982
 
 
983
            from_name, from_parent, from_kind, from_executable = \
 
984
                self._from_file_data(from_trans_id, from_versioned, from_path)
 
985
 
 
986
            to_name, to_parent, to_kind, to_executable = \
 
987
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
988
 
904
989
            if from_kind != to_kind:
905
990
                modified = True
906
991
            elif to_kind in ('file', 'symlink') and (
907
 
                to_trans_id != from_trans_id or
908
 
                to_trans_id in self._new_contents):
 
992
                    to_trans_id != from_trans_id
 
993
                    or to_trans_id in self._new_contents):
909
994
                modified = True
910
 
            if (not modified and from_versioned == to_versioned and
911
 
                from_parent==to_parent and from_name == to_name and
912
 
                from_executable == to_executable):
 
995
            if (not modified and from_versioned == to_versioned
 
996
                and from_parent == to_parent and from_name == to_name
 
997
                    and from_executable == to_executable):
913
998
                continue
914
999
            results.append((file_id, (from_path, to_path), modified,
915
 
                   (from_versioned, to_versioned),
916
 
                   (from_parent, to_parent),
917
 
                   (from_name, to_name),
918
 
                   (from_kind, to_kind),
919
 
                   (from_executable, to_executable)))
920
 
        return iter(sorted(results, key=lambda x:x[1]))
 
1000
                            (from_versioned, to_versioned),
 
1001
                            (from_parent, to_parent),
 
1002
                            (from_name, to_name),
 
1003
                            (from_kind, to_kind),
 
1004
                            (from_executable, to_executable)))
 
1005
 
 
1006
        def path_key(t):
 
1007
            paths = t[1]
 
1008
            return (paths[0] or '', paths[1] or '')
 
1009
        return iter(sorted(results, key=path_key))
921
1010
 
922
1011
    def get_preview_tree(self):
923
1012
        """Return a tree representing the result of the transform.
927
1016
        """
928
1017
        return _PreviewTree(self)
929
1018
 
930
 
    def commit(self, branch, message, merge_parents=None, strict=False):
 
1019
    def commit(self, branch, message, merge_parents=None, strict=False,
 
1020
               timestamp=None, timezone=None, committer=None, authors=None,
 
1021
               revprops=None, revision_id=None):
931
1022
        """Commit the result of this TreeTransform to a branch.
932
1023
 
933
1024
        :param branch: The branch to commit to.
934
1025
        :param message: The message to attach to the commit.
935
 
        :param merge_parents: Additional parents specified by pending merges.
 
1026
        :param merge_parents: Additional parent revision-ids specified by
 
1027
            pending merges.
 
1028
        :param strict: If True, abort the commit if there are unversioned
 
1029
            files.
 
1030
        :param timestamp: if not None, seconds-since-epoch for the time and
 
1031
            date.  (May be a float.)
 
1032
        :param timezone: Optional timezone for timestamp, as an offset in
 
1033
            seconds.
 
1034
        :param committer: Optional committer in email-id format.
 
1035
            (e.g. "J Random Hacker <jrandom@example.com>")
 
1036
        :param authors: Optional list of authors in email-id format.
 
1037
        :param revprops: Optional dictionary of revision properties.
 
1038
        :param revision_id: Optional revision id.  (Specifying a revision-id
 
1039
            may reduce performance for some non-native formats.)
936
1040
        :return: The revision_id of the revision committed.
937
1041
        """
938
1042
        self._check_malformed()
954
1058
                parent_ids.extend(merge_parents)
955
1059
        if self._tree.get_revision_id() != last_rev_id:
956
1060
            raise ValueError('TreeTransform not based on branch basis: %s' %
957
 
                             self._tree.get_revision_id())
958
 
        builder = branch.get_commit_builder(parent_ids)
 
1061
                             self._tree.get_revision_id().decode('utf-8'))
 
1062
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
 
1063
        builder = branch.get_commit_builder(parent_ids,
 
1064
                                            timestamp=timestamp,
 
1065
                                            timezone=timezone,
 
1066
                                            committer=committer,
 
1067
                                            revprops=revprops,
 
1068
                                            revision_id=revision_id)
959
1069
        preview = self.get_preview_tree()
960
1070
        list(builder.record_iter_changes(preview, last_rev_id,
961
1071
                                         self.iter_changes()))
965
1075
        return revision_id
966
1076
 
967
1077
    def _text_parent(self, trans_id):
968
 
        file_id = self.tree_file_id(trans_id)
 
1078
        path = self.tree_path(trans_id)
969
1079
        try:
970
 
            if file_id is None or self._tree.kind(file_id) != 'file':
 
1080
            if path is None or self._tree.kind(path) != 'file':
971
1081
                return None
972
1082
        except errors.NoSuchFile:
973
1083
            return None
974
 
        return file_id
 
1084
        return path
975
1085
 
976
1086
    def _get_parents_texts(self, trans_id):
977
1087
        """Get texts for compression parents of this file."""
978
 
        file_id = self._text_parent(trans_id)
979
 
        if file_id is None:
 
1088
        path = self._text_parent(trans_id)
 
1089
        if path is None:
980
1090
            return ()
981
 
        return (self._tree.get_file_text(file_id),)
 
1091
        return (self._tree.get_file_text(path),)
982
1092
 
983
1093
    def _get_parents_lines(self, trans_id):
984
1094
        """Get lines for compression parents of this file."""
985
 
        file_id = self._text_parent(trans_id)
986
 
        if file_id is None:
 
1095
        path = self._text_parent(trans_id)
 
1096
        if path is None:
987
1097
            return ()
988
 
        return (self._tree.get_file_lines(file_id),)
 
1098
        return (self._tree.get_file_lines(path),)
989
1099
 
990
1100
    def serialize(self, serializer):
991
1101
        """Serialize this TreeTransform.
992
1102
 
993
1103
        :param serializer: A Serialiser like pack.ContainerSerializer.
994
1104
        """
995
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
996
 
                        self._new_name.items())
997
 
        new_executability = dict((k, int(v)) for k, v in
998
 
                                 self._new_executability.items())
999
 
        tree_path_ids = dict((k.encode('utf-8'), v)
1000
 
                             for k, v in self._tree_path_ids.items())
 
1105
        new_name = {k.encode('utf-8'): v.encode('utf-8')
 
1106
                    for k, v in viewitems(self._new_name)}
 
1107
        new_parent = {k.encode('utf-8'): v.encode('utf-8')
 
1108
                      for k, v in viewitems(self._new_parent)}
 
1109
        new_id = {k.encode('utf-8'): v
 
1110
                  for k, v in viewitems(self._new_id)}
 
1111
        new_executability = {k.encode('utf-8'): int(v)
 
1112
                             for k, v in viewitems(self._new_executability)}
 
1113
        tree_path_ids = {k.encode('utf-8'): v.encode('utf-8')
 
1114
                         for k, v in viewitems(self._tree_path_ids)}
 
1115
        non_present_ids = {k: v.encode('utf-8')
 
1116
                           for k, v in viewitems(self._non_present_ids)}
 
1117
        removed_contents = [trans_id.encode('utf-8')
 
1118
                            for trans_id in self._removed_contents]
 
1119
        removed_id = [trans_id.encode('utf-8')
 
1120
                      for trans_id in self._removed_id]
1001
1121
        attribs = {
1002
 
            '_id_number': self._id_number,
1003
 
            '_new_name': new_name,
1004
 
            '_new_parent': self._new_parent,
1005
 
            '_new_executability': new_executability,
1006
 
            '_new_id': self._new_id,
1007
 
            '_tree_path_ids': tree_path_ids,
1008
 
            '_removed_id': list(self._removed_id),
1009
 
            '_removed_contents': list(self._removed_contents),
1010
 
            '_non_present_ids': self._non_present_ids,
 
1122
            b'_id_number': self._id_number,
 
1123
            b'_new_name': new_name,
 
1124
            b'_new_parent': new_parent,
 
1125
            b'_new_executability': new_executability,
 
1126
            b'_new_id': new_id,
 
1127
            b'_tree_path_ids': tree_path_ids,
 
1128
            b'_removed_id': removed_id,
 
1129
            b'_removed_contents': removed_contents,
 
1130
            b'_non_present_ids': non_present_ids,
1011
1131
            }
1012
1132
        yield serializer.bytes_record(bencode.bencode(attribs),
1013
 
                                      (('attribs',),))
1014
 
        for trans_id, kind in self._new_contents.items():
 
1133
                                      ((b'attribs',),))
 
1134
        for trans_id, kind in sorted(viewitems(self._new_contents)):
1015
1135
            if kind == 'file':
1016
 
                lines = osutils.chunks_to_lines(
1017
 
                    self._read_file_chunks(trans_id))
 
1136
                with open(self._limbo_name(trans_id), 'rb') as cur_file:
 
1137
                    lines = cur_file.readlines()
1018
1138
                parents = self._get_parents_lines(trans_id)
1019
1139
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1020
 
                content = ''.join(mpdiff.to_patch())
 
1140
                content = b''.join(mpdiff.to_patch())
1021
1141
            if kind == 'directory':
1022
 
                content = ''
 
1142
                content = b''
1023
1143
            if kind == 'symlink':
1024
1144
                content = self._read_symlink_target(trans_id)
1025
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
 
1145
                if not isinstance(content, bytes):
 
1146
                    content = content.encode('utf-8')
 
1147
            yield serializer.bytes_record(
 
1148
                content, ((trans_id.encode('utf-8'), kind.encode('ascii')),))
1026
1149
 
1027
1150
    def deserialize(self, records):
1028
1151
        """Deserialize a stored TreeTransform.
1030
1153
        :param records: An iterable of (names, content) tuples, as per
1031
1154
            pack.ContainerPushParser.
1032
1155
        """
1033
 
        names, content = records.next()
 
1156
        names, content = next(records)
1034
1157
        attribs = bencode.bdecode(content)
1035
 
        self._id_number = attribs['_id_number']
1036
 
        self._new_name = dict((k, v.decode('utf-8'))
1037
 
                            for k, v in attribs['_new_name'].items())
1038
 
        self._new_parent = attribs['_new_parent']
1039
 
        self._new_executability = dict((k, bool(v)) for k, v in
1040
 
            attribs['_new_executability'].items())
1041
 
        self._new_id = attribs['_new_id']
1042
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
 
1158
        self._id_number = attribs[b'_id_number']
 
1159
        self._new_name = {k.decode('utf-8'): v.decode('utf-8')
 
1160
                          for k, v in viewitems(attribs[b'_new_name'])}
 
1161
        self._new_parent = {k.decode('utf-8'): v.decode('utf-8')
 
1162
                            for k, v in viewitems(attribs[b'_new_parent'])}
 
1163
        self._new_executability = {
 
1164
            k.decode('utf-8'): bool(v)
 
1165
            for k, v in viewitems(attribs[b'_new_executability'])}
 
1166
        self._new_id = {k.decode('utf-8'): v
 
1167
                        for k, v in viewitems(attribs[b'_new_id'])}
 
1168
        self._r_new_id = {v: k for k, v in viewitems(self._new_id)}
1043
1169
        self._tree_path_ids = {}
1044
1170
        self._tree_id_paths = {}
1045
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
 
1171
        for bytepath, trans_id in viewitems(attribs[b'_tree_path_ids']):
1046
1172
            path = bytepath.decode('utf-8')
 
1173
            trans_id = trans_id.decode('utf-8')
1047
1174
            self._tree_path_ids[path] = trans_id
1048
1175
            self._tree_id_paths[trans_id] = path
1049
 
        self._removed_id = set(attribs['_removed_id'])
1050
 
        self._removed_contents = set(attribs['_removed_contents'])
1051
 
        self._non_present_ids = attribs['_non_present_ids']
 
1176
        self._removed_id = {trans_id.decode('utf-8')
 
1177
                            for trans_id in attribs[b'_removed_id']}
 
1178
        self._removed_contents = set(
 
1179
            trans_id.decode('utf-8')
 
1180
            for trans_id in attribs[b'_removed_contents'])
 
1181
        self._non_present_ids = {
 
1182
            k: v.decode('utf-8')
 
1183
            for k, v in viewitems(attribs[b'_non_present_ids'])}
1052
1184
        for ((trans_id, kind),), content in records:
 
1185
            trans_id = trans_id.decode('utf-8')
 
1186
            kind = kind.decode('ascii')
1053
1187
            if kind == 'file':
1054
1188
                mpdiff = multiparent.MultiParent.from_patch(content)
1055
1189
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1079
1213
        self._deletiondir = None
1080
1214
        # A mapping of transform ids to their limbo filename
1081
1215
        self._limbo_files = {}
 
1216
        self._possibly_stale_limbo_files = set()
1082
1217
        # A mapping of transform ids to a set of the transform ids of children
1083
1218
        # that their limbo directory has
1084
1219
        self._limbo_children = {}
1097
1232
        if self._tree is None:
1098
1233
            return
1099
1234
        try:
1100
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1101
 
                       self._new_contents.iteritems()]
1102
 
            entries.sort(reverse=True)
1103
 
            for path, trans_id, kind in entries:
1104
 
                delete_any(path)
 
1235
            limbo_paths = list(viewvalues(self._limbo_files))
 
1236
            limbo_paths.extend(self._possibly_stale_limbo_files)
 
1237
            limbo_paths.sort(reverse=True)
 
1238
            for path in limbo_paths:
 
1239
                try:
 
1240
                    delete_any(path)
 
1241
                except OSError as e:
 
1242
                    if e.errno != errno.ENOENT:
 
1243
                        raise
 
1244
                    # XXX: warn? perhaps we just got interrupted at an
 
1245
                    # inconvenient moment, but perhaps files are disappearing
 
1246
                    # from under us?
1105
1247
            try:
1106
1248
                delete_any(self._limbodir)
1107
1249
            except OSError:
1115
1257
        finally:
1116
1258
            TreeTransformBase.finalize(self)
1117
1259
 
 
1260
    def _limbo_supports_executable(self):
 
1261
        """Check if the limbo path supports the executable bit."""
 
1262
        # FIXME: Check actual file system capabilities of limbodir
 
1263
        return osutils.supports_executable()
 
1264
 
1118
1265
    def _limbo_name(self, trans_id):
1119
1266
        """Generate the limbo name of a file"""
1120
1267
        limbo_name = self._limbo_files.get(trans_id)
1136
1283
        previous_parent = self._new_parent.get(trans_id)
1137
1284
        previous_name = self._new_name.get(trans_id)
1138
1285
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1139
 
        if (trans_id in self._limbo_files and
1140
 
            trans_id not in self._needs_rename):
 
1286
        if (trans_id in self._limbo_files
 
1287
                and trans_id not in self._needs_rename):
1141
1288
            self._rename_in_limbo([trans_id])
1142
1289
            if previous_parent != parent:
1143
1290
                self._limbo_children[previous_parent].remove(trans_id)
1156
1303
        entries from _limbo_files, because they are now stale.
1157
1304
        """
1158
1305
        for trans_id in trans_ids:
1159
 
            old_path = self._limbo_files.pop(trans_id)
 
1306
            old_path = self._limbo_files[trans_id]
 
1307
            self._possibly_stale_limbo_files.add(old_path)
 
1308
            del self._limbo_files[trans_id]
1160
1309
            if trans_id not in self._new_contents:
1161
1310
                continue
1162
1311
            new_path = self._limbo_name(trans_id)
1163
 
            osutils.rename(old_path, new_path)
 
1312
            os.rename(old_path, new_path)
 
1313
            self._possibly_stale_limbo_files.remove(old_path)
1164
1314
            for descendant in self._limbo_descendants(trans_id):
1165
1315
                desc_path = self._limbo_files[descendant]
1166
1316
                desc_path = new_path + desc_path[len(old_path):]
1173
1323
            descendants.update(self._limbo_descendants(descendant))
1174
1324
        return descendants
1175
1325
 
1176
 
    def create_file(self, contents, trans_id, mode_id=None):
 
1326
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1177
1327
        """Schedule creation of a new file.
1178
1328
 
1179
 
        See also new_file.
1180
 
 
1181
 
        Contents is an iterator of strings, all of which will be written
1182
 
        to the target destination.
1183
 
 
1184
 
        New file takes the permissions of any existing file with that id,
1185
 
        unless mode_id is specified.
 
1329
        :seealso: new_file.
 
1330
 
 
1331
        :param contents: an iterator of strings, all of which will be written
 
1332
            to the target destination.
 
1333
        :param trans_id: TreeTransform handle
 
1334
        :param mode_id: If not None, force the mode of the target file to match
 
1335
            the mode of the object referenced by mode_id.
 
1336
            Otherwise, we will try to preserve mode bits of an existing file.
 
1337
        :param sha1: If the sha1 of this content is already known, pass it in.
 
1338
            We can use it to prevent future sha1 computations.
1186
1339
        """
1187
1340
        name = self._limbo_name(trans_id)
1188
 
        f = open(name, 'wb')
1189
 
        try:
1190
 
            try:
1191
 
                unique_add(self._new_contents, trans_id, 'file')
1192
 
            except:
1193
 
                # Clean up the file, it never got registered so
1194
 
                # TreeTransform.finalize() won't clean it up.
1195
 
                f.close()
1196
 
                os.unlink(name)
1197
 
                raise
1198
 
 
 
1341
        with open(name, 'wb') as f:
 
1342
            unique_add(self._new_contents, trans_id, 'file')
1199
1343
            f.writelines(contents)
1200
 
        finally:
1201
 
            f.close()
1202
1344
        self._set_mtime(name)
1203
1345
        self._set_mode(trans_id, mode_id, S_ISREG)
1204
 
 
1205
 
    def _read_file_chunks(self, trans_id):
1206
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1207
 
        try:
1208
 
            return cur_file.readlines()
1209
 
        finally:
1210
 
            cur_file.close()
 
1346
        # It is unfortunate we have to use lstat instead of fstat, but we just
 
1347
        # used utime and chmod on the file, so we need the accurate final
 
1348
        # details.
 
1349
        if sha1 is not None:
 
1350
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1211
1351
 
1212
1352
    def _read_symlink_target(self, trans_id):
1213
1353
        return os.readlink(self._limbo_name(trans_id))
1226
1366
        name = self._limbo_name(trans_id)
1227
1367
        try:
1228
1368
            os.link(path, name)
1229
 
        except OSError, e:
 
1369
        except OSError as e:
1230
1370
            if e.errno != errno.EPERM:
1231
1371
                raise
1232
1372
            raise errors.HardLinkNotSupported(path)
1233
1373
        try:
1234
1374
            unique_add(self._new_contents, trans_id, 'file')
1235
 
        except:
 
1375
        except BaseException:
1236
1376
            # Clean up the file, it never got registered so
1237
1377
            # TreeTransform.finalize() won't clean it up.
1238
1378
            os.unlink(name)
1265
1405
    def cancel_creation(self, trans_id):
1266
1406
        """Cancel the creation of new file contents."""
1267
1407
        del self._new_contents[trans_id]
 
1408
        if trans_id in self._observed_sha1s:
 
1409
            del self._observed_sha1s[trans_id]
1268
1410
        children = self._limbo_children.get(trans_id)
1269
1411
        # if this is a limbo directory with children, move them before removing
1270
1412
        # the directory
1274
1416
            del self._limbo_children_names[trans_id]
1275
1417
        delete_any(self._limbo_name(trans_id))
1276
1418
 
 
1419
    def new_orphan(self, trans_id, parent_id):
 
1420
        conf = self._tree.get_config_stack()
 
1421
        handle_orphan = conf.get('transform.orphan_policy')
 
1422
        handle_orphan(self, trans_id, parent_id)
 
1423
 
 
1424
 
 
1425
class OrphaningError(errors.BzrError):
 
1426
 
 
1427
    # Only bugs could lead to such exception being seen by the user
 
1428
    internal_error = True
 
1429
    _fmt = "Error while orphaning %s in %s directory"
 
1430
 
 
1431
    def __init__(self, orphan, parent):
 
1432
        errors.BzrError.__init__(self)
 
1433
        self.orphan = orphan
 
1434
        self.parent = parent
 
1435
 
 
1436
 
 
1437
class OrphaningForbidden(OrphaningError):
 
1438
 
 
1439
    _fmt = "Policy: %s doesn't allow creating orphans."
 
1440
 
 
1441
    def __init__(self, policy):
 
1442
        errors.BzrError.__init__(self)
 
1443
        self.policy = policy
 
1444
 
 
1445
 
 
1446
def move_orphan(tt, orphan_id, parent_id):
 
1447
    """See TreeTransformBase.new_orphan.
 
1448
 
 
1449
    This creates a new orphan in the `brz-orphans` dir at the root of the
 
1450
    `TreeTransform`.
 
1451
 
 
1452
    :param tt: The TreeTransform orphaning `trans_id`.
 
1453
 
 
1454
    :param orphan_id: The trans id that should be orphaned.
 
1455
 
 
1456
    :param parent_id: The orphan parent trans id.
 
1457
    """
 
1458
    # Add the orphan dir if it doesn't exist
 
1459
    orphan_dir_basename = 'brz-orphans'
 
1460
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
 
1461
    if tt.final_kind(od_id) is None:
 
1462
        tt.create_directory(od_id)
 
1463
    parent_path = tt._tree_id_paths[parent_id]
 
1464
    # Find a name that doesn't exist yet in the orphan dir
 
1465
    actual_name = tt.final_name(orphan_id)
 
1466
    new_name = tt._available_backup_name(actual_name, od_id)
 
1467
    tt.adjust_path(new_name, od_id, orphan_id)
 
1468
    trace.warning('%s has been orphaned in %s'
 
1469
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
 
1470
 
 
1471
 
 
1472
def refuse_orphan(tt, orphan_id, parent_id):
 
1473
    """See TreeTransformBase.new_orphan.
 
1474
 
 
1475
    This refuses to create orphan, letting the caller handle the conflict.
 
1476
    """
 
1477
    raise OrphaningForbidden('never')
 
1478
 
 
1479
 
 
1480
orphaning_registry = registry.Registry()
 
1481
orphaning_registry.register(
 
1482
    u'conflict', refuse_orphan,
 
1483
    'Leave orphans in place and create a conflict on the directory.')
 
1484
orphaning_registry.register(
 
1485
    u'move', move_orphan,
 
1486
    'Move orphans into the brz-orphans directory.')
 
1487
orphaning_registry._set_default_key(u'conflict')
 
1488
 
 
1489
 
 
1490
opt_transform_orphan = _mod_config.RegistryOption(
 
1491
    'transform.orphan_policy', orphaning_registry,
 
1492
    help='Policy for orphaned files during transform operations.',
 
1493
    invalid='warning')
 
1494
 
1277
1495
 
1278
1496
class TreeTransform(DiskTreeTransform):
1279
1497
    """Represent a tree transformation.
1340
1558
    FileMover does not delete files until it is sure that a rollback will not
1341
1559
    happen.
1342
1560
    """
 
1561
 
1343
1562
    def __init__(self, tree, pb=None):
1344
1563
        """Note: a tree_write lock is taken on the tree.
1345
1564
 
1347
1566
        TreeTransform.apply() called).
1348
1567
        """
1349
1568
        tree.lock_tree_write()
1350
 
 
1351
1569
        try:
1352
1570
            limbodir = urlutils.local_path_from_url(
1353
1571
                tree._transport.abspath('limbo'))
1354
 
            try:
1355
 
                os.mkdir(limbodir)
1356
 
            except OSError, e:
1357
 
                if e.errno == errno.EEXIST:
1358
 
                    raise ExistingLimbo(limbodir)
 
1572
            osutils.ensure_empty_directory_exists(
 
1573
                limbodir,
 
1574
                errors.ExistingLimbo)
1359
1575
            deletiondir = urlutils.local_path_from_url(
1360
1576
                tree._transport.abspath('pending-deletion'))
1361
 
            try:
1362
 
                os.mkdir(deletiondir)
1363
 
            except OSError, e:
1364
 
                if e.errno == errno.EEXIST:
1365
 
                    raise errors.ExistingPendingDeletion(deletiondir)
1366
 
        except:
 
1577
            osutils.ensure_empty_directory_exists(
 
1578
                deletiondir,
 
1579
                errors.ExistingPendingDeletion)
 
1580
        except BaseException:
1367
1581
            tree.unlock()
1368
1582
            raise
1369
1583
 
1397
1611
    def tree_kind(self, trans_id):
1398
1612
        """Determine the file kind in the working tree.
1399
1613
 
1400
 
        Raises NoSuchFile if the file does not exist
 
1614
        :returns: The file kind or None if the file does not exist
1401
1615
        """
1402
1616
        path = self._tree_id_paths.get(trans_id)
1403
1617
        if path is None:
1404
 
            raise NoSuchFile(None)
 
1618
            return None
1405
1619
        try:
1406
1620
            return file_kind(self._tree.abspath(path))
1407
 
        except OSError, e:
1408
 
            if e.errno != errno.ENOENT:
1409
 
                raise
1410
 
            else:
1411
 
                raise NoSuchFile(path)
 
1621
        except errors.NoSuchFile:
 
1622
            return None
1412
1623
 
1413
1624
    def _set_mode(self, trans_id, mode_id, typefunc):
1414
1625
        """Set the mode of new file contents.
1424
1635
            return
1425
1636
        try:
1426
1637
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1427
 
        except OSError, e:
 
1638
        except OSError as e:
1428
1639
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1429
1640
                # Either old_path doesn't exist, or the parent of the
1430
1641
                # target is not a directory (but will be one eventually)
1434
1645
            else:
1435
1646
                raise
1436
1647
        if typefunc(mode):
1437
 
            os.chmod(self._limbo_name(trans_id), mode)
 
1648
            osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1438
1649
 
1439
1650
    def iter_tree_children(self, parent_id):
1440
1651
        """Iterate through the entry's tree children, if any"""
1444
1655
            return
1445
1656
        try:
1446
1657
            children = os.listdir(self._tree.abspath(path))
1447
 
        except OSError, e:
1448
 
            if not (osutils._is_error_enotdir(e)
1449
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
1658
        except OSError as e:
 
1659
            if not (osutils._is_error_enotdir(e) or
 
1660
                    e.errno in (errno.ENOENT, errno.ESRCH)):
1450
1661
                raise
1451
1662
            return
1452
1663
 
1483
1694
                # if it is already associated with this trans_id.
1484
1695
                elif self._case_sensitive_target:
1485
1696
                    if (self._limbo_children_names[parent].get(filename)
1486
 
                        in (trans_id, None)):
 
1697
                            in (trans_id, None)):
1487
1698
                        use_direct_path = True
1488
1699
                else:
1489
 
                    for l_filename, l_trans_id in\
1490
 
                        self._limbo_children_names[parent].iteritems():
 
1700
                    for l_filename, l_trans_id in viewitems(
 
1701
                            self._limbo_children_names[parent]):
1491
1702
                        if l_trans_id == trans_id:
1492
1703
                            continue
1493
1704
                        if l_filename.lower() == filename.lower():
1503
1714
        self._limbo_children_names[parent][filename] = trans_id
1504
1715
        return limbo_name
1505
1716
 
1506
 
 
1507
1717
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1508
1718
        """Apply all changes to the inventory and filesystem.
1509
1719
 
1518
1728
            calculating one.
1519
1729
        :param _mover: Supply an alternate FileMover, for testing
1520
1730
        """
 
1731
        for hook in MutableTree.hooks['pre_transform']:
 
1732
            hook(self._tree, self)
1521
1733
        if not no_conflicts:
1522
1734
            self._check_malformed()
1523
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
 
        try:
 
1735
        with ui.ui_factory.nested_progress_bar() as child_pb:
1525
1736
            if precomputed_delta is None:
1526
 
                child_pb.update('Apply phase', 0, 2)
 
1737
                child_pb.update(gettext('Apply phase'), 0, 2)
1527
1738
                inventory_delta = self._generate_inventory_delta()
1528
1739
                offset = 1
1529
1740
            else:
1534
1745
            else:
1535
1746
                mover = _mover
1536
1747
            try:
1537
 
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
 
1748
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1538
1749
                self._apply_removals(mover)
1539
 
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
 
1750
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1540
1751
                modified_paths = self._apply_insertions(mover)
1541
 
            except:
 
1752
            except BaseException:
1542
1753
                mover.rollback()
1543
1754
                raise
1544
1755
            else:
1545
1756
                mover.apply_deletions()
1546
 
        finally:
1547
 
            child_pb.finished()
 
1757
        if self.final_file_id(self.root) is None:
 
1758
            inventory_delta = [e for e in inventory_delta if e[0] != '']
1548
1759
        self._tree.apply_inventory_delta(inventory_delta)
 
1760
        self._apply_observed_sha1s()
1549
1761
        self._done = True
1550
1762
        self.finalize()
1551
1763
        return _TransformResults(modified_paths, self.rename_count)
1553
1765
    def _generate_inventory_delta(self):
1554
1766
        """Generate an inventory delta for the current transform."""
1555
1767
        inventory_delta = []
1556
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1557
1768
        new_paths = self._inventory_altered()
1558
1769
        total_entries = len(new_paths) + len(self._removed_id)
1559
 
        try:
 
1770
        with ui.ui_factory.nested_progress_bar() as child_pb:
1560
1771
            for num, trans_id in enumerate(self._removed_id):
1561
1772
                if (num % 10) == 0:
1562
 
                    child_pb.update('removing file', num, total_entries)
 
1773
                    child_pb.update(gettext('removing file'),
 
1774
                                    num, total_entries)
1563
1775
                if trans_id == self._new_root:
1564
1776
                    file_id = self._tree.get_root_id()
1565
1777
                else:
1571
1783
                inventory_delta.append((path, None, file_id, None))
1572
1784
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1573
1785
                                     new_paths)
1574
 
            entries = self._tree.iter_entries_by_dir(
1575
 
                new_path_file_ids.values())
1576
 
            old_paths = dict((e.file_id, p) for p, e in entries)
1577
 
            final_kinds = {}
1578
1786
            for num, (path, trans_id) in enumerate(new_paths):
1579
1787
                if (num % 10) == 0:
1580
 
                    child_pb.update('adding file',
 
1788
                    child_pb.update(gettext('adding file'),
1581
1789
                                    num + len(self._removed_id), total_entries)
1582
1790
                file_id = new_path_file_ids[trans_id]
1583
1791
                if file_id is None:
1584
1792
                    continue
1585
 
                needs_entry = False
1586
 
                try:
1587
 
                    kind = self.final_kind(trans_id)
1588
 
                except NoSuchFile:
1589
 
                    kind = self._tree.stored_kind(file_id)
 
1793
                kind = self.final_kind(trans_id)
 
1794
                if kind is None:
 
1795
                    kind = self._tree.stored_kind(
 
1796
                        self._tree.id2path(file_id), file_id)
1590
1797
                parent_trans_id = self.final_parent(trans_id)
1591
1798
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1592
1799
                if parent_file_id is None:
1599
1806
                        None, self._new_reference_revision[trans_id])
1600
1807
                else:
1601
1808
                    new_entry = inventory.make_entry(kind,
1602
 
                        self.final_name(trans_id),
1603
 
                        parent_file_id, file_id)
1604
 
                old_path = old_paths.get(new_entry.file_id)
 
1809
                                                     self.final_name(trans_id),
 
1810
                                                     parent_file_id, file_id)
 
1811
                try:
 
1812
                    old_path = self._tree.id2path(new_entry.file_id)
 
1813
                except errors.NoSuchId:
 
1814
                    old_path = None
1605
1815
                new_executability = self._new_executability.get(trans_id)
1606
1816
                if new_executability is not None:
1607
1817
                    new_entry.executable = new_executability
1608
1818
                inventory_delta.append(
1609
1819
                    (old_path, path, new_entry.file_id, new_entry))
1610
 
        finally:
1611
 
            child_pb.finished()
1612
1820
        return inventory_delta
1613
1821
 
1614
1822
    def _apply_removals(self, mover):
1620
1828
 
1621
1829
        If inventory_delta is None, no inventory delta generation is performed.
1622
1830
        """
1623
 
        tree_paths = list(self._tree_path_ids.iteritems())
1624
 
        tree_paths.sort(reverse=True)
1625
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1626
 
        try:
1627
 
            for num, data in enumerate(tree_paths):
1628
 
                path, trans_id = data
1629
 
                child_pb.update('removing file', num, len(tree_paths))
 
1831
        tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
 
1832
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
1833
            for num, (path, trans_id) in enumerate(tree_paths):
 
1834
                # do not attempt to move root into a subdirectory of itself.
 
1835
                if path == '':
 
1836
                    continue
 
1837
                child_pb.update(gettext('removing file'), num, len(tree_paths))
1630
1838
                full_path = self._tree.abspath(path)
1631
1839
                if trans_id in self._removed_contents:
1632
1840
                    delete_path = os.path.join(self._deletiondir, trans_id)
1633
1841
                    mover.pre_delete(full_path, delete_path)
1634
 
                elif (trans_id in self._new_name
1635
 
                      or trans_id in self._new_parent):
 
1842
                elif (trans_id in self._new_name or
 
1843
                      trans_id in self._new_parent):
1636
1844
                    try:
1637
1845
                        mover.rename(full_path, self._limbo_name(trans_id))
1638
 
                    except OSError, e:
 
1846
                    except errors.TransformRenameFailed as e:
1639
1847
                        if e.errno != errno.ENOENT:
1640
1848
                            raise
1641
1849
                    else:
1642
1850
                        self.rename_count += 1
1643
 
        finally:
1644
 
            child_pb.finished()
1645
1851
 
1646
1852
    def _apply_insertions(self, mover):
1647
1853
        """Perform tree operations that insert directory/inventory names.
1655
1861
        """
1656
1862
        new_paths = self.new_paths(filesystem_only=True)
1657
1863
        modified_paths = []
1658
 
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1659
 
                                 new_paths)
1660
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1661
 
        try:
 
1864
        with ui.ui_factory.nested_progress_bar() as child_pb:
1662
1865
            for num, (path, trans_id) in enumerate(new_paths):
1663
1866
                if (num % 10) == 0:
1664
 
                    child_pb.update('adding file', num, len(new_paths))
 
1867
                    child_pb.update(gettext('adding file'),
 
1868
                                    num, len(new_paths))
1665
1869
                full_path = self._tree.abspath(path)
1666
1870
                if trans_id in self._needs_rename:
1667
1871
                    try:
1668
1872
                        mover.rename(self._limbo_name(trans_id), full_path)
1669
 
                    except OSError, e:
 
1873
                    except errors.TransformRenameFailed as e:
1670
1874
                        # We may be renaming a dangling inventory id
1671
1875
                        if e.errno != errno.ENOENT:
1672
1876
                            raise
1673
1877
                    else:
1674
1878
                        self.rename_count += 1
1675
 
                if (trans_id in self._new_contents or
1676
 
                    self.path_changed(trans_id)):
 
1879
                    # TODO: if trans_id in self._observed_sha1s, we should
 
1880
                    #       re-stat the final target, since ctime will be
 
1881
                    #       updated by the change.
 
1882
                if (trans_id in self._new_contents
 
1883
                        or self.path_changed(trans_id)):
1677
1884
                    if trans_id in self._new_contents:
1678
1885
                        modified_paths.append(full_path)
1679
1886
                if trans_id in self._new_executability:
1680
1887
                    self._set_executability(path, trans_id)
1681
 
        finally:
1682
 
            child_pb.finished()
 
1888
                if trans_id in self._observed_sha1s:
 
1889
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
 
1890
                    st = osutils.lstat(full_path)
 
1891
                    self._observed_sha1s[trans_id] = (o_sha1, st)
 
1892
        for path, trans_id in new_paths:
 
1893
            # new_paths includes stuff like workingtree conflicts. Only the
 
1894
            # stuff in new_contents actually comes from limbo.
 
1895
            if trans_id in self._limbo_files:
 
1896
                del self._limbo_files[trans_id]
1683
1897
        self._new_contents.clear()
1684
1898
        return modified_paths
1685
1899
 
 
1900
    def _apply_observed_sha1s(self):
 
1901
        """After we have finished renaming everything, update observed sha1s
 
1902
 
 
1903
        This has to be done after self._tree.apply_inventory_delta, otherwise
 
1904
        it doesn't know anything about the files we are updating. Also, we want
 
1905
        to do this as late as possible, so that most entries end up cached.
 
1906
        """
 
1907
        # TODO: this doesn't update the stat information for directories. So
 
1908
        #       the first 'bzr status' will still need to rewrite
 
1909
        #       .bzr/checkout/dirstate. However, we at least don't need to
 
1910
        #       re-read all of the files.
 
1911
        # TODO: If the operation took a while, we could do a time.sleep(3) here
 
1912
        #       to allow the clock to tick over and ensure we won't have any
 
1913
        #       problems. (we could observe start time, and finish time, and if
 
1914
        #       it is less than eg 10% overhead, add a sleep call.)
 
1915
        paths = FinalPaths(self)
 
1916
        for trans_id, observed in viewitems(self._observed_sha1s):
 
1917
            path = paths.get_path(trans_id)
 
1918
            # We could get the file_id, but dirstate prefers to use the path
 
1919
            # anyway, and it is 'cheaper' to determine.
 
1920
            # file_id = self._new_id[trans_id]
 
1921
            self._tree._observed_sha1(None, path, observed)
 
1922
 
1686
1923
 
1687
1924
class TransformPreview(DiskTreeTransform):
1688
1925
    """A TreeTransform for generating preview trees.
1703
1940
    def tree_kind(self, trans_id):
1704
1941
        path = self._tree_id_paths.get(trans_id)
1705
1942
        if path is None:
1706
 
            raise NoSuchFile(None)
1707
 
        file_id = self._tree.path2id(path)
1708
 
        return self._tree.kind(file_id)
 
1943
            return None
 
1944
        kind = self._tree.path_content_summary(path)[0]
 
1945
        if kind == 'missing':
 
1946
            kind = None
 
1947
        return kind
1709
1948
 
1710
1949
    def _set_mode(self, trans_id, mode_id, typefunc):
1711
1950
        """Set the mode of new file contents.
1722
1961
            path = self._tree_id_paths[parent_id]
1723
1962
        except KeyError:
1724
1963
            return
1725
 
        file_id = self.tree_file_id(parent_id)
1726
 
        if file_id is None:
 
1964
        try:
 
1965
            entry = next(self._tree.iter_entries_by_dir(
 
1966
                specific_files=[path]))[1]
 
1967
        except StopIteration:
1727
1968
            return
1728
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1729
1969
        children = getattr(entry, 'children', {})
1730
1970
        for child in children:
1731
1971
            childpath = joinpath(path, child)
1732
1972
            yield self.trans_id_tree_path(childpath)
1733
1973
 
1734
 
 
1735
 
class _PreviewTree(tree.Tree):
 
1974
    def new_orphan(self, trans_id, parent_id):
 
1975
        raise NotImplementedError(self.new_orphan)
 
1976
 
 
1977
 
 
1978
class _PreviewTree(inventorytree.InventoryTree):
1736
1979
    """Partial implementation of Tree to support show_diff_trees"""
1737
1980
 
1738
1981
    def __init__(self, transform):
1766
2009
            except errors.NoSuchRevisionInTree:
1767
2010
                yield self._get_repository().revision_tree(revision_id)
1768
2011
 
1769
 
    def _get_file_revision(self, file_id, vf, tree_revision):
1770
 
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1771
 
                       self._iter_parent_trees()]
 
2012
    def _get_file_revision(self, path, file_id, vf, tree_revision):
 
2013
        parent_keys = [
 
2014
            (file_id, t.get_file_revision(t.id2path(file_id), file_id))
 
2015
            for t in self._iter_parent_trees()]
1772
2016
        vf.add_lines((file_id, tree_revision), parent_keys,
1773
 
                     self.get_file(file_id).readlines())
 
2017
                     self.get_file_lines(path, file_id))
1774
2018
        repo = self._get_repository()
1775
2019
        base_vf = repo.texts
1776
2020
        if base_vf not in vf.fallback_versionedfiles:
1777
2021
            vf.fallback_versionedfiles.append(base_vf)
1778
2022
        return tree_revision
1779
2023
 
1780
 
    def _stat_limbo_file(self, file_id):
1781
 
        trans_id = self._transform.trans_id_file_id(file_id)
 
2024
    def _stat_limbo_file(self, trans_id):
1782
2025
        name = self._transform._limbo_name(trans_id)
1783
2026
        return os.lstat(name)
1784
2027
 
1795
2038
            executable = False
1796
2039
        else:
1797
2040
            file_id = self._transform.final_file_id(self._path2trans_id(path))
1798
 
            executable = self.is_executable(file_id, path)
 
2041
            executable = self.is_executable(path, file_id)
1799
2042
        return kind, executable, None
1800
2043
 
 
2044
    def is_locked(self):
 
2045
        return False
 
2046
 
1801
2047
    def lock_read(self):
1802
2048
        # Perhaps in theory, this should lock the TreeTransform?
1803
 
        pass
 
2049
        return lock.LogicalLockResult(self.unlock)
1804
2050
 
1805
2051
    def unlock(self):
1806
2052
        pass
1807
2053
 
1808
2054
    @property
1809
 
    def inventory(self):
 
2055
    def root_inventory(self):
1810
2056
        """This Tree does not use inventory as its backing data."""
1811
 
        raise NotImplementedError(_PreviewTree.inventory)
 
2057
        raise NotImplementedError(_PreviewTree.root_inventory)
1812
2058
 
1813
2059
    def get_root_id(self):
1814
2060
        return self._transform.final_file_id(self._transform.root)
1817
2063
        tree_ids = set(self._transform._tree.all_file_ids())
1818
2064
        tree_ids.difference_update(self._transform.tree_file_id(t)
1819
2065
                                   for t in self._transform._removed_id)
1820
 
        tree_ids.update(self._transform._new_id.values())
 
2066
        tree_ids.update(viewvalues(self._transform._new_id))
1821
2067
        return tree_ids
1822
2068
 
1823
 
    def __iter__(self):
1824
 
        return iter(self.all_file_ids())
 
2069
    def all_versioned_paths(self):
 
2070
        return {self.id2path(fid) for fid in self.all_file_ids()}
1825
2071
 
1826
2072
    def _has_id(self, file_id, fallback_check):
1827
2073
        if file_id in self._transform._r_new_id:
1828
2074
            return True
1829
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1830
 
            trans_id in self._transform._removed_id]):
 
2075
        elif file_id in {self._transform.tree_file_id(trans_id) for
 
2076
                         trans_id in self._transform._removed_id}:
1831
2077
            return False
1832
2078
        else:
1833
2079
            return fallback_check(file_id)
1861
2107
        return cur_parent
1862
2108
 
1863
2109
    def path2id(self, path):
 
2110
        if isinstance(path, list):
 
2111
            if path == []:
 
2112
                path = [""]
 
2113
            path = osutils.pathjoin(*path)
1864
2114
        return self._transform.final_file_id(self._path2trans_id(path))
1865
2115
 
1866
2116
    def id2path(self, file_id):
1876
2126
            return children
1877
2127
        children = set(self._transform.iter_tree_children(trans_id))
1878
2128
        # children in the _new_parent set are provided by _by_parent.
1879
 
        children.difference_update(self._transform._new_parent.keys())
 
2129
        children.difference_update(self._transform._new_parent)
1880
2130
        children.update(self._by_parent.get(trans_id, []))
1881
2131
        self._all_children_cache[trans_id] = children
1882
2132
        return children
1883
2133
 
1884
 
    def iter_children(self, file_id):
 
2134
    def _iter_children(self, file_id):
1885
2135
        trans_id = self._transform.trans_id_file_id(file_id)
1886
2136
        for child_trans_id in self._all_children(trans_id):
1887
2137
            yield self._transform.final_file_id(child_trans_id)
1895
2145
            if self._transform.final_file_id(trans_id) is None:
1896
2146
                yield self._final_paths._determine_path(trans_id)
1897
2147
 
1898
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1899
 
        yield_parents=False):
 
2148
    def _make_inv_entries(self, ordered_entries, specific_files=None):
1900
2149
        for trans_id, parent_file_id in ordered_entries:
1901
2150
            file_id = self._transform.final_file_id(trans_id)
1902
2151
            if file_id is None:
1903
2152
                continue
1904
 
            if (specific_file_ids is not None
1905
 
                and file_id not in specific_file_ids):
 
2153
            if (specific_files is not None
 
2154
                    and self._final_paths.get_path(trans_id) not in specific_files):
1906
2155
                continue
1907
 
            try:
1908
 
                kind = self._transform.final_kind(trans_id)
1909
 
            except NoSuchFile:
1910
 
                kind = self._transform._tree.stored_kind(file_id)
 
2156
            kind = self._transform.final_kind(trans_id)
 
2157
            if kind is None:
 
2158
                kind = self._transform._tree.stored_kind(
 
2159
                    self._transform._tree.id2path(file_id),
 
2160
                    file_id)
1911
2161
            new_entry = inventory.make_entry(
1912
2162
                kind,
1913
2163
                self._transform.final_name(trans_id),
1928
2178
                ordered_ids.append((trans_id, parent_file_id))
1929
2179
        return ordered_ids
1930
2180
 
1931
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
2181
    def iter_child_entries(self, path, file_id=None):
 
2182
        trans_id = self._path2trans_id(path)
 
2183
        if trans_id is None:
 
2184
            raise errors.NoSuchFile(path)
 
2185
        todo = [(child_trans_id, trans_id) for child_trans_id in
 
2186
                self._all_children(trans_id)]
 
2187
        for entry, trans_id in self._make_inv_entries(todo):
 
2188
            yield entry
 
2189
 
 
2190
    def iter_entries_by_dir(self, specific_files=None):
1932
2191
        # This may not be a maximally efficient implementation, but it is
1933
2192
        # reasonably straightforward.  An implementation that grafts the
1934
2193
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1936
2195
        # position.
1937
2196
        ordered_ids = self._list_files_by_dir()
1938
2197
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1939
 
            specific_file_ids, yield_parents=yield_parents):
1940
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
2198
                                                      specific_files):
 
2199
            yield self._final_paths.get_path(trans_id), entry
1941
2200
 
1942
2201
    def _iter_entries_for_dir(self, dir_path):
1943
2202
        """Return path, entry for items in a directory without recursing down."""
1944
 
        dir_file_id = self.path2id(dir_path)
1945
2203
        ordered_ids = []
1946
 
        for file_id in self.iter_children(dir_file_id):
1947
 
            trans_id = self._transform.trans_id_file_id(file_id)
1948
 
            ordered_ids.append((trans_id, file_id))
 
2204
        dir_trans_id = self._path2trans_id(dir_path)
 
2205
        dir_id = self._transform.final_file_id(dir_trans_id)
 
2206
        for child_trans_id in self._all_children(dir_trans_id):
 
2207
            ordered_ids.append((child_trans_id, dir_id))
 
2208
        path_entries = []
1949
2209
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1950
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
2210
            path_entries.append((self._final_paths.get_path(trans_id), entry))
 
2211
        path_entries.sort()
 
2212
        return path_entries
1951
2213
 
1952
2214
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1953
2215
        """See WorkingTree.list_files."""
1969
2231
        else:
1970
2232
            if from_dir is None and include_root is True:
1971
2233
                root_entry = inventory.make_entry('directory', '',
1972
 
                    ROOT_PARENT, self.get_root_id())
 
2234
                                                  ROOT_PARENT, self.get_root_id())
1973
2235
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1974
2236
            entries = self._iter_entries_for_dir(from_dir or '')
1975
2237
            for path, entry in entries:
1976
2238
                yield path, 'V', entry.kind, entry.file_id, entry
1977
2239
 
1978
 
    def kind(self, file_id):
1979
 
        trans_id = self._transform.trans_id_file_id(file_id)
 
2240
    def kind(self, path, file_id=None):
 
2241
        trans_id = self._path2trans_id(path)
 
2242
        if trans_id is None:
 
2243
            raise errors.NoSuchFile(path)
1980
2244
        return self._transform.final_kind(trans_id)
1981
2245
 
1982
 
    def stored_kind(self, file_id):
1983
 
        trans_id = self._transform.trans_id_file_id(file_id)
 
2246
    def stored_kind(self, path, file_id=None):
 
2247
        trans_id = self._path2trans_id(path)
 
2248
        if trans_id is None:
 
2249
            raise errors.NoSuchFile(path)
1984
2250
        try:
1985
2251
            return self._transform._new_contents[trans_id]
1986
2252
        except KeyError:
1987
 
            return self._transform._tree.stored_kind(file_id)
 
2253
            return self._transform._tree.stored_kind(path, file_id)
1988
2254
 
1989
 
    def get_file_mtime(self, file_id, path=None):
 
2255
    def get_file_mtime(self, path, file_id=None):
1990
2256
        """See Tree.get_file_mtime"""
 
2257
        if file_id is None:
 
2258
            file_id = self.path2id(path)
 
2259
        if file_id is None:
 
2260
            raise errors.NoSuchFile(path)
1991
2261
        if not self._content_change(file_id):
1992
 
            return self._transform._tree.get_file_mtime(file_id)
1993
 
        return self._stat_limbo_file(file_id).st_mtime
1994
 
 
1995
 
    def _file_size(self, entry, stat_value):
1996
 
        return self.get_file_size(entry.file_id)
1997
 
 
1998
 
    def get_file_size(self, file_id):
 
2262
            return self._transform._tree.get_file_mtime(
 
2263
                self._transform._tree.id2path(file_id), file_id)
 
2264
        trans_id = self._path2trans_id(path)
 
2265
        return self._stat_limbo_file(trans_id).st_mtime
 
2266
 
 
2267
    def get_file_size(self, path, file_id=None):
1999
2268
        """See Tree.get_file_size"""
2000
 
        if self.kind(file_id) == 'file':
2001
 
            return self._transform._tree.get_file_size(file_id)
 
2269
        trans_id = self._path2trans_id(path)
 
2270
        if trans_id is None:
 
2271
            raise errors.NoSuchFile(path)
 
2272
        kind = self._transform.final_kind(trans_id)
 
2273
        if kind != 'file':
 
2274
            return None
 
2275
        if trans_id in self._transform._new_contents:
 
2276
            return self._stat_limbo_file(trans_id).st_size
 
2277
        if self.kind(path, file_id) == 'file':
 
2278
            return self._transform._tree.get_file_size(path, file_id)
2002
2279
        else:
2003
2280
            return None
2004
2281
 
2005
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2006
 
        trans_id = self._transform.trans_id_file_id(file_id)
2007
 
        kind = self._transform._new_contents.get(trans_id)
2008
 
        if kind is None:
2009
 
            return self._transform._tree.get_file_sha1(file_id)
2010
 
        if kind == 'file':
2011
 
            fileobj = self.get_file(file_id)
2012
 
            try:
 
2282
    def get_file_verifier(self, path, file_id=None, stat_value=None):
 
2283
        trans_id = self._path2trans_id(path)
 
2284
        if trans_id is None:
 
2285
            raise errors.NoSuchFile(path)
 
2286
        kind = self._transform._new_contents.get(trans_id)
 
2287
        if kind is None:
 
2288
            return self._transform._tree.get_file_verifier(path, file_id)
 
2289
        if kind == 'file':
 
2290
            with self.get_file(path, file_id) as fileobj:
 
2291
                return ("SHA1", sha_file(fileobj))
 
2292
 
 
2293
    def get_file_sha1(self, path, file_id=None, stat_value=None):
 
2294
        trans_id = self._path2trans_id(path)
 
2295
        if trans_id is None:
 
2296
            raise errors.NoSuchFile(path)
 
2297
        kind = self._transform._new_contents.get(trans_id)
 
2298
        if kind is None:
 
2299
            return self._transform._tree.get_file_sha1(path, file_id)
 
2300
        if kind == 'file':
 
2301
            with self.get_file(path, file_id) as fileobj:
2013
2302
                return sha_file(fileobj)
2014
 
            finally:
2015
 
                fileobj.close()
2016
2303
 
2017
 
    def is_executable(self, file_id, path=None):
2018
 
        if file_id is None:
 
2304
    def is_executable(self, path, file_id=None):
 
2305
        trans_id = self._path2trans_id(path)
 
2306
        if trans_id is None:
2019
2307
            return False
2020
 
        trans_id = self._transform.trans_id_file_id(file_id)
2021
2308
        try:
2022
2309
            return self._transform._new_executability[trans_id]
2023
2310
        except KeyError:
2024
2311
            try:
2025
 
                return self._transform._tree.is_executable(file_id, path)
2026
 
            except OSError, e:
 
2312
                return self._transform._tree.is_executable(path, file_id)
 
2313
            except OSError as e:
2027
2314
                if e.errno == errno.ENOENT:
2028
2315
                    return False
2029
2316
                raise
2030
 
            except errors.NoSuchId:
 
2317
            except errors.NoSuchFile:
2031
2318
                return False
2032
2319
 
 
2320
    def has_filename(self, path):
 
2321
        trans_id = self._path2trans_id(path)
 
2322
        if trans_id in self._transform._new_contents:
 
2323
            return True
 
2324
        elif trans_id in self._transform._removed_contents:
 
2325
            return False
 
2326
        else:
 
2327
            return self._transform._tree.has_filename(path)
 
2328
 
2033
2329
    def path_content_summary(self, path):
2034
2330
        trans_id = self._path2trans_id(path)
2035
2331
        tt = self._transform
2048
2344
            if kind == 'file':
2049
2345
                statval = os.lstat(limbo_name)
2050
2346
                size = statval.st_size
2051
 
                if not supports_executable():
 
2347
                if not tt._limbo_supports_executable():
2052
2348
                    executable = False
2053
2349
                else:
2054
2350
                    executable = statval.st_mode & S_IEXEC
2056
2352
                size = None
2057
2353
                executable = None
2058
2354
            if kind == 'symlink':
2059
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
2355
                link_or_sha1 = os.readlink(limbo_name)
 
2356
                if not isinstance(link_or_sha1, text_type):
 
2357
                    link_or_sha1 = link_or_sha1.decode(osutils._fs_enc)
2060
2358
        executable = tt._new_executability.get(trans_id, executable)
2061
2359
        return kind, size, executable, link_or_sha1
2062
2360
 
2063
2361
    def iter_changes(self, from_tree, include_unchanged=False,
2064
 
                      specific_files=None, pb=None, extra_trees=None,
2065
 
                      require_versioned=True, want_unversioned=False):
 
2362
                     specific_files=None, pb=None, extra_trees=None,
 
2363
                     require_versioned=True, want_unversioned=False):
2066
2364
        """See InterTree.iter_changes.
2067
2365
 
2068
2366
        This has a fast path that is only used when the from_tree matches
2069
2367
        the transform tree, and no fancy options are supplied.
2070
2368
        """
2071
 
        if (from_tree is not self._transform._tree or include_unchanged or
2072
 
            specific_files or want_unversioned):
 
2369
        if (from_tree is not self._transform._tree or include_unchanged
 
2370
                or specific_files or want_unversioned):
2073
2371
            return tree.InterTree(from_tree, self).iter_changes(
2074
2372
                include_unchanged=include_unchanged,
2075
2373
                specific_files=specific_files,
2081
2379
            raise ValueError('want_unversioned is not supported')
2082
2380
        return self._transform.iter_changes()
2083
2381
 
2084
 
    def get_file(self, file_id, path=None):
 
2382
    def get_file(self, path, file_id=None):
2085
2383
        """See Tree.get_file"""
 
2384
        if file_id is None:
 
2385
            file_id = self.path2id(path)
2086
2386
        if not self._content_change(file_id):
2087
 
            return self._transform._tree.get_file(file_id, path)
2088
 
        trans_id = self._transform.trans_id_file_id(file_id)
 
2387
            return self._transform._tree.get_file(path, file_id)
 
2388
        trans_id = self._path2trans_id(path)
2089
2389
        name = self._transform._limbo_name(trans_id)
2090
2390
        return open(name, 'rb')
2091
2391
 
2092
 
    def get_file_with_stat(self, file_id, path=None):
2093
 
        return self.get_file(file_id, path), None
 
2392
    def get_file_with_stat(self, path, file_id=None):
 
2393
        return self.get_file(path, file_id), None
2094
2394
 
2095
 
    def annotate_iter(self, file_id,
 
2395
    def annotate_iter(self, path, file_id=None,
2096
2396
                      default_revision=_mod_revision.CURRENT_REVISION):
 
2397
        if file_id is None:
 
2398
            file_id = self.path2id(path)
2097
2399
        changes = self._iter_changes_cache.get(file_id)
2098
2400
        if changes is None:
2099
2401
            get_old = True
2104
2406
                return None
2105
2407
            get_old = (kind[0] == 'file' and versioned[0])
2106
2408
        if get_old:
2107
 
            old_annotation = self._transform._tree.annotate_iter(file_id,
2108
 
                default_revision=default_revision)
 
2409
            old_annotation = self._transform._tree.annotate_iter(
 
2410
                path, file_id=file_id, default_revision=default_revision)
2109
2411
        else:
2110
2412
            old_annotation = []
2111
2413
        if changes is None:
2120
2422
        #       It would be nice to be able to use the new Annotator based
2121
2423
        #       approach, as well.
2122
2424
        return annotate.reannotate([old_annotation],
2123
 
                                   self.get_file(file_id).readlines(),
 
2425
                                   self.get_file(path, file_id).readlines(),
2124
2426
                                   default_revision)
2125
2427
 
2126
 
    def get_symlink_target(self, file_id):
 
2428
    def get_symlink_target(self, path, file_id=None):
2127
2429
        """See Tree.get_symlink_target"""
 
2430
        if file_id is None:
 
2431
            file_id = self.path2id(path)
2128
2432
        if not self._content_change(file_id):
2129
 
            return self._transform._tree.get_symlink_target(file_id)
2130
 
        trans_id = self._transform.trans_id_file_id(file_id)
 
2433
            return self._transform._tree.get_symlink_target(path)
 
2434
        trans_id = self._path2trans_id(path)
2131
2435
        name = self._transform._limbo_name(trans_id)
2132
2436
        return osutils.readlink(name)
2133
2437
 
2144
2448
                path_from_root = self._final_paths.get_path(child_id)
2145
2449
                basename = self._transform.final_name(child_id)
2146
2450
                file_id = self._transform.final_file_id(child_id)
2147
 
                try:
2148
 
                    kind = self._transform.final_kind(child_id)
 
2451
                kind = self._transform.final_kind(child_id)
 
2452
                if kind is not None:
2149
2453
                    versioned_kind = kind
2150
 
                except NoSuchFile:
 
2454
                else:
2151
2455
                    kind = 'unknown'
2152
 
                    versioned_kind = self._transform._tree.stored_kind(file_id)
 
2456
                    versioned_kind = self._transform._tree.stored_kind(
 
2457
                        self._transform._tree.id2path(file_id),
 
2458
                        file_id)
2153
2459
                if versioned_kind == 'directory':
2154
2460
                    subdirs.append(child_id)
2155
2461
                children.append((path_from_root, basename, kind, None,
2184
2490
    The underlying tree must not be manipulated between calls, or else
2185
2491
    the results will likely be incorrect.
2186
2492
    """
 
2493
 
2187
2494
    def __init__(self, transform):
2188
2495
        object.__init__(self)
2189
2496
        self._known_paths = {}
2191
2498
 
2192
2499
    def _determine_path(self, trans_id):
2193
2500
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2194
 
            return ""
 
2501
            return u""
2195
2502
        name = self.transform.final_name(trans_id)
2196
2503
        parent_id = self.transform.final_parent(trans_id)
2197
2504
        if parent_id == self.transform.root:
2209
2516
        return [(self.get_path(t), t) for t in trans_ids]
2210
2517
 
2211
2518
 
2212
 
 
2213
2519
def topology_sorted_ids(tree):
2214
2520
    """Determine the topological order of the ids in a tree"""
2215
2521
    file_ids = list(tree)
2243
2549
    :param delta_from_tree: If true, build_tree may use the input Tree to
2244
2550
        generate the inventory delta.
2245
2551
    """
2246
 
    wt.lock_tree_write()
2247
 
    try:
2248
 
        tree.lock_read()
 
2552
    with wt.lock_tree_write(), tree.lock_read():
 
2553
        if accelerator_tree is not None:
 
2554
            accelerator_tree.lock_read()
2249
2555
        try:
 
2556
            return _build_tree(tree, wt, accelerator_tree, hardlink,
 
2557
                               delta_from_tree)
 
2558
        finally:
2250
2559
            if accelerator_tree is not None:
2251
 
                accelerator_tree.lock_read()
2252
 
            try:
2253
 
                return _build_tree(tree, wt, accelerator_tree, hardlink,
2254
 
                                   delta_from_tree)
2255
 
            finally:
2256
 
                if accelerator_tree is not None:
2257
 
                    accelerator_tree.unlock()
2258
 
        finally:
2259
 
            tree.unlock()
2260
 
    finally:
2261
 
        wt.unlock()
 
2560
                accelerator_tree.unlock()
2262
2561
 
2263
2562
 
2264
2563
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2265
2564
    """See build_tree."""
2266
 
    for num, _unused in enumerate(wt.all_file_ids()):
 
2565
    for num, _unused in enumerate(wt.all_versioned_paths()):
2267
2566
        if num > 0:  # more than just a root
2268
2567
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2269
 
    existing_files = set()
2270
 
    for dir, files in wt.walkdirs():
2271
 
        existing_files.update(f[0] for f in files)
2272
2568
    file_trans_id = {}
2273
 
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2569
    top_pb = ui.ui_factory.nested_progress_bar()
2274
2570
    pp = ProgressPhase("Build phase", 2, top_pb)
2275
 
    if tree.inventory.root is not None:
 
2571
    if tree.get_root_id() is not None:
2276
2572
        # This is kind of a hack: we should be altering the root
2277
2573
        # as part of the regular tree shape diff logic.
2278
2574
        # The conditional test here is to avoid doing an
2287
2583
    divert = set()
2288
2584
    try:
2289
2585
        pp.next_phase()
2290
 
        file_trans_id[wt.get_root_id()] = \
2291
 
            tt.trans_id_tree_file_id(wt.get_root_id())
2292
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2293
 
        try:
 
2586
        file_trans_id[wt.get_root_id()] = tt.trans_id_tree_path('')
 
2587
        with ui.ui_factory.nested_progress_bar() as pb:
2294
2588
            deferred_contents = []
2295
2589
            num = 0
2296
 
            total = len(tree.inventory)
 
2590
            total = len(tree.all_versioned_paths())
2297
2591
            if delta_from_tree:
2298
2592
                precomputed_delta = []
2299
2593
            else:
2300
2594
                precomputed_delta = None
 
2595
            # Check if tree inventory has content. If so, we populate
 
2596
            # existing_files with the directory content. If there are no
 
2597
            # entries we skip populating existing_files as its not used.
 
2598
            # This improves performance and unncessary work on large
 
2599
            # directory trees. (#501307)
 
2600
            if total > 0:
 
2601
                existing_files = set()
 
2602
                for dir, files in wt.walkdirs():
 
2603
                    existing_files.update(f[0] for f in files)
2301
2604
            for num, (tree_path, entry) in \
2302
 
                enumerate(tree.inventory.iter_entries_by_dir()):
2303
 
                pb.update("Building tree", num - len(deferred_contents), total)
 
2605
                    enumerate(tree.iter_entries_by_dir()):
 
2606
                pb.update(gettext("Building tree"), num
 
2607
                          - len(deferred_contents), total)
2304
2608
                if entry.parent_id is None:
2305
2609
                    continue
2306
2610
                reparent = False
2312
2616
                    kind = file_kind(target_path)
2313
2617
                    if kind == "directory":
2314
2618
                        try:
2315
 
                            bzrdir.BzrDir.open(target_path)
 
2619
                            controldir.ControlDir.open(target_path)
2316
2620
                        except errors.NotBranchError:
2317
2621
                            pass
2318
2622
                        else:
2319
2623
                            divert.add(file_id)
2320
 
                    if (file_id not in divert and
2321
 
                        _content_match(tree, entry, file_id, kind,
2322
 
                        target_path)):
 
2624
                    if (file_id not in divert
 
2625
                        and _content_match(tree, entry, tree_path, file_id, kind,
 
2626
                                       target_path)):
2323
2627
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2324
2628
                        if kind == 'directory':
2325
2629
                            reparent = True
2330
2634
                    trans_id = tt.create_path(entry.name, parent_id)
2331
2635
                    file_trans_id[file_id] = trans_id
2332
2636
                    tt.version_file(file_id, trans_id)
2333
 
                    executable = tree.is_executable(file_id, tree_path)
 
2637
                    executable = tree.is_executable(tree_path, file_id)
2334
2638
                    if executable:
2335
2639
                        tt.set_executability(executable, trans_id)
2336
 
                    trans_data = (trans_id, tree_path)
2337
 
                    deferred_contents.append((file_id, trans_data))
 
2640
                    trans_data = (trans_id, file_id,
 
2641
                                  tree_path, entry.text_sha1)
 
2642
                    deferred_contents.append((tree_path, trans_data))
2338
2643
                else:
2339
 
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2340
 
                                                          tree)
 
2644
                    file_trans_id[file_id] = new_by_entry(
 
2645
                        tree_path, tt, entry, parent_id, tree)
2341
2646
                if reparent:
2342
2647
                    new_trans_id = file_trans_id[file_id]
2343
2648
                    old_parent = tt.trans_id_tree_path(tree_path)
2345
2650
            offset = num + 1 - len(deferred_contents)
2346
2651
            _create_files(tt, tree, deferred_contents, pb, offset,
2347
2652
                          accelerator_tree, hardlink)
2348
 
        finally:
2349
 
            pb.finished()
2350
2653
        pp.next_phase()
2351
2654
        divert_trans = set(file_trans_id[f] for f in divert)
2352
 
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
 
2655
 
 
2656
        def resolver(t, c):
 
2657
            return resolve_checkout(t, c, divert_trans)
2353
2658
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2354
2659
        if len(raw_conflicts) > 0:
2355
2660
            precomputed_delta = None
2356
2661
        conflicts = cook_conflicts(raw_conflicts, tt)
2357
2662
        for conflict in conflicts:
2358
 
            warning(conflict)
 
2663
            trace.warning(text_type(conflict))
2359
2664
        try:
2360
2665
            wt.add_conflicts(conflicts)
2361
2666
        except errors.UnsupportedOperation:
2376
2681
        new_desired_files = desired_files
2377
2682
    else:
2378
2683
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2379
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
 
2684
        unchanged = [(p[0], p[1]) for (f, p, c, v, d, n, k, e)
2380
2685
                     in iter if not (c or e[0] != e[1])]
2381
2686
        if accelerator_tree.supports_content_filtering():
2382
 
            unchanged = [(f, p) for (f, p) in unchanged
2383
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
 
2687
            unchanged = [(tp, ap) for (tp, ap) in unchanged
 
2688
                         if not next(accelerator_tree.iter_search_rules([ap]))]
2384
2689
        unchanged = dict(unchanged)
2385
2690
        new_desired_files = []
2386
2691
        count = 0
2387
 
        for file_id, (trans_id, tree_path) in desired_files:
2388
 
            accelerator_path = unchanged.get(file_id)
 
2692
        for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
 
2693
            accelerator_path = unchanged.get(tree_path)
2389
2694
            if accelerator_path is None:
2390
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
2695
                new_desired_files.append((tree_path,
 
2696
                                          (trans_id, file_id, tree_path, text_sha1)))
2391
2697
                continue
2392
 
            pb.update('Adding file contents', count + offset, total)
 
2698
            pb.update(gettext('Adding file contents'), count + offset, total)
2393
2699
            if hardlink:
2394
2700
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2395
2701
                                   trans_id)
2396
2702
            else:
2397
 
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2398
 
                if wt.supports_content_filtering():
2399
 
                    filters = wt._content_filter_stack(tree_path)
2400
 
                    contents = filtered_output_bytes(contents, filters,
2401
 
                        ContentFilterContext(tree_path, tree))
2402
 
                try:
2403
 
                    tt.create_file(contents, trans_id)
2404
 
                finally:
2405
 
                    try:
2406
 
                        contents.close()
2407
 
                    except AttributeError:
2408
 
                        # after filtering, contents may no longer be file-like
2409
 
                        pass
 
2703
                with accelerator_tree.get_file(accelerator_path, file_id) as f:
 
2704
                    chunks = osutils.file_iterator(f)
 
2705
                    if wt.supports_content_filtering():
 
2706
                        filters = wt._content_filter_stack(tree_path)
 
2707
                        chunks = filtered_output_bytes(chunks, filters,
 
2708
                                                       ContentFilterContext(tree_path, tree))
 
2709
                    tt.create_file(chunks, trans_id, sha1=text_sha1)
2410
2710
            count += 1
2411
2711
        offset += count
2412
 
    for count, ((trans_id, tree_path), contents) in enumerate(
 
2712
    for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
2413
2713
            tree.iter_files_bytes(new_desired_files)):
2414
2714
        if wt.supports_content_filtering():
2415
2715
            filters = wt._content_filter_stack(tree_path)
2416
2716
            contents = filtered_output_bytes(contents, filters,
2417
 
                ContentFilterContext(tree_path, tree))
2418
 
        tt.create_file(contents, trans_id)
2419
 
        pb.update('Adding file contents', count + offset, total)
 
2717
                                             ContentFilterContext(tree_path, tree))
 
2718
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2719
        pb.update(gettext('Adding file contents'), count + offset, total)
2420
2720
 
2421
2721
 
2422
2722
def _reparent_children(tt, old_parent, new_parent):
2423
2723
    for child in tt.iter_tree_children(old_parent):
2424
2724
        tt.adjust_path(tt.final_name(child), new_parent, child)
2425
2725
 
 
2726
 
2426
2727
def _reparent_transform_children(tt, old_parent, new_parent):
2427
2728
    by_parent = tt.by_parent()
2428
2729
    for child in by_parent[old_parent]:
2429
2730
        tt.adjust_path(tt.final_name(child), new_parent, child)
2430
2731
    return by_parent[old_parent]
2431
2732
 
2432
 
def _content_match(tree, entry, file_id, kind, target_path):
 
2733
 
 
2734
def _content_match(tree, entry, tree_path, file_id, kind, target_path):
2433
2735
    if entry.kind != kind:
2434
2736
        return False
2435
2737
    if entry.kind == "directory":
2436
2738
        return True
2437
2739
    if entry.kind == "file":
2438
 
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2439
 
            return True
 
2740
        with open(target_path, 'rb') as f1, \
 
2741
                tree.get_file(tree_path, file_id) as f2:
 
2742
            if osutils.compare_files(f1, f2):
 
2743
                return True
2440
2744
    elif entry.kind == "symlink":
2441
 
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
 
2745
        if tree.get_symlink_target(tree_path, file_id) == os.readlink(target_path):
2442
2746
            return True
2443
2747
    return False
2444
2748
 
2461
2765
        # resolved
2462
2766
        final_parent = tt.final_parent(old_file)
2463
2767
        if new_file in divert:
2464
 
            new_name = tt.final_name(old_file)+'.diverted'
 
2768
            new_name = tt.final_name(old_file) + '.diverted'
2465
2769
            tt.adjust_path(new_name, final_parent, new_file)
2466
2770
            new_conflicts.add((c_type, 'Diverted to',
2467
2771
                               new_file, old_file))
2468
2772
        else:
2469
 
            new_name = tt.final_name(old_file)+'.moved'
 
2773
            new_name = tt.final_name(old_file) + '.moved'
2470
2774
            tt.adjust_path(new_name, final_parent, old_file)
2471
2775
            new_conflicts.add((c_type, 'Moved existing file to',
2472
2776
                               old_file, new_file))
2473
2777
    return new_conflicts
2474
2778
 
2475
2779
 
2476
 
def new_by_entry(tt, entry, parent_id, tree):
 
2780
def new_by_entry(path, tt, entry, parent_id, tree):
2477
2781
    """Create a new file according to its inventory entry"""
2478
2782
    name = entry.name
2479
2783
    kind = entry.kind
2480
2784
    if kind == 'file':
2481
 
        contents = tree.get_file(entry.file_id).readlines()
2482
 
        executable = tree.is_executable(entry.file_id)
2483
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
2484
 
                           executable)
 
2785
        with tree.get_file(path, entry.file_id) as f:
 
2786
            executable = tree.is_executable(path, entry.file_id)
 
2787
            return tt.new_file(
 
2788
                name, parent_id, osutils.file_iterator(f), entry.file_id,
 
2789
                executable)
2485
2790
    elif kind in ('directory', 'tree-reference'):
2486
2791
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2487
2792
        if kind == 'tree-reference':
2488
2793
            tt.set_tree_reference(entry.reference_revision, trans_id)
2489
2794
        return trans_id
2490
2795
    elif kind == 'symlink':
2491
 
        target = tree.get_symlink_target(entry.file_id)
 
2796
        target = tree.get_symlink_target(path, entry.file_id)
2492
2797
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2493
2798
    else:
2494
2799
        raise errors.BadFileKindError(name, kind)
2495
2800
 
2496
2801
 
2497
 
@deprecated_function(deprecated_in((1, 9, 0)))
2498
 
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2499
 
    """Create new file contents according to an inventory entry.
2500
 
 
2501
 
    DEPRECATED.  Use create_from_tree instead.
2502
 
    """
2503
 
    if entry.kind == "file":
2504
 
        if lines is None:
2505
 
            lines = tree.get_file(entry.file_id).readlines()
2506
 
        tt.create_file(lines, trans_id, mode_id=mode_id)
2507
 
    elif entry.kind == "symlink":
2508
 
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2509
 
    elif entry.kind == "directory":
2510
 
        tt.create_directory(trans_id)
2511
 
 
2512
 
 
2513
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2514
 
    filter_tree_path=None):
 
2802
def create_from_tree(tt, trans_id, tree, path, file_id=None, chunks=None,
 
2803
                     filter_tree_path=None):
2515
2804
    """Create new file contents according to tree contents.
2516
 
    
 
2805
 
2517
2806
    :param filter_tree_path: the tree path to use to lookup
2518
2807
      content filters to apply to the bytes output in the working tree.
2519
2808
      This only applies if the working tree supports content filtering.
2520
2809
    """
2521
 
    kind = tree.kind(file_id)
 
2810
    kind = tree.kind(path, file_id)
2522
2811
    if kind == 'directory':
2523
2812
        tt.create_directory(trans_id)
2524
2813
    elif kind == "file":
2525
 
        if bytes is None:
2526
 
            tree_file = tree.get_file(file_id)
2527
 
            try:
2528
 
                bytes = tree_file.readlines()
2529
 
            finally:
2530
 
                tree_file.close()
2531
 
        wt = tt._tree
2532
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2533
 
            filters = wt._content_filter_stack(filter_tree_path)
2534
 
            bytes = filtered_output_bytes(bytes, filters,
2535
 
                ContentFilterContext(filter_tree_path, tree))
2536
 
        tt.create_file(bytes, trans_id)
 
2814
        if chunks is None:
 
2815
            f = tree.get_file(path, file_id)
 
2816
            chunks = osutils.file_iterator(f)
 
2817
        else:
 
2818
            f = None
 
2819
        try:
 
2820
            wt = tt._tree
 
2821
            if wt.supports_content_filtering() and filter_tree_path is not None:
 
2822
                filters = wt._content_filter_stack(filter_tree_path)
 
2823
                chunks = filtered_output_bytes(
 
2824
                    chunks, filters,
 
2825
                    ContentFilterContext(filter_tree_path, tree))
 
2826
            tt.create_file(chunks, trans_id)
 
2827
        finally:
 
2828
            if f is not None:
 
2829
                f.close()
2537
2830
    elif kind == "symlink":
2538
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
 
2831
        tt.create_symlink(tree.get_symlink_target(path, file_id), trans_id)
2539
2832
    else:
2540
2833
        raise AssertionError('Unknown kind %r' % kind)
2541
2834
 
2546
2839
        tt.set_executability(entry.executable, trans_id)
2547
2840
 
2548
2841
 
2549
 
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2550
 
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2551
 
 
2552
 
 
2553
 
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2554
 
    """Produce a backup-style name that appears to be available"""
2555
 
    def name_gen():
2556
 
        counter = 1
2557
 
        while True:
2558
 
            yield "%s.~%d~" % (name, counter)
2559
 
            counter += 1
2560
 
    for new_name in name_gen():
2561
 
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2562
 
            return new_name
2563
 
 
2564
 
 
2565
 
def _entry_changes(file_id, entry, working_tree):
2566
 
    """Determine in which ways the inventory entry has changed.
2567
 
 
2568
 
    Returns booleans: has_contents, content_mod, meta_mod
2569
 
    has_contents means there are currently contents, but they differ
2570
 
    contents_mod means contents need to be modified
2571
 
    meta_mod means the metadata needs to be modified
2572
 
    """
2573
 
    cur_entry = working_tree.inventory[file_id]
2574
 
    try:
2575
 
        working_kind = working_tree.kind(file_id)
2576
 
        has_contents = True
2577
 
    except NoSuchFile:
2578
 
        has_contents = False
2579
 
        contents_mod = True
2580
 
        meta_mod = False
2581
 
    if has_contents is True:
2582
 
        if entry.kind != working_kind:
2583
 
            contents_mod, meta_mod = True, False
2584
 
        else:
2585
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
2586
 
                                       working_tree)
2587
 
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2588
 
            cur_entry._forget_tree_state()
2589
 
    return has_contents, contents_mod, meta_mod
2590
 
 
2591
 
 
2592
2842
def revert(working_tree, target_tree, filenames, backups=False,
2593
2843
           pb=None, change_reporter=None):
2594
2844
    """Revert a working tree's contents to those of a target tree."""
2595
 
    target_tree.lock_read()
2596
2845
    pb = ui.ui_factory.nested_progress_bar()
2597
 
    tt = TreeTransform(working_tree, pb)
2598
2846
    try:
2599
 
        pp = ProgressPhase("Revert phase", 3, pb)
2600
 
        conflicts, merge_modified = _prepare_revert_transform(
2601
 
            working_tree, target_tree, tt, filenames, backups, pp)
2602
 
        if change_reporter:
2603
 
            change_reporter = delta._ChangeReporter(
2604
 
                unversioned_filter=working_tree.is_ignored)
2605
 
            delta.report_changes(tt.iter_changes(), change_reporter)
2606
 
        for conflict in conflicts:
2607
 
            warning(conflict)
2608
 
        pp.next_phase()
2609
 
        tt.apply()
2610
 
        working_tree.set_merge_modified(merge_modified)
 
2847
        with target_tree.lock_read(), TreeTransform(working_tree, pb) as tt:
 
2848
            pp = ProgressPhase("Revert phase", 3, pb)
 
2849
            conflicts, merge_modified = _prepare_revert_transform(
 
2850
                working_tree, target_tree, tt, filenames, backups, pp)
 
2851
            if change_reporter:
 
2852
                change_reporter = delta._ChangeReporter(
 
2853
                    unversioned_filter=working_tree.is_ignored)
 
2854
                delta.report_changes(tt.iter_changes(), change_reporter)
 
2855
            for conflict in conflicts:
 
2856
                trace.warning(text_type(conflict))
 
2857
            pp.next_phase()
 
2858
            tt.apply()
 
2859
            if working_tree.supports_merge_modified():
 
2860
                working_tree.set_merge_modified(merge_modified)
2611
2861
    finally:
2612
 
        target_tree.unlock()
2613
 
        tt.finalize()
2614
2862
        pb.clear()
2615
2863
    return conflicts
2616
2864
 
2618
2866
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2619
2867
                              backups, pp, basis_tree=None,
2620
2868
                              merge_modified=None):
2621
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2622
 
    try:
 
2869
    with ui.ui_factory.nested_progress_bar() as child_pb:
2623
2870
        if merge_modified is None:
2624
2871
            merge_modified = working_tree.merge_modified()
2625
2872
        merge_modified = _alter_files(working_tree, target_tree, tt,
2626
2873
                                      child_pb, filenames, backups,
2627
2874
                                      merge_modified, basis_tree)
2628
 
    finally:
2629
 
        child_pb.finished()
2630
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2631
 
    try:
2632
 
        raw_conflicts = resolve_conflicts(tt, child_pb,
2633
 
            lambda t, c: conflict_pass(t, c, target_tree))
2634
 
    finally:
2635
 
        child_pb.finished()
 
2875
    with ui.ui_factory.nested_progress_bar() as child_pb:
 
2876
        raw_conflicts = resolve_conflicts(
 
2877
            tt, child_pb, lambda t, c: conflict_pass(t, c, target_tree))
2636
2878
    conflicts = cook_conflicts(raw_conflicts, tt)
2637
2879
    return conflicts, merge_modified
2638
2880
 
2641
2883
                 backups, merge_modified, basis_tree=None):
2642
2884
    if basis_tree is not None:
2643
2885
        basis_tree.lock_read()
2644
 
    change_list = target_tree.iter_changes(working_tree,
2645
 
        specific_files=specific_files, pb=pb)
2646
 
    if target_tree.get_root_id() is None:
 
2886
    # We ask the working_tree for its changes relative to the target, rather
 
2887
    # than the target changes relative to the working tree. Because WT4 has an
 
2888
    # optimizer to compare itself to a target, but no optimizer for the
 
2889
    # reverse.
 
2890
    change_list = working_tree.iter_changes(
 
2891
        target_tree, specific_files=specific_files, pb=pb)
 
2892
    if not target_tree.is_versioned(u''):
2647
2893
        skip_root = True
2648
2894
    else:
2649
2895
        skip_root = False
2650
2896
    try:
2651
2897
        deferred_files = []
2652
2898
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2653
 
                kind, executable) in enumerate(change_list):
2654
 
            if skip_root and file_id[0] is not None and parent[0] is None:
 
2899
                     kind, executable) in enumerate(change_list):
 
2900
            target_path, wt_path = path
 
2901
            target_versioned, wt_versioned = versioned
 
2902
            target_parent, wt_parent = parent
 
2903
            target_name, wt_name = name
 
2904
            target_kind, wt_kind = kind
 
2905
            target_executable, wt_executable = executable
 
2906
            if skip_root and wt_parent is None:
2655
2907
                continue
2656
2908
            trans_id = tt.trans_id_file_id(file_id)
2657
2909
            mode_id = None
2658
2910
            if changed_content:
2659
2911
                keep_content = False
2660
 
                if kind[0] == 'file' and (backups or kind[1] is None):
2661
 
                    wt_sha1 = working_tree.get_file_sha1(file_id)
 
2912
                if wt_kind == 'file' and (backups or target_kind is None):
 
2913
                    wt_sha1 = working_tree.get_file_sha1(wt_path, file_id)
2662
2914
                    if merge_modified.get(file_id) != wt_sha1:
2663
2915
                        # acquire the basis tree lazily to prevent the
2664
2916
                        # expense of accessing it when it's not needed ?
2666
2918
                        if basis_tree is None:
2667
2919
                            basis_tree = working_tree.basis_tree()
2668
2920
                            basis_tree.lock_read()
2669
 
                        if file_id in basis_tree:
2670
 
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2671
 
                                keep_content = True
2672
 
                        elif kind[1] is None and not versioned[1]:
2673
 
                            keep_content = True
2674
 
                if kind[0] is not None:
 
2921
                        basis_path = find_previous_path(
 
2922
                            working_tree, basis_tree, wt_path)
 
2923
                        if basis_path is None:
 
2924
                            if target_kind is None and not target_versioned:
 
2925
                                keep_content = True
 
2926
                        else:
 
2927
                            if wt_sha1 != basis_tree.get_file_sha1(basis_path, file_id):
 
2928
                                keep_content = True
 
2929
                if wt_kind is not None:
2675
2930
                    if not keep_content:
2676
2931
                        tt.delete_contents(trans_id)
2677
 
                    elif kind[1] is not None:
2678
 
                        parent_trans_id = tt.trans_id_file_id(parent[0])
2679
 
                        by_parent = tt.by_parent()
2680
 
                        backup_name = _get_backup_name(name[0], by_parent,
2681
 
                                                       parent_trans_id, tt)
 
2932
                    elif target_kind is not None:
 
2933
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
 
2934
                        backup_name = tt._available_backup_name(
 
2935
                            wt_name, parent_trans_id)
2682
2936
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2683
 
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
2684
 
                        if versioned == (True, True):
 
2937
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
 
2938
                        if wt_versioned and target_versioned:
2685
2939
                            tt.unversion_file(trans_id)
2686
2940
                            tt.version_file(file_id, new_trans_id)
2687
2941
                        # New contents should have the same unix perms as old
2688
2942
                        # contents
2689
2943
                        mode_id = trans_id
2690
2944
                        trans_id = new_trans_id
2691
 
                if kind[1] in ('directory', 'tree-reference'):
 
2945
                if target_kind in ('directory', 'tree-reference'):
2692
2946
                    tt.create_directory(trans_id)
2693
 
                    if kind[1] == 'tree-reference':
2694
 
                        revision = target_tree.get_reference_revision(file_id,
2695
 
                                                                      path[1])
 
2947
                    if target_kind == 'tree-reference':
 
2948
                        revision = target_tree.get_reference_revision(
 
2949
                            target_path, file_id)
2696
2950
                        tt.set_tree_reference(revision, trans_id)
2697
 
                elif kind[1] == 'symlink':
2698
 
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2699
 
                                      trans_id)
2700
 
                elif kind[1] == 'file':
2701
 
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
2951
                elif target_kind == 'symlink':
 
2952
                    tt.create_symlink(target_tree.get_symlink_target(
 
2953
                        target_path, file_id), trans_id)
 
2954
                elif target_kind == 'file':
 
2955
                    deferred_files.append(
 
2956
                        (target_path, (trans_id, mode_id, file_id)))
2702
2957
                    if basis_tree is None:
2703
2958
                        basis_tree = working_tree.basis_tree()
2704
2959
                        basis_tree.lock_read()
2705
 
                    new_sha1 = target_tree.get_file_sha1(file_id)
2706
 
                    if (file_id in basis_tree and new_sha1 ==
2707
 
                        basis_tree.get_file_sha1(file_id)):
 
2960
                    new_sha1 = target_tree.get_file_sha1(target_path, file_id)
 
2961
                    basis_path = find_previous_path(
 
2962
                        target_tree, basis_tree, target_path)
 
2963
                    if (basis_path is not None
 
2964
                            and new_sha1 == basis_tree.get_file_sha1(basis_path, file_id)):
2708
2965
                        if file_id in merge_modified:
2709
2966
                            del merge_modified[file_id]
2710
2967
                    else:
2711
2968
                        merge_modified[file_id] = new_sha1
2712
2969
 
2713
2970
                    # preserve the execute bit when backing up
2714
 
                    if keep_content and executable[0] == executable[1]:
2715
 
                        tt.set_executability(executable[1], trans_id)
2716
 
                elif kind[1] is not None:
2717
 
                    raise AssertionError(kind[1])
2718
 
            if versioned == (False, True):
 
2971
                    if keep_content and wt_executable == target_executable:
 
2972
                        tt.set_executability(target_executable, trans_id)
 
2973
                elif target_kind is not None:
 
2974
                    raise AssertionError(target_kind)
 
2975
            if not wt_versioned and target_versioned:
2719
2976
                tt.version_file(file_id, trans_id)
2720
 
            if versioned == (True, False):
 
2977
            if wt_versioned and not target_versioned:
2721
2978
                tt.unversion_file(trans_id)
2722
 
            if (name[1] is not None and
2723
 
                (name[0] != name[1] or parent[0] != parent[1])):
2724
 
                if name[1] == '' and parent[1] is None:
 
2979
            if (target_name is not None
 
2980
                    and (wt_name != target_name or wt_parent != target_parent)):
 
2981
                if target_name == '' and target_parent is None:
2725
2982
                    parent_trans = ROOT_PARENT
2726
2983
                else:
2727
 
                    parent_trans = tt.trans_id_file_id(parent[1])
2728
 
                if parent[0] is None and versioned[0]:
2729
 
                    tt.adjust_root_path(name[1], parent_trans)
 
2984
                    parent_trans = tt.trans_id_file_id(target_parent)
 
2985
                if wt_parent is None and wt_versioned:
 
2986
                    tt.adjust_root_path(target_name, parent_trans)
2730
2987
                else:
2731
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
2732
 
            if executable[0] != executable[1] and kind[1] == "file":
2733
 
                tt.set_executability(executable[1], trans_id)
 
2988
                    tt.adjust_path(target_name, parent_trans, trans_id)
 
2989
            if wt_executable != target_executable and target_kind == "file":
 
2990
                tt.set_executability(target_executable, trans_id)
2734
2991
        if working_tree.supports_content_filtering():
2735
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2736
 
                target_tree.iter_files_bytes(deferred_files)):
2737
 
                file_id = deferred_files[index][0]
 
2992
            for (trans_id, mode_id, file_id), bytes in (
 
2993
                    target_tree.iter_files_bytes(deferred_files)):
2738
2994
                # We're reverting a tree to the target tree so using the
2739
2995
                # target tree to find the file path seems the best choice
2740
2996
                # here IMO - Ian C 27/Oct/2009
2741
2997
                filter_tree_path = target_tree.id2path(file_id)
2742
2998
                filters = working_tree._content_filter_stack(filter_tree_path)
2743
 
                bytes = filtered_output_bytes(bytes, filters,
 
2999
                bytes = filtered_output_bytes(
 
3000
                    bytes, filters,
2744
3001
                    ContentFilterContext(filter_tree_path, working_tree))
2745
3002
                tt.create_file(bytes, trans_id, mode_id)
2746
3003
        else:
2747
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2748
 
                deferred_files):
 
3004
            for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
 
3005
                    deferred_files):
2749
3006
                tt.create_file(bytes, trans_id, mode_id)
2750
3007
        tt.fixup_new_roots()
2751
3008
    finally:
2759
3016
    if pass_func is None:
2760
3017
        pass_func = conflict_pass
2761
3018
    new_conflicts = set()
2762
 
    pb = ui.ui_factory.nested_progress_bar()
2763
 
    try:
 
3019
    with ui.ui_factory.nested_progress_bar() as pb:
2764
3020
        for n in range(10):
2765
 
            pb.update('Resolution pass', n+1, 10)
 
3021
            pb.update(gettext('Resolution pass'), n + 1, 10)
2766
3022
            conflicts = tt.find_conflicts()
2767
3023
            if len(conflicts) == 0:
2768
3024
                return new_conflicts
2769
3025
            new_conflicts.update(pass_func(tt, conflicts))
2770
3026
        raise MalformedTransform(conflicts=conflicts)
2771
 
    finally:
2772
 
        pb.finished()
2773
3027
 
2774
3028
 
2775
3029
def conflict_pass(tt, conflicts, path_tree=None):
2792
3046
                existing_file, new_file = conflict[2], conflict[1]
2793
3047
            else:
2794
3048
                existing_file, new_file = conflict[1], conflict[2]
2795
 
            new_name = tt.final_name(existing_file)+'.moved'
 
3049
            new_name = tt.final_name(existing_file) + '.moved'
2796
3050
            tt.adjust_path(new_name, final_parent, existing_file)
2797
3051
            new_conflicts.add((c_type, 'Moved existing file to',
2798
3052
                               existing_file, new_file))
2807
3061
 
2808
3062
        elif c_type == 'missing parent':
2809
3063
            trans_id = conflict[1]
2810
 
            try:
2811
 
                tt.cancel_deletion(trans_id)
2812
 
                new_conflicts.add(('deleting parent', 'Not deleting',
2813
 
                                   trans_id))
2814
 
            except KeyError:
 
3064
            if trans_id in tt._removed_contents:
 
3065
                cancel_deletion = True
 
3066
                orphans = tt._get_potential_orphans(trans_id)
 
3067
                if orphans:
 
3068
                    cancel_deletion = False
 
3069
                    # All children are orphans
 
3070
                    for o in orphans:
 
3071
                        try:
 
3072
                            tt.new_orphan(o, trans_id)
 
3073
                        except OrphaningError:
 
3074
                            # Something bad happened so we cancel the directory
 
3075
                            # deletion which will leave it in place with a
 
3076
                            # conflict. The user can deal with it from there.
 
3077
                            # Note that this also catch the case where we don't
 
3078
                            # want to create orphans and leave the directory in
 
3079
                            # place.
 
3080
                            cancel_deletion = True
 
3081
                            break
 
3082
                if cancel_deletion:
 
3083
                    # Cancel the directory deletion
 
3084
                    tt.cancel_deletion(trans_id)
 
3085
                    new_conflicts.add(('deleting parent', 'Not deleting',
 
3086
                                       trans_id))
 
3087
            else:
2815
3088
                create = True
2816
3089
                try:
2817
3090
                    tt.final_name(trans_id)
2820
3093
                        file_id = tt.final_file_id(trans_id)
2821
3094
                        if file_id is None:
2822
3095
                            file_id = tt.inactive_file_id(trans_id)
2823
 
                        entry = path_tree.inventory[file_id]
 
3096
                        _, entry = next(path_tree.iter_entries_by_dir(
 
3097
                            specific_files=[path_tree.id2path(file_id)]))
2824
3098
                        # special-case the other tree root (move its
2825
3099
                        # children to current root)
2826
3100
                        if entry.parent_id is None:
2841
3115
        elif c_type == 'unversioned parent':
2842
3116
            file_id = tt.inactive_file_id(conflict[1])
2843
3117
            # special-case the other tree root (move its children instead)
2844
 
            if path_tree and file_id in path_tree:
2845
 
                if path_tree.inventory[file_id].parent_id is None:
2846
 
                    continue
 
3118
            if path_tree and path_tree.path2id('') == file_id:
 
3119
                    # This is the root entry, skip it
 
3120
                continue
2847
3121
            tt.version_file(file_id, conflict[1])
2848
3122
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2849
3123
        elif c_type == 'non-directory parent':
2852
3126
            parent_name = tt.final_name(parent_id)
2853
3127
            parent_file_id = tt.final_file_id(parent_id)
2854
3128
            new_parent_id = tt.new_directory(parent_name + '.new',
2855
 
                parent_parent, parent_file_id)
 
3129
                                             parent_parent, parent_file_id)
2856
3130
            _reparent_transform_children(tt, parent_id, new_parent_id)
2857
3131
            if parent_file_id is not None:
2858
3132
                tt.unversion_file(parent_id)
2864
3138
 
2865
3139
def cook_conflicts(raw_conflicts, tt):
2866
3140
    """Generate a list of cooked conflicts, sorted by file path"""
2867
 
    from bzrlib.conflicts import Conflict
2868
3141
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2869
 
    return sorted(conflict_iter, key=Conflict.sort_key)
 
3142
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
2870
3143
 
2871
3144
 
2872
3145
def iter_cook_conflicts(raw_conflicts, tt):
2873
 
    from bzrlib.conflicts import Conflict
2874
3146
    fp = FinalPaths(tt)
2875
3147
    for conflict in raw_conflicts:
2876
3148
        c_type = conflict[0]
2878
3150
        modified_path = fp.get_path(conflict[2])
2879
3151
        modified_id = tt.final_file_id(conflict[2])
2880
3152
        if len(conflict) == 3:
2881
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
2882
 
                                     file_id=modified_id)
 
3153
            yield conflicts.Conflict.factory(
 
3154
                c_type, action=action, path=modified_path, file_id=modified_id)
2883
3155
 
2884
3156
        else:
2885
3157
            conflicting_path = fp.get_path(conflict[3])
2886
3158
            conflicting_id = tt.final_file_id(conflict[3])
2887
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
2888
 
                                   file_id=modified_id,
2889
 
                                   conflict_path=conflicting_path,
2890
 
                                   conflict_file_id=conflicting_id)
 
3159
            yield conflicts.Conflict.factory(
 
3160
                c_type, action=action, path=modified_path,
 
3161
                file_id=modified_id,
 
3162
                conflict_path=conflicting_path,
 
3163
                conflict_file_id=conflicting_id)
2891
3164
 
2892
3165
 
2893
3166
class _FileMover(object):
2900
3173
    def rename(self, from_, to):
2901
3174
        """Rename a file from one path to another."""
2902
3175
        try:
2903
 
            osutils.rename(from_, to)
2904
 
        except OSError, e:
 
3176
            os.rename(from_, to)
 
3177
        except OSError as e:
2905
3178
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2906
3179
                raise errors.FileExists(to, str(e))
2907
 
            raise
 
3180
            # normal OSError doesn't include filenames so it's hard to see where
 
3181
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
 
3182
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
2908
3183
        self.past_renames.append((from_, to))
2909
3184
 
2910
3185
    def pre_delete(self, from_, to):
2920
3195
    def rollback(self):
2921
3196
        """Reverse all renames that have been performed"""
2922
3197
        for from_, to in reversed(self.past_renames):
2923
 
            osutils.rename(to, from_)
 
3198
            try:
 
3199
                os.rename(to, from_)
 
3200
            except OSError as e:
 
3201
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
2924
3202
        # after rollback, don't reuse _FileMover
2925
 
        past_renames = None
2926
 
        pending_deletions = None
 
3203
        self.past_renames = None
 
3204
        self.pending_deletions = None
2927
3205
 
2928
3206
    def apply_deletions(self):
2929
3207
        """Apply all marked deletions"""
2930
3208
        for path in self.pending_deletions:
2931
3209
            delete_any(path)
2932
3210
        # after apply_deletions, don't reuse _FileMover
2933
 
        past_renames = None
2934
 
        pending_deletions = None
 
3211
        self.past_renames = None
 
3212
        self.pending_deletions = None
 
3213
 
 
3214
 
 
3215
def link_tree(target_tree, source_tree):
 
3216
    """Where possible, hard-link files in a tree to those in another tree.
 
3217
 
 
3218
    :param target_tree: Tree to change
 
3219
    :param source_tree: Tree to hard-link from
 
3220
    """
 
3221
    tt = TreeTransform(target_tree)
 
3222
    try:
 
3223
        for (file_id, paths, changed_content, versioned, parent, name, kind,
 
3224
             executable) in target_tree.iter_changes(source_tree,
 
3225
                                                     include_unchanged=True):
 
3226
            if changed_content:
 
3227
                continue
 
3228
            if kind != ('file', 'file'):
 
3229
                continue
 
3230
            if executable[0] != executable[1]:
 
3231
                continue
 
3232
            trans_id = tt.trans_id_tree_path(paths[1])
 
3233
            tt.delete_contents(trans_id)
 
3234
            tt.create_hardlink(source_tree.abspath(paths[0]), trans_id)
 
3235
        tt.apply()
 
3236
    finally:
 
3237
        tt.finalize()