/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: 2019-06-21 11:21:12 UTC
  • mto: This revision was merged to the branch mainline in revision 7352.
  • Revision ID: jelmer@jelmer.uk-20190621112112-v0uorrdgqib5z1ur
For python 2.x, install sphinx 1.8.5. Newer versions don't support python 2.

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