/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-11 04:08:32 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-20181111040832-nsljjynzzwmznf3h
Run autopep8.

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
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
 
429
        # Now add all their children to the set.
 
430
        for parent_trans_id in new_file_id:
 
431
            changed_ids.update(self.iter_tree_children(parent_trans_id))
 
432
        return sorted(FinalPaths(self).get_paths(changed_ids))
395
433
 
396
434
    def final_kind(self, trans_id):
397
435
        """Determine the final file kind, after any changes applied.
398
436
 
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)
 
437
        :return: None if the file does not exist/has no contents.  (It is
 
438
            conceivable that a path would be created without the corresponding
 
439
            contents insertion command)
402
440
        """
403
441
        if trans_id in self._new_contents:
404
442
            return self._new_contents[trans_id]
405
443
        elif trans_id in self._removed_contents:
406
 
            raise NoSuchFile(None)
 
444
            return None
407
445
        else:
408
446
            return self.tree_kind(trans_id)
409
447
 
 
448
    def tree_path(self, trans_id):
 
449
        """Determine the tree path associated with the trans_id."""
 
450
        return self._tree_id_paths.get(trans_id)
 
451
 
410
452
    def tree_file_id(self, trans_id):
411
453
        """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
 
454
        path = self.tree_path(trans_id)
 
455
        if path is None:
416
456
            return None
417
457
        # the file is old; the old id is still valid
418
458
        if self._new_root == trans_id:
440
480
        file_id = self.tree_file_id(trans_id)
441
481
        if file_id is not None:
442
482
            return file_id
443
 
        for key, value in self._non_present_ids.iteritems():
 
483
        for key, value in viewitems(self._non_present_ids):
444
484
            if value == trans_id:
445
485
                return key
446
486
 
470
510
        Only new paths and parents of tree files with assigned ids are used.
471
511
        """
472
512
        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())
 
513
        items = list(viewitems(self._new_parent))
 
514
        items.extend((t, self.final_parent(t))
 
515
                     for t in list(self._tree_id_paths))
476
516
        for trans_id, parent_id in items:
477
517
            if parent_id not in by_parent:
478
518
                by_parent[parent_id] = set()
516
556
        Active parents are those which gain children, and those which are
517
557
        removed.  This is a necessary first step in detecting conflicts.
518
558
        """
519
 
        parents = self.by_parent().keys()
 
559
        parents = list(self.by_parent())
520
560
        parents.extend([t for t in self._removed_contents if
521
561
                        self.tree_kind(t) == 'directory'])
522
562
        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':
 
563
            path = self.tree_path(trans_id)
 
564
            if path is not None:
 
565
                if self._tree.stored_kind(path) == 'directory':
526
566
                    parents.append(trans_id)
527
567
            elif self.tree_kind(trans_id) == 'directory':
528
568
                parents.append(trans_id)
531
571
            # ensure that all children are registered with the transaction
532
572
            list(self.iter_tree_children(parent_id))
533
573
 
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:
 
574
    def _has_named_child(self, name, parent_id, known_children):
 
575
        """Does a parent already have a name child.
 
576
 
 
577
        :param name: The searched for name.
 
578
 
 
579
        :param parent_id: The parent for which the check is made.
 
580
 
 
581
        :param known_children: The already known children. This should have
 
582
            been recently obtained from `self.by_parent.get(parent_id)`
 
583
            (or will be if None is passed).
 
584
        """
 
585
        if known_children is None:
 
586
            known_children = self.by_parent().get(parent_id, [])
 
587
        for child in known_children:
540
588
            if self.final_name(child) == name:
541
589
                return True
542
 
        try:
543
 
            path = self._tree_id_paths[parent_id]
544
 
        except KeyError:
 
590
        parent_path = self._tree_id_paths.get(parent_id, None)
 
591
        if parent_path is None:
 
592
            # No parent... no children
545
593
            return False
546
 
        childpath = joinpath(path, name)
547
 
        child_id = self._tree_path_ids.get(childpath)
 
594
        child_path = joinpath(parent_path, name)
 
595
        child_id = self._tree_path_ids.get(child_path, None)
548
596
        if child_id is None:
549
 
            return lexists(self._tree.abspath(childpath))
 
597
            # Not known by the tree transform yet, check the filesystem
 
598
            return osutils.lexists(self._tree.abspath(child_path))
550
599
        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
 
600
            raise AssertionError('child_id is missing: %s, %s, %s'
 
601
                                 % (name, parent_id, child_id))
 
602
 
 
603
    def _available_backup_name(self, name, target_id):
 
604
        """Find an available backup name.
 
605
 
 
606
        :param name: The basename of the file.
 
607
 
 
608
        :param target_id: The directory trans_id where the backup should 
 
609
            be placed.
 
610
        """
 
611
        known_children = self.by_parent().get(target_id, [])
 
612
        return osutils.available_backup_name(
 
613
            name,
 
614
            lambda base: self._has_named_child(
 
615
                base, target_id, known_children))
558
616
 
559
617
    def _parent_loops(self):
560
618
        """No entry should be its own ancestor"""
562
620
        for trans_id in self._new_parent:
563
621
            seen = set()
564
622
            parent_id = trans_id
565
 
            while parent_id is not ROOT_PARENT:
 
623
            while parent_id != ROOT_PARENT:
566
624
                seen.add(parent_id)
567
625
                try:
568
626
                    parent_id = self.final_parent(parent_id)
577
635
    def _unversioned_parents(self, by_parent):
578
636
        """If parent directories are versioned, children must be versioned."""
579
637
        conflicts = []
580
 
        for parent_id, children in by_parent.iteritems():
581
 
            if parent_id is ROOT_PARENT:
 
638
        for parent_id, children in viewitems(by_parent):
 
639
            if parent_id == ROOT_PARENT:
582
640
                continue
583
641
            if self.final_file_id(parent_id) is not None:
584
642
                continue
585
643
            for child_id in children:
586
644
                if self.final_file_id(child_id) is not None:
587
645
                    conflicts.append(('unversioned parent', parent_id))
588
 
                    break;
 
646
                    break
589
647
        return conflicts
590
648
 
591
649
    def _improper_versioning(self):
594
652
        However, existing entries with no contents are okay.
595
653
        """
596
654
        conflicts = []
597
 
        for trans_id in self._new_id.iterkeys():
598
 
            try:
599
 
                kind = self.final_kind(trans_id)
600
 
            except NoSuchFile:
 
655
        for trans_id in self._new_id:
 
656
            kind = self.final_kind(trans_id)
 
657
            if kind is None:
601
658
                conflicts.append(('versioning no contents', trans_id))
602
659
                continue
603
 
            if not InventoryEntry.versionable_kind(kind):
 
660
            if not self._tree.versionable_kind(kind):
604
661
                conflicts.append(('versioning bad kind', trans_id, kind))
605
662
        return conflicts
606
663
 
617
674
            if self.final_file_id(trans_id) is None:
618
675
                conflicts.append(('unversioned executability', trans_id))
619
676
            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:
 
677
                if self.final_kind(trans_id) != "file":
625
678
                    conflicts.append(('non-file executability', trans_id))
626
679
        return conflicts
627
680
 
629
682
        """Check for overwrites (not permitted on Win32)"""
630
683
        conflicts = []
631
684
        for trans_id in self._new_contents:
632
 
            try:
633
 
                self.tree_kind(trans_id)
634
 
            except NoSuchFile:
 
685
            if self.tree_kind(trans_id) is None:
635
686
                continue
636
687
            if trans_id not in self._removed_contents:
637
688
                conflicts.append(('overwrite', trans_id,
638
 
                                 self.final_name(trans_id)))
 
689
                                  self.final_name(trans_id)))
639
690
        return conflicts
640
691
 
641
692
    def _duplicate_entries(self, by_parent):
643
694
        conflicts = []
644
695
        if (self._new_name, self._new_parent) == ({}, {}):
645
696
            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]
 
697
        for children in viewvalues(by_parent):
 
698
            name_ids = []
 
699
            for child_tid in children:
 
700
                name = self.final_name(child_tid)
 
701
                if name is not None:
 
702
                    # Keep children only if they still exist in the end
 
703
                    if not self._case_sensitive_target:
 
704
                        name = name.lower()
 
705
                    name_ids.append((name, child_tid))
650
706
            name_ids.sort()
651
707
            last_name = None
652
708
            last_trans_id = None
653
709
            for name, trans_id in name_ids:
654
 
                try:
655
 
                    kind = self.final_kind(trans_id)
656
 
                except NoSuchFile:
657
 
                    kind = None
 
710
                kind = self.final_kind(trans_id)
658
711
                file_id = self.final_file_id(trans_id)
659
712
                if kind is None and file_id is None:
660
713
                    continue
661
714
                if name == last_name:
662
715
                    conflicts.append(('duplicate', last_trans_id, trans_id,
663
 
                    name))
 
716
                                      name))
664
717
                last_name = name
665
718
                last_trans_id = trans_id
666
719
        return conflicts
672
725
                                self._removed_id))
673
726
        all_ids = self._tree.all_file_ids()
674
727
        active_tree_ids = all_ids.difference(removed_tree_ids)
675
 
        for trans_id, file_id in self._new_id.iteritems():
 
728
        for trans_id, file_id in viewitems(self._new_id):
676
729
            if file_id in active_tree_ids:
677
 
                old_trans_id = self.trans_id_tree_file_id(file_id)
 
730
                path = self._tree.id2path(file_id)
 
731
                old_trans_id = self.trans_id_tree_path(path)
678
732
                conflicts.append(('duplicate id', old_trans_id, trans_id))
679
733
        return conflicts
680
734
 
681
735
    def _parent_type_conflicts(self, by_parent):
682
 
        """parents must have directory 'contents'."""
 
736
        """Children must have a directory parent"""
683
737
        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
 
738
        for parent_id, children in viewitems(by_parent):
 
739
            if parent_id == ROOT_PARENT:
 
740
                continue
 
741
            no_children = True
 
742
            for child_id in children:
 
743
                if self.final_kind(child_id) is not None:
 
744
                    no_children = False
 
745
                    break
 
746
            if no_children:
 
747
                continue
 
748
            # There is at least a child, so we need an existing directory to
 
749
            # contain it.
 
750
            kind = self.final_kind(parent_id)
698
751
            if kind is None:
 
752
                # The directory will be deleted
699
753
                conflicts.append(('missing parent', parent_id))
700
754
            elif kind != "directory":
 
755
                # Meh, we need a *directory* to put something in it
701
756
                conflicts.append(('non-directory parent', parent_id))
702
757
        return conflicts
703
758
 
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
759
    def _set_executability(self, path, trans_id):
715
760
        """Set the executability of versioned files """
716
 
        if supports_executable():
 
761
        if self._tree._supports_executable():
717
762
            new_executability = self._new_executability[trans_id]
718
763
            abspath = self._tree.abspath(path)
719
764
            current_mode = os.stat(abspath).st_mode
720
765
            if new_executability:
721
766
                umask = os.umask(0)
722
767
                os.umask(umask)
