/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 bzrlib/transform.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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