/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2019-12-22 13:21:36 UTC
  • mfrom: (7413.6.1 prober-features)
  • Revision ID: breezy.the.bot@gmail.com-20191222132136-v7g7cv3zepxhzj6x
Add an optional priority method for probers.

Merged from https://code.launchpad.net/~jelmer/brz/prober-features/+merge/375187

Show diffs side-by-side

added added

removed removed

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