723
 
                to_mode = current_mode | (0100 & ~umask)
 
768
                to_mode = current_mode | (0o100 & ~umask)
724
769
                # 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
 
770
                if current_mode & 0o004:
 
771
                    to_mode |= 0o001 & ~umask
 
772
                if current_mode & 0o040:
 
773
                    to_mode |= 0o010 & ~umask
729
774
            else:
730
 
                to_mode = current_mode & ~0111
731
 
            os.chmod(abspath, to_mode)
 
775
                to_mode = current_mode & ~0o111
 
776
            osutils.chmod_if_possible(abspath, to_mode)
732
777
 
733
778
    def _new_entry(self, name, parent_id, file_id):
734
779
        """Helper function to create a new filesystem entry."""
738
783
        return trans_id
739
784
 
740
785
    def new_file(self, name, parent_id, contents, file_id=None,
741
 
                 executable=None):
 
786
                 executable=None, sha1=None):
742
787
        """Convenience method to create files.
743
788
 
744
789
        name is the name of the file to create.
751
796
        trans_id = self._new_entry(name, parent_id, file_id)
752
797
        # TODO: rather than scheduling a set_executable call,
753
798
        # have create_file create the file with the right mode.
754
 
        self.create_file(contents, trans_id)
 
799
        self.create_file(contents, trans_id, sha1=sha1)
755
800
        if executable is not None:
756
801
            self.set_executability(executable, trans_id)
757
802
        return trans_id
780
825
        self.create_symlink(target, trans_id)
781
826
        return trans_id
782
827
 
 
828
    def new_orphan(self, trans_id, parent_id):
 
829
        """Schedule an item to be orphaned.
 
830
 
 
831
        When a directory is about to be removed, its children, if they are not
 
832
        versioned are moved out of the way: they don't have a parent anymore.
 
833
 
 
834
        :param trans_id: The trans_id of the existing item.
 
835
        :param parent_id: The parent trans_id of the item.
 
836
        """
 
837
        raise NotImplementedError(self.new_orphan)
 
838
 
 
839
    def _get_potential_orphans(self, dir_id):
 
840
        """Find the potential orphans in a directory.
 
841
 
 
842
        A directory can't be safely deleted if there are versioned files in it.
 
843
        If all the contained files are unversioned then they can be orphaned.
 
844
 
 
845
        The 'None' return value means that the directory contains at least one
 
846
        versioned file and should not be deleted.
 
847
 
 
848
        :param dir_id: The directory trans id.
 
849
 
 
850
        :return: A list of the orphan trans ids or None if at least one
 
851
             versioned file is present.
 
852
        """
 
853
        orphans = []
 
854
        # Find the potential orphans, stop if one item should be kept
 
855
        for child_tid in self.by_parent()[dir_id]:
 
856
            if child_tid in self._removed_contents:
 
857
                # The child is removed as part of the transform. Since it was
 
858
                # versioned before, it's not an orphan
 
859
                continue
 
860
            elif self.final_file_id(child_tid) is None:
 
861
                # The child is not versioned
 
862
                orphans.append(child_tid)
 
863
            else:
 
864
                # We have a versioned file here, searching for orphans is
 
865
                # meaningless.
 
866
                orphans = None
 
867
                break
 
868
        return orphans
 
869
 
783
870
    def _affected_ids(self):
784
871
        """Return the set of transform ids affected by the transform"""
785
872
        trans_ids = set(self._removed_id)
786
 
        trans_ids.update(self._new_id.keys())
 
873
        trans_ids.update(self._new_id)
787
874
        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())
 
875
        trans_ids.update(self._new_contents)
 
876
        trans_ids.update(self._new_executability)
 
877
        trans_ids.update(self._new_name)
 
878
        trans_ids.update(self._new_parent)
792
879
        return trans_ids
793
880
 
794
881
    def _get_file_id_maps(self):
807
894
                to_trans_ids[to_file_id] = trans_id
808
895
        return from_trans_ids, to_trans_ids
809
896
 
810
 
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
 
897
    def _from_file_data(self, from_trans_id, from_versioned, from_path):
811
898
        """Get data about a file in the from (tree) state
812
899
 
813
900
        Return a (name, parent, kind, executable) tuple
815
902
        from_path = self._tree_id_paths.get(from_trans_id)
816
903
        if from_versioned:
817
904
            # get data from working tree if versioned
818
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
905
            from_entry = next(self._tree.iter_entries_by_dir(
 
906
                specific_files=[from_path]))[1]
819
907
            from_name = from_entry.name
820
908
            from_parent = from_entry.parent_id
821
909
        else:
844
932
        Return a (name, parent, kind, executable) tuple
845
933
        """
846
934
        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
 
935
        to_kind = self.final_kind(to_trans_id)
851
936
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
852
937
        if to_trans_id in self._new_executability:
853
938
            to_executable = self._new_executability[to_trans_id]
871
956
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
872
957
        results = []
873
958
        # Now iterate through all active file_ids
874
 
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
 
959
        for file_id in set(from_trans_ids).union(to_trans_ids):
875
960
            modified = False
876
961
            from_trans_id = from_trans_ids.get(file_id)
877
962
            # find file ids, and determine versioning state
887
972
            else:
888
973
                to_versioned = True
889
974
 
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
975
            if not from_versioned:
897
976
                from_path = None
898
977
            else:
901
980
                to_path = None
902
981
            else:
903
982
                to_path = final_paths.get_path(to_trans_id)
 
983
 
 
984
            from_name, from_parent, from_kind, from_executable = \
 
985
                self._from_file_data(from_trans_id, from_versioned, from_path)
 
986
 
 
987
            to_name, to_parent, to_kind, to_executable = \
 
988
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
989
 
904
990
            if from_kind != to_kind:
905
991
                modified = True
906
992
            elif to_kind in ('file', 'symlink') and (
907
 
                to_trans_id != from_trans_id or
908
 
                to_trans_id in self._new_contents):
 
993
                    to_trans_id != from_trans_id
 
994
                    or to_trans_id in self._new_contents):
909
995
                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):
 
996
            if (not modified and from_versioned == to_versioned
 
997
                and from_parent == to_parent and from_name == to_name
 
998
                    and from_executable == to_executable):
913
999
                continue
914
1000
            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]))
 
1001
                            (from_versioned, to_versioned),
 
1002
                            (from_parent, to_parent),
 
1003
                            (from_name, to_name),
 
1004
                            (from_kind, to_kind),
 
1005
                            (from_executable, to_executable)))
 
1006
 
 
1007
        def path_key(t):
 
1008
            paths = t[1]
 
1009
            return (paths[0] or '', paths[1] or '')
 
1010
        return iter(sorted(results, key=path_key))
921
1011
 
922
1012
    def get_preview_tree(self):
923
1013
        """Return a tree representing the result of the transform.
927
1017
        """
928
1018
        return _PreviewTree(self)
929
1019
 
930
 
    def commit(self, branch, message, merge_parents=None, strict=False):
 
1020
    def commit(self, branch, message, merge_parents=None, strict=False,
 
1021
               timestamp=None, timezone=None, committer=None, authors=None,
 
1022
               revprops=None, revision_id=None):
931
1023
        """Commit the result of this TreeTransform to a branch.
932
1024
 
933
1025
        :param branch: The branch to commit to.
934
1026
        :param message: The message to attach to the commit.
935
 
        :param merge_parents: Additional parents specified by pending merges.
 
1027
        :param merge_parents: Additional parent revision-ids specified by
 
1028
            pending merges.
 
1029
        :param strict: If True, abort the commit if there are unversioned
 
1030
            files.
 
1031
        :param timestamp: if not None, seconds-since-epoch for the time and
 
1032
            date.  (May be a float.)
 
1033
        :param timezone: Optional timezone for timestamp, as an offset in
 
1034
            seconds.
 
1035
        :param committer: Optional committer in email-id format.
 
1036
            (e.g. "J Random Hacker <jrandom@example.com>")
 
1037
        :param authors: Optional list of authors in email-id format.
 
1038
        :param revprops: Optional dictionary of revision properties.
 
1039
        :param revision_id: Optional revision id.  (Specifying a revision-id
 
1040
            may reduce performance for some non-native formats.)
936
1041
        :return: The revision_id of the revision committed.
937
1042
        """
938
1043
        self._check_malformed()
954
1059
                parent_ids.extend(merge_parents)
955
1060
        if self._tree.get_revision_id() != last_rev_id:
956
1061
            raise ValueError('TreeTransform not based on branch basis: %s' %
957
 
                             self._tree.get_revision_id())
958
 
        builder = branch.get_commit_builder(parent_ids)
 
1062
                             self._tree.get_revision_id().decode('utf-8'))
 
1063
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
 
1064
        builder = branch.get_commit_builder(parent_ids,
 
1065
                                            timestamp=timestamp,
 
1066
                                            timezone=timezone,
 
1067
                                            committer=committer,
 
1068
                                            revprops=revprops,
 
1069
                                            revision_id=revision_id)
959
1070
        preview = self.get_preview_tree()
960
1071
        list(builder.record_iter_changes(preview, last_rev_id,
961
1072
                                         self.iter_changes()))
965
1076
        return revision_id
966
1077
 
967
1078
    def _text_parent(self, trans_id):
968
 
        file_id = self.tree_file_id(trans_id)
 
1079
        path = self.tree_path(trans_id)
969
1080
        try:
970
 
            if file_id is None or self._tree.kind(file_id) != 'file':
 
1081
            if path is None or self._tree.kind(path) != 'file':
971
1082
                return None
972
1083
        except errors.NoSuchFile:
973
1084
            return None
974
 
        return file_id
 
1085
        return path
975
1086
 
976
1087
    def _get_parents_texts(self, trans_id):
977
1088
        """Get texts for compression parents of this file."""
978
 
        file_id = self._text_parent(trans_id)
979
 
        if file_id is None:
 
1089
        path = self._text_parent(trans_id)
 
1090
        if path is None:
980
1091
            return ()
981
 
        return (self._tree.get_file_text(file_id),)
 
1092
        return (self._tree.get_file_text(path),)
982
1093
 
983
1094
    def _get_parents_lines(self, trans_id):
984
1095
        """Get lines for compression parents of this file."""
985
 
        file_id = self._text_parent(trans_id)
986
 
        if file_id is None:
 
1096
        path = self._text_parent(trans_id)
 
1097
        if path is None:
987
1098
            return ()
988
 
        return (self._tree.get_file_lines(file_id),)
 
1099
        return (self._tree.get_file_lines(path),)
989
1100
 
990
1101
    def serialize(self, serializer):
991
1102
        """Serialize this TreeTransform.
992
1103
 
993
1104
        :param serializer: A Serialiser like pack.ContainerSerializer.
