/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: 2020-01-12 13:56:10 UTC
  • mto: This revision was merged to the branch mainline in revision 7443.
  • Revision ID: jelmer@jelmer.uk-20200112135610-0a9bct6x4cw7he6y
Add strip_segment_parameters function.

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