/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2020-06-01 19:35:12 UTC
  • mfrom: (7490.29.10 work)
  • mto: This revision was merged to the branch mainline in revision 7507.
  • Revision ID: jelmer@jelmer.uk-20200601193512-yx77edrbrs12d0qy
Merge lp:brz/3.1.

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