994
1105
        """
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())
 
1106
        new_name = {k.encode('utf-8'): v.encode('utf-8')
 
1107
                    for k, v in viewitems(self._new_name)}
 
1108
        new_parent = {k.encode('utf-8'): v.encode('utf-8')
 
1109
                      for k, v in viewitems(self._new_parent)}
 
1110
        new_id = {k.encode('utf-8'): v
 
1111
                  for k, v in viewitems(self._new_id)}
 
1112
        new_executability = {k.encode('utf-8'): int(v)
 
1113
                             for k, v in viewitems(self._new_executability)}
 
1114
        tree_path_ids = {k.encode('utf-8'): v.encode('utf-8')
 
1115
                         for k, v in viewitems(self._tree_path_ids)}
 
1116
        non_present_ids = {k: v.encode('utf-8')
 
1117
                           for k, v in viewitems(self._non_present_ids)}
 
1118
        removed_contents = [trans_id.encode('utf-8')
 
1119
                            for trans_id in self._removed_contents]
 
1120
        removed_id = [trans_id.encode('utf-8')
 
1121
                      for trans_id in self._removed_id]
1001
1122
        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,
 
1123
            b'_id_number': self._id_number,
 
1124
            b'_new_name': new_name,
 
1125
            b'_new_parent': new_parent,
 
1126
            b'_new_executability': new_executability,
 
1127
            b'_new_id': new_id,
 
1128
            b'_tree_path_ids': tree_path_ids,
 
1129
            b'_removed_id': removed_id,
 
1130
            b'_removed_contents': removed_contents,
 
1131
            b'_non_present_ids': non_present_ids,
1011
1132
            }
1012
1133
        yield serializer.bytes_record(bencode.bencode(attribs),
1013
 
                                      (('attribs',),))
1014
 
        for trans_id, kind in self._new_contents.items():
 
1134
                                      ((b'attribs',),))
 
1135
        for trans_id, kind in sorted(viewitems(self._new_contents)):
1015
1136
            if kind == 'file':
1016
 
                lines = osutils.chunks_to_lines(
1017
 
                    self._read_file_chunks(trans_id))
 
1137
                with open(self._limbo_name(trans_id), 'rb') as cur_file:
 
1138
                    lines = cur_file.readlines()
1018
1139
                parents = self._get_parents_lines(trans_id)
1019
1140
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1020
 
                content = ''.join(mpdiff.to_patch())
 
1141
                content = b''.join(mpdiff.to_patch())
1021
1142
            if kind == 'directory':
1022
 
                content = ''
 
1143
                content = b''
1023
1144
            if kind == 'symlink':
1024
1145
                content = self._read_symlink_target(trans_id)
1025
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
 
1146
                if not isinstance(content, bytes):
 
1147
                    content = content.encode('utf-8')
 
1148
            yield serializer.bytes_record(
 
1149
                content, ((trans_id.encode('utf-8'), kind.encode('ascii')),))
1026
1150
 
1027
1151
    def deserialize(self, records):
1028
1152
        """Deserialize a stored TreeTransform.
1030
1154
        :param records: An iterable of (names, content) tuples, as per
1031
1155
            pack.ContainerPushParser.
1032
1156
        """
1033
 
        names, content = records.next()
 
1157
        names, content = next(records)
1034
1158
        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())
 
1159
        self._id_number = attribs[b'_id_number']
 
1160
        self._new_name = {k.decode('utf-8'): v.decode('utf-8')
 
1161
                          for k, v in viewitems(attribs[b'_new_name'])}
 
1162
        self._new_parent = {k.decode('utf-8'): v.decode('utf-8')
 
1163
                            for k, v in viewitems(attribs[b'_new_parent'])}
 
1164
        self._new_executability = {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(trans_id.decode('utf-8')
 
1179
                                     for trans_id in attribs[b'_removed_contents'])
 
1180
        self._non_present_ids = {k: v.decode('utf-8')
 
1181
                                 for k, v in viewitems(attribs[b'_non_present_ids'])}
1052
1182
        for ((trans_id, kind),), content in records:
 
1183
            trans_id = trans_id.decode('utf-8')
 
1184
            kind = kind.decode('ascii')
1053
1185
            if kind == 'file':
1054
1186
                mpdiff = multiparent.MultiParent.from_patch(content)
1055
1187
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1079
1211
        self._deletiondir = None
1080
1212
        # A mapping of transform ids to their limbo filename
1081
1213
        self._limbo_files = {}
 
1214
        self._possibly_stale_limbo_files = set()
1082
1215
        # A mapping of transform ids to a set of the transform ids of children
1083
1216
        # that their limbo directory has
1084
1217
        self._limbo_children = {}
1097
1230
        if self._tree is None:
1098
1231
            return
1099
1232
        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)
 
1233
            limbo_paths = list(viewvalues(self._limbo_files))
 
1234
            limbo_paths.extend(self._possibly_stale_limbo_files)
 
1235
            limbo_paths.sort(reverse=True)
 
1236
            for path in limbo_paths:
 
1237
                try:
 
1238
                    delete_any(path)
 
1239
                except OSError as e:
 
1240
                    if e.errno != errno.ENOENT:
 
1241
                        raise
 
1242
                    # XXX: warn? perhaps we just got interrupted at an
 
1243
                    # inconvenient moment, but perhaps files are disappearing
 
1244
                    # from under us?
1105
1245
            try:
1106
1246
                delete_any(self._limbodir)
1107
1247
            except OSError:
1115
1255
        finally:
1116
1256
            TreeTransformBase.finalize(self)
1117
1257
 
 
1258
    def _limbo_supports_executable(self):
 
1259
        """Check if the limbo path supports the executable bit."""
 
1260
        # FIXME: Check actual file system capabilities of limbodir
 
1261
        return osutils.supports_executable()
 
1262
 
1118
1263
    def _limbo_name(self, trans_id):
1119
1264
        """Generate the limbo name of a file"""
1120
1265
        limbo_name = self._limbo_files.get(trans_id)
1136
1281
        previous_parent = self._new_parent.get(trans_id)
1137
1282
        previous_name = self._new_name.get(trans_id)
1138
1283
        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):
 
1284
        if (trans_id in self._limbo_files
 
1285
                and trans_id not in self._needs_rename):
1141
1286
            self._rename_in_limbo([trans_id])
1142
1287
            if previous_parent != parent:
1143
1288
                self._limbo_children[previous_parent].remove(trans_id)
1156
1301
        entries from _limbo_files, because they are now stale.
1157
1302
        """
1158
1303
        for trans_id in trans_ids:
1159
 
            old_path = self._limbo_files.pop(trans_id)
 
1304
            old_path = self._limbo_files[trans_id]
 
1305
            self._possibly_stale_limbo_files.add(old_path)
 
1306
            del self._limbo_files[trans_id]
1160
1307
            if trans_id not in self._new_contents:
1161
1308
                continue
1162
1309
            new_path = self._limbo_name(trans_id)
1163
 
            osutils.rename(old_path, new_path)
 
1310
            os.rename(old_path, new_path)
 
1311
            self._possibly_stale_limbo_files.remove(old_path)
1164
1312
            for descendant in self._limbo_descendants(trans_id):
1165
1313
                desc_path = self._limbo_files[descendant]
1166
1314
                desc_path = new_path + desc_path[len(old_path):]
1173
1321
            descendants.update(self._limbo_descendants(descendant))
1174
1322
        return descendants
1175
1323
 
1176
 
    def create_file(self, contents, trans_id, mode_id=None):
 
1324
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1177
1325
        """Schedule creation of a new file.
1178
1326
 
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.
 
1327
        :seealso: new_file.
 
1328
 
 
1329
        :param contents: an iterator of strings, all of which will be written
 
1330
            to the target destination.
 
1331
        :param trans_id: TreeTransform handle
 
1332
        :param mode_id: If not None, force the mode of the target file to match
 
1333
            the mode of the object referenced by mode_id.
 
1334
            Otherwise, we will try to preserve mode bits of an existing file.
 
1335
        :param sha1: If the sha1 of this content is already known, pass it in.
 
1336
            We can use it to prevent future sha1 computations.
1186
1337
        """
1187
1338
        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
 
 
 
1339
        with open(name, 'wb') as f:
 
1340
            unique_add(self._new_contents, trans_id, 'file')
1199
1341
            f.writelines(contents)
1200
 
        finally:
1201
 
            f.close()
1202
1342
        self._set_mtime(name)
1203
1343
        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()
 
1344
        # It is unfortunate we have to use lstat instead of fstat, but we just
 
1345
        # used utime and chmod on the file, so we need the accurate final
 
1346
        # details.
 
1347
        if sha1 is not None:
 
1348
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1211
1349
 
1212
1350
    def _read_symlink_target(self, trans_id):
1213
1351
        return os.readlink(self._limbo_name(trans_id))
1226
1364
        name = self._limbo_name(trans_id)
1227
1365
        try:
1228
1366
            os.link(path, name)
1229
 
        except OSError, e:
 
1367
        except OSError as e:
1230
1368
            if e.errno != errno.EPERM:
1231
1369
                raise
1232
1370
            raise errors.HardLinkNotSupported(path)
1265
1403
    def cancel_creation(self, trans_id):
1266
1404
        """Cancel the creation of new file contents."""
1267
1405
        del self._new_contents[trans_id]
 
1406
        if trans_id in self._observed_sha1s:
 
1407
            del self._observed_sha1s[trans_id]
1268
1408
        children = self._limbo_children.get(trans_id)
1269
1409
        # if this is a limbo directory with children, move them before removing
1270
1410
        # the directory
1274
1414
            del self._limbo_children_names[trans_id]
1275
1415
        delete_any(self._limbo_name(trans_id))
1276
1416
 
 
1417
    def new_orphan(self, trans_id, parent_id):
 
1418
        conf = self._tree.get_config_stack()
 
1419
        handle_orphan = conf.get('transform.orphan_policy')
 
1420
        handle_orphan(self, trans_id, parent_id)
 
1421
 
 
1422
 
 
1423
class OrphaningError(errors.BzrError):
 
1424
 
 
1425
    # Only bugs could lead to such exception being seen by the user
 
1426
    internal_error = True
 
1427
    _fmt = "Error while orphaning %s in %s directory"
 
1428
 
 
1429
    def __init__(self, orphan, parent):
 
1430
        errors.BzrError.__init__(self)
 
1431
        self.orphan = orphan
 
1432
        self.parent = parent
 
1433
 
 
1434
 
 
1435
class OrphaningForbidden(OrphaningError):
 
1436
 
 
1437
    _fmt = "Policy: %s doesn't allow creating orphans."
 
1438
 
 
1439
    def __init__(self, policy):
 
1440
        errors.BzrError.__init__(self)
 
1441
        self.policy = policy
 
1442
 
 
1443
 
 
1444
def move_orphan(tt, orphan_id, parent_id):
 
1445
    """See TreeTransformBase.new_orphan.
 
1446
 
 
1447
    This creates a new orphan in the `brz-orphans` dir at the root of the
 
1448
    `TreeTransform`.
 
1449
 
 
1450
    :param tt: The TreeTransform orphaning `trans_id`.
 
1451
 
 
1452
    :param orphan_id: The trans id that should be orphaned.
 
1453
 
 
1454
    :param parent_id: The orphan parent trans id.
 
1455
    """
 
1456
    # Add the orphan dir if it doesn't exist
 
