/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2019-02-04 01:01:24 UTC
  • mto: This revision was merged to the branch mainline in revision 7268.
  • Revision ID: jelmer@jelmer.uk-20190204010124-ni0i4qc6f5tnbvux
Fix source tests.

Show diffs side-by-side

added added

removed removed

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