1457
    orphan_dir_basename = 'brz-orphans'
 
1458
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
 
1459
    if tt.final_kind(od_id) is None:
 
1460
        tt.create_directory(od_id)
 
1461
    parent_path = tt._tree_id_paths[parent_id]
 
1462
    # Find a name that doesn't exist yet in the orphan dir
 
1463
    actual_name = tt.final_name(orphan_id)
 
1464
    new_name = tt._available_backup_name(actual_name, od_id)
 
1465
    tt.adjust_path(new_name, od_id, orphan_id)
 
1466
    trace.warning('%s has been orphaned in %s'
 
1467
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
 
1468
 
 
1469
 
 
1470
def refuse_orphan(tt, orphan_id, parent_id):
 
1471
    """See TreeTransformBase.new_orphan.
 
1472
 
 
1473
    This refuses to create orphan, letting the caller handle the conflict.
 
1474
    """
 
1475
    raise OrphaningForbidden('never')
 
1476
 
 
1477
 
 
1478
orphaning_registry = registry.Registry()
 
1479
orphaning_registry.register(
 
1480
    u'conflict', refuse_orphan,
 
1481
    'Leave orphans in place and create a conflict on the directory.')
 
1482
orphaning_registry.register(
 
1483
    u'move', move_orphan,
 
1484
    'Move orphans into the brz-orphans directory.')
 
1485
orphaning_registry._set_default_key(u'conflict')
 
1486
 
 
1487
 
 
1488
opt_transform_orphan = _mod_config.RegistryOption(
 
1489
    'transform.orphan_policy', orphaning_registry,
 
1490
    help='Policy for orphaned files during transform operations.',
 
1491
    invalid='warning')
 
1492
 
1277
1493
 
1278
1494
class TreeTransform(DiskTreeTransform):
1279
1495
    """Represent a tree transformation.
1340
1556
    FileMover does not delete files until it is sure that a rollback will not
1341
1557
    happen.
1342
1558
    """
 
1559
 
1343
1560
    def __init__(self, tree, pb=None):
1344
1561
        """Note: a tree_write lock is taken on the tree.
1345
1562
 
1347
1564
        TreeTransform.apply() called).
1348
1565
        """
1349
1566
        tree.lock_tree_write()
1350
 
 
1351
1567
        try:
1352
1568
            limbodir = urlutils.local_path_from_url(
1353
1569
                tree._transport.abspath('limbo'))
1354
 
            try:
1355
 
                os.mkdir(limbodir)
1356
 
            except OSError, e:
1357
 
                if e.errno == errno.EEXIST:
1358
 
                    raise ExistingLimbo(limbodir)
 
1570
            osutils.ensure_empty_directory_exists(
 
1571
                limbodir,
 
1572
                errors.ExistingLimbo)
1359
1573
            deletiondir = urlutils.local_path_from_url(
1360
1574
                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)
 
1575
            osutils.ensure_empty_directory_exists(
 
1576
                deletiondir,
 
1577
                errors.ExistingPendingDeletion)
1366
1578
        except:
1367
1579
            tree.unlock()
1368
1580
            raise
1397
1609
    def tree_kind(self, trans_id):
1398
1610
        """Determine the file kind in the working tree.
1399
1611
 
1400
 
        Raises NoSuchFile if the file does not exist
 
1612
        :returns: The file kind or None if the file does not exist
1401
1613
        """
1402
1614
        path = self._tree_id_paths.get(trans_id)
1403
1615
        if path is None:
1404
 
            raise NoSuchFile(None)
 
1616
            return None
1405
1617
        try:
1406
1618
            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)
 
1619
        except errors.NoSuchFile:
 
1620
            return None
1412
1621
 
1413
1622
    def _set_mode(self, trans_id, mode_id, typefunc):
1414
1623
        """Set the mode of new file contents.
1424
1633
            return
1425
1634
        try:
1426
1635
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1427
 
        except OSError, e:
 
1636
        except OSError as e:
1428
1637
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1429
1638
                # Either old_path doesn't exist, or the parent of the
1430
1639
                # target is not a directory (but will be one eventually)
1434
1643
            else:
1435
1644
                raise
1436
1645
        if typefunc(mode):
1437
 
            os.chmod(self._limbo_name(trans_id), mode)
 
1646
            osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1438
1647
 
1439
1648
    def iter_tree_children(self, parent_id):
1440
1649
        """Iterate through the entry's tree children, if any"""
1444
1653
            return
1445
1654
        try:
1446
1655
            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)):
 
1656
        except OSError as e:
 
1657
            if not (osutils._is_error_enotdir(e) or
 
1658
                    e.errno in (errno.ENOENT, errno.ESRCH)):
1450
1659
                raise
1451
1660
            return
1452
1661
 
1483
1692
                # if it is already associated with this trans_id.
1484
1693
                elif self._case_sensitive_target:
1485
1694
                    if (self._limbo_children_names[parent].get(filename)
1486
 
                        in (trans_id, None)):
 
1695
                            in (trans_id, None)):
1487
1696
                        use_direct_path = True
1488
1697
                else:
1489
 
                    for l_filename, l_trans_id in\
1490
 
                        self._limbo_children_names[parent].iteritems():
 
1698
                    for l_filename, l_trans_id in viewitems(
 
1699
                            self._limbo_children_names[parent]):
1491
1700
                        if l_trans_id == trans_id:
1492
1701
                            continue
1493
1702
                        if l_filename.lower() == filename.lower():
1503
1712
        self._limbo_children_names[parent][filename] = trans_id
1504
1713
        return limbo_name
1505
1714
 
1506
 
 
1507
1715
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1508
1716
        """Apply all changes to the inventory and filesystem.
1509
1717
 
1518
1726
            calculating one.
1519
1727
        :param _mover: Supply an alternate FileMover, for testing
1520
1728
        """
 
1729
        for hook in MutableTree.hooks['pre_transform']:
 
1730
            hook(self._tree, self)
1521
1731
        if not no_conflicts:
1522
1732
            self._check_malformed()
1523
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
 
        try:
 
1733
        with ui.ui_factory.nested_progress_bar() as child_pb:
1525
1734
            if precomputed_delta is None:
1526
 
                child_pb.update('Apply phase', 0, 2)
 
1735
                child_pb.update(gettext('Apply phase'), 0, 2)
1527
1736
                inventory_delta = self._generate_inventory_delta()
1528
1737
                offset = 1
1529
1738
            else:
1534
1743
            else:
1535
1744
                mover = _mover
1536
1745
            try:
1537
 
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
 
1746
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1538
1747
                self._apply_removals(mover)
1539
 
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
 
1748
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1540
1749
                modified_paths = self._apply_insertions(mover)
1541
1750
            except:
1542
1751
                mover.rollback()
1543
1752
                raise
1544
1753
            else:
1545
1754
                mover.apply_deletions()
1546
 
        finally:
1547
 
            child_pb.finished()
 
1755
        if self.final_file_id(self.root) is None:
 
1756
            inventory_delta = [e for e in inventory_delta if e[0] != '']
1548
1757
        self._tree.apply_inventory_delta(inventory_delta)
 
1758
        self._apply_observed_sha1s()
1549
1759
        self._done = True
1550
1760
        self.finalize()
1551
1761
        return _TransformResults(modified_paths, self.rename_count)
1553
1763
    def _generate_inventory_delta(self):
1554
1764
        """Generate an inventory delta for the current transform."""
1555
1765
        inventory_delta = []
1556
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1557
1766
        new_paths = self._inventory_altered()
1558
1767
        total_entries = len(new_paths) + len(self._removed_id)
1559
 
        try:
 
1768
        with ui.ui_factory.nested_progress_bar() as child_pb:
1560
1769
            for num, trans_id in enumerate(self._removed_id):
1561
1770
                if (num % 10) == 0:
1562
 
                    child_pb.update('removing file', num, total_entries)
 
1771
                    child_pb.update(gettext('removing file'),
 
1772
                                    num, total_entries)
1563
1773
                if trans_id == self._new_root:
1564
1774
                    file_id = self._tree.get_root_id()
1565
1775
                else:
1571
1781
                inventory_delta.append((path, None, file_id, None))
1572
1782
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1573
1783
                                     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
1784
            final_kinds = {}
1578
1785
            for num, (path, trans_id) in enumerate(new_paths):
1579
1786
                if (num % 10) == 0:
1580
 
                    child_pb.update('adding file',
 
1787
                    child_pb.update(gettext('adding file'),
1581
1788
                                    num + len(self._removed_id), total_entries)
1582
1789
                file_id = new_path_file_ids[trans_id]
1583
1790
                if file_id is None:
1584
1791
                    continue
1585
1792
                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.
1657
1863
        modified_paths = []
1658
1864
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1659
1865
                                 new_paths)
1660
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1661
 
        try:
 
1866
        with ui.ui_factory.nested_progress_bar() as child_pb:
1662
1867
            for num, (path, trans_id) in enumerate(new_paths):
1663
1868
                if (num % 10) == 0:
1664
 
                    child_pb.update('adding file', num, len(new_paths))
 
1869
                    child_pb.update(gettext('adding file'),
 
1870
                                    num, len(new_paths))
1665
1871
                full_path = self._tree.abspath(path)
1666
1872
                if trans_id in self._needs_rename:
1667
1873
                    try:
1668
1874
                        mover.rename(self._limbo_name(trans_id), full_path)
1669
 
                    except OSError, e:
 
1875
                    except errors.TransformRenameFailed as e:
1670
1876
                        # We may be renaming a dangling inventory id
1671
1877
                        if e.errno != errno.ENOENT:
1672
1878
                            raise
1673
1879
                    else:
1674
1880
                        self.rename_count += 1
1675
 
                if (trans_id in self._new_contents or
1676
 
                    self.path_changed(trans_id)):
 
1881
                    # TODO: if trans_id in self._observed_sha1s, we should
 
1882
                    #       re-stat the final target, since ctime will be
 
1883
                    #       updated by the change.
 
1884
                if (trans_id in self._new_contents
 
1885
                        or self.path_changed(trans_id)):
1677
1886
                    if trans_id in self._new_contents:
1678
1887
                        modified_paths.append(full_path)
1679
1888
                if trans_id in self._new_executability:
1680
1889
                    self._set_executability(path, trans_id)
1681
 
        finally:
1682
 
            child_pb.finished()
 
1890
                if trans_id in self._observed_sha1s:
 
1891
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
 
1892
                    st = osutils.lstat(full_path)
 
1893
                    self._observed_sha1s[trans_id] = (o_sha1, st)
 
1894
        for path, trans_id in new_paths:
 
1895
            # new_paths includes stuff like workingtree conflicts. Only the
 
1896
            # stuff in new_contents actually comes from limbo.
 
1897
            if trans_id in self._limbo_files:
 
1898
                del self._limbo_files[trans_id]
1683
1899
        self._new_contents.clear()
1684
1900
        return modified_paths
1685
1901
 
 
1902
    def _apply_observed_sha1s(self):
 
1903
        """After we have finished renaming everything, update observed sha1s
 
1904
 
 
1905
        This has to be done after self._tree.apply_inventory_delta, otherwise
 
1906
        it doesn't know anything about the files we are updating. Also, we want
 
1907
        to do this as late as possible, so that most entries end up cached.
 
1908
        """
 
1909
        # TODO: this doesn't update the stat information for directories. So
 
1910
        #       the first 'bzr status' will still need to rewrite
 
1911
        #       .bzr/checkout/dirstate. However, we at least don't need to
 
1912
        #       re-read all of the files.
 
1913
        # TODO: If the operation took a while, we could do a time.sleep(3) here
 
1914
        #       to allow the clock to tick over and ensure we won't have any
 
1915
        #       problems. (we could observe start time, and finish time, and if
 
1916
        #       it is less than eg 10% overhead, add a sleep call.)
 
1917
        paths = FinalPaths(self)
 
1918
        for trans_id, observed in viewitems(self._observed_sha1s):
 
1919
            path = paths.get_path(trans_id)
 
1920
            # We could get the file_id, but dirstate prefers to use the path
 
1921
            # anyway, and it is 'cheaper' to determine.
 
1922
            # file_id = self._new_id[trans_id]
 
1923
            self._tree._observed_sha1(None, path, observed)
 
1924
 
1686
1925
 
1687
1926
class TransformPreview(DiskTreeTransform):
1688
1927
    """A TreeTransform for generating preview trees.
1703
1942
    def tree_kind(self, trans_id):
1704
1943
        path = self._tree_id_paths.get(trans_id)
1705
1944
        if path is None:
1706
 
            raise NoSuchFile(None)
1707
 
        file_id = self._tree.path2id(path)
1708
 
        return self._tree.kind(file_id)
 
1945
            return None
 
1946
        kind = self._tree.path_content_summary(path)[0]
 
1947
        if kind == 'missing':
 
1948
            kind = None
 
1949
        return kind
1709
1950
 
1710
1951
    def _set_mode(self, trans_id, mode_id, typefunc):
1711
1952
        """Set the mode of new file contents.
1722
1963
            path = self._tree_id_paths[parent_id]
1723
1964
        except KeyError:
1724
1965
            return
1725
 
        file_id = self.tree_file_id(parent_id)
1726
 
        if file_id is None:
 
1966
        try:
 
1967
            entry = next(self._tree.iter_entries_by_dir(
 
1968
                specific_files=[path]))[1]
 
1969
        except StopIteration:
1727
1970
            return
1728
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1729
1971
        children = getattr(entry, 'children', {})
1730
1972
        for child in children:
1731
1973
            childpath = joinpath(path, child)
1732
1974
            yield self.trans_id_tree_path(childpath)
1733
1975
 
1734
 
 
1735
 
class _PreviewTree(tree.Tree):
 
1976
    def new_orphan(self, trans_id, parent_id):
 
1977
        raise NotImplementedError(self.new_orphan)
 
1978
 
 
1979
 
 
1980
class _PreviewTree(inventorytree.InventoryTree):
1736
1981
    """Partial implementation of Tree to support show_diff_trees"""
1737
1982
 
1738
1983
    def __init__(self, transform):
1766
2011
            except errors.NoSuchRevisionInTree:
1767
2012
                yield self._get_repository().revision_tree(revision_id)
1768
2013
 
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()]
 
2014
    def _get_file_revision(self, path, file_id, vf, tree_revision):
 
2015
        parent_keys = [
 
2016
            (file_id, t.get_file_revision(t.id2path(file_id), file_id))
 
2017
            for t in self._iter_parent_trees()]
1772
2018
        vf.add_lines((file_id, tree_revision), parent_keys,
1773
 
                     self.get_file(file_id).readlines())
 
2019
                     self.get_file_lines(path, file_id))
1774
2020
        repo = self._get_repository()
1775
2021
        base_vf = repo.texts
1776
2022
        if base_vf not in vf.fallback_versionedfiles:
1777
2023
            vf.fallback_versionedfiles.append(base_vf)
1778
2024
        return tree_revision
1779
2025
 
1780
 
    def _stat_limbo_file(self, file_id):
1781
 
        trans_id = self._transform.trans_id_file_id(file_id)
 
2026
    def _stat_limbo_file(self, trans_id):
1782
2027
        name = self._transform._limbo_name(trans_id)
1783
2028
        return os.lstat(name)
1784
2029
 
1795
2040
            executable = False
1796
2041
        else:
1797
2042
            file_id = self._transform.final_file_id(self._path2trans_id(path))
1798
 
            executable = self.is_executable(file_id, path)
 
2043
            executable = self.is_executable(path, file_id)
1799
2044
        return kind, executable, None
1800
2045
 
 
2046
    def is_locked(self):
 
2047
        return False
 
2048
 
1801
2049
    def lock_read(self):
1802
2050
        # Perhaps in theory, this should lock the TreeTransform?
1803
 
        pass
 
2051
        return lock.LogicalLockResult(self.unlock)
1804
2052
 
1805
2053
    def unlock(self):
1806
2054
        pass
1807
2055
 
1808
2056
    @property
1809
 
    def inventory(self):
 
2057
    def root_inventory(self):
1810
2058
        """This Tree does not use inventory as its backing data."""
1811
 
        raise NotImplementedError(_PreviewTree.inventory)
 
2059
        raise NotImplementedError(_PreviewTree.root_inventory)
1812
2060
 
1813
2061
    def get_root_id(self):
1814
2062
        return self._transform.final_file_id(self._transform.root)
1817
2065
        tree_ids = set(self._transform._tree.all_file_ids())
1818
2066
        tree_ids.difference_update(self._transform.tree_file_id(t)
1819
2067
                                   for t in self._transform._removed_id)
1820
 
        tree_ids.update(self._transform._new_id.values())
 
2068
        tree_ids.update(viewvalues(self._transform._new_id))
1821
2069
        return tree_ids
1822
2070
 
1823
 
    def __iter__(self):
1824
 
        return iter(self.all_file_ids())
 
2071
    def all_versioned_paths(self):
 
2072
        return {self.id2path(fid) for fid in self.all_file_ids()}
1825
2073
 
1826
2074
    def _has_id(self, file_id, fallback_check):
1827
2075
        if file_id in self._transform._r_new_id:
1828
2076
            return True
1829
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1830
 
            trans_id in self._transform._removed_id]):
 
2077
        elif file_id in {self._transform.tree_file_id(trans_id) for
 
2078
                         trans_id in self._transform._removed_id}:
1831
2079
            return False
1832
2080
        else:
1833
2081
            return fallback_check(file_id)
1861
2109
        return cur_parent
1862
2110
 
1863
2111
    def path2id(self, path):
 
2112
        if isinstance(path, list):
 
2113
            if path == []:
 
2114
                path = [""]
 
2115
            path = osutils.pathjoin(*path)
1864
2116
        return self._transform.final_file_id(self._path2trans_id(path))
1865
2117
 
1866
2118
    def id2path(self, file_id):
1876
2128
            return children
1877
2129
        children = set(self._transform.iter_tree_children(trans_id))
1878
2130
        # children in the _new_parent set are provided by _by_parent.
1879
 
        children.difference_update(self._transform._new_parent.keys())
 
2131
        children.difference_update(self._transform._new_parent)
1880
2132
        children.update(self._by_parent.get(trans_id, []))
1881
2133
        self._all_children_cache[trans_id] = children
1882
2134
        return children
1883
2135
 
1884
 
    def iter_children(self, file_id):
 
2136
    def _iter_children(self, file_id):
1885
2137
        trans_id = self._transform.trans_id_file_id(file_id)
1886
2138
        for child_trans_id in self._all_children(trans_id):
1887
2139
            yield self._transform.final_file_id(child_trans_id)
1895
2147
            if self._transform.final_file_id(trans_id) is None:
1896
2148
                yield self._final_paths._determine_path(trans_id)
1897
2149
 
1898
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1899
 
        yield_parents=False):
 
2150
    def _make_inv_entries(self, ordered_entries, specific_files=None):
1900
2151
        for trans_id, parent_file_id in ordered_entries:
1901
2152
            file_id = self._transform.final_file_id(trans_id)
1902
2153
            if file_id is None:
1903
2154
                continue
1904
 
            if (specific_file_ids is not None
1905
 
                and file_id not in specific_file_ids):
 
2155
            if (specific_files is not None
 
2156
                    and self._final_paths.get_path(trans_id) not in specific_files):
1906
2157
                continue
1907
 
            try:
1908
 
                kind = self._transform.final_kind(trans_id)
1909
 
            except NoSuchFile:
1910
 
                kind = self._transform._tree.stored_kind(file_id)
 
2158
            kind = self._transform.final_kind(trans_id)
 
2159
            if kind is None:
 
2160
                kind = self._transform._tree.stored_kind(
 
2161
                    self._transform._tree.id2path(file_id),
 
2162
                    file_id)
1911
2163
            new_entry = inventory.make_entry(
1912
2164
                kind,
1913
2165
                self._transform.final_name(trans_id),
1928
2180
                ordered_ids.append((trans_id, parent_file_id))
1929
2181
        return ordered_ids
1930
2182
 
1931
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
2183
    def iter_child_entries(self, path, file_id=None):
 
2184
        trans_id = self._path2trans_id(path)
 
2185
        if trans_id is None:
 
2186
            raise errors.NoSuchFile(path)
 
2187
        todo = [(child_trans_id, trans_id) for child_trans_id in
 
2188
                self._all_children(trans_id)]
 
2189
        for entry, trans_id in self._make_inv_entries(todo):
 
2190
            yield entry
 
2191
 
 
2192
    def iter_entries_by_dir(self, specific_files=None):
1932
2193
        # This may not be a maximally efficient implementation, but it is
1933
2194
        # reasonably straightforward.  An implementation that grafts the
1934
2195
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1936
2197
        # position.
1937
2198
        ordered_ids = self._list_files_by_dir()
1938
2199
        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
 
2200
                                                      specific_files):
 
2201
            yield self._final_paths.get_path(trans_id), entry
1941
2202
 
1942
2203
    def _iter_entries_for_dir(self, dir_path):
1943
2204
        """Return path, entry for items in a directory without recursing down."""
1944
 
        dir_file_id = self.path2id(dir_path)
1945
2205
        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))
 
2206
        dir_trans_id = self._path2trans_id(dir_path)
 
2207
        dir_id = self._transform.final_file_id(dir_trans_id)
 
2208
        for child_trans_id in self._all_children(dir_trans_id):
 
2209
            ordered_ids.append((child_trans_id, dir_id))
 
2210
        path_entries = []
1949
2211
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1950
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
2212
            path_entries.append((self._final_paths.get_path(trans_id), entry))
 
2213
        path_entries.sort()
 
2214
        return path_entries
1951
2215
 
1952
2216
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1953
2217
        """See WorkingTree.list_files."""
1969
2233
        else:
1970
2234
            if from_dir is None and include_root is True:
1971
2235
                root_entry = inventory.make_entry('directory', '',
1972
 
                    ROOT_PARENT, self.get_root_id())
 
2236
                                                  ROOT_PARENT, self.get_root_id())
1973
2237
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1974
2238
            entries = self._iter_entries_for_dir(from_dir or '')
1975
2239
            for path, entry in entries:
1976
2240
                yield path, 'V', entry.kind, entry.file_id, entry
1977
2241
 
1978
 
    def kind(self, file_id):
1979
 
        trans_id = self._transform.trans_id_file_id(file_id)
 
2242
    def kind(self, path, file_id=None):
 
2243
        trans_id = self._path2trans_id(path)
 
2244
        if trans_id is None:
 
2245
            raise errors.NoSuchFile(path)
1980
2246
        return self._transform.final_kind(trans_id)
1981
2247
 
1982
 
    def stored_kind(self, file_id):
1983
 
        trans_id = self._transform.trans_id_file_id(file_id)
 
2248
    def stored_kind(self, path, file_id=None):
 
2249
        trans_id = self._path2trans_id(path)
 
2250
        if trans_id is None:
 
2251
            raise errors.NoSuchFile(path)
1984
2252
        try:
1985
2253
            return self._transform._new_contents[trans_id]
1986
2254
        except KeyError:
1987
 
            return self._transform._tree.stored_kind(file_id)
 
2255
            return self._transform._tree.stored_kind(path, file_id)
1988
2256
 
1989
 
    def get_file_mtime(self, file_id, path=None):
 
2257
    def get_file_mtime(self, path, file_id=None):
1990
2258
        """See Tree.get_file_mtime"""
 
2259
        if file_id is None:
 
2260
            file_id = self.path2id(path)
 
2261
        if file_id is None:
 
2262
            raise errors.NoSuchFile(path)
1991
2263
        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):
 
2264
            return self._transform._tree.get_file_mtime(
 
2265
                self._transform._tree.id2path(file_id), file_id)
 
2266
        trans_id = self._path2trans_id(path)
 
2267
        return self._stat_limbo_file(trans_id).st_mtime
 
2268
 
 
2269
    def get_file_size(self, path, file_id=None):
1999
2270
        """See Tree.get_file_size"""
2000
 
        if self.kind(file_id) == 'file':
2001
 
            return self._transform._tree.get_file_size(file_id)
 
2271
        trans_id = self._path2trans_id(path)
 
2272
        if trans_id is None:
 
2273
            raise errors.NoSuchFile(path)
 
2274
        kind = self._transform.final_kind(trans_id)
 
2275
        if kind != 'file':
 
2276
            return None
 
2277
        if trans_id in self._transform._new_contents:
 
2278
            return self._stat_limbo_file(trans_id).st_size
 
2279
        if self.kind(path, file_id) == 'file':
 
2280
            return self._transform._tree.get_file_size(path, file_id)
2002
2281
        else:
2003
2282
            return None
2004
2283
 
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:
 
2284
    def get_file_verifier(self, path, file_id=None, stat_value=None):
 
2285
        trans_id = self._path2trans_id(path)
 
2286
        if trans_id is None:
 
2287
            raise errors.NoSuchFile(path)
 
2288
        kind = self._transform._new_contents.get(trans_id)
 
2289
        if kind is None:
 
2290
            return self._transform._tree.get_file_verifier(path, file_id)
 
2291
        if kind == 'file':
 
2292
            with self.get_file(path, file_id) as fileobj:
 
2293
                return ("SHA1", sha_file(fileobj))
 
2294
 
 
2295
    def get_file_sha1(self, path, file_id=None, stat_value=None):
 
2296
        trans_id = self._path2trans_id(path)
 
2297
        if trans_id is None:
 
2298
            raise errors.NoSuchFile(path)
 
2299
        kind = self._transform._new_contents.get(trans_id)
 
2300
        if kind is None:
 
2301
            return self._transform._tree.get_file_sha1(path, file_id)
 
2302
        if kind == 'file':
 
2303
            with self.get_file(path, file_id) as fileobj:
2013
2304
                return sha_file(fileobj)
2014
 
            finally:
2015
 
                fileobj.close()
2016
2305
 
2017
 
    def is_executable(self, file_id, path=None):
2018
 
        if file_id is None:
 
2306
    def is_executable(self, path, file_id=None):
 
2307
        trans_id = self._path2trans_id(path)
 
2308
        if trans_id is None:
2019
2309
            return False
2020
 
        trans_id = self._transform.trans_id_file_id(file_id)
2021
2310
        try:
2022
2311
            return self._transform._new_executability[trans_id]
2023
2312
        except KeyError:
2024
2313
            try:
2025
 
                return self._transform._tree.is_executable(file_id, path)
2026
 
            except OSError, e:
 
2314
                return self._transform._tree.is_executable(path, file_id)
 
2315
            except OSError as e:
2027
2316
                if e.errno == errno.ENOENT:
2028
2317
                    return False
2029
2318
                raise
2030
 
            except errors.NoSuchId:
 
2319
            except errors.NoSuchFile:
2031
2320
                return False
2032
2321
 
 
2322
    def has_filename(self, path):
 
2323
        trans_id = self._path2trans_id(path)
 
2324
        if trans_id in self._transform._new_contents:
 
2325
            return True
 
2326
        elif trans_id in self._transform._removed_contents:
 
2327
            return False
 
2328
        else:
 
2329
            return self._transform._tree.has_filename(path)
 
2330
 
2033
2331
    def path_content_summary(self, path):
2034
2332
        trans_id = self._path2trans_id(path)
2035
2333
        tt = self._transform
2048
2346
            if kind == 'file':
2049
2347
                statval = os.lstat(limbo_name)
2050
2348
                size = statval.st_size
2051
 
                if not supports_executable():
 
2349
                if not tt._limbo_supports_executable():
2052
2350
                    executable = False
2053
2351
                else:
2054
2352
                    executable = statval.st_mode & S_IEXEC
2056
2354
                size = None
2057
2355
                executable = None
2058
2356
            if kind == 'symlink':
2059
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
2357
                link_or_sha1 = os.readlink(limbo_name)
 
2358
                if not isinstance(link_or_sha1, text_type):
 
2359
                    link_or_sha1 = link_or_sha1.decode(osutils._fs_enc)
2060
2360
        executable = tt._new_executability.get(trans_id, executable)
2061
2361
        return kind, size, executable, link_or_sha1
2062
2362
 
2063
2363
    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):
 
2364
                     specific_files=None, pb=None, extra_trees=None,
 
2365
                     require_versioned=True, want_unversioned=False):
2066
2366
        """See InterTree.iter_changes.
2067
2367
 
2068
2368
        This has a fast path that is only used when the from_tree matches
2069
2369
        the transform tree, and no fancy options are supplied.
2070
2370
        """
2071
 
        if (from_tree is not self._transform._tree or include_unchanged or
2072
 
            specific_files or want_unversioned):
 
2371
        if (from_tree is not self._transform._tree or include_unchanged
 
2372
                or specific_files or want_unversioned):
2073
2373
            return tree.InterTree(from_tree, self).iter_changes(
2074
2374
                include_unchanged=include_unchanged,
2075
2375
                specific_files=specific_files,
2081
2381
            raise ValueError('want_unversioned is not supported')
2082
2382
        return self._transform.iter_changes()
2083
2383
 
2084
 
    def get_file(self, file_id, path=None):
 
2384
    def get_file(self, path, file_id=None):
2085
2385
        """See Tree.get_file"""
 
2386
        if file_id is None:
 
2387
            file_id = self.path2id(path)
2086
2388
        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)
 
2389
            return self._transform._tree.get_file(path, file_id)
 
2390
        trans_id = self._path2trans_id(path)
2089
2391
        name = self._transform._limbo_name(trans_id)
2090
2392
        return open(name, 'rb')
2091
2393
 
2092
 
    def get_file_with_stat(self, file_id, path=None):
2093
 
        return self.get_file(file_id, path), None
 
2394
    def get_file_with_stat(self, path, file_id=None):
 
2395
        return self.get_file(path, file_id), None
2094
2396
 
2095
 
    def annotate_iter(self, file_id,
 
2397
    def annotate_iter(self, path, file_id=None,
2096
2398
                      default_revision=_mod_revision.CURRENT_REVISION):
 
2399
        if file_id is None:
 
2400
            file_id = self.path2id(path)
2097
2401
        changes = self._iter_changes_cache.get(file_id)
2098
2402
        if changes is None:
2099
2403
            get_old = True
2104
2408
                return None
2105
2409
            get_old = (kind[0] == 'file' and versioned[0])
2106
2410
        if get_old:
2107
 
            old_annotation = self._transform._tree.annotate_iter(file_id,
2108
 
                default_revision=default_revision)
 
2411
            old_annotation = self._transform._tree.annotate_iter(
 
2412
                path, file_id=file_id, default_revision=default_revision)
2109
2413
        else:
2110
2414
            old_annotation = []
2111
2415
        if changes is None:
2120
2424
        #       It would be nice to be able to use the new Annotator based
2121
2425
        #       approach, as well.
2122
2426
        return annotate.reannotate([old_annotation],
2123
 
                                   self.get_file(file_id).readlines(),
 
2427
                                   self.get_file(path, file_id).readlines(),
2124
2428
                                   default_revision)
2125
2429
 
2126
 
    def get_symlink_target(self, file_id):
 
2430
    def get_symlink_target(self, path, file_id=None):
2127
2431
        """See Tree.get_symlink_target"""
 
2432
        if file_id is None:
 
2433
            file_id = self.path2id(path)
2128
2434
        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)
 
2435
            return self._transform._tree.get_symlink_target(path)
 
2436
        trans_id = self._path2trans_id(path)
2131
2437
        name = self._transform._limbo_name(trans_id)
2132
2438
        return osutils.readlink(name)
2133
2439
 
2144
2450
                path_from_root = self._final_paths.get_path(child_id)
2145
2451
                basename = self._transform.final_name(child_id)
2146
2452
                file_id = self._transform.final_file_id(child_id)
2147
 
                try:
2148
 
                    kind = self._transform.final_kind(child_id)
 
2453
                kind = self._transform.final_kind(child_id)
 
2454
                if kind is not None:
2149
2455
                    versioned_kind = kind
2150
 
                except NoSuchFile:
 
2456
                else:
2151
2457
                    kind = 'unknown'
2152
 
                    versioned_kind = self._transform._tree.stored_kind(file_id)
 
2458
                    versioned_kind = self._transform._tree.stored_kind(
 
2459
                        self._transform._tree.id2path(file_id),
 
2460
                        file_id)
2153
2461
                if versioned_kind == 'directory':
2154
2462
                    subdirs.append(child_id)
2155
2463
                children.append((path_from_root, basename, kind, None,
2184
2492
    The underlying tree must not be manipulated between calls, or else
2185
2493
    the results will likely be incorrect.
2186
2494
    """
 
2495
 
2187
2496
    def __init__(self, transform):
2188
2497
        object.__init__(self)
2189
2498
        self._known_paths = {}
2191
2500
 
2192
2501
    def _determine_path(self, trans_id):
2193
2502
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2194
 
            return ""
 
2503
            return u""
2195
2504
        name = self.transform.final_name(trans_id)
2196
2505
        parent_id = self.transform.final_parent(trans_id)
2197
2506
        if parent_id == self.transform.root:
2209
2518
        return [(self.get_path(t), t) for t in trans_ids]
2210
2519
 
2211
2520
 
2212
 
 
2213
2521
def topology_sorted_ids(tree):
2214
2522
    """Determine the topological order of the ids in a tree"""
2215
2523
    file_ids = list(tree)
2243
2551
    :param delta_from_tree: If true, build_tree may use the input Tree to
2244
2552
        generate the inventory delta.
2245
2553
    """
2246
 
    wt.lock_tree_write()
2247
 
    try:
2248
 
        tree.lock_read()
 
2554
    with wt.lock_tree_write(), tree.lock_read():
 
2555
        if accelerator_tree is not None:
 
2556
            accelerator_tree.lock_read()
2249
2557
        try:
 
2558
            return _build_tree(tree, wt, accelerator_tree, hardlink,
 
2559
                               delta_from_tree)
 
2560
        finally:
2250
2561
            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()
 
2562
                accelerator_tree.unlock()
2262
2563
 
2263
2564
 
2264
2565
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2265
2566
    """See build_tree."""
2266
 
    for num, _unused in enumerate(wt.all_file_ids()):
 
2567
    for num, _unused in enumerate(wt.all_versioned_paths()):
2267
2568
        if num > 0:  # more than just a root
2268
2569
            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
2570
    file_trans_id = {}
2273
 
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2571
    top_pb = ui.ui_factory.nested_progress_bar()
2274
2572
    pp = ProgressPhase("Build phase", 2, top_pb)
2275
 
    if tree.inventory.root is not None:
 
2573
    if tree.get_root_id() is not None:
2276
2574
        # This is kind of a hack: we should be altering the root
2277
2575
        # as part of the regular tree shape diff logic.
2278
2576
        # The conditional test here is to avoid doing an
2287
2585
    divert = set()
2288
2586
    try:
2289
2587
        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:
 
2588
        file_trans_id[wt.get_root_id()] = tt.trans_id_tree_path('')
 
2589
        with ui.ui_factory.nested_progress_bar() as pb:
2294
2590
            deferred_contents = []
2295
2591
            num = 0
2296
 
            total = len(tree.inventory)
 
2592
            total = len(tree.all_versioned_paths())
2297
2593
            if delta_from_tree:
2298
2594
                precomputed_delta = []
2299
2595
            else:
2300
2596
                precomputed_delta = None
 
2597
            # Check if tree inventory has content. If so, we populate
 
2598
            # existing_files with the directory content. If there are no
 
2599
            # entries we skip populating existing_files as its not used.
 
2600
            # This improves performance and unncessary work on large
 
2601
            # directory trees. (#501307)
 
2602
            if total > 0:
 
2603
                existing_files = set()
 
2604
                for dir, files in wt.walkdirs():
 
2605
                    existing_files.update(f[0] for f in files)
2301
2606
            for num, (tree_path, entry) in \
2302
 
                enumerate(tree.inventory.iter_entries_by_dir()):
2303
 
                pb.update("Building tree", num - len(deferred_contents), total)
 
2607
                    enumerate(tree.iter_entries_by_dir()):
 
2608
                pb.update(gettext("Building tree"), num
 
2609
                          - len(deferred_contents), total)
2304
2610
                if entry.parent_id is None:
2305
2611
                    continue
2306
2612
                reparent = False
2312
2618
                    kind = file_kind(target_path)
2313
2619
                    if kind == "directory":
2314
2620
                        try:
2315
 
                            bzrdir.BzrDir.open(target_path)
 
2621
                            controldir.ControlDir.open(target_path)
2316
2622
                        except errors.NotBranchError:
2317
2623
                            pass
2318
2624
                        else:
2319
2625
                            divert.add(file_id)
2320
 
                    if (file_id not in divert and
2321
 
                        _content_match(tree, entry, file_id, kind,
2322
 
                        target_path)):
 
2626
                    if (file_id not in divert
 
2627
                        and _content_match(tree, entry, tree_path, file_id, kind,
 
2628
                                       target_path)):
2323
2629
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2324
2630
                        if kind == 'directory':
2325
2631
                            reparent = True
2330
2636
                    trans_id = tt.create_path(entry.name, parent_id)
2331
2637
                    file_trans_id[file_id] = trans_id
2332
2638
                    tt.version_file(file_id, trans_id)
2333
 
                    executable = tree.is_executable(file_id, tree_path)
 
2639
                    executable = tree.is_executable(tree_path, file_id)
2334
2640
                    if executable:
2335
2641
                        tt.set_executability(executable, trans_id)
2336
 
                    trans_data = (trans_id, tree_path)
2337
 
                    deferred_contents.append((file_id, trans_data))
 
2642
                    trans_data = (trans_id, file_id,
 
2643
                                  tree_path, entry.text_sha1)
 
2644
                    deferred_contents.append((tree_path, trans_data))
2338
2645
                else:
2339
 
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2340
 
                                                          tree)
 
2646
                    file_trans_id[file_id] = new_by_entry(
 
2647
                        tree_path, tt, entry, parent_id, tree)
2341
2648
                if reparent:
2342
2649
                    new_trans_id = file_trans_id[file_id]
2343
2650
                    old_parent = tt.trans_id_tree_path(tree_path)
2345
2652
            offset = num + 1 - len(deferred_contents)
2346
2653
            _create_files(tt, tree, deferred_contents, pb, offset,
2347
2654
                          accelerator_tree, hardlink)
2348
 
        finally:
2349
 
            pb.finished()
2350
2655
        pp.next_phase()
2351
2656
        divert_trans = set(file_trans_id[f] for f in divert)
2352
 
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
 
2657
 
 
2658
        def resolver(t, c): return resolve_checkout(t, c, divert_trans)
2353
2659
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2354
2660
        if len(raw_conflicts) > 0:
2355
2661
            precomputed_delta = None
2356
2662
        conflicts = cook_conflicts(raw_conflicts, tt)
2357
2663
        for conflict in conflicts:
2358
 
            warning(conflict)
 
2664
            trace.warning(text_type(conflict))
2359
2665
        try:
2360
2666
            wt.add_conflicts(conflicts)
2361
2667
        except errors.UnsupportedOperation:
2376
2682
        new_desired_files = desired_files
2377
2683
    else:
2378
2684
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2379
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
 
2685
        unchanged = [(p[0], p[1]) for (f, p, c, v, d, n, k, e)
2380
2686
                     in iter if not (c or e[0] != e[1])]
2381
2687
        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()]
 
2688
            unchanged = [(tp, ap) for (tp, ap) in unchanged
 
2689
                         if not next(accelerator_tree.iter_search_rules([ap]))]
2384
2690
        unchanged = dict(unchanged)
2385
2691
        new_desired_files = []
2386
2692
        count = 0
2387
 
        for file_id, (trans_id, tree_path) in desired_files:
2388
 
            accelerator_path = unchanged.get(file_id)
 
2693
        for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
 
2694
            accelerator_path = unchanged.get(tree_path)
2389
2695
            if accelerator_path is None:
2390
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
2696
                new_desired_files.append((tree_path,
 
2697
                                          (trans_id, file_id, tree_path, text_sha1)))
2391
2698
                continue
2392
 
            pb.update('Adding file contents', count + offset, total)
 
2699
            pb.update(gettext('Adding file contents'), count + offset, total)
2393
2700
            if hardlink:
2394
2701
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2395
2702
                                   trans_id)
2396
2703
            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
 
2704
                with accelerator_tree.get_file(accelerator_path, file_id) as f:
 
2705
                    chunks = osutils.file_iterator(f)
 
2706
                    if wt.supports_content_filtering():
 
2707
                        filters = wt._content_filter_stack(tree_path)
 
2708
                        chunks = filtered_output_bytes(chunks, filters,
 
2709
                                                       ContentFilterContext(tree_path, tree))
 
2710
                    tt.create_file(chunks, trans_id, sha1=text_sha1)
2410
2711
            count += 1
2411
2712
        offset += count
2412
 
    for count, ((trans_id, tree_path), contents) in enumerate(
 
2713
    for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
2413
2714
            tree.iter_files_bytes(new_desired_files)):
2414
2715
        if wt.supports_content_filtering():
2415
2716
            filters = wt._content_filter_stack(tree_path)
2416
2717
            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)
 
2718
                                             ContentFilterContext(tree_path, tree))
 
2719
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2720
        pb.update(gettext('Adding file contents'), count + offset, total)
2420
2721
 
2421
2722
 
2422
2723
def _reparent_children(tt, old_parent, new_parent):
2423
2724
    for child in tt.iter_tree_children(old_parent):
2424
2725
        tt.adjust_path(tt.final_name(child), new_parent, child)
2425
2726
 
 
2727
 
2426
2728
def _reparent_transform_children(tt, old_parent, new_parent):
2427
2729
    by_parent = tt.by_parent()
2428
2730
    for child in by_parent[old_parent]:
2429
2731
        tt.adjust_path(tt.final_name(child), new_parent, child)
2430
2732
    return by_parent[old_parent]
2431
2733
 
2432
 
def _content_match(tree, entry, file_id, kind, target_path):
 
2734
 
 
2735
def _content_match(tree, entry, tree_path, file_id, kind, target_path):
2433
2736
    if entry.kind != kind:
2434
2737
        return False
2435
2738
    if entry.kind == "directory":
2436
2739
        return True
2437
2740
    if entry.kind == "file":
2438
 
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2439
 
            return True
 
2741
        with open(target_path, 'rb') as f1, \
 
2742
                tree.get_file(tree_path, file_id) as f2:
 
2743
            if osutils.compare_files(f1, f2):
 
2744
                return True
2440
2745
    elif entry.kind == "symlink":
2441
 
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
 
2746
        if tree.get_symlink_target(tree_path, file_id) == os.readlink(target_path):
2442
2747
            return True
2443
2748
    return False
2444
2749
 
2461
2766
        # resolved
2462
2767
        final_parent = tt.final_parent(old_file)
2463
2768
        if new_file in divert:
2464
 
            new_name = tt.final_name(old_file)+'.diverted'
 
2769
            new_name = tt.final_name(old_file) + '.diverted'
2465
2770
            tt.adjust_path(new_name, final_parent, new_file)
2466
2771
            new_conflicts.add((c_type, 'Diverted to',
2467
2772
                               new_file, old_file))
2468
2773
        else:
2469
 
            new_name = tt.final_name(old_file)+'.moved'
 
2774
            new_name = tt.final_name(old_file) + '.moved'
2470
2775
            tt.adjust_path(new_name, final_parent, old_file)
2471
2776
            new_conflicts.add((c_type, 'Moved existing file to',
2472
2777
                               old_file, new_file))
2473
2778
    return new_conflicts
2474
2779
 
2475
2780
 
2476
 
def new_by_entry(tt, entry, parent_id, tree):
 
2781
def new_by_entry(path, tt, entry, parent_id, tree):
2477
2782
    """Create a new file according to its inventory entry"""
2478
2783
    name = entry.name
2479
2784
    kind = entry.kind
2480
2785
    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)
 
2786
        with tree.get_file(path, entry.file_id) as f:
 
2787
            executable = tree.is_executable(path, entry.file_id)
 
2788
            return tt.new_file(
 
2789
                name, parent_id, osutils.file_iterator(f), entry.file_id,
 
2790
                executable)
2485
2791
    elif kind in ('directory', 'tree-reference'):
2486
2792
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2487
2793
        if kind == 'tree-reference':
2488
2794
            tt.set_tree_reference(entry.reference_revision, trans_id)
2489
2795
        return trans_id
2490
2796
    elif kind == 'symlink':
2491
 
        target = tree.get_symlink_target(entry.file_id)
 
2797
        target = tree.get_symlink_target(path, entry.file_id)
2492
2798
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2493
2799
    else:
2494
2800
        raise errors.BadFileKindError(name, kind)
2495
2801
 
2496
2802
 
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):
 
2803
def create_from_tree(tt, trans_id, tree, path, file_id=None, chunks=None,
 
2804
                     filter_tree_path=None):
2515
2805
    """Create new file contents according to tree contents.
2516
 
    
 
2806
 
2517
2807
    :param filter_tree_path: the tree path to use to lookup
2518
2808
      content filters to apply to the bytes output in the working tree.
2519
2809
      This only applies if the working tree supports content filtering.
2520
2810
    """
2521
 
    kind = tree.kind(file_id)
 
2811
    kind = tree.kind(path, file_id)
2522
2812
    if kind == 'directory':
2523
2813
        tt.create_directory(trans_id)
2524
2814
    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)
 
2815
        if chunks is None:
 
2816
            f = tree.get_file(path, file_id)
 
2817
            chunks = osutils.file_iterator(f)
 
2818
        else:
 
2819
            f = None
 
2820
        try:
 
2821
            wt = tt._tree
 
2822
            if wt.supports_content_filtering() and filter_tree_path is not None:
 
2823
                filters = wt._content_filter_stack(filter_tree_path)
 
2824
                chunks = filtered_output_bytes(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:
 
2875
    with ui.ui_factory.nested_progress_bar() as child_pb:
2632
2876
        raw_conflicts = resolve_conflicts(tt, child_pb,
2633
 
            lambda t, c: conflict_pass(t, c, target_tree))
2634
 
    finally:
2635
 
        child_pb.finished()
 
2877
                                          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(target_tree,
 
2891
                                            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
2999
                bytes = filtered_output_bytes(bytes, filters,
2744
 
                    ContentFilterContext(filter_tree_path, working_tree))
 
3000
                                              ContentFilterContext(filter_tree_path, working_tree))
2745
3001
                tt.create_file(bytes, trans_id, mode_id)
2746
3002
        else:
2747
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2748
 
                deferred_files):
 
3003
            for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
 
3004
                    deferred_files):
2749
3005
                tt.create_file(bytes, trans_id, mode_id)
2750
3006
        tt.fixup_new_roots()
2751
3007
    finally:
2759
3015
    if pass_func is None:
2760
3016
        pass_func = conflict_pass
2761
3017
    new_conflicts = set()
2762
 
    pb = ui.ui_factory.nested_progress_bar()
2763
 
    try:
 
3018
    with ui.ui_factory.nested_progress_bar() as pb:
2764
3019
        for n in range(10):
2765
 
            pb.update('Resolution pass', n+1, 10)
 
3020
            pb.update(gettext('Resolution pass'), n + 1, 10)
2766
3021
            conflicts = tt.find_conflicts()
2767
3022
            if len(conflicts) == 0:
2768
3023
                return new_conflicts
2769
3024
            new_conflicts.update(pass_func(tt, conflicts))
2770
3025
        raise MalformedTransform(conflicts=conflicts)
2771
 
    finally:
2772
 
        pb.finished()
2773
3026
 
2774
3027
 
2775
3028
def conflict_pass(tt, conflicts, path_tree=None):
2792
3045
                existing_file, new_file = conflict[2], conflict[1]
2793
3046
            else:
2794
3047
                existing_file, new_file = conflict[1], conflict[2]
2795
 
            new_name = tt.final_name(existing_file)+'.moved'
 
3048
            new_name = tt.final_name(existing_file) + '.moved'
2796
3049
            tt.adjust_path(new_name, final_parent, existing_file)
2797
3050
            new_conflicts.add((c_type, 'Moved existing file to',
2798
3051
                               existing_file, new_file))
2807
3060
 
2808
3061
        elif c_type == 'missing parent':
2809
3062
            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:
 
3063
            if trans_id in tt._removed_contents:
 
3064
                cancel_deletion = True
 
3065
                orphans = tt._get_potential_orphans(trans_id)
 
3066
                if orphans:
 
3067
                    cancel_deletion = False
 
3068
                    # All children are orphans
 
3069
                    for o in orphans:
 
3070
                        try:
 
3071
                            tt.new_orphan(o, trans_id)
 
3072
                        except OrphaningError:
 
3073
                            # Something bad happened so we cancel the directory
 
3074
                            # deletion which will leave it in place with a
 
3075
                            # conflict. The user can deal with it from there.
 
3076
                            # Note that this also catch the case where we don't
 
3077
                            # want to create orphans and leave the directory in
 
3078
                            # place.
 
3079
                            cancel_deletion = True
 
3080
                            break
 
3081
                if cancel_deletion:
 
3082
                    # Cancel the directory deletion
 
3083
                    tt.cancel_deletion(trans_id)
 
3084
                    new_conflicts.add(('deleting parent', 'Not deleting',
 
3085
                                       trans_id))
 
3086
            else:
2815
3087
                create = True
2816
3088
                try:
2817
3089
                    tt.final_name(trans_id)
2820
3092
                        file_id = tt.final_file_id(trans_id)
2821
3093
                        if file_id is None:
2822
3094
                            file_id = tt.inactive_file_id(trans_id)
2823
 
                        entry = path_tree.inventory[file_id]
 
3095
                        _, entry = next(path_tree.iter_entries_by_dir(
 
3096
                            specific_files=[path_tree.id2path(file_id)]))
2824
3097
                        # special-case the other tree root (move its
2825
3098
                        # children to current root)
2826
3099
                        if entry.parent_id is None:
2841
3114
        elif c_type == 'unversioned parent':
2842
3115
            file_id = tt.inactive_file_id(conflict[1])
2843
3116
            # 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
 
3117
            if path_tree and path_tree.path2id('') == file_id:
 
3118
                    # This is the root entry, skip it
 
3119
                continue
2847
3120
            tt.version_file(file_id, conflict[1])
2848
3121
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2849
3122
        elif c_type == 'non-directory parent':
2852
3125
            parent_name = tt.final_name(parent_id)
2853
3126
            parent_file_id = tt.final_file_id(parent_id)
2854
3127
            new_parent_id = tt.new_directory(parent_name + '.new',
2855
 
                parent_parent, parent_file_id)
 
3128
                                             parent_parent, parent_file_id)
2856
3129
            _reparent_transform_children(tt, parent_id, new_parent_id)
2857
3130
            if parent_file_id is not None:
2858
3131
                tt.unversion_file(parent_id)
2864
3137
 
2865
3138
def cook_conflicts(raw_conflicts, tt):
2866
3139
    """Generate a list of cooked conflicts, sorted by file path"""
2867
 
    from bzrlib.conflicts import Conflict
2868
3140
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2869
 
    return sorted(conflict_iter, key=Conflict.sort_key)
 
3141
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
2870
3142
 
2871
3143
 
2872
3144
def iter_cook_conflicts(raw_conflicts, tt):
2873
 
    from bzrlib.conflicts import Conflict
2874
3145
    fp = FinalPaths(tt)
2875
3146
    for conflict in raw_conflicts:
2876
3147
        c_type = conflict[0]
2878
3149
        modified_path = fp.get_path(conflict[2])
2879
3150
        modified_id = tt.final_file_id(conflict[2])
2880
3151
        if len(conflict) == 3:
2881
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
2882
 
                                     file_id=modified_id)
 
3152
            yield conflicts.Conflict.factory(
 
3153
                c_type, action=action, path=modified_path, file_id=modified_id)
2883
3154
 
2884
3155
        else:
2885
3156
            conflicting_path = fp.get_path(conflict[3])
2886
3157
            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)
 
3158
            yield conflicts.Conflict.factory(
 
3159
                c_type, action=action, path=modified_path,
 
3160
                file_id=modified_id,
 
3161
                conflict_path=conflicting_path,
 
3162
                conflict_file_id=conflicting_id)
2891
3163
 
2892
3164
 
2893
3165
class _FileMover(object):
2900
3172
    def rename(self, from_, to):
2901
3173
        """Rename a file from one path to another."""
2902
3174
        try:
2903
 
            osutils.rename(from_, to)
2904
 
        except OSError, e:
 
3175
            os.rename(from_, to)
 
3176
        except OSError as e:
2905
3177
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2906
3178
                raise errors.FileExists(to, str(e))
2907
 
            raise
 
3179
            # normal OSError doesn't include filenames so it's hard to see where
 
3180
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
 
3181
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
2908
3182
        self.past_renames.append((from_, to))
2909
3183
 
2910
3184
    def pre_delete(self, from_, to):
2920
3194
    def rollback(self):
2921
3195
        """Reverse all renames that have been performed"""
2922
3196
        for from_, to in reversed(self.past_renames):
2923
 
            osutils.rename(to, from_)
 
3197
            try:
 
3198
                os.rename(to, from_)
 
3199
            except OSError as e:
 
3200
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
2924
3201
        # after rollback, don't reuse _FileMover
2925
3202
        past_renames = None
2926
3203
        pending_deletions = None
2932
3209
        # after apply_deletions, don't reuse _FileMover
2933
3210
        past_renames = None
2934
3211
        pending_deletions = None
 
3212
 
 
3213
 
 
3214
def link_tree(target_tree, source_tree):
 
3215
    """Where possible, hard-link files in a tree to those in another tree.
 
3216
 
 
3217
    :param target_tree: Tree to change
 
3218
    :param source_tree: Tree to hard-link from
 
3219
    """
 
3220
    tt = TreeTransform(target_tree)
 
3221
    try:
 
3222
        for (file_id, paths, changed_content, versioned, parent, name, kind,
 
3223
             executable) in target_tree.iter_changes(source_tree,
 
3224
                                                     include_unchanged=True):
 
3225
            if changed_content:
 
3226
                continue
 
3227
            if kind != ('file', 'file'):
 
3228
                continue
 
3229
            if executable[0] != executable[1]:
 
3230
                continue
 
3231
            trans_id = tt.trans_id_tree_path(paths[1])
 
3232
            tt.delete_contents(trans_id)
 
3233
            tt.create_hardlink(source_tree.abspath(paths[0]), trans_id)
 
3234
        tt.apply()
 
3235
    finally:
 
3236
        tt.finalize()