/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2019-03-05 07:32:38 UTC
  • mto: (7290.1.21 work)
  • mto: This revision was merged to the branch mainline in revision 7311.
  • Revision ID: jelmer@jelmer.uk-20190305073238-zlqn981opwnqsmzi
Add appveyor configuration.

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
import contextlib
 
17
from __future__ import absolute_import
 
18
 
18
19
import os
19
20
import errno
20
21
from stat import S_ISREG, S_IEXEC
22
23
 
23
24
from . import (
24
25
    config as _mod_config,
25
 
    controldir,
26
26
    errors,
27
27
    lazy_import,
28
 
    lock,
29
 
    osutils,
30
28
    registry,
31
29
    trace,
 
30
    tree,
32
31
    )
33
32
lazy_import.lazy_import(globals(), """
34
33
from breezy import (
 
34
    annotate,
 
35
    bencode,
 
36
    controldir,
 
37
    commit,
 
38
    conflicts,
 
39
    delta,
 
40
    lock,
35
41
    multiparent,
 
42
    osutils,
36
43
    revision as _mod_revision,
37
44
    ui,
38
45
    urlutils,
39
46
    )
 
47
from breezy.bzr import (
 
48
    inventory,
 
49
    inventorytree,
 
50
    )
40
51
from breezy.i18n import gettext
41
52
""")
42
 
 
43
 
from .errors import (DuplicateKey,
44
 
                     BzrError, InternalBzrError)
 
53
from .errors import (DuplicateKey, MalformedTransform,
 
54
                     ReusingTransform, CantMoveRoot,
 
55
                     ImmortalLimbo, NoFinalPath,
 
56
                     UnableCreateSymlink)
45
57
from .filters import filtered_output_bytes, ContentFilterContext
46
58
from .mutabletree import MutableTree
47
59
from .osutils import (
48
60
    delete_any,
49
61
    file_kind,
 
62
    has_symlinks,
50
63
    pathjoin,
51
64
    sha_file,
52
65
    splitpath,
53
 
    supports_symlinks,
54
66
    )
55
67
from .progress import ProgressPhase
 
68
from .sixish import (
 
69
    text_type,
 
70
    viewitems,
 
71
    viewvalues,
 
72
    )
56
73
from .tree import (
57
 
    InterTree,
58
74
    find_previous_path,
59
75
    )
60
76
 
62
78
ROOT_PARENT = "root-parent"
63
79
 
64
80
 
65
 
class NoFinalPath(BzrError):
66
 
 
67
 
    _fmt = ("No final name for trans_id %(trans_id)r\n"
68
 
            "root trans-id: %(root_trans_id)r\n")
69
 
 
70
 
    def __init__(self, trans_id, transform):
71
 
        self.trans_id = trans_id
72
 
        self.root_trans_id = transform.root
73
 
 
74
 
 
75
 
class ReusingTransform(BzrError):
76
 
 
77
 
    _fmt = "Attempt to reuse a transform that has already been applied."
78
 
 
79
 
 
80
 
class MalformedTransform(InternalBzrError):
81
 
 
82
 
    _fmt = "Tree transform is malformed %(conflicts)r"
83
 
 
84
 
 
85
 
class CantMoveRoot(BzrError):
86
 
 
87
 
    _fmt = "Moving the root directory is not supported at this time"
88
 
 
89
 
 
90
 
class ImmortalLimbo(BzrError):
91
 
 
92
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
93
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
94
 
    keep, and delete it when you are done."""
95
 
 
96
 
    def __init__(self, limbo_dir):
97
 
        BzrError.__init__(self)
98
 
        self.limbo_dir = limbo_dir
99
 
 
100
 
 
101
 
class TransformRenameFailed(BzrError):
102
 
 
103
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
104
 
 
105
 
    def __init__(self, from_path, to_path, why, errno):
106
 
        self.from_path = from_path
107
 
        self.to_path = to_path
108
 
        self.why = why
109
 
        self.errno = errno
110
 
 
111
 
 
112
81
def unique_add(map, key, value):
113
82
    if key in map:
114
83
        raise DuplicateKey(key=key)
116
85
 
117
86
 
118
87
class _TransformResults(object):
119
 
 
120
88
    def __init__(self, modified_paths, rename_count):
121
89
        object.__init__(self)
122
90
        self.modified_paths = modified_paths
123
91
        self.rename_count = rename_count
124
92
 
125
93
 
126
 
class TreeTransform(object):
127
 
    """Represent a tree transformation.
128
 
 
129
 
    This object is designed to support incremental generation of the transform,
130
 
    in any order.
131
 
 
132
 
    However, it gives optimum performance when parent directories are created
133
 
    before their contents.  The transform is then able to put child files
134
 
    directly in their parent directory, avoiding later renames.
135
 
 
136
 
    It is easy to produce malformed transforms, but they are generally
137
 
    harmless.  Attempting to apply a malformed transform will cause an
138
 
    exception to be raised before any modifications are made to the tree.
139
 
 
140
 
    Many kinds of malformed transforms can be corrected with the
141
 
    resolve_conflicts function.  The remaining ones indicate programming error,
142
 
    such as trying to create a file with no path.
143
 
 
144
 
    Two sets of file creation methods are supplied.  Convenience methods are:
145
 
     * new_file
146
 
     * new_directory
147
 
     * new_symlink
148
 
 
149
 
    These are composed of the low-level methods:
150
 
     * create_path
151
 
     * create_file or create_directory or create_symlink
152
 
     * version_file
153
 
     * set_executability
154
 
 
155
 
    Transform/Transaction ids
156
 
    -------------------------
157
 
    trans_ids are temporary ids assigned to all files involved in a transform.
158
 
    It's possible, even common, that not all files in the Tree have trans_ids.
159
 
 
160
 
    trans_ids are only valid for the TreeTransform that generated them.
161
 
    """
162
 
 
163
 
    def __init__(self, tree, pb=None):
 
94
class TreeTransformBase(object):
 
95
    """The base class for TreeTransform and its kin."""
 
96
 
 
97
    def __init__(self, tree, pb=None, case_sensitive=True):
 
98
        """Constructor.
 
99
 
 
100
        :param tree: The tree that will be transformed, but not necessarily
 
101
            the output tree.
 
102
        :param pb: ignored
 
103
        :param case_sensitive: If True, the target of the transform is
 
104
            case sensitive, not just case preserving.
 
105
        """
 
106
        object.__init__(self)
164
107
        self._tree = tree
165
 
        # A progress bar
166
 
        self._pb = pb
167
108
        self._id_number = 0
168
 
        # Mapping of path in old tree -> trans_id
169
 
        self._tree_path_ids = {}
170
 
        # Mapping trans_id -> path in old tree
171
 
        self._tree_id_paths = {}
172
109
        # mapping of trans_id -> new basename
173
110
        self._new_name = {}
174
111
        # mapping of trans_id -> new parent trans_id
175
112
        self._new_parent = {}
176
113
        # mapping of trans_id with new contents -> new file_kind
177
114
        self._new_contents = {}
 
115
        # mapping of trans_id => (sha1 of content, stat_value)
 
116
        self._observed_sha1s = {}
178
117
        # Set of trans_ids whose contents will be removed
179
118
        self._removed_contents = set()
180
119
        # Mapping of trans_id -> new execute-bit value
181
120
        self._new_executability = {}
182
121
        # Mapping of trans_id -> new tree-reference value
183
122
        self._new_reference_revision = {}
 
123
        # Mapping of trans_id -> new file_id
 
124
        self._new_id = {}
 
125
        # Mapping of old file-id -> trans_id
 
126
        self._non_present_ids = {}
 
127
        # Mapping of new file_id -> trans_id
 
128
        self._r_new_id = {}
184
129
        # Set of trans_ids that will be removed
185
130
        self._removed_id = set()
 
131
        # Mapping of path in old tree -> trans_id
 
132
        self._tree_path_ids = {}
 
133
        # Mapping trans_id -> path in old tree
 
134
        self._tree_id_paths = {}
 
135
        # The trans_id that will be used as the tree root
 
136
        if tree.is_versioned(''):
 
137
            self._new_root = self.trans_id_tree_path('')
 
138
        else:
 
139
            self._new_root = None
186
140
        # Indicator of whether the transform has been applied
187
141
        self._done = False
 
142
        # A progress bar
 
143
        self._pb = pb
 
144
        # Whether the target is case sensitive
 
145
        self._case_sensitive_target = case_sensitive
 
146
        # A counter of how many files have been renamed
 
147
        self.rename_count = 0
188
148
 
189
149
    def __enter__(self):
190
150
        """Support Context Manager API."""
194
154
        """Support Context Manager API."""
195
155
        self.finalize()
196
156
 
197
 
    def iter_tree_children(self, trans_id):
198
 
        """Iterate through the entry's tree children, if any.
199
 
 
200
 
        :param trans_id: trans id to iterate
201
 
        :returns: Iterator over paths
202
 
        """
203
 
        raise NotImplementedError(self.iter_tree_children)
204
 
 
205
 
    def canonical_path(self, path):
206
 
        return path
207
 
 
208
 
    def tree_kind(self, trans_id):
209
 
        raise NotImplementedError(self.tree_kind)
210
 
 
211
 
    def by_parent(self):
212
 
        """Return a map of parent: children for known parents.
213
 
 
214
 
        Only new paths and parents of tree files with assigned ids are used.
215
 
        """
216
 
        by_parent = {}
217
 
        items = list(self._new_parent.items())
218
 
        items.extend((t, self.final_parent(t))
219
 
                     for t in list(self._tree_id_paths))
220
 
        for trans_id, parent_id in items:
221
 
            if parent_id not in by_parent:
222
 
                by_parent[parent_id] = set()
223
 
            by_parent[parent_id].add(trans_id)
224
 
        return by_parent
225
 
 
226
157
    def finalize(self):
227
158
        """Release the working tree lock, if held.
228
159
 
229
160
        This is required if apply has not been invoked, but can be invoked
230
161
        even after apply.
231
162
        """
232
 
        raise NotImplementedError(self.finalize)
 
163
        if self._tree is None:
 
164
            return
 
165
        for hook in MutableTree.hooks['post_transform']:
 
166
            hook(self._tree, self)
 
167
        self._tree.unlock()
 
168
        self._tree = None
 
169
 
 
170
    def __get_root(self):
 
171
        return self._new_root
 
172
 
 
173
    root = property(__get_root)
 
174
 
 
175
    def _assign_id(self):
 
176
        """Produce a new tranform id"""
 
177
        new_id = "new-%s" % self._id_number
 
178
        self._id_number += 1
 
179
        return new_id
233
180
 
234
181
    def create_path(self, name, parent):
235
182
        """Assign a transaction id to a new path"""
236
 
        trans_id = self.assign_id()
 
183
        trans_id = self._assign_id()
237
184
        unique_add(self._new_name, trans_id, name)
238
185
        unique_add(self._new_parent, trans_id, parent)
239
186
        return trans_id
242
189
        """Change the path that is assigned to a transaction id."""
243
190
        if parent is None:
244
191
            raise ValueError("Parent trans-id may not be None")
245
 
        if trans_id == self.root:
 
192
        if trans_id == self._new_root:
246
193
            raise CantMoveRoot
247
194
        self._new_name[trans_id] = name
248
195
        self._new_parent[trans_id] = parent
256
203
        physically new directory, and hope someone versions the tree root
257
204
        later.
258
205
        """
259
 
        raise NotImplementedError(self.adjust_root_path)
 
206
        old_root = self._new_root
 
207
        old_root_file_id = self.final_file_id(old_root)
 
208
        # force moving all children of root
 
209
        for child_id in self.iter_tree_children(old_root):
 
210
            if child_id != parent:
 
211
                self.adjust_path(self.final_name(child_id),
 
212
                                 self.final_parent(child_id), child_id)
 
213
            file_id = self.final_file_id(child_id)
 
214
            if file_id is not None:
 
215
                self.unversion_file(child_id)
 
216
            self.version_file(file_id, child_id)
 
217
 
 
218
        # the physical root needs a new transaction id
 
219
        self._tree_path_ids.pop("")
 
220
        self._tree_id_paths.pop(old_root)
 
221
        self._new_root = self.trans_id_tree_path('')
 
222
        if parent == old_root:
 
223
            parent = self._new_root
 
224
        self.adjust_path(name, parent, old_root)
 
225
        self.create_directory(old_root)
 
226
        self.version_file(old_root_file_id, old_root)
 
227
        self.unversion_file(self._new_root)
260
228
 
261
229
    def fixup_new_roots(self):
262
230
        """Reinterpret requests to change the root directory
268
236
        This means that the old root trans-id becomes obsolete, so it is
269
237
        recommended only to invoke this after the root trans-id has become
270
238
        irrelevant.
271
 
        """
272
 
        raise NotImplementedError(self.fixup_new_roots)
273
 
 
274
 
    def assign_id(self):
275
 
        """Produce a new tranform id"""
276
 
        new_id = "new-%s" % self._id_number
277
 
        self._id_number += 1
278
 
        return new_id
 
239
 
 
240
        """
 
241
        new_roots = [k for k, v in viewitems(self._new_parent)
 
242
                     if v == ROOT_PARENT]
 
243
        if len(new_roots) < 1:
 
244
            return
 
245
        if len(new_roots) != 1:
 
246
            raise ValueError('A tree cannot have two roots!')
 
247
        if self._new_root is None:
 
248
            self._new_root = new_roots[0]
 
249
            return
 
250
        old_new_root = new_roots[0]
 
251
        # unversion the new root's directory.
 
252
        if self.final_kind(self._new_root) is None:
 
253
            file_id = self.final_file_id(old_new_root)
 
254
        else:
 
255
            file_id = self.final_file_id(self._new_root)
 
256
        if old_new_root in self._new_id:
 
257
            self.cancel_versioning(old_new_root)
 
258
        else:
 
259
            self.unversion_file(old_new_root)
 
260
        # if, at this stage, root still has an old file_id, zap it so we can
 
261
        # stick a new one in.
 
262
        if (self.tree_file_id(self._new_root) is not None
 
263
                and self._new_root not in self._removed_id):
 
264
            self.unversion_file(self._new_root)
 
265
        if file_id is not None:
 
266
            self.version_file(file_id, self._new_root)
 
267
 
 
268
        # Now move children of new root into old root directory.
 
269
        # Ensure all children are registered with the transaction, but don't
 
270
        # use directly-- some tree children have new parents
 
271
        list(self.iter_tree_children(old_new_root))
 
272
        # Move all children of new root into old root directory.
 
273
        for child in self.by_parent().get(old_new_root, []):
 
274
            self.adjust_path(self.final_name(child), self._new_root, child)
 
275
 
 
276
        # Ensure old_new_root has no directory.
 
277
        if old_new_root in self._new_contents:
 
278
            self.cancel_creation(old_new_root)
 
279
        else:
 
280
            self.delete_contents(old_new_root)
 
281
 
 
282
        # prevent deletion of root directory.
 
283
        if self._new_root in self._removed_contents:
 
284
            self.cancel_deletion(self._new_root)
 
285
 
 
286
        # destroy path info for old_new_root.
 
287
        del self._new_parent[old_new_root]
 
288
        del self._new_name[old_new_root]
 
289
 
 
290
    def trans_id_file_id(self, file_id):
 
291
        """Determine or set the transaction id associated with a file ID.
 
292
        A new id is only created for file_ids that were never present.  If
 
293
        a transaction has been unversioned, it is deliberately still returned.
 
294
        (this will likely lead to an unversioned parent conflict.)
 
295
        """
 
296
        if file_id is None:
 
297
            raise ValueError('None is not a valid file id')
 
298
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
 
299
            return self._r_new_id[file_id]
 
300
        else:
 
301
            try:
 
302
                path = self._tree.id2path(file_id)
 
303
            except errors.NoSuchId:
 
304
                if file_id in self._non_present_ids:
 
305
                    return self._non_present_ids[file_id]
 
306
                else:
 
307
                    trans_id = self._assign_id()
 
308
                    self._non_present_ids[file_id] = trans_id
 
309
                    return trans_id
 
310
            else:
 
311
                return self.trans_id_tree_path(path)
279
312
 
280
313
    def trans_id_tree_path(self, path):
281
314
        """Determine (and maybe set) the transaction ID for a tree path."""
282
315
        path = self.canonical_path(path)
283
316
        if path not in self._tree_path_ids:
284
 
            self._tree_path_ids[path] = self.assign_id()
 
317
            self._tree_path_ids[path] = self._assign_id()
285
318
            self._tree_id_paths[self._tree_path_ids[path]] = path
286
319
        return self._tree_path_ids[path]
287
320
 
302
335
        """Cancel a scheduled deletion"""
303
336
        self._removed_contents.remove(trans_id)
304
337
 
 
338
    def unversion_file(self, trans_id):
 
339
        """Schedule a path entry to become unversioned"""
 
340
        self._removed_id.add(trans_id)
 
341
 
305
342
    def delete_versioned(self, trans_id):
306
343
        """Delete and unversion a versioned file"""
307
344
        self.delete_contents(trans_id)
320
357
        """Set the reference associated with a directory"""
321
358
        unique_add(self._new_reference_revision, trans_id, revision_id)
322
359
 
323
 
    def version_file(self, trans_id, file_id=None):
 
360
    def version_file(self, file_id, trans_id):
324
361
        """Schedule a file to become versioned."""
325
 
        raise NotImplementedError(self.version_file)
 
362
        if file_id is None:
 
363
            raise ValueError()
 
364
        unique_add(self._new_id, trans_id, file_id)
 
365
        unique_add(self._r_new_id, file_id, trans_id)
326
366
 
327
367
    def cancel_versioning(self, trans_id):
328
368
        """Undo a previous versioning of a file"""
329
 
        raise NotImplementedError(self.cancel_versioning)
330
 
 
331
 
    def unversion_file(self, trans_id):
332
 
        """Schedule a path entry to become unversioned"""
333
 
        self._removed_id.add(trans_id)
 
369
        file_id = self._new_id[trans_id]
 
370
        del self._new_id[trans_id]
 
371
        del self._r_new_id[file_id]
334
372
 
335
373
    def new_paths(self, filesystem_only=False):
336
374
        """Determine the paths of all new and changed files.
338
376
        :param filesystem_only: if True, only calculate values for files
339
377
            that require renames or execute bit changes.
340
378
        """
341
 
        raise NotImplementedError(self.new_paths)
 
379
        new_ids = set()
 
380
        if filesystem_only:
 
381
            stale_ids = self._needs_rename.difference(self._new_name)
 
382
            stale_ids.difference_update(self._new_parent)
 
383
            stale_ids.difference_update(self._new_contents)
 
384
            stale_ids.difference_update(self._new_id)
 
385
            needs_rename = self._needs_rename.difference(stale_ids)
 
386
            id_sets = (needs_rename, self._new_executability)
 
387
        else:
 
388
            id_sets = (self._new_name, self._new_parent, self._new_contents,
 
389
                       self._new_id, self._new_executability)
 
390
        for id_set in id_sets:
 
391
            new_ids.update(id_set)
 
392
        return sorted(FinalPaths(self).get_paths(new_ids))
 
393
 
 
394
    def _inventory_altered(self):
 
395
        """Determine which trans_ids need new Inventory entries.
 
396
 
 
397
        An new entry is needed when anything that would be reflected by an
 
398
        inventory entry changes, including file name, file_id, parent file_id,
 
399
        file kind, and the execute bit.
 
400
 
 
401
        Some care is taken to return entries with real changes, not cases
 
402
        where the value is deleted and then restored to its original value,
 
403
        but some actually unchanged values may be returned.
 
404
 
 
405
        :returns: A list of (path, trans_id) for all items requiring an
 
406
            inventory change. Ordered by path.
 
407
        """
 
408
        changed_ids = set()
 
409
        # Find entries whose file_ids are new (or changed).
 
410
        new_file_id = set(t for t in self._new_id
 
411
                          if self._new_id[t] != self.tree_file_id(t))
 
412
        for id_set in [self._new_name, self._new_parent, new_file_id,
 
413
                       self._new_executability]:
 
414
            changed_ids.update(id_set)
 
415
        # removing implies a kind change
 
416
        changed_kind = set(self._removed_contents)
 
417
        # so does adding
 
418
        changed_kind.intersection_update(self._new_contents)
 
419
        # Ignore entries that are already known to have changed.
 
420
        changed_kind.difference_update(changed_ids)
 
421
        #  to keep only the truly changed ones
 
422
        changed_kind = (t for t in changed_kind
 
423
                        if self.tree_kind(t) != self.final_kind(t))
 
424
        # all kind changes will alter the inventory
 
425
        changed_ids.update(changed_kind)
 
426
        # To find entries with changed parent_ids, find parents which existed,
 
427
        # but changed file_id.
 
428
        # Now add all their children to the set.
 
429
        for parent_trans_id in new_file_id:
 
430
            changed_ids.update(self.iter_tree_children(parent_trans_id))
 
431
        return sorted(FinalPaths(self).get_paths(changed_ids))
342
432
 
343
433
    def final_kind(self, trans_id):
344
434
        """Determine the final file kind, after any changes applied.
348
438
            contents insertion command)
349
439
        """
350
440
        if trans_id in self._new_contents:
351
 
            if trans_id in self._new_reference_revision:
352
 
                return 'tree-reference'
353
441
            return self._new_contents[trans_id]
354
442
        elif trans_id in self._removed_contents:
355
443
            return None
360
448
        """Determine the tree path associated with the trans_id."""
361
449
        return self._tree_id_paths.get(trans_id)
362
450
 
363
 
    def final_is_versioned(self, trans_id):
364
 
        raise NotImplementedError(self.final_is_versioned)
 
451
    def tree_file_id(self, trans_id):
 
452
        """Determine the file id associated with the trans_id in the tree"""
 
453
        path = self.tree_path(trans_id)
 
454
        if path is None:
 
455
            return None
 
456
        # the file is old; the old id is still valid
 
457
        if self._new_root == trans_id:
 
458
            return self._tree.get_root_id()
 
459
        return self._tree.path2id(path)
 
460
 
 
461
    def final_file_id(self, trans_id):
 
462
        """Determine the file id after any changes are applied, or None.
 
463
 
 
464
        None indicates that the file will not be versioned after changes are
 
465
        applied.
 
466
        """
 
467
        try:
 
468
            return self._new_id[trans_id]
 
469
        except KeyError:
 
470
            if trans_id in self._removed_id:
 
471
                return None
 
472
        return self.tree_file_id(trans_id)
 
473
 
 
474
    def inactive_file_id(self, trans_id):
 
475
        """Return the inactive file_id associated with a transaction id.
 
476
        That is, the one in the tree or in non_present_ids.
 
477
        The file_id may actually be active, too.
 
478
        """
 
479
        file_id = self.tree_file_id(trans_id)
 
480
        if file_id is not None:
 
481
            return file_id
 
482
        for key, value in viewitems(self._non_present_ids):
 
483
            if value == trans_id:
 
484
                return key
365
485
 
366
486
    def final_parent(self, trans_id):
367
487
        """Determine the parent file_id, after any changes are applied.
383
503
            except KeyError:
384
504
                raise NoFinalPath(trans_id, self)
385
505
 
 
506
    def by_parent(self):
 
507
        """Return a map of parent: children for known parents.
 
508
 
 
509
        Only new paths and parents of tree files with assigned ids are used.
 
510
        """
 
511
        by_parent = {}
 
512
        items = list(viewitems(self._new_parent))
 
513
        items.extend((t, self.final_parent(t))
 
514
                     for t in list(self._tree_id_paths))
 
515
        for trans_id, parent_id in items:
 
516
            if parent_id not in by_parent:
 
517
                by_parent[parent_id] = set()
 
518
            by_parent[parent_id].add(trans_id)
 
519
        return by_parent
 
520
 
386
521
    def path_changed(self, trans_id):
387
522
        """Return True if a trans_id's path has changed."""
388
523
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
390
525
    def new_contents(self, trans_id):
391
526
        return (trans_id in self._new_contents)
392
527
 
393
 
    def find_raw_conflicts(self):
 
528
    def find_conflicts(self):
394
529
        """Find any violations of inventory or filesystem invariants"""
395
 
        raise NotImplementedError(self.find_raw_conflicts)
 
530
        if self._done is True:
 
531
            raise ReusingTransform()
 
532
        conflicts = []
 
533
        # ensure all children of all existent parents are known
 
534
        # all children of non-existent parents are known, by definition.
 
535
        self._add_tree_children()
 
536
        by_parent = self.by_parent()
 
537
        conflicts.extend(self._unversioned_parents(by_parent))
 
538
        conflicts.extend(self._parent_loops())
 
539
        conflicts.extend(self._duplicate_entries(by_parent))
 
540
        conflicts.extend(self._duplicate_ids())
 
541
        conflicts.extend(self._parent_type_conflicts(by_parent))
 
542
        conflicts.extend(self._improper_versioning())
 
543
        conflicts.extend(self._executability_conflicts())
 
544
        conflicts.extend(self._overwrite_conflicts())
 
545
        return conflicts
 
546
 
 
547
    def _check_malformed(self):
 
548
        conflicts = self.find_conflicts()
 
549
        if len(conflicts) != 0:
 
550
            raise MalformedTransform(conflicts=conflicts)
 
551
 
 
552
    def _add_tree_children(self):
 
553
        """Add all the children of all active parents to the known paths.
 
554
 
 
555
        Active parents are those which gain children, and those which are
 
556
        removed.  This is a necessary first step in detecting conflicts.
 
557
        """
 
558
        parents = list(self.by_parent())
 
559
        parents.extend([t for t in self._removed_contents if
 
560
                        self.tree_kind(t) == 'directory'])
 
561
        for trans_id in self._removed_id:
 
562
            path = self.tree_path(trans_id)
 
563
            if path is not None:
 
564
                if self._tree.stored_kind(path) == 'directory':
 
565
                    parents.append(trans_id)
 
566
            elif self.tree_kind(trans_id) == 'directory':
 
567
                parents.append(trans_id)
 
568
 
 
569
        for parent_id in parents:
 
570
            # ensure that all children are registered with the transaction
 
571
            list(self.iter_tree_children(parent_id))
 
572
 
 
573
    def _has_named_child(self, name, parent_id, known_children):
 
574
        """Does a parent already have a name child.
 
575
 
 
576
        :param name: The searched for name.
 
577
 
 
578
        :param parent_id: The parent for which the check is made.
 
579
 
 
580
        :param known_children: The already known children. This should have
 
581
            been recently obtained from `self.by_parent.get(parent_id)`
 
582
            (or will be if None is passed).
 
583
        """
 
584
        if known_children is None:
 
585
            known_children = self.by_parent().get(parent_id, [])
 
586
        for child in known_children:
 
587
            if self.final_name(child) == name:
 
588
                return True
 
589
        parent_path = self._tree_id_paths.get(parent_id, None)
 
590
        if parent_path is None:
 
591
            # No parent... no children
 
592
            return False
 
593
        child_path = joinpath(parent_path, name)
 
594
        child_id = self._tree_path_ids.get(child_path, None)
 
595
        if child_id is None:
 
596
            # Not known by the tree transform yet, check the filesystem
 
597
            return osutils.lexists(self._tree.abspath(child_path))
 
598
        else:
 
599
            raise AssertionError('child_id is missing: %s, %s, %s'
 
600
                                 % (name, parent_id, child_id))
 
601
 
 
602
    def _available_backup_name(self, name, target_id):
 
603
        """Find an available backup name.
 
604
 
 
605
        :param name: The basename of the file.
 
606
 
 
607
        :param target_id: The directory trans_id where the backup should
 
608
            be placed.
 
609
        """
 
610
        known_children = self.by_parent().get(target_id, [])
 
611
        return osutils.available_backup_name(
 
612
            name,
 
613
            lambda base: self._has_named_child(
 
614
                base, target_id, known_children))
 
615
 
 
616
    def _parent_loops(self):
 
617
        """No entry should be its own ancestor"""
 
618
        conflicts = []
 
619
        for trans_id in self._new_parent:
 
620
            seen = set()
 
621
            parent_id = trans_id
 
622
            while parent_id != ROOT_PARENT:
 
623
                seen.add(parent_id)
 
624
                try:
 
625
                    parent_id = self.final_parent(parent_id)
 
626
                except KeyError:
 
627
                    break
 
628
                if parent_id == trans_id:
 
629
                    conflicts.append(('parent loop', trans_id))
 
630
                if parent_id in seen:
 
631
                    break
 
632
        return conflicts
 
633
 
 
634
    def _unversioned_parents(self, by_parent):
 
635
        """If parent directories are versioned, children must be versioned."""
 
636
        conflicts = []
 
637
        for parent_id, children in viewitems(by_parent):
 
638
            if parent_id == ROOT_PARENT:
 
639
                continue
 
640
            if self.final_file_id(parent_id) is not None:
 
641
                continue
 
642
            for child_id in children:
 
643
                if self.final_file_id(child_id) is not None:
 
644
                    conflicts.append(('unversioned parent', parent_id))
 
645
                    break
 
646
        return conflicts
 
647
 
 
648
    def _improper_versioning(self):
 
649
        """Cannot version a file with no contents, or a bad type.
 
650
 
 
651
        However, existing entries with no contents are okay.
 
652
        """
 
653
        conflicts = []
 
654
        for trans_id in self._new_id:
 
655
            kind = self.final_kind(trans_id)
 
656
            if kind is None:
 
657
                conflicts.append(('versioning no contents', trans_id))
 
658
                continue
 
659
            if not self._tree.versionable_kind(kind):
 
660
                conflicts.append(('versioning bad kind', trans_id, kind))
 
661
        return conflicts
 
662
 
 
663
    def _executability_conflicts(self):
 
664
        """Check for bad executability changes.
 
665
 
 
666
        Only versioned files may have their executability set, because
 
667
        1. only versioned entries can have executability under windows
 
668
        2. only files can be executable.  (The execute bit on a directory
 
669
           does not indicate searchability)
 
670
        """
 
671
        conflicts = []
 
672
        for trans_id in self._new_executability:
 
673
            if self.final_file_id(trans_id) is None:
 
674
                conflicts.append(('unversioned executability', trans_id))
 
675
            else:
 
676
                if self.final_kind(trans_id) != "file":
 
677
                    conflicts.append(('non-file executability', trans_id))
 
678
        return conflicts
 
679
 
 
680
    def _overwrite_conflicts(self):
 
681
        """Check for overwrites (not permitted on Win32)"""
 
682
        conflicts = []
 
683
        for trans_id in self._new_contents:
 
684
            if self.tree_kind(trans_id) is None:
 
685
                continue
 
686
            if trans_id not in self._removed_contents:
 
687
                conflicts.append(('overwrite', trans_id,
 
688
                                  self.final_name(trans_id)))
 
689
        return conflicts
 
690
 
 
691
    def _duplicate_entries(self, by_parent):
 
692
        """No directory may have two entries with the same name."""
 
693
        conflicts = []
 
694
        if (self._new_name, self._new_parent) == ({}, {}):
 
695
            return conflicts
 
696
        for children in viewvalues(by_parent):
 
697
            name_ids = []
 
698
            for child_tid in children:
 
699
                name = self.final_name(child_tid)
 
700
                if name is not None:
 
701
                    # Keep children only if they still exist in the end
 
702
                    if not self._case_sensitive_target:
 
703
                        name = name.lower()
 
704
                    name_ids.append((name, child_tid))
 
705
            name_ids.sort()
 
706
            last_name = None
 
707
            last_trans_id = None
 
708
            for name, trans_id in name_ids:
 
709
                kind = self.final_kind(trans_id)
 
710
                file_id = self.final_file_id(trans_id)
 
711
                if kind is None and file_id is None:
 
712
                    continue
 
713
                if name == last_name:
 
714
                    conflicts.append(('duplicate', last_trans_id, trans_id,
 
715
                                      name))
 
716
                last_name = name
 
717
                last_trans_id = trans_id
 
718
        return conflicts
 
719
 
 
720
    def _duplicate_ids(self):
 
721
        """Each inventory id may only be used once"""
 
722
        conflicts = []
 
723
        try:
 
724
            all_ids = self._tree.all_file_ids()
 
725
        except errors.UnsupportedOperation:
 
726
            # it's okay for non-file-id trees to raise UnsupportedOperation.
 
727
            return []
 
728
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
 
729
                                self._removed_id))
 
730
        active_tree_ids = all_ids.difference(removed_tree_ids)
 
731
        for trans_id, file_id in viewitems(self._new_id):
 
732
            if file_id in active_tree_ids:
 
733
                path = self._tree.id2path(file_id)
 
734
                old_trans_id = self.trans_id_tree_path(path)
 
735
                conflicts.append(('duplicate id', old_trans_id, trans_id))
 
736
        return conflicts
 
737
 
 
738
    def _parent_type_conflicts(self, by_parent):
 
739
        """Children must have a directory parent"""
 
740
        conflicts = []
 
741
        for parent_id, children in viewitems(by_parent):
 
742
            if parent_id == ROOT_PARENT:
 
743
                continue
 
744
            no_children = True
 
745
            for child_id in children:
 
746
                if self.final_kind(child_id) is not None:
 
747
                    no_children = False
 
748
                    break
 
749
            if no_children:
 
750
                continue
 
751
            # There is at least a child, so we need an existing directory to
 
752
            # contain it.
 
753
            kind = self.final_kind(parent_id)
 
754
            if kind is None:
 
755
                # The directory will be deleted
 
756
                conflicts.append(('missing parent', parent_id))
 
757
            elif kind != "directory":
 
758
                # Meh, we need a *directory* to put something in it
 
759
                conflicts.append(('non-directory parent', parent_id))
 
760
        return conflicts
 
761
 
 
762
    def _set_executability(self, path, trans_id):
 
763
        """Set the executability of versioned files """
 
764
        if self._tree._supports_executable():
 
765
            new_executability = self._new_executability[trans_id]
 
766
            abspath = self._tree.abspath(path)
 
767
            current_mode = os.stat(abspath).st_mode
 
768
            if new_executability:
 
769
                umask = os.umask(0)
 
770
                os.umask(umask)
 
771
                to_mode = current_mode | (0o100 & ~umask)
 
772
                # Enable x-bit for others only if they can read it.
 
773
                if current_mode & 0o004:
 
774
                    to_mode |= 0o001 & ~umask
 
775
                if current_mode & 0o040:
 
776
                    to_mode |= 0o010 & ~umask
 
777
            else:
 
778
                to_mode = current_mode & ~0o111
 
779
            osutils.chmod_if_possible(abspath, to_mode)
 
780
 
 
781
    def _new_entry(self, name, parent_id, file_id):
 
782
        """Helper function to create a new filesystem entry."""
 
783
        trans_id = self.create_path(name, parent_id)
 
784
        if file_id is not None:
 
785
            self.version_file(file_id, trans_id)
 
786
        return trans_id
396
787
 
397
788
    def new_file(self, name, parent_id, contents, file_id=None,
398
789
                 executable=None, sha1=None):
405
796
        :param file_id: The inventory ID of the file, if it is to be versioned.
406
797
        :param executable: Only valid when a file_id has been supplied.
407
798
        """
408
 
        raise NotImplementedError(self.new_file)
 
799
        trans_id = self._new_entry(name, parent_id, file_id)
 
800
        # TODO: rather than scheduling a set_executable call,
 
801
        # have create_file create the file with the right mode.
 
802
        self.create_file(contents, trans_id, sha1=sha1)
 
803
        if executable is not None:
 
804
            self.set_executability(executable, trans_id)
 
805
        return trans_id
409
806
 
410
807
    def new_directory(self, name, parent_id, file_id=None):
411
808
        """Convenience method to create directories.
415
812
        directory.
416
813
        file_id is the inventory ID of the directory, if it is to be versioned.
417
814
        """
418
 
        raise NotImplementedError(self.new_directory)
 
815
        trans_id = self._new_entry(name, parent_id, file_id)
 
816
        self.create_directory(trans_id)
 
817
        return trans_id
419
818
 
420
819
    def new_symlink(self, name, parent_id, target, file_id=None):
421
820
        """Convenience method to create symbolic link.
425
824
        target is a bytestring of the target of the symlink.
426
825
        file_id is the inventory ID of the file, if it is to be versioned.
427
826
        """
428
 
        raise NotImplementedError(self.new_symlink)
 
827
        trans_id = self._new_entry(name, parent_id, file_id)
 
828
        self.create_symlink(target, trans_id)
 
829
        return trans_id
429
830
 
430
831
    def new_orphan(self, trans_id, parent_id):
431
832
        """Schedule an item to be orphaned.
438
839
        """
439
840
        raise NotImplementedError(self.new_orphan)
440
841
 
 
842
    def _get_potential_orphans(self, dir_id):
 
843
        """Find the potential orphans in a directory.
 
844
 
 
845
        A directory can't be safely deleted if there are versioned files in it.
 
846
        If all the contained files are unversioned then they can be orphaned.
 
847
 
 
848
        The 'None' return value means that the directory contains at least one
 
849
        versioned file and should not be deleted.
 
850
 
 
851
        :param dir_id: The directory trans id.
 
852
 
 
853
        :return: A list of the orphan trans ids or None if at least one
 
854
             versioned file is present.
 
855
        """
 
856
        orphans = []
 
857
        # Find the potential orphans, stop if one item should be kept
 
858
        for child_tid in self.by_parent()[dir_id]:
 
859
            if child_tid in self._removed_contents:
 
860
                # The child is removed as part of the transform. Since it was
 
861
                # versioned before, it's not an orphan
 
862
                continue
 
863
            elif self.final_file_id(child_tid) is None:
 
864
                # The child is not versioned
 
865
                orphans.append(child_tid)
 
866
            else:
 
867
                # We have a versioned file here, searching for orphans is
 
868
                # meaningless.
 
869
                orphans = None
 
870
                break
 
871
        return orphans
 
872
 
 
873
    def _affected_ids(self):
 
874
        """Return the set of transform ids affected by the transform"""
 
875
        trans_ids = set(self._removed_id)
 
876
        trans_ids.update(self._new_id)
 
877
        trans_ids.update(self._removed_contents)
 
878
        trans_ids.update(self._new_contents)
 
879
        trans_ids.update(self._new_executability)
 
880
        trans_ids.update(self._new_name)
 
881
        trans_ids.update(self._new_parent)
 
882
        return trans_ids
 
883
 
 
884
    def _get_file_id_maps(self):
 
885
        """Return mapping of file_ids to trans_ids in the to and from states"""
 
886
        trans_ids = self._affected_ids()
 
887
        from_trans_ids = {}
 
888
        to_trans_ids = {}
 
889
        # Build up two dicts: trans_ids associated with file ids in the
 
890
        # FROM state, vs the TO state.
 
891
        for trans_id in trans_ids:
 
892
            from_file_id = self.tree_file_id(trans_id)
 
893
            if from_file_id is not None:
 
894
                from_trans_ids[from_file_id] = trans_id
 
895
            to_file_id = self.final_file_id(trans_id)
 
896
            if to_file_id is not None:
 
897
                to_trans_ids[to_file_id] = trans_id
 
898
        return from_trans_ids, to_trans_ids
 
899
 
 
900
    def _from_file_data(self, from_trans_id, from_versioned, from_path):
 
901
        """Get data about a file in the from (tree) state
 
902
 
 
903
        Return a (name, parent, kind, executable) tuple
 
904
        """
 
905
        from_path = self._tree_id_paths.get(from_trans_id)
 
906
        if from_versioned:
 
907
            # get data from working tree if versioned
 
908
            from_entry = next(self._tree.iter_entries_by_dir(
 
909
                specific_files=[from_path]))[1]
 
910
            from_name = from_entry.name
 
911
            from_parent = from_entry.parent_id
 
912
        else:
 
913
            from_entry = None
 
914
            if from_path is None:
 
915
                # File does not exist in FROM state
 
916
                from_name = None
 
917
                from_parent = None
 
918
            else:
 
919
                # File exists, but is not versioned.  Have to use path-
 
920
                # splitting stuff
 
921
                from_name = os.path.basename(from_path)
 
922
                tree_parent = self.get_tree_parent(from_trans_id)
 
923
                from_parent = self.tree_file_id(tree_parent)
 
924
        if from_path is not None:
 
925
            from_kind, from_executable, from_stats = \
 
926
                self._tree._comparison_data(from_entry, from_path)
 
927
        else:
 
928
            from_kind = None
 
929
            from_executable = False
 
930
        return from_name, from_parent, from_kind, from_executable
 
931
 
 
932
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
 
933
        """Get data about a file in the to (target) state
 
934
 
 
935
        Return a (name, parent, kind, executable) tuple
 
936
        """
 
937
        to_name = self.final_name(to_trans_id)
 
938
        to_kind = self.final_kind(to_trans_id)
 
939
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
 
940
        if to_trans_id in self._new_executability:
 
941
            to_executable = self._new_executability[to_trans_id]
 
942
        elif to_trans_id == from_trans_id:
 
943
            to_executable = from_executable
 
944
        else:
 
945
            to_executable = False
 
946
        return to_name, to_parent, to_kind, to_executable
 
947
 
441
948
    def iter_changes(self):
442
949
        """Produce output in the same format as Tree.iter_changes.
443
950
 
444
951
        Will produce nonsensical results if invoked while inventory/filesystem
445
 
        conflicts (as reported by TreeTransform.find_raw_conflicts()) are present.
 
952
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
446
953
 
447
954
        This reads the Transform, but only reproduces changes involving a
448
955
        file_id.  Files that are not versioned in either of the FROM or TO
449
956
        states are not reflected.
450
957
        """
451
 
        raise NotImplementedError(self.iter_changes)
 
958
        final_paths = FinalPaths(self)
 
959
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
 
960
        results = []
 
961
        # Now iterate through all active file_ids
 
962
        for file_id in set(from_trans_ids).union(to_trans_ids):
 
963
            modified = False
 
964
            from_trans_id = from_trans_ids.get(file_id)
 
965
            # find file ids, and determine versioning state
 
966
            if from_trans_id is None:
 
967
                from_versioned = False
 
968
                from_trans_id = to_trans_ids[file_id]
 
969
            else:
 
970
                from_versioned = True
 
971
            to_trans_id = to_trans_ids.get(file_id)
 
972
            if to_trans_id is None:
 
973
                to_versioned = False
 
974
                to_trans_id = from_trans_id
 
975
            else:
 
976
                to_versioned = True
 
977
 
 
978
            if not from_versioned:
 
979
                from_path = None
 
980
            else:
 
981
                from_path = self._tree_id_paths.get(from_trans_id)
 
982
            if not to_versioned:
 
983
                to_path = None
 
984
            else:
 
985
                to_path = final_paths.get_path(to_trans_id)
 
986
 
 
987
            from_name, from_parent, from_kind, from_executable = \
 
988
                self._from_file_data(from_trans_id, from_versioned, from_path)
 
989
 
 
990
            to_name, to_parent, to_kind, to_executable = \
 
991
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
992
 
 
993
            if from_kind != to_kind:
 
994
                modified = True
 
995
            elif to_kind in ('file', 'symlink') and (
 
996
                    to_trans_id != from_trans_id
 
997
                    or to_trans_id in self._new_contents):
 
998
                modified = True
 
999
            if (not modified and from_versioned == to_versioned
 
1000
                and from_parent == to_parent and from_name == to_name
 
1001
                    and from_executable == to_executable):
 
1002
                continue
 
1003
            results.append((file_id, (from_path, to_path), modified,
 
1004
                            (from_versioned, to_versioned),
 
1005
                            (from_parent, to_parent),
 
1006
                            (from_name, to_name),
 
1007
                            (from_kind, to_kind),
 
1008
                            (from_executable, to_executable)))
 
1009
 
 
1010
        def path_key(t):
 
1011
            paths = t[1]
 
1012
            return (paths[0] or '', paths[1] or '')
 
1013
        return iter(sorted(results, key=path_key))
452
1014
 
453
1015
    def get_preview_tree(self):
454
1016
        """Return a tree representing the result of the transform.
456
1018
        The tree is a snapshot, and altering the TreeTransform will invalidate
457
1019
        it.
458
1020
        """
459
 
        raise NotImplementedError(self.get_preview_tree)
 
1021
        return _PreviewTree(self)
460
1022
 
461
1023
    def commit(self, branch, message, merge_parents=None, strict=False,
462
1024
               timestamp=None, timezone=None, committer=None, authors=None,
481
1043
            may reduce performance for some non-native formats.)
482
1044
        :return: The revision_id of the revision committed.
483
1045
        """
484
 
        raise NotImplementedError(self.commit)
 
1046
        self._check_malformed()
 
1047
        if strict:
 
1048
            unversioned = set(self._new_contents).difference(set(self._new_id))
 
1049
            for trans_id in unversioned:
 
1050
                if self.final_file_id(trans_id) is None:
 
1051
                    raise errors.StrictCommitFailed()
 
1052
 
 
1053
        revno, last_rev_id = branch.last_revision_info()
 
1054
        if last_rev_id == _mod_revision.NULL_REVISION:
 
1055
            if merge_parents is not None:
 
1056
                raise ValueError('Cannot supply merge parents for first'
 
1057
                                 ' commit.')
 
1058
            parent_ids = []
 
1059
        else:
 
1060
            parent_ids = [last_rev_id]
 
1061
            if merge_parents is not None:
 
1062
                parent_ids.extend(merge_parents)
 
1063
        if self._tree.get_revision_id() != last_rev_id:
 
1064
            raise ValueError('TreeTransform not based on branch basis: %s' %
 
1065
                             self._tree.get_revision_id().decode('utf-8'))
 
1066
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
 
1067
        builder = branch.get_commit_builder(parent_ids,
 
1068
                                            timestamp=timestamp,
 
1069
                                            timezone=timezone,
 
1070
                                            committer=committer,
 
1071
                                            revprops=revprops,
 
1072
                                            revision_id=revision_id)
 
1073
        preview = self.get_preview_tree()
 
1074
        list(builder.record_iter_changes(preview, last_rev_id,
 
1075
                                         self.iter_changes()))
 
1076
        builder.finish_inventory()
 
1077
        revision_id = builder.commit(message)
 
1078
        branch.set_last_revision_info(revno + 1, revision_id)
 
1079
        return revision_id
 
1080
 
 
1081
    def _text_parent(self, trans_id):
 
1082
        path = self.tree_path(trans_id)
 
1083
        try:
 
1084
            if path is None or self._tree.kind(path) != 'file':
 
1085
                return None
 
1086
        except errors.NoSuchFile:
 
1087
            return None
 
1088
        return path
 
1089
 
 
1090
    def _get_parents_texts(self, trans_id):
 
1091
        """Get texts for compression parents of this file."""
 
1092
        path = self._text_parent(trans_id)
 
1093
        if path is None:
 
1094
            return ()
 
1095
        return (self._tree.get_file_text(path),)
 
1096
 
 
1097
    def _get_parents_lines(self, trans_id):
 
1098
        """Get lines for compression parents of this file."""
 
1099
        path = self._text_parent(trans_id)
 
1100
        if path is None:
 
1101
            return ()
 
1102
        return (self._tree.get_file_lines(path),)
 
1103
 
 
1104
    def serialize(self, serializer):
 
1105
        """Serialize this TreeTransform.
 
1106
 
 
1107
        :param serializer: A Serialiser like pack.ContainerSerializer.
 
1108
        """
 
1109
        new_name = {k.encode('utf-8'): v.encode('utf-8')
 
1110
                    for k, v in viewitems(self._new_name)}
 
1111
        new_parent = {k.encode('utf-8'): v.encode('utf-8')
 
1112
                      for k, v in viewitems(self._new_parent)}
 
1113
        new_id = {k.encode('utf-8'): v
 
1114
                  for k, v in viewitems(self._new_id)}
 
1115
        new_executability = {k.encode('utf-8'): int(v)
 
1116
                             for k, v in viewitems(self._new_executability)}
 
1117
        tree_path_ids = {k.encode('utf-8'): v.encode('utf-8')
 
1118
                         for k, v in viewitems(self._tree_path_ids)}
 
1119
        non_present_ids = {k: v.encode('utf-8')
 
1120
                           for k, v in viewitems(self._non_present_ids)}
 
1121
        removed_contents = [trans_id.encode('utf-8')
 
1122
                            for trans_id in self._removed_contents]
 
1123
        removed_id = [trans_id.encode('utf-8')
 
1124
                      for trans_id in self._removed_id]
 
1125
        attribs = {
 
1126
            b'_id_number': self._id_number,
 
1127
            b'_new_name': new_name,
 
1128
            b'_new_parent': new_parent,
 
1129
            b'_new_executability': new_executability,
 
1130
            b'_new_id': new_id,
 
1131
            b'_tree_path_ids': tree_path_ids,
 
1132
            b'_removed_id': removed_id,
 
1133
            b'_removed_contents': removed_contents,
 
1134
            b'_non_present_ids': non_present_ids,
 
1135
            }
 
1136
        yield serializer.bytes_record(bencode.bencode(attribs),
 
1137
                                      ((b'attribs',),))
 
1138
        for trans_id, kind in sorted(viewitems(self._new_contents)):
 
1139
            if kind == 'file':
 
1140
                with open(self._limbo_name(trans_id), 'rb') as cur_file:
 
1141
                    lines = cur_file.readlines()
 
1142
                parents = self._get_parents_lines(trans_id)
 
1143
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
 
1144
                content = b''.join(mpdiff.to_patch())
 
1145
            if kind == 'directory':
 
1146
                content = b''
 
1147
            if kind == 'symlink':
 
1148
                content = self._read_symlink_target(trans_id)
 
1149
                if not isinstance(content, bytes):
 
1150
                    content = content.encode('utf-8')
 
1151
            yield serializer.bytes_record(
 
1152
                content, ((trans_id.encode('utf-8'), kind.encode('ascii')),))
 
1153
 
 
1154
    def deserialize(self, records):
 
1155
        """Deserialize a stored TreeTransform.
 
1156
 
 
1157
        :param records: An iterable of (names, content) tuples, as per
 
1158
            pack.ContainerPushParser.
 
1159
        """
 
1160
        names, content = next(records)
 
1161
        attribs = bencode.bdecode(content)
 
1162
        self._id_number = attribs[b'_id_number']
 
1163
        self._new_name = {k.decode('utf-8'): v.decode('utf-8')
 
1164
                          for k, v in viewitems(attribs[b'_new_name'])}
 
1165
        self._new_parent = {k.decode('utf-8'): v.decode('utf-8')
 
1166
                            for k, v in viewitems(attribs[b'_new_parent'])}
 
1167
        self._new_executability = {
 
1168
            k.decode('utf-8'): bool(v)
 
1169
            for k, v in viewitems(attribs[b'_new_executability'])}
 
1170
        self._new_id = {k.decode('utf-8'): v
 
1171
                        for k, v in viewitems(attribs[b'_new_id'])}
 
1172
        self._r_new_id = {v: k for k, v in viewitems(self._new_id)}
 
1173
        self._tree_path_ids = {}
 
1174
        self._tree_id_paths = {}
 
1175
        for bytepath, trans_id in viewitems(attribs[b'_tree_path_ids']):
 
1176
            path = bytepath.decode('utf-8')
 
1177
            trans_id = trans_id.decode('utf-8')
 
1178
            self._tree_path_ids[path] = trans_id
 
1179
            self._tree_id_paths[trans_id] = path
 
1180
        self._removed_id = {trans_id.decode('utf-8')
 
1181
                            for trans_id in attribs[b'_removed_id']}
 
1182
        self._removed_contents = set(
 
1183
            trans_id.decode('utf-8')
 
1184
            for trans_id in attribs[b'_removed_contents'])
 
1185
        self._non_present_ids = {
 
1186
            k: v.decode('utf-8')
 
1187
            for k, v in viewitems(attribs[b'_non_present_ids'])}
 
1188
        for ((trans_id, kind),), content in records:
 
1189
            trans_id = trans_id.decode('utf-8')
 
1190
            kind = kind.decode('ascii')
 
1191
            if kind == 'file':
 
1192
                mpdiff = multiparent.MultiParent.from_patch(content)
 
1193
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
 
1194
                self.create_file(lines, trans_id)
 
1195
            if kind == 'directory':
 
1196
                self.create_directory(trans_id)
 
1197
            if kind == 'symlink':
 
1198
                self.create_symlink(content.decode('utf-8'), trans_id)
 
1199
 
 
1200
 
 
1201
class DiskTreeTransform(TreeTransformBase):
 
1202
    """Tree transform storing its contents on disk."""
 
1203
 
 
1204
    def __init__(self, tree, limbodir, pb=None,
 
1205
                 case_sensitive=True):
 
1206
        """Constructor.
 
1207
        :param tree: The tree that will be transformed, but not necessarily
 
1208
            the output tree.
 
1209
        :param limbodir: A directory where new files can be stored until
 
1210
            they are installed in their proper places
 
1211
        :param pb: ignored
 
1212
        :param case_sensitive: If True, the target of the transform is
 
1213
            case sensitive, not just case preserving.
 
1214
        """
 
1215
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
 
1216
        self._limbodir = limbodir
 
1217
        self._deletiondir = None
 
1218
        # A mapping of transform ids to their limbo filename
 
1219
        self._limbo_files = {}
 
1220
        self._possibly_stale_limbo_files = set()
 
1221
        # A mapping of transform ids to a set of the transform ids of children
 
1222
        # that their limbo directory has
 
1223
        self._limbo_children = {}
 
1224
        # Map transform ids to maps of child filename to child transform id
 
1225
        self._limbo_children_names = {}
 
1226
        # List of transform ids that need to be renamed from limbo into place
 
1227
        self._needs_rename = set()
 
1228
        self._creation_mtime = None
 
1229
 
 
1230
    def finalize(self):
 
1231
        """Release the working tree lock, if held, clean up limbo dir.
 
1232
 
 
1233
        This is required if apply has not been invoked, but can be invoked
 
1234
        even after apply.
 
1235
        """
 
1236
        if self._tree is None:
 
1237
            return
 
1238
        try:
 
1239
            limbo_paths = list(viewvalues(self._limbo_files))
 
1240
            limbo_paths.extend(self._possibly_stale_limbo_files)
 
1241
            limbo_paths.sort(reverse=True)
 
1242
            for path in limbo_paths:
 
1243
                try:
 
1244
                    delete_any(path)
 
1245
                except OSError as e:
 
1246
                    if e.errno != errno.ENOENT:
 
1247
                        raise
 
1248
                    # XXX: warn? perhaps we just got interrupted at an
 
1249
                    # inconvenient moment, but perhaps files are disappearing
 
1250
                    # from under us?
 
1251
            try:
 
1252
                delete_any(self._limbodir)
 
1253
            except OSError:
 
1254
                # We don't especially care *why* the dir is immortal.
 
1255
                raise ImmortalLimbo(self._limbodir)
 
1256
            try:
 
1257
                if self._deletiondir is not None:
 
1258
                    delete_any(self._deletiondir)
 
1259
            except OSError:
 
1260
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
1261
        finally:
 
1262
            TreeTransformBase.finalize(self)
 
1263
 
 
1264
    def _limbo_supports_executable(self):
 
1265
        """Check if the limbo path supports the executable bit."""
 
1266
        # FIXME: Check actual file system capabilities of limbodir
 
1267
        return osutils.supports_executable()
 
1268
 
 
1269
    def _limbo_name(self, trans_id):
 
1270
        """Generate the limbo name of a file"""
 
1271
        limbo_name = self._limbo_files.get(trans_id)
 
1272
        if limbo_name is None:
 
1273
            limbo_name = self._generate_limbo_path(trans_id)
 
1274
            self._limbo_files[trans_id] = limbo_name
 
1275
        return limbo_name
 
1276
 
 
1277
    def _generate_limbo_path(self, trans_id):
 
1278
        """Generate a limbo path using the trans_id as the relative path.
 
1279
 
 
1280
        This is suitable as a fallback, and when the transform should not be
 
1281
        sensitive to the path encoding of the limbo directory.
 
1282
        """
 
1283
        self._needs_rename.add(trans_id)
 
1284
        return pathjoin(self._limbodir, trans_id)
 
1285
 
 
1286
    def adjust_path(self, name, parent, trans_id):
 
1287
        previous_parent = self._new_parent.get(trans_id)
 
1288
        previous_name = self._new_name.get(trans_id)
 
1289
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
 
1290
        if (trans_id in self._limbo_files
 
1291
                and trans_id not in self._needs_rename):
 
1292
            self._rename_in_limbo([trans_id])
 
1293
            if previous_parent != parent:
 
1294
                self._limbo_children[previous_parent].remove(trans_id)
 
1295
            if previous_parent != parent or previous_name != name:
 
1296
                del self._limbo_children_names[previous_parent][previous_name]
 
1297
 
 
1298
    def _rename_in_limbo(self, trans_ids):
 
1299
        """Fix limbo names so that the right final path is produced.
 
1300
 
 
1301
        This means we outsmarted ourselves-- we tried to avoid renaming
 
1302
        these files later by creating them with their final names in their
 
1303
        final parents.  But now the previous name or parent is no longer
 
1304
        suitable, so we have to rename them.
 
1305
 
 
1306
        Even for trans_ids that have no new contents, we must remove their
 
1307
        entries from _limbo_files, because they are now stale.
 
1308
        """
 
1309
        for trans_id in trans_ids:
 
1310
            old_path = self._limbo_files[trans_id]
 
1311
            self._possibly_stale_limbo_files.add(old_path)
 
1312
            del self._limbo_files[trans_id]
 
1313
            if trans_id not in self._new_contents:
 
1314
                continue
 
1315
            new_path = self._limbo_name(trans_id)
 
1316
            os.rename(old_path, new_path)
 
1317
            self._possibly_stale_limbo_files.remove(old_path)
 
1318
            for descendant in self._limbo_descendants(trans_id):
 
1319
                desc_path = self._limbo_files[descendant]
 
1320
                desc_path = new_path + desc_path[len(old_path):]
 
1321
                self._limbo_files[descendant] = desc_path
 
1322
 
 
1323
    def _limbo_descendants(self, trans_id):
 
1324
        """Return the set of trans_ids whose limbo paths descend from this."""
 
1325
        descendants = set(self._limbo_children.get(trans_id, []))
 
1326
        for descendant in list(descendants):
 
1327
            descendants.update(self._limbo_descendants(descendant))
 
1328
        return descendants
485
1329
 
486
1330
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
487
1331
        """Schedule creation of a new file.
497
1341
        :param sha1: If the sha1 of this content is already known, pass it in.
498
1342
            We can use it to prevent future sha1 computations.
499
1343
        """
500
 
        raise NotImplementedError(self.create_file)
 
1344
        name = self._limbo_name(trans_id)
 
1345
        with open(name, 'wb') as f:
 
1346
            unique_add(self._new_contents, trans_id, 'file')
 
1347
            f.writelines(contents)
 
1348
        self._set_mtime(name)
 
1349
        self._set_mode(trans_id, mode_id, S_ISREG)
 
1350
        # It is unfortunate we have to use lstat instead of fstat, but we just
 
1351
        # used utime and chmod on the file, so we need the accurate final
 
1352
        # details.
 
1353
        if sha1 is not None:
 
1354
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
 
1355
 
 
1356
    def _read_symlink_target(self, trans_id):
 
1357
        return os.readlink(self._limbo_name(trans_id))
 
1358
 
 
1359
    def _set_mtime(self, path):
 
1360
        """All files that are created get the same mtime.
 
1361
 
 
1362
        This time is set by the first object to be created.
 
1363
        """
 
1364
        if self._creation_mtime is None:
 
1365
            self._creation_mtime = time.time()
 
1366
        os.utime(path, (self._creation_mtime, self._creation_mtime))
 
1367
 
 
1368
    def create_hardlink(self, path, trans_id):
 
1369
        """Schedule creation of a hard link"""
 
1370
        name = self._limbo_name(trans_id)
 
1371
        try:
 
1372
            os.link(path, name)
 
1373
        except OSError as e:
 
1374
            if e.errno != errno.EPERM:
 
1375
                raise
 
1376
            raise errors.HardLinkNotSupported(path)
 
1377
        try:
 
1378
            unique_add(self._new_contents, trans_id, 'file')
 
1379
        except BaseException:
 
1380
            # Clean up the file, it never got registered so
 
1381
            # TreeTransform.finalize() won't clean it up.
 
1382
            os.unlink(name)
 
1383
            raise
501
1384
 
502
1385
    def create_directory(self, trans_id):
503
1386
        """Schedule creation of a new directory.
504
1387
 
505
1388
        See also new_directory.
506
1389
        """
507
 
        raise NotImplementedError(self.create_directory)
 
1390
        os.mkdir(self._limbo_name(trans_id))
 
1391
        unique_add(self._new_contents, trans_id, 'directory')
508
1392
 
509
1393
    def create_symlink(self, target, trans_id):
510
1394
        """Schedule creation of a new symbolic link.
512
1396
        target is a bytestring.
513
1397
        See also new_symlink.
514
1398
        """
515
 
        raise NotImplementedError(self.create_symlink)
516
 
 
517
 
    def create_hardlink(self, path, trans_id):
518
 
        """Schedule creation of a hard link"""
519
 
        raise NotImplementedError(self.create_hardlink)
 
1399
        if has_symlinks():
 
1400
            os.symlink(target, self._limbo_name(trans_id))
 
1401
            unique_add(self._new_contents, trans_id, 'symlink')
 
1402
        else:
 
1403
            try:
 
1404
                path = FinalPaths(self).get_path(trans_id)
 
1405
            except KeyError:
 
1406
                path = None
 
1407
            raise UnableCreateSymlink(path=path)
520
1408
 
521
1409
    def cancel_creation(self, trans_id):
522
1410
        """Cancel the creation of new file contents."""
523
 
        raise NotImplementedError(self.cancel_creation)
 
1411
        del self._new_contents[trans_id]
 
1412
        if trans_id in self._observed_sha1s:
 
1413
            del self._observed_sha1s[trans_id]
 
1414
        children = self._limbo_children.get(trans_id)
 
1415
        # if this is a limbo directory with children, move them before removing
 
1416
        # the directory
 
1417
        if children is not None:
 
1418
            self._rename_in_limbo(children)
 
1419
            del self._limbo_children[trans_id]
 
1420
            del self._limbo_children_names[trans_id]
 
1421
        delete_any(self._limbo_name(trans_id))
524
1422
 
525
 
    def cook_conflicts(self, raw_conflicts):
526
 
        """Cook conflicts.
527
 
        """
528
 
        raise NotImplementedError(self.cook_conflicts)
 
1423
    def new_orphan(self, trans_id, parent_id):
 
1424
        conf = self._tree.get_config_stack()
 
1425
        handle_orphan = conf.get('transform.orphan_policy')
 
1426
        handle_orphan(self, trans_id, parent_id)
529
1427
 
530
1428
 
531
1429
class OrphaningError(errors.BzrError):
599
1497
    invalid='warning')
600
1498
 
601
1499
 
 
1500
class TreeTransform(DiskTreeTransform):
 
1501
    """Represent a tree transformation.
 
1502
 
 
1503
    This object is designed to support incremental generation of the transform,
 
1504
    in any order.
 
1505
 
 
1506
    However, it gives optimum performance when parent directories are created
 
1507
    before their contents.  The transform is then able to put child files
 
1508
    directly in their parent directory, avoiding later renames.
 
1509
 
 
1510
    It is easy to produce malformed transforms, but they are generally
 
1511
    harmless.  Attempting to apply a malformed transform will cause an
 
1512
    exception to be raised before any modifications are made to the tree.
 
1513
 
 
1514
    Many kinds of malformed transforms can be corrected with the
 
1515
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1516
    such as trying to create a file with no path.
 
1517
 
 
1518
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1519
     * new_file
 
1520
     * new_directory
 
1521
     * new_symlink
 
1522
 
 
1523
    These are composed of the low-level methods:
 
1524
     * create_path
 
1525
     * create_file or create_directory or create_symlink
 
1526
     * version_file
 
1527
     * set_executability
 
1528
 
 
1529
    Transform/Transaction ids
 
1530
    -------------------------
 
1531
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1532
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1533
 
 
1534
    trans_ids are used because filenames and file_ids are not good enough
 
1535
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1536
    are also associated with trans-ids, so that moving a file moves its
 
1537
    file-id.
 
1538
 
 
1539
    trans_ids are only valid for the TreeTransform that generated them.
 
1540
 
 
1541
    Limbo
 
1542
    -----
 
1543
    Limbo is a temporary directory use to hold new versions of files.
 
1544
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1545
    and their convenience variants (new_*).  Files may be removed from limbo
 
1546
    using cancel_creation.  Files are renamed from limbo into their final
 
1547
    location as part of TreeTransform.apply
 
1548
 
 
1549
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1550
    calling TreeTransform.finalize.
 
1551
 
 
1552
    Files are placed into limbo inside their parent directories, where
 
1553
    possible.  This reduces subsequent renames, and makes operations involving
 
1554
    lots of files faster.  This optimization is only possible if the parent
 
1555
    directory is created *before* creating any of its children, so avoid
 
1556
    creating children before parents, where possible.
 
1557
 
 
1558
    Pending-deletion
 
1559
    ----------------
 
1560
    This temporary directory is used by _FileMover for storing files that are
 
1561
    about to be deleted.  In case of rollback, the files will be restored.
 
1562
    FileMover does not delete files until it is sure that a rollback will not
 
1563
    happen.
 
1564
    """
 
1565
 
 
1566
    def __init__(self, tree, pb=None):
 
1567
        """Note: a tree_write lock is taken on the tree.
 
1568
 
 
1569
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1570
        TreeTransform.apply() called).
 
1571
        """
 
1572
        tree.lock_tree_write()
 
1573
        try:
 
1574
            limbodir = urlutils.local_path_from_url(
 
1575
                tree._transport.abspath('limbo'))
 
1576
            osutils.ensure_empty_directory_exists(
 
1577
                limbodir,
 
1578
                errors.ExistingLimbo)
 
1579
            deletiondir = urlutils.local_path_from_url(
 
1580
                tree._transport.abspath('pending-deletion'))
 
1581
            osutils.ensure_empty_directory_exists(
 
1582
                deletiondir,
 
1583
                errors.ExistingPendingDeletion)
 
1584
        except BaseException:
 
1585
            tree.unlock()
 
1586
            raise
 
1587
 
 
1588
        # Cache of realpath results, to speed up canonical_path
 
1589
        self._realpaths = {}
 
1590
        # Cache of relpath results, to speed up canonical_path
 
1591
        self._relpaths = {}
 
1592
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1593
                                   tree.case_sensitive)
 
1594
        self._deletiondir = deletiondir
 
1595
 
 
1596
    def canonical_path(self, path):
 
1597
        """Get the canonical tree-relative path"""
 
1598
        # don't follow final symlinks
 
1599
        abs = self._tree.abspath(path)
 
1600
        if abs in self._relpaths:
 
1601
            return self._relpaths[abs]
 
1602
        dirname, basename = os.path.split(abs)
 
1603
        if dirname not in self._realpaths:
 
1604
            self._realpaths[dirname] = os.path.realpath(dirname)
 
1605
        dirname = self._realpaths[dirname]
 
1606
        abs = pathjoin(dirname, basename)
 
1607
        if dirname in self._relpaths:
 
1608
            relpath = pathjoin(self._relpaths[dirname], basename)
 
1609
            relpath = relpath.rstrip('/\\')
 
1610
        else:
 
1611
            relpath = self._tree.relpath(abs)
 
1612
        self._relpaths[abs] = relpath
 
1613
        return relpath
 
1614
 
 
1615
    def tree_kind(self, trans_id):
 
1616
        """Determine the file kind in the working tree.
 
1617
 
 
1618
        :returns: The file kind or None if the file does not exist
 
1619
        """
 
1620
        path = self._tree_id_paths.get(trans_id)
 
1621
        if path is None:
 
1622
            return None
 
1623
        try:
 
1624
            return file_kind(self._tree.abspath(path))
 
1625
        except errors.NoSuchFile:
 
1626
            return None
 
1627
 
 
1628
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1629
        """Set the mode of new file contents.
 
1630
        The mode_id is the existing file to get the mode from (often the same
 
1631
        as trans_id).  The operation is only performed if there's a mode match
 
1632
        according to typefunc.
 
1633
        """
 
1634
        if mode_id is None:
 
1635
            mode_id = trans_id
 
1636
        try:
 
1637
            old_path = self._tree_id_paths[mode_id]
 
1638
        except KeyError:
 
1639
            return
 
1640
        try:
 
1641
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
1642
        except OSError as e:
 
1643
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
1644
                # Either old_path doesn't exist, or the parent of the
 
1645
                # target is not a directory (but will be one eventually)
 
1646
                # Either way, we know it doesn't exist *right now*
 
1647
                # See also bug #248448
 
1648
                return
 
1649
            else:
 
1650
                raise
 
1651
        if typefunc(mode):
 
1652
            osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
 
1653
 
 
1654
    def iter_tree_children(self, parent_id):
 
1655
        """Iterate through the entry's tree children, if any"""
 
1656
        try:
 
1657
            path = self._tree_id_paths[parent_id]
 
1658
        except KeyError:
 
1659
            return
 
1660
        try:
 
1661
            children = os.listdir(self._tree.abspath(path))
 
1662
        except OSError as e:
 
1663
            if not (osutils._is_error_enotdir(e) or
 
1664
                    e.errno in (errno.ENOENT, errno.ESRCH)):
 
1665
                raise
 
1666
            return
 
1667
 
 
1668
        for child in children:
 
1669
            childpath = joinpath(path, child)
 
1670
            if self._tree.is_control_filename(childpath):
 
1671
                continue
 
1672
            yield self.trans_id_tree_path(childpath)
 
1673
 
 
1674
    def _generate_limbo_path(self, trans_id):
 
1675
        """Generate a limbo path using the final path if possible.
 
1676
 
 
1677
        This optimizes the performance of applying the tree transform by
 
1678
        avoiding renames.  These renames can be avoided only when the parent
 
1679
        directory is already scheduled for creation.
 
1680
 
 
1681
        If the final path cannot be used, falls back to using the trans_id as
 
1682
        the relpath.
 
1683
        """
 
1684
        parent = self._new_parent.get(trans_id)
 
1685
        # if the parent directory is already in limbo (e.g. when building a
 
1686
        # tree), choose a limbo name inside the parent, to reduce further
 
1687
        # renames.
 
1688
        use_direct_path = False
 
1689
        if self._new_contents.get(parent) == 'directory':
 
1690
            filename = self._new_name.get(trans_id)
 
1691
            if filename is not None:
 
1692
                if parent not in self._limbo_children:
 
1693
                    self._limbo_children[parent] = set()
 
1694
                    self._limbo_children_names[parent] = {}
 
1695
                    use_direct_path = True
 
1696
                # the direct path can only be used if no other file has
 
1697
                # already taken this pathname, i.e. if the name is unused, or
 
1698
                # if it is already associated with this trans_id.
 
1699
                elif self._case_sensitive_target:
 
1700
                    if (self._limbo_children_names[parent].get(filename)
 
1701
                            in (trans_id, None)):
 
1702
                        use_direct_path = True
 
1703
                else:
 
1704
                    for l_filename, l_trans_id in viewitems(
 
1705
                            self._limbo_children_names[parent]):
 
1706
                        if l_trans_id == trans_id:
 
1707
                            continue
 
1708
                        if l_filename.lower() == filename.lower():
 
1709
                            break
 
1710
                    else:
 
1711
                        use_direct_path = True
 
1712
 
 
1713
        if not use_direct_path:
 
1714
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
 
1715
 
 
1716
        limbo_name = pathjoin(self._limbo_files[parent], filename)
 
1717
        self._limbo_children[parent].add(trans_id)
 
1718
        self._limbo_children_names[parent][filename] = trans_id
 
1719
        return limbo_name
 
1720
 
 
1721
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1722
        """Apply all changes to the inventory and filesystem.
 
1723
 
 
1724
        If filesystem or inventory conflicts are present, MalformedTransform
 
1725
        will be thrown.
 
1726
 
 
1727
        If apply succeeds, finalize is not necessary.
 
1728
 
 
1729
        :param no_conflicts: if True, the caller guarantees there are no
 
1730
            conflicts, so no check is made.
 
1731
        :param precomputed_delta: An inventory delta to use instead of
 
1732
            calculating one.
 
1733
        :param _mover: Supply an alternate FileMover, for testing
 
1734
        """
 
1735
        for hook in MutableTree.hooks['pre_transform']:
 
1736
            hook(self._tree, self)
 
1737
        if not no_conflicts:
 
1738
            self._check_malformed()
 
1739
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
1740
            if precomputed_delta is None:
 
1741
                child_pb.update(gettext('Apply phase'), 0, 2)
 
1742
                inventory_delta = self._generate_inventory_delta()
 
1743
                offset = 1
 
1744
            else:
 
1745
                inventory_delta = precomputed_delta
 
1746
                offset = 0
 
1747
            if _mover is None:
 
1748
                mover = _FileMover()
 
1749
            else:
 
1750
                mover = _mover
 
1751
            try:
 
1752
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
 
1753
                self._apply_removals(mover)
 
1754
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
 
1755
                modified_paths = self._apply_insertions(mover)
 
1756
            except BaseException:
 
1757
                mover.rollback()
 
1758
                raise
 
1759
            else:
 
1760
                mover.apply_deletions()
 
1761
        if self.final_file_id(self.root) is None:
 
1762
            inventory_delta = [e for e in inventory_delta if e[0] != '']
 
1763
        self._tree.apply_inventory_delta(inventory_delta)
 
1764
        self._apply_observed_sha1s()
 
1765
        self._done = True
 
1766
        self.finalize()
 
1767
        return _TransformResults(modified_paths, self.rename_count)
 
1768
 
 
1769
    def _generate_inventory_delta(self):
 
1770
        """Generate an inventory delta for the current transform."""
 
1771
        inventory_delta = []
 
1772
        new_paths = self._inventory_altered()
 
1773
        total_entries = len(new_paths) + len(self._removed_id)
 
1774
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
1775
            for num, trans_id in enumerate(self._removed_id):
 
1776
                if (num % 10) == 0:
 
1777
                    child_pb.update(gettext('removing file'),
 
1778
                                    num, total_entries)
 
1779
                if trans_id == self._new_root:
 
1780
                    file_id = self._tree.get_root_id()
 
1781
                else:
 
1782
                    file_id = self.tree_file_id(trans_id)
 
1783
                # File-id isn't really being deleted, just moved
 
1784
                if file_id in self._r_new_id:
 
1785
                    continue
 
1786
                path = self._tree_id_paths[trans_id]
 
1787
                inventory_delta.append((path, None, file_id, None))
 
1788
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1789
                                     new_paths)
 
1790
            for num, (path, trans_id) in enumerate(new_paths):
 
1791
                if (num % 10) == 0:
 
1792
                    child_pb.update(gettext('adding file'),
 
1793
                                    num + len(self._removed_id), total_entries)
 
1794
                file_id = new_path_file_ids[trans_id]
 
1795
                if file_id is None:
 
1796
                    continue
 
1797
                kind = self.final_kind(trans_id)
 
1798
                if kind is None:
 
1799
                    kind = self._tree.stored_kind(self._tree.id2path(file_id))
 
1800
                parent_trans_id = self.final_parent(trans_id)
 
1801
                parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1802
                if parent_file_id is None:
 
1803
                    parent_file_id = self.final_file_id(parent_trans_id)
 
1804
                if trans_id in self._new_reference_revision:
 
1805
                    new_entry = inventory.TreeReference(
 
1806
                        file_id,
 
1807
                        self._new_name[trans_id],
 
1808
                        self.final_file_id(self._new_parent[trans_id]),
 
1809
                        None, self._new_reference_revision[trans_id])
 
1810
                else:
 
1811
                    new_entry = inventory.make_entry(kind,
 
1812
                                                     self.final_name(trans_id),
 
1813
                                                     parent_file_id, file_id)
 
1814
                try:
 
1815
                    old_path = self._tree.id2path(new_entry.file_id)
 
1816
                except errors.NoSuchId:
 
1817
                    old_path = None
 
1818
                new_executability = self._new_executability.get(trans_id)
 
1819
                if new_executability is not None:
 
1820
                    new_entry.executable = new_executability
 
1821
                inventory_delta.append(
 
1822
                    (old_path, path, new_entry.file_id, new_entry))
 
1823
        return inventory_delta
 
1824
 
 
1825
    def _apply_removals(self, mover):
 
1826
        """Perform tree operations that remove directory/inventory names.
 
1827
 
 
1828
        That is, delete files that are to be deleted, and put any files that
 
1829
        need renaming into limbo.  This must be done in strict child-to-parent
 
1830
        order.
 
1831
 
 
1832
        If inventory_delta is None, no inventory delta generation is performed.
 
1833
        """
 
1834
        tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
 
1835
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
1836
            for num, (path, trans_id) in enumerate(tree_paths):
 
1837
                # do not attempt to move root into a subdirectory of itself.
 
1838
                if path == '':
 
1839
                    continue
 
1840
                child_pb.update(gettext('removing file'), num, len(tree_paths))
 
1841
                full_path = self._tree.abspath(path)
 
1842
                if trans_id in self._removed_contents:
 
1843
                    delete_path = os.path.join(self._deletiondir, trans_id)
 
1844
                    mover.pre_delete(full_path, delete_path)
 
1845
                elif (trans_id in self._new_name or
 
1846
                      trans_id in self._new_parent):
 
1847
                    try:
 
1848
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1849
                    except errors.TransformRenameFailed as e:
 
1850
                        if e.errno != errno.ENOENT:
 
1851
                            raise
 
1852
                    else:
 
1853
                        self.rename_count += 1
 
1854
 
 
1855
    def _apply_insertions(self, mover):
 
1856
        """Perform tree operations that insert directory/inventory names.
 
1857
 
 
1858
        That is, create any files that need to be created, and restore from
 
1859
        limbo any files that needed renaming.  This must be done in strict
 
1860
        parent-to-child order.
 
1861
 
 
1862
        If inventory_delta is None, no inventory delta is calculated, and
 
1863
        no list of modified paths is returned.
 
1864
        """
 
1865
        new_paths = self.new_paths(filesystem_only=True)
 
1866
        modified_paths = []
 
1867
        with ui.ui_factory.nested_progress_bar() as child_pb:
 
1868
            for num, (path, trans_id) in enumerate(new_paths):
 
1869
                if (num % 10) == 0:
 
1870
                    child_pb.update(gettext('adding file'),
 
1871
                                    num, len(new_paths))
 
1872
                full_path = self._tree.abspath(path)
 
1873
                if trans_id in self._needs_rename:
 
1874
                    try:
 
1875
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1876
                    except errors.TransformRenameFailed as e:
 
1877
                        # We may be renaming a dangling inventory id
 
1878
                        if e.errno != errno.ENOENT:
 
1879
                            raise
 
1880
                    else:
 
1881
                        self.rename_count += 1
 
1882
                    # TODO: if trans_id in self._observed_sha1s, we should
 
1883
                    #       re-stat the final target, since ctime will be
 
1884
                    #       updated by the change.
 
1885
                if (trans_id in self._new_contents
 
1886
                        or self.path_changed(trans_id)):
 
1887
                    if trans_id in self._new_contents:
 
1888
                        modified_paths.append(full_path)
 
1889
                if trans_id in self._new_executability:
 
1890
                    self._set_executability(path, trans_id)
 
1891
                if trans_id in self._observed_sha1s:
 
1892
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
 
1893
                    st = osutils.lstat(full_path)
 
1894
                    self._observed_sha1s[trans_id] = (o_sha1, st)
 
1895
        for path, trans_id in new_paths:
 
1896
            # new_paths includes stuff like workingtree conflicts. Only the
 
1897
            # stuff in new_contents actually comes from limbo.
 
1898
            if trans_id in self._limbo_files:
 
1899
                del self._limbo_files[trans_id]
 
1900
        self._new_contents.clear()
 
1901
        return modified_paths
 
1902
 
 
1903
    def _apply_observed_sha1s(self):
 
1904
        """After we have finished renaming everything, update observed sha1s
 
1905
 
 
1906
        This has to be done after self._tree.apply_inventory_delta, otherwise
 
1907
        it doesn't know anything about the files we are updating. Also, we want
 
1908
        to do this as late as possible, so that most entries end up cached.
 
1909
        """
 
1910
        # TODO: this doesn't update the stat information for directories. So
 
1911
        #       the first 'bzr status' will still need to rewrite
 
1912
        #       .bzr/checkout/dirstate. However, we at least don't need to
 
1913
        #       re-read all of the files.
 
1914
        # TODO: If the operation took a while, we could do a time.sleep(3) here
 
1915
        #       to allow the clock to tick over and ensure we won't have any
 
1916
        #       problems. (we could observe start time, and finish time, and if
 
1917
        #       it is less than eg 10% overhead, add a sleep call.)
 
1918
        paths = FinalPaths(self)
 
1919
        for trans_id, observed in viewitems(self._observed_sha1s):
 
1920
            path = paths.get_path(trans_id)
 
1921
            self._tree._observed_sha1(path, observed)
 
1922
 
 
1923
 
 
1924
class TransformPreview(DiskTreeTransform):
 
1925
    """A TreeTransform for generating preview trees.
 
1926
 
 
1927
    Unlike TreeTransform, this version works when the input tree is a
 
1928
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1929
    unversioned files in the input tree.
 
1930
    """
 
1931
 
 
1932
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1933
        tree.lock_read()
 
1934
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
 
1935
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1936
 
 
1937
    def canonical_path(self, path):
 
1938
        return path
 
1939
 
 
1940
    def tree_kind(self, trans_id):
 
1941
        path = self._tree_id_paths.get(trans_id)
 
1942
        if path is None:
 
1943
            return None
 
1944
        kind = self._tree.path_content_summary(path)[0]
 
1945
        if kind == 'missing':
 
1946
            kind = None
 
1947
        return kind
 
1948
 
 
1949
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1950
        """Set the mode of new file contents.
 
1951
        The mode_id is the existing file to get the mode from (often the same
 
1952
        as trans_id).  The operation is only performed if there's a mode match
 
1953
        according to typefunc.
 
1954
        """
 
1955
        # is it ok to ignore this?  probably
 
1956
        pass
 
1957
 
 
1958
    def iter_tree_children(self, parent_id):
 
1959
        """Iterate through the entry's tree children, if any"""
 
1960
        try:
 
1961
            path = self._tree_id_paths[parent_id]
 
1962
        except KeyError:
 
1963
            return
 
1964
        try:
 
1965
            entry = next(self._tree.iter_entries_by_dir(
 
1966
                specific_files=[path]))[1]
 
1967
        except StopIteration:
 
1968
            return
 
1969
        children = getattr(entry, 'children', {})
 
1970
        for child in children:
 
1971
            childpath = joinpath(path, child)
 
1972
            yield self.trans_id_tree_path(childpath)
 
1973
 
 
1974
    def new_orphan(self, trans_id, parent_id):
 
1975
        raise NotImplementedError(self.new_orphan)
 
1976
 
 
1977
 
 
1978
class _PreviewTree(inventorytree.InventoryTree):
 
1979
    """Partial implementation of Tree to support show_diff_trees"""
 
1980
 
 
1981
    def __init__(self, transform):
 
1982
        self._transform = transform
 
1983
        self._final_paths = FinalPaths(transform)
 
1984
        self.__by_parent = None
 
1985
        self._parent_ids = []
 
1986
        self._all_children_cache = {}
 
1987
        self._path2trans_id_cache = {}
 
1988
        self._final_name_cache = {}
 
1989
        self._iter_changes_cache = dict((c[0], c) for c in
 
1990
                                        self._transform.iter_changes())
 
1991
 
 
1992
    def _content_change(self, file_id):
 
1993
        """Return True if the content of this file changed"""
 
1994
        changes = self._iter_changes_cache.get(file_id)
 
1995
        # changes[2] is true if the file content changed.  See
 
1996
        # InterTree.iter_changes.
 
1997
        return (changes is not None and changes[2])
 
1998
 
 
1999
    def _get_repository(self):
 
2000
        repo = getattr(self._transform._tree, '_repository', None)
 
2001
        if repo is None:
 
2002
            repo = self._transform._tree.branch.repository
 
2003
        return repo
 
2004
 
 
2005
    def _iter_parent_trees(self):
 
2006
        for revision_id in self.get_parent_ids():
 
2007
            try:
 
2008
                yield self.revision_tree(revision_id)
 
2009
            except errors.NoSuchRevisionInTree:
 
2010
                yield self._get_repository().revision_tree(revision_id)
 
2011
 
 
2012
    def _get_file_revision(self, path, file_id, vf, tree_revision):
 
2013
        parent_keys = [
 
2014
            (file_id, t.get_file_revision(t.id2path(file_id)))
 
2015
            for t in self._iter_parent_trees()]
 
2016
        vf.add_lines((file_id, tree_revision), parent_keys,
 
2017
                     self.get_file_lines(path))
 
2018
        repo = self._get_repository()
 
2019
        base_vf = repo.texts
 
2020
        if base_vf not in vf.fallback_versionedfiles:
 
2021
            vf.fallback_versionedfiles.append(base_vf)
 
2022
        return tree_revision
 
2023
 
 
2024
    def _stat_limbo_file(self, trans_id):
 
2025
        name = self._transform._limbo_name(trans_id)
 
2026
        return os.lstat(name)
 
2027
 
 
2028
    @property
 
2029
    def _by_parent(self):
 
2030
        if self.__by_parent is None:
 
2031
            self.__by_parent = self._transform.by_parent()
 
2032
        return self.__by_parent
 
2033
 
 
2034
    def _comparison_data(self, entry, path):
 
2035
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
 
2036
        if kind == 'missing':
 
2037
            kind = None
 
2038
            executable = False
 
2039
        else:
 
2040
            file_id = self._transform.final_file_id(self._path2trans_id(path))
 
2041
            executable = self.is_executable(path)
 
2042
        return kind, executable, None
 
2043
 
 
2044
    def is_locked(self):
 
2045
        return False
 
2046
 
 
2047
    def lock_read(self):
 
2048
        # Perhaps in theory, this should lock the TreeTransform?
 
2049
        return lock.LogicalLockResult(self.unlock)
 
2050
 
 
2051
    def unlock(self):
 
2052
        pass
 
2053
 
 
2054
    @property
 
2055
    def root_inventory(self):
 
2056
        """This Tree does not use inventory as its backing data."""
 
2057
        raise NotImplementedError(_PreviewTree.root_inventory)
 
2058
 
 
2059
    def get_root_id(self):
 
2060
        return self._transform.final_file_id(self._transform.root)
 
2061
 
 
2062
    def all_file_ids(self):
 
2063
        tree_ids = set(self._transform._tree.all_file_ids())
 
2064
        tree_ids.difference_update(self._transform.tree_file_id(t)
 
2065
                                   for t in self._transform._removed_id)
 
2066
        tree_ids.update(viewvalues(self._transform._new_id))
 
2067
        return tree_ids
 
2068
 
 
2069
    def all_versioned_paths(self):
 
2070
        tree_paths = set(self._transform._tree.all_versioned_paths())
 
2071
 
 
2072
        tree_paths.difference_update(
 
2073
            self._transform.trans_id_tree_path(t)
 
2074
            for t in self._transform._removed_id)
 
2075
 
 
2076
        tree_paths.update(
 
2077
            self._final_paths._determine_path(t)
 
2078
            for t in self._transform._new_id)
 
2079
 
 
2080
        return tree_paths
 
2081
 
 
2082
    def _has_id(self, file_id, fallback_check):
 
2083
        if file_id in self._transform._r_new_id:
 
2084
            return True
 
2085
        elif file_id in {self._transform.tree_file_id(trans_id) for
 
2086
                         trans_id in self._transform._removed_id}:
 
2087
            return False
 
2088
        else:
 
2089
            return fallback_check(file_id)
 
2090
 
 
2091
    def has_id(self, file_id):
 
2092
        return self._has_id(file_id, self._transform._tree.has_id)
 
2093
 
 
2094
    def has_or_had_id(self, file_id):
 
2095
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
2096
 
 
2097
    def _path2trans_id(self, path):
 
2098
        # We must not use None here, because that is a valid value to store.
 
2099
        trans_id = self._path2trans_id_cache.get(path, object)
 
2100
        if trans_id is not object:
 
2101
            return trans_id
 
2102
        segments = splitpath(path)
 
2103
        cur_parent = self._transform.root
 
2104
        for cur_segment in segments:
 
2105
            for child in self._all_children(cur_parent):
 
2106
                final_name = self._final_name_cache.get(child)
 
2107
                if final_name is None:
 
2108
                    final_name = self._transform.final_name(child)
 
2109
                    self._final_name_cache[child] = final_name
 
2110
                if final_name == cur_segment:
 
2111
                    cur_parent = child
 
2112
                    break
 
2113
            else:
 
2114
                self._path2trans_id_cache[path] = None
 
2115
                return None
 
2116
        self._path2trans_id_cache[path] = cur_parent
 
2117
        return cur_parent
 
2118
 
 
2119
    def path2id(self, path):
 
2120
        if isinstance(path, list):
 
2121
            if path == []:
 
2122
                path = [""]
 
2123
            path = osutils.pathjoin(*path)
 
2124
        return self._transform.final_file_id(self._path2trans_id(path))
 
2125
 
 
2126
    def id2path(self, file_id):
 
2127
        trans_id = self._transform.trans_id_file_id(file_id)
 
2128
        try:
 
2129
            return self._final_paths._determine_path(trans_id)
 
2130
        except NoFinalPath:
 
2131
            raise errors.NoSuchId(self, file_id)
 
2132
 
 
2133
    def _all_children(self, trans_id):
 
2134
        children = self._all_children_cache.get(trans_id)
 
2135
        if children is not None:
 
2136
            return children
 
2137
        children = set(self._transform.iter_tree_children(trans_id))
 
2138
        # children in the _new_parent set are provided by _by_parent.
 
2139
        children.difference_update(self._transform._new_parent)
 
2140
        children.update(self._by_parent.get(trans_id, []))
 
2141
        self._all_children_cache[trans_id] = children
 
2142
        return children
 
2143
 
 
2144
    def _iter_children(self, file_id):
 
2145
        trans_id = self._transform.trans_id_file_id(file_id)
 
2146
        for child_trans_id in self._all_children(trans_id):
 
2147
            yield self._transform.final_file_id(child_trans_id)
 
2148
 
 
2149
    def extras(self):
 
2150
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
 
2151
                              in self._transform._tree.extras())
 
2152
        possible_extras.update(self._transform._new_contents)
 
2153
        possible_extras.update(self._transform._removed_id)
 
2154
        for trans_id in possible_extras:
 
2155
            if self._transform.final_file_id(trans_id) is None:
 
2156
                yield self._final_paths._determine_path(trans_id)
 
2157
 
 
2158
    def _make_inv_entries(self, ordered_entries, specific_files=None):
 
2159
        for trans_id, parent_file_id in ordered_entries:
 
2160
            file_id = self._transform.final_file_id(trans_id)
 
2161
            if file_id is None:
 
2162
                continue
 
2163
            if (specific_files is not None
 
2164
                    and self._final_paths.get_path(trans_id) not in specific_files):
 
2165
                continue
 
2166
            kind = self._transform.final_kind(trans_id)
 
2167
            if kind is None:
 
2168
                kind = self._transform._tree.stored_kind(
 
2169
                    self._transform._tree.id2path(file_id))
 
2170
            new_entry = inventory.make_entry(
 
2171
                kind,
 
2172
                self._transform.final_name(trans_id),
 
2173
                parent_file_id, file_id)
 
2174
            yield new_entry, trans_id
 
2175
 
 
2176
    def _list_files_by_dir(self):
 
2177
        todo = [ROOT_PARENT]
 
2178
        ordered_ids = []
 
2179
        while len(todo) > 0:
 
2180
            parent = todo.pop()
 
2181
            parent_file_id = self._transform.final_file_id(parent)
 
2182
            children = list(self._all_children(parent))
 
2183
            paths = dict(zip(children, self._final_paths.get_paths(children)))
 
2184
            children.sort(key=paths.get)
 
2185
            todo.extend(reversed(children))
 
2186
            for trans_id in children:
 
2187
                ordered_ids.append((trans_id, parent_file_id))
 
2188
        return ordered_ids
 
2189
 
 
2190
    def iter_child_entries(self, path):
 
2191
        trans_id = self._path2trans_id(path)
 
2192
        if trans_id is None:
 
2193
            raise errors.NoSuchFile(path)
 
2194
        todo = [(child_trans_id, trans_id) for child_trans_id in
 
2195
                self._all_children(trans_id)]
 
2196
        for entry, trans_id in self._make_inv_entries(todo):
 
2197
            yield entry
 
2198
 
 
2199
    def iter_entries_by_dir(self, specific_files=None):
 
2200
        # This may not be a maximally efficient implementation, but it is
 
2201
        # reasonably straightforward.  An implementation that grafts the
 
2202
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
2203
        # might be more efficient, but requires tricky inferences about stack
 
2204
        # position.
 
2205
        ordered_ids = self._list_files_by_dir()
 
2206
        for entry, trans_id in self._make_inv_entries(ordered_ids,
 
2207
                                                      specific_files):
 
2208
            yield self._final_paths.get_path(trans_id), entry
 
2209
 
 
2210
    def _iter_entries_for_dir(self, dir_path):
 
2211
        """Return path, entry for items in a directory without recursing down."""
 
2212
        ordered_ids = []
 
2213
        dir_trans_id = self._path2trans_id(dir_path)
 
2214
        dir_id = self._transform.final_file_id(dir_trans_id)
 
2215
        for child_trans_id in self._all_children(dir_trans_id):
 
2216
            ordered_ids.append((child_trans_id, dir_id))
 
2217
        path_entries = []
 
2218
        for entry, trans_id in self._make_inv_entries(ordered_ids):
 
2219
            path_entries.append((self._final_paths.get_path(trans_id), entry))
 
2220
        path_entries.sort()
 
2221
        return path_entries
 
2222
 
 
2223
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2224
        """See WorkingTree.list_files."""
 
2225
        # XXX This should behave like WorkingTree.list_files, but is really
 
2226
        # more like RevisionTree.list_files.
 
2227
        if from_dir == '.':
 
2228
            from_dir = None
 
2229
        if recursive:
 
2230
            prefix = None
 
2231
            if from_dir:
 
2232
                prefix = from_dir + '/'
 
2233
            entries = self.iter_entries_by_dir()
 
2234
            for path, entry in entries:
 
2235
                if entry.name == '' and not include_root:
 
2236
                    continue
 
2237
                if prefix:
 
2238
                    if not path.startswith(prefix):
 
2239
                        continue
 
2240
                    path = path[len(prefix):]
 
2241
                yield path, 'V', entry.kind, entry
 
2242
        else:
 
2243
            if from_dir is None and include_root is True:
 
2244
                root_entry = inventory.make_entry(
 
2245
                    'directory', '', ROOT_PARENT, self.get_root_id())
 
2246
                yield '', 'V', 'directory', root_entry
 
2247
            entries = self._iter_entries_for_dir(from_dir or '')
 
2248
            for path, entry in entries:
 
2249
                yield path, 'V', entry.kind, entry
 
2250
 
 
2251
    def kind(self, path):
 
2252
        trans_id = self._path2trans_id(path)
 
2253
        if trans_id is None:
 
2254
            raise errors.NoSuchFile(path)
 
2255
        return self._transform.final_kind(trans_id)
 
2256
 
 
2257
    def stored_kind(self, path):
 
2258
        trans_id = self._path2trans_id(path)
 
2259
        if trans_id is None:
 
2260
            raise errors.NoSuchFile(path)
 
2261
        try:
 
2262
            return self._transform._new_contents[trans_id]
 
2263
        except KeyError:
 
2264
            return self._transform._tree.stored_kind(path)
 
2265
 
 
2266
    def get_file_mtime(self, path):
 
2267
        """See Tree.get_file_mtime"""
 
2268
        file_id = self.path2id(path)
 
2269
        if file_id is None:
 
2270
            raise errors.NoSuchFile(path)
 
2271
        if not self._content_change(file_id):
 
2272
            return self._transform._tree.get_file_mtime(
 
2273
                self._transform._tree.id2path(file_id))
 
2274
        trans_id = self._path2trans_id(path)
 
2275
        return self._stat_limbo_file(trans_id).st_mtime
 
2276
 
 
2277
    def get_file_size(self, path):
 
2278
        """See Tree.get_file_size"""
 
2279
        trans_id = self._path2trans_id(path)
 
2280
        if trans_id is None:
 
2281
            raise errors.NoSuchFile(path)
 
2282
        kind = self._transform.final_kind(trans_id)
 
2283
        if kind != 'file':
 
2284
            return None
 
2285
        if trans_id in self._transform._new_contents:
 
2286
            return self._stat_limbo_file(trans_id).st_size
 
2287
        if self.kind(path) == 'file':
 
2288
            return self._transform._tree.get_file_size(path)
 
2289
        else:
 
2290
            return None
 
2291
 
 
2292
    def get_file_verifier(self, path, stat_value=None):
 
2293
        trans_id = self._path2trans_id(path)
 
2294
        if trans_id is None:
 
2295
            raise errors.NoSuchFile(path)
 
2296
        kind = self._transform._new_contents.get(trans_id)
 
2297
        if kind is None:
 
2298
            return self._transform._tree.get_file_verifier(path)
 
2299
        if kind == 'file':
 
2300
            with self.get_file(path) as fileobj:
 
2301
                return ("SHA1", sha_file(fileobj))
 
2302
 
 
2303
    def get_file_sha1(self, path, stat_value=None):
 
2304
        trans_id = self._path2trans_id(path)
 
2305
        if trans_id is None:
 
2306
            raise errors.NoSuchFile(path)
 
2307
        kind = self._transform._new_contents.get(trans_id)
 
2308
        if kind is None:
 
2309
            return self._transform._tree.get_file_sha1(path)
 
2310
        if kind == 'file':
 
2311
            with self.get_file(path) as fileobj:
 
2312
                return sha_file(fileobj)
 
2313
 
 
2314
    def is_executable(self, path):
 
2315
        trans_id = self._path2trans_id(path)
 
2316
        if trans_id is None:
 
2317
            return False
 
2318
        try:
 
2319
            return self._transform._new_executability[trans_id]
 
2320
        except KeyError:
 
2321
            try:
 
2322
                return self._transform._tree.is_executable(path)
 
2323
            except OSError as e:
 
2324
                if e.errno == errno.ENOENT:
 
2325
                    return False
 
2326
                raise
 
2327
            except errors.NoSuchFile:
 
2328
                return False
 
2329
 
 
2330
    def has_filename(self, path):
 
2331
        trans_id = self._path2trans_id(path)
 
2332
        if trans_id in self._transform._new_contents:
 
2333
            return True
 
2334
        elif trans_id in self._transform._removed_contents:
 
2335
            return False
 
2336
        else:
 
2337
            return self._transform._tree.has_filename(path)
 
2338
 
 
2339
    def path_content_summary(self, path):
 
2340
        trans_id = self._path2trans_id(path)
 
2341
        tt = self._transform
 
2342
        tree_path = tt._tree_id_paths.get(trans_id)
 
2343
        kind = tt._new_contents.get(trans_id)
 
2344
        if kind is None:
 
2345
            if tree_path is None or trans_id in tt._removed_contents:
 
2346
                return 'missing', None, None, None
 
2347
            summary = tt._tree.path_content_summary(tree_path)
 
2348
            kind, size, executable, link_or_sha1 = summary
 
2349
        else:
 
2350
            link_or_sha1 = None
 
2351
            limbo_name = tt._limbo_name(trans_id)
 
2352
            if trans_id in tt._new_reference_revision:
 
2353
                kind = 'tree-reference'
 
2354
            if kind == 'file':
 
2355
                statval = os.lstat(limbo_name)
 
2356
                size = statval.st_size
 
2357
                if not tt._limbo_supports_executable():
 
2358
                    executable = False
 
2359
                else:
 
2360
                    executable = statval.st_mode & S_IEXEC
 
2361
            else:
 
2362
                size = None
 
2363
                executable = None
 
2364
            if kind == 'symlink':
 
2365
                link_or_sha1 = os.readlink(limbo_name)
 
2366
                if not isinstance(link_or_sha1, text_type):
 
2367
                    link_or_sha1 = link_or_sha1.decode(osutils._fs_enc)
 
2368
        executable = tt._new_executability.get(trans_id, executable)
 
2369
        return kind, size, executable, link_or_sha1
 
2370
 
 
2371
    def iter_changes(self, from_tree, include_unchanged=False,
 
2372
                     specific_files=None, pb=None, extra_trees=None,
 
2373
                     require_versioned=True, want_unversioned=False):
 
2374
        """See InterTree.iter_changes.
 
2375
 
 
2376
        This has a fast path that is only used when the from_tree matches
 
2377
        the transform tree, and no fancy options are supplied.
 
2378
        """
 
2379
        if (from_tree is not self._transform._tree or include_unchanged
 
2380
                or specific_files or want_unversioned):
 
2381
            return tree.InterTree(from_tree, self).iter_changes(
 
2382
                include_unchanged=include_unchanged,
 
2383
                specific_files=specific_files,
 
2384
                pb=pb,
 
2385
                extra_trees=extra_trees,
 
2386
                require_versioned=require_versioned,
 
2387
                want_unversioned=want_unversioned)
 
2388
        if want_unversioned:
 
2389
            raise ValueError('want_unversioned is not supported')
 
2390
        return self._transform.iter_changes()
 
2391
 
 
2392
    def get_file(self, path):
 
2393
        """See Tree.get_file"""
 
2394
        file_id = self.path2id(path)
 
2395
        if not self._content_change(file_id):
 
2396
            return self._transform._tree.get_file(path)
 
2397
        trans_id = self._path2trans_id(path)
 
2398
        name = self._transform._limbo_name(trans_id)
 
2399
        return open(name, 'rb')
 
2400
 
 
2401
    def get_file_with_stat(self, path):
 
2402
        return self.get_file(path), None
 
2403
 
 
2404
    def annotate_iter(self, path,
 
2405
                      default_revision=_mod_revision.CURRENT_REVISION):
 
2406
        file_id = self.path2id(path)
 
2407
        changes = self._iter_changes_cache.get(file_id)
 
2408
        if changes is None:
 
2409
            get_old = True
 
2410
        else:
 
2411
            changed_content, versioned, kind = (changes[2], changes[3],
 
2412
                                                changes[6])
 
2413
            if kind[1] is None:
 
2414
                return None
 
2415
            get_old = (kind[0] == 'file' and versioned[0])
 
2416
        if get_old:
 
2417
            old_annotation = self._transform._tree.annotate_iter(
 
2418
                path, default_revision=default_revision)
 
2419
        else:
 
2420
            old_annotation = []
 
2421
        if changes is None:
 
2422
            return old_annotation
 
2423
        if not changed_content:
 
2424
            return old_annotation
 
2425
        # TODO: This is doing something similar to what WT.annotate_iter is
 
2426
        #       doing, however it fails slightly because it doesn't know what
 
2427
        #       the *other* revision_id is, so it doesn't know how to give the
 
2428
        #       other as the origin for some lines, they all get
 
2429
        #       'default_revision'
 
2430
        #       It would be nice to be able to use the new Annotator based
 
2431
        #       approach, as well.
 
2432
        return annotate.reannotate([old_annotation],
 
2433
                                   self.get_file(path).readlines(),
 
2434
                                   default_revision)
 
2435
 
 
2436
    def get_symlink_target(self, path):
 
2437
        """See Tree.get_symlink_target"""
 
2438
        file_id = self.path2id(path)
 
2439
        if not self._content_change(file_id):
 
2440
            return self._transform._tree.get_symlink_target(path)
 
2441
        trans_id = self._path2trans_id(path)
 
2442
        name = self._transform._limbo_name(trans_id)
 
2443
        return osutils.readlink(name)
 
2444
 
 
2445
    def walkdirs(self, prefix=''):
 
2446
        pending = [self._transform.root]
 
2447
        while len(pending) > 0:
 
2448
            parent_id = pending.pop()
 
2449
            children = []
 
2450
            subdirs = []
 
2451
            prefix = prefix.rstrip('/')
 
2452
            parent_path = self._final_paths.get_path(parent_id)
 
2453
            parent_file_id = self._transform.final_file_id(parent_id)
 
2454
            for child_id in self._all_children(parent_id):
 
2455
                path_from_root = self._final_paths.get_path(child_id)
 
2456
                basename = self._transform.final_name(child_id)
 
2457
                file_id = self._transform.final_file_id(child_id)
 
2458
                kind = self._transform.final_kind(child_id)
 
2459
                if kind is not None:
 
2460
                    versioned_kind = kind
 
2461
                else:
 
2462
                    kind = 'unknown'
 
2463
                    versioned_kind = self._transform._tree.stored_kind(
 
2464
                        self._transform._tree.id2path(file_id))
 
2465
                if versioned_kind == 'directory':
 
2466
                    subdirs.append(child_id)
 
2467
                children.append((path_from_root, basename, kind, None,
 
2468
                                 file_id, versioned_kind))
 
2469
            children.sort()
 
2470
            if parent_path.startswith(prefix):
 
2471
                yield (parent_path, parent_file_id), children
 
2472
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
 
2473
                                  reverse=True))
 
2474
 
 
2475
    def get_parent_ids(self):
 
2476
        return self._parent_ids
 
2477
 
 
2478
    def set_parent_ids(self, parent_ids):
 
2479
        self._parent_ids = parent_ids
 
2480
 
 
2481
    def get_revision_tree(self, revision_id):
 
2482
        return self._transform._tree.get_revision_tree(revision_id)
 
2483
 
 
2484
 
602
2485
def joinpath(parent, child):
603
2486
    """Join tree-relative paths, handling the tree root specially"""
604
2487
    if parent is None or parent == "":
620
2503
        self.transform = transform
621
2504
 
622
2505
    def _determine_path(self, trans_id):
623
 
        if trans_id == self.transform.root or trans_id == ROOT_PARENT:
 
2506
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
624
2507
            return u""
625
2508
        name = self.transform.final_name(trans_id)
626
2509
        parent_id = self.transform.final_parent(trans_id)
639
2522
        return [(self.get_path(t), t) for t in trans_ids]
640
2523
 
641
2524
 
 
2525
def topology_sorted_ids(tree):
 
2526
    """Determine the topological order of the ids in a tree"""
 
2527
    file_ids = list(tree)
 
2528
    file_ids.sort(key=tree.id2path)
 
2529
    return file_ids
 
2530
 
 
2531
 
642
2532
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
643
2533
               delta_from_tree=False):
644
2534
    """Create working tree for a branch, using a TreeTransform.
665
2555
    :param delta_from_tree: If true, build_tree may use the input Tree to
666
2556
        generate the inventory delta.
667
2557
    """
668
 
    with contextlib.ExitStack() as exit_stack:
669
 
        exit_stack.enter_context(wt.lock_tree_write())
670
 
        exit_stack.enter_context(tree.lock_read())
 
2558
    with wt.lock_tree_write(), tree.lock_read():
671
2559
        if accelerator_tree is not None:
672
 
            exit_stack.enter_context(accelerator_tree.lock_read())
673
 
        return _build_tree(tree, wt, accelerator_tree, hardlink,
674
 
                           delta_from_tree)
 
2560
            accelerator_tree.lock_read()
 
2561
        try:
 
2562
            return _build_tree(tree, wt, accelerator_tree, hardlink,
 
2563
                               delta_from_tree)
 
2564
        finally:
 
2565
            if accelerator_tree is not None:
 
2566
                accelerator_tree.unlock()
675
2567
 
676
2568
 
677
2569
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
682
2574
    file_trans_id = {}
683
2575
    top_pb = ui.ui_factory.nested_progress_bar()
684
2576
    pp = ProgressPhase("Build phase", 2, top_pb)
685
 
    if tree.path2id('') is not None:
 
2577
    if tree.get_root_id() is not None:
686
2578
        # This is kind of a hack: we should be altering the root
687
2579
        # as part of the regular tree shape diff logic.
688
2580
        # The conditional test here is to avoid doing an
690
2582
        # is set within the tree, nor setting the root and thus
691
2583
        # marking the tree as dirty, because we use two different
692
2584
        # idioms here: tree interfaces and inventory interfaces.
693
 
        if wt.path2id('') != tree.path2id(''):
694
 
            wt.set_root_id(tree.path2id(''))
 
2585
        if wt.get_root_id() != tree.get_root_id():
 
2586
            wt.set_root_id(tree.get_root_id())
695
2587
            wt.flush()
696
 
    tt = wt.transform()
 
2588
    tt = TreeTransform(wt)
697
2589
    divert = set()
698
2590
    try:
699
2591
        pp.next_phase()
700
 
        file_trans_id[find_previous_path(wt, tree, '')] = tt.trans_id_tree_path('')
 
2592
        file_trans_id[wt.get_root_id()] = tt.trans_id_tree_path('')
701
2593
        with ui.ui_factory.nested_progress_bar() as pb:
702
2594
            deferred_contents = []
703
2595
            num = 0
734
2626
                        except errors.NotBranchError:
735
2627
                            pass
736
2628
                        else:
737
 
                            divert.add(tree_path)
738
 
                    if (tree_path not in divert
 
2629
                            divert.add(file_id)
 
2630
                    if (file_id not in divert
739
2631
                        and _content_match(
740
 
                            tree, entry, tree_path, kind, target_path)):
 
2632
                            tree, entry, tree_path, file_id, kind,
 
2633
                            target_path)):
741
2634
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
742
2635
                        if kind == 'directory':
743
2636
                            reparent = True
744
 
                parent_id = file_trans_id[osutils.dirname(tree_path)]
 
2637
                parent_id = file_trans_id[entry.parent_id]
745
2638
                if entry.kind == 'file':
746
2639
                    # We *almost* replicate new_by_entry, so that we can defer
747
2640
                    # getting the file text, and get them all at once.
748
2641
                    trans_id = tt.create_path(entry.name, parent_id)
749
 
                    file_trans_id[tree_path] = trans_id
750
 
                    tt.version_file(trans_id, file_id=file_id)
 
2642
                    file_trans_id[file_id] = trans_id
 
2643
                    tt.version_file(file_id, trans_id)
751
2644
                    executable = tree.is_executable(tree_path)
752
2645
                    if executable:
753
2646
                        tt.set_executability(executable, trans_id)
754
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
 
2647
                    trans_data = (trans_id, file_id,
 
2648
                                  tree_path, entry.text_sha1)
755
2649
                    deferred_contents.append((tree_path, trans_data))
756
2650
                else:
757
 
                    file_trans_id[tree_path] = new_by_entry(
 
2651
                    file_trans_id[file_id] = new_by_entry(
758
2652
                        tree_path, tt, entry, parent_id, tree)
759
2653
                if reparent:
760
 
                    new_trans_id = file_trans_id[tree_path]
 
2654
                    new_trans_id = file_trans_id[file_id]
761
2655
                    old_parent = tt.trans_id_tree_path(tree_path)
762
2656
                    _reparent_children(tt, old_parent, new_trans_id)
763
2657
            offset = num + 1 - len(deferred_contents)
771
2665
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
772
2666
        if len(raw_conflicts) > 0:
773
2667
            precomputed_delta = None
774
 
        conflicts = tt.cook_conflicts(raw_conflicts)
 
2668
        conflicts = cook_conflicts(raw_conflicts, tt)
775
2669
        for conflict in conflicts:
776
 
            trace.warning(str(conflict))
 
2670
            trace.warning(text_type(conflict))
777
2671
        try:
778
2672
            wt.add_conflicts(conflicts)
779
2673
        except errors.UnsupportedOperation:
794
2688
        new_desired_files = desired_files
795
2689
    else:
796
2690
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
797
 
        unchanged = [
798
 
            change.path for change in iter
799
 
            if not (change.changed_content or change.executable[0] != change.executable[1])]
 
2691
        unchanged = [(p[0], p[1]) for (f, p, c, v, d, n, k, e)
 
2692
                     in iter if not (c or e[0] != e[1])]
800
2693
        if accelerator_tree.supports_content_filtering():
801
2694
            unchanged = [(tp, ap) for (tp, ap) in unchanged
802
2695
                         if not next(accelerator_tree.iter_search_rules([ap]))]
803
2696
        unchanged = dict(unchanged)
804
2697
        new_desired_files = []
805
2698
        count = 0
806
 
        for unused_tree_path, (trans_id, tree_path, text_sha1) in desired_files:
 
2699
        for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
807
2700
            accelerator_path = unchanged.get(tree_path)
808
2701
            if accelerator_path is None:
809
2702
                new_desired_files.append((tree_path,
810
 
                                          (trans_id, tree_path, text_sha1)))
 
2703
                                          (trans_id, file_id, tree_path, text_sha1)))
811
2704
                continue
812
2705
            pb.update(gettext('Adding file contents'), count + offset, total)
813
2706
            if hardlink:
823
2716
                    tt.create_file(chunks, trans_id, sha1=text_sha1)
824
2717
            count += 1
825
2718
        offset += count
826
 
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
 
2719
    for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
827
2720
            tree.iter_files_bytes(new_desired_files)):
828
2721
        if wt.supports_content_filtering():
829
2722
            filters = wt._content_filter_stack(tree_path)
845
2738
    return by_parent[old_parent]
846
2739
 
847
2740
 
848
 
def _content_match(tree, entry, tree_path, kind, target_path):
 
2741
def _content_match(tree, entry, tree_path, file_id, kind, target_path):
849
2742
    if entry.kind != kind:
850
2743
        return False
851
2744
    if entry.kind == "directory":
913
2806
        raise errors.BadFileKindError(name, kind)
914
2807
 
915
2808
 
916
 
def create_from_tree(tt, trans_id, tree, path, chunks=None,
 
2809
def create_from_tree(tt, trans_id, tree, path, file_id=None, chunks=None,
917
2810
                     filter_tree_path=None):
918
2811
    """Create new file contents according to tree contents.
919
2812
 
958
2851
    """Revert a working tree's contents to those of a target tree."""
959
2852
    pb = ui.ui_factory.nested_progress_bar()
960
2853
    try:
961
 
        with target_tree.lock_read(), working_tree.transform(pb) as tt:
 
2854
        with target_tree.lock_read(), TreeTransform(working_tree, pb) as tt:
962
2855
            pp = ProgressPhase("Revert phase", 3, pb)
963
2856
            conflicts, merge_modified = _prepare_revert_transform(
964
2857
                working_tree, target_tree, tt, filenames, backups, pp)
965
2858
            if change_reporter:
966
 
                from . import delta
967
2859
                change_reporter = delta._ChangeReporter(
968
2860
                    unversioned_filter=working_tree.is_ignored)
969
2861
                delta.report_changes(tt.iter_changes(), change_reporter)
970
2862
            for conflict in conflicts:
971
 
                trace.warning(str(conflict))
 
2863
                trace.warning(text_type(conflict))
972
2864
            pp.next_phase()
973
2865
            tt.apply()
974
2866
            if working_tree.supports_merge_modified():
990
2882
    with ui.ui_factory.nested_progress_bar() as child_pb:
991
2883
        raw_conflicts = resolve_conflicts(
992
2884
            tt, child_pb, lambda t, c: conflict_pass(t, c, target_tree))
993
 
    conflicts = tt.cook_conflicts(raw_conflicts)
 
2885
    conflicts = cook_conflicts(raw_conflicts, tt)
994
2886
    return conflicts, merge_modified
995
2887
 
996
2888
 
1010
2902
        skip_root = False
1011
2903
    try:
1012
2904
        deferred_files = []
1013
 
        for id_num, change in enumerate(change_list):
1014
 
            target_path, wt_path = change.path
1015
 
            target_versioned, wt_versioned = change.versioned
1016
 
            target_parent = change.parent_id[0]
1017
 
            target_name, wt_name = change.name
1018
 
            target_kind, wt_kind = change.kind
1019
 
            target_executable, wt_executable = change.executable
1020
 
            if skip_root and wt_path == '':
 
2905
        for id_num, (file_id, path, changed_content, versioned, parent, name,
 
2906
                     kind, executable) in enumerate(change_list):
 
2907
            target_path, wt_path = path
 
2908
            target_versioned, wt_versioned = versioned
 
2909
            target_parent, wt_parent = parent
 
2910
            target_name, wt_name = name
 
2911
            target_kind, wt_kind = kind
 
2912
            target_executable, wt_executable = executable
 
2913
            if skip_root and wt_parent is None:
1021
2914
                continue
1022
 
            trans_id = tt.trans_id_file_id(change.file_id)
 
2915
            trans_id = tt.trans_id_file_id(file_id)
1023
2916
            mode_id = None
1024
 
            if change.changed_content:
 
2917
            if changed_content:
1025
2918
                keep_content = False
1026
2919
                if wt_kind == 'file' and (backups or target_kind is None):
1027
2920
                    wt_sha1 = working_tree.get_file_sha1(wt_path)
1028
 
                    if merge_modified.get(wt_path) != wt_sha1:
 
2921
                    if merge_modified.get(file_id) != wt_sha1:
1029
2922
                        # acquire the basis tree lazily to prevent the
1030
2923
                        # expense of accessing it when it's not needed ?
1031
2924
                        # (Guessing, RBC, 200702)
1032
2925
                        if basis_tree is None:
1033
2926
                            basis_tree = working_tree.basis_tree()
1034
2927
                            basis_tree.lock_read()
1035
 
                        basis_inter = InterTree.get(basis_tree, working_tree)
1036
 
                        basis_path = basis_inter.find_source_path(wt_path)
 
2928
                        basis_path = find_previous_path(
 
2929
                            working_tree, basis_tree, wt_path)
1037
2930
                        if basis_path is None:
1038
2931
                            if target_kind is None and not target_versioned:
1039
2932
                                keep_content = True
1044
2937
                    if not keep_content:
1045
2938
                        tt.delete_contents(trans_id)
1046
2939
                    elif target_kind is not None:
1047
 
                        parent_trans_id = tt.trans_id_tree_path(osutils.dirname(wt_path))
 
2940
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
1048
2941
                        backup_name = tt._available_backup_name(
1049
2942
                            wt_name, parent_trans_id)
1050
2943
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
1051
2944
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
1052
2945
                        if wt_versioned and target_versioned:
1053
2946
                            tt.unversion_file(trans_id)
1054
 
                            tt.version_file(
1055
 
                                new_trans_id, file_id=getattr(change, 'file_id', None))
 
2947
                            tt.version_file(file_id, new_trans_id)
1056
2948
                        # New contents should have the same unix perms as old
1057
2949
                        # contents
1058
2950
                        mode_id = trans_id
1068
2960
                        target_path), trans_id)
1069
2961
                elif target_kind == 'file':
1070
2962
                    deferred_files.append(
1071
 
                        (target_path, (trans_id, mode_id, target_path)))
 
2963
                        (target_path, (trans_id, mode_id, file_id)))
1072
2964
                    if basis_tree is None:
1073
2965
                        basis_tree = working_tree.basis_tree()
1074
2966
                        basis_tree.lock_read()
1075
2967
                    new_sha1 = target_tree.get_file_sha1(target_path)
1076
 
                    basis_inter = InterTree.get(basis_tree, target_tree)
1077
 
                    basis_path = basis_inter.find_source_path(target_path)
 
2968
                    basis_path = find_previous_path(target_tree, basis_tree, target_path)
1078
2969
                    if (basis_path is not None and
1079
2970
                            new_sha1 == basis_tree.get_file_sha1(basis_path)):
1080
 
                        # If the new contents of the file match what is in basis,
1081
 
                        # then there is no need to store in merge_modified.
1082
 
                        if basis_path in merge_modified:
1083
 
                            del merge_modified[basis_path]
 
2971
                        if file_id in merge_modified:
 
2972
                            del merge_modified[file_id]
1084
2973
                    else:
1085
 
                        merge_modified[target_path] = new_sha1
 
2974
                        merge_modified[file_id] = new_sha1
1086
2975
 
1087
2976
                    # preserve the execute bit when backing up
1088
2977
                    if keep_content and wt_executable == target_executable:
1090
2979
                elif target_kind is not None:
1091
2980
                    raise AssertionError(target_kind)
1092
2981
            if not wt_versioned and target_versioned:
1093
 
                tt.version_file(
1094
 
                    trans_id, file_id=getattr(change, 'file_id', None))
 
2982
                tt.version_file(file_id, trans_id)
1095
2983
            if wt_versioned and not target_versioned:
1096
2984
                tt.unversion_file(trans_id)
1097
2985
            if (target_name is not None
1098
 
                    and (wt_name != target_name or change.is_reparented())):
1099
 
                if target_path == '':
 
2986
                    and (wt_name != target_name or wt_parent != target_parent)):
 
2987
                if target_name == '' and target_parent is None:
1100
2988
                    parent_trans = ROOT_PARENT
1101
2989
                else:
1102
2990
                    parent_trans = tt.trans_id_file_id(target_parent)
1103
 
                if wt_path == '' and wt_versioned:
 
2991
                if wt_parent is None and wt_versioned:
1104
2992
                    tt.adjust_root_path(target_name, parent_trans)
1105
2993
                else:
1106
2994
                    tt.adjust_path(target_name, parent_trans, trans_id)
1107
2995
            if wt_executable != target_executable and target_kind == "file":
1108
2996
                tt.set_executability(target_executable, trans_id)
1109
2997
        if working_tree.supports_content_filtering():
1110
 
            for (trans_id, mode_id, target_path), bytes in (
 
2998
            for (trans_id, mode_id, file_id), bytes in (
1111
2999
                    target_tree.iter_files_bytes(deferred_files)):
1112
3000
                # We're reverting a tree to the target tree so using the
1113
3001
                # target tree to find the file path seems the best choice
1114
3002
                # here IMO - Ian C 27/Oct/2009
1115
 
                filters = working_tree._content_filter_stack(target_path)
 
3003
                filter_tree_path = target_tree.id2path(file_id)
 
3004
                filters = working_tree._content_filter_stack(filter_tree_path)
1116
3005
                bytes = filtered_output_bytes(
1117
3006
                    bytes, filters,
1118
 
                    ContentFilterContext(target_path, working_tree))
 
3007
                    ContentFilterContext(filter_tree_path, working_tree))
1119
3008
                tt.create_file(bytes, trans_id, mode_id)
1120
3009
        else:
1121
 
            for (trans_id, mode_id, target_path), bytes in target_tree.iter_files_bytes(
 
3010
            for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
1122
3011
                    deferred_files):
1123
3012
                tt.create_file(bytes, trans_id, mode_id)
1124
3013
        tt.fixup_new_roots()
1136
3025
    with ui.ui_factory.nested_progress_bar() as pb:
1137
3026
        for n in range(10):
1138
3027
            pb.update(gettext('Resolution pass'), n + 1, 10)
1139
 
            conflicts = tt.find_raw_conflicts()
 
3028
            conflicts = tt.find_conflicts()
1140
3029
            if len(conflicts) == 0:
1141
3030
                return new_conflicts
1142
3031
            new_conflicts.update(pass_func(tt, conflicts))
1143
3032
        raise MalformedTransform(conflicts=conflicts)
1144
3033
 
1145
3034
 
1146
 
def resolve_duplicate_id(tt, path_tree, c_type, old_trans_id, trans_id):
1147
 
    tt.unversion_file(old_trans_id)
1148
 
    yield (c_type, 'Unversioned existing file', old_trans_id, trans_id)
1149
 
 
1150
 
 
1151
 
def resolve_duplicate(tt, path_tree, c_type, last_trans_id, trans_id, name):
1152
 
    # files that were renamed take precedence
1153
 
    final_parent = tt.final_parent(last_trans_id)
1154
 
    if tt.path_changed(last_trans_id):
1155
 
        existing_file, new_file = trans_id, last_trans_id
1156
 
    else:
1157
 
        existing_file, new_file = last_trans_id, trans_id
1158
 
    new_name = tt.final_name(existing_file) + '.moved'
1159
 
    tt.adjust_path(new_name, final_parent, existing_file)
1160
 
    yield (c_type, 'Moved existing file to', existing_file, new_file)
1161
 
 
1162
 
 
1163
 
def resolve_parent_loop(tt, path_tree, c_type, cur):
1164
 
    # break the loop by undoing one of the ops that caused the loop
1165
 
    while not tt.path_changed(cur):
1166
 
        cur = tt.final_parent(cur)
1167
 
    yield (c_type, 'Cancelled move', cur, tt.final_parent(cur),)
1168
 
    tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1169
 
 
1170
 
 
1171
 
def resolve_missing_parent(tt, path_tree, c_type, trans_id):
1172
 
    if trans_id in tt._removed_contents:
1173
 
        cancel_deletion = True
1174
 
        orphans = tt._get_potential_orphans(trans_id)
1175
 
        if orphans:
1176
 
            cancel_deletion = False
1177
 
            # All children are orphans
1178
 
            for o in orphans:
1179
 
                try:
1180
 
                    tt.new_orphan(o, trans_id)
1181
 
                except OrphaningError:
1182
 
                    # Something bad happened so we cancel the directory
1183
 
                    # deletion which will leave it in place with a
1184
 
                    # conflict. The user can deal with it from there.
1185
 
                    # Note that this also catch the case where we don't
1186
 
                    # want to create orphans and leave the directory in
1187
 
                    # place.
1188
 
                    cancel_deletion = True
1189
 
                    break
1190
 
        if cancel_deletion:
1191
 
            # Cancel the directory deletion
1192
 
            tt.cancel_deletion(trans_id)
1193
 
            yield ('deleting parent', 'Not deleting', trans_id)
1194
 
    else:
1195
 
        create = True
1196
 
        try:
1197
 
            tt.final_name(trans_id)
1198
 
        except NoFinalPath:
1199
 
            if path_tree is not None:
1200
 
                file_id = tt.final_file_id(trans_id)
1201
 
                if file_id is None:
1202
 
                    file_id = tt.inactive_file_id(trans_id)
1203
 
                _, entry = next(path_tree.iter_entries_by_dir(
1204
 
                    specific_files=[path_tree.id2path(file_id)]))
1205
 
                # special-case the other tree root (move its
1206
 
                # children to current root)
1207
 
                if entry.parent_id is None:
1208
 
                    create = False
1209
 
                    moved = _reparent_transform_children(
1210
 
                        tt, trans_id, tt.root)
1211
 
                    for child in moved:
1212
 
                        yield (c_type, 'Moved to root', child)
1213
 
                else:
1214
 
                    parent_trans_id = tt.trans_id_file_id(
1215
 
                        entry.parent_id)
1216
 
                    tt.adjust_path(entry.name, parent_trans_id,
1217
 
                                   trans_id)
1218
 
        if create:
1219
 
            tt.create_directory(trans_id)
1220
 
            yield (c_type, 'Created directory', trans_id)
1221
 
 
1222
 
 
1223
 
def resolve_unversioned_parent(tt, path_tree, c_type, trans_id):
1224
 
    file_id = tt.inactive_file_id(trans_id)
1225
 
    # special-case the other tree root (move its children instead)
1226
 
    if path_tree and path_tree.path2id('') == file_id:
1227
 
        # This is the root entry, skip it
1228
 
        return
1229
 
    tt.version_file(trans_id, file_id=file_id)
1230
 
    yield (c_type, 'Versioned directory', trans_id)
1231
 
 
1232
 
 
1233
 
def resolve_non_directory_parent(tt, path_tree, c_type, parent_id):
1234
 
    parent_parent = tt.final_parent(parent_id)
1235
 
    parent_name = tt.final_name(parent_id)
1236
 
    # TODO(jelmer): Make this code transform-specific
1237
 
    if tt._tree.supports_setting_file_ids():
1238
 
        parent_file_id = tt.final_file_id(parent_id)
1239
 
    else:
1240
 
        parent_file_id = b'DUMMY'
1241
 
    new_parent_id = tt.new_directory(parent_name + '.new',
1242
 
                                     parent_parent, parent_file_id)
1243
 
    _reparent_transform_children(tt, parent_id, new_parent_id)
1244
 
    if parent_file_id is not None:
1245
 
        tt.unversion_file(parent_id)
1246
 
    yield (c_type, 'Created directory', new_parent_id)
1247
 
 
1248
 
 
1249
 
def resolve_versioning_no_contents(tt, path_tree, c_type, trans_id):
1250
 
    tt.cancel_versioning(trans_id)
1251
 
    return []
1252
 
 
1253
 
 
1254
 
CONFLICT_RESOLVERS = {
1255
 
    'duplicate id': resolve_duplicate_id,
1256
 
    'duplicate': resolve_duplicate,
1257
 
    'parent loop': resolve_parent_loop,
1258
 
    'missing parent': resolve_missing_parent,
1259
 
    'unversioned parent': resolve_unversioned_parent,
1260
 
    'non-directory parent': resolve_non_directory_parent,
1261
 
    'versioning no contents': resolve_versioning_no_contents,
1262
 
}
1263
 
 
1264
 
 
1265
3035
def conflict_pass(tt, conflicts, path_tree=None):
1266
3036
    """Resolve some classes of conflicts.
1267
3037
 
1270
3040
    :param path_tree: A Tree to get supplemental paths from
1271
3041
    """
1272
3042
    new_conflicts = set()
1273
 
    for conflict in conflicts:
1274
 
        resolver = CONFLICT_RESOLVERS.get(conflict[0])
1275
 
        if resolver is None:
1276
 
            continue
1277
 
        new_conflicts.update(resolver(tt, path_tree, *conflict))
 
3043
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
3044
        if c_type == 'duplicate id':
 
3045
            tt.unversion_file(conflict[1])
 
3046
            new_conflicts.add((c_type, 'Unversioned existing file',
 
3047
                               conflict[1], conflict[2], ))
 
3048
        elif c_type == 'duplicate':
 
3049
            # files that were renamed take precedence
 
3050
            final_parent = tt.final_parent(conflict[1])
 
3051
            if tt.path_changed(conflict[1]):
 
3052
                existing_file, new_file = conflict[2], conflict[1]
 
3053
            else:
 
3054
                existing_file, new_file = conflict[1], conflict[2]
 
3055
            new_name = tt.final_name(existing_file) + '.moved'
 
3056
            tt.adjust_path(new_name, final_parent, existing_file)
 
3057
            new_conflicts.add((c_type, 'Moved existing file to',
 
3058
                               existing_file, new_file))
 
3059
        elif c_type == 'parent loop':
 
3060
            # break the loop by undoing one of the ops that caused the loop
 
3061
            cur = conflict[1]
 
3062
            while not tt.path_changed(cur):
 
3063
                cur = tt.final_parent(cur)
 
3064
            new_conflicts.add((c_type, 'Cancelled move', cur,
 
3065
                               tt.final_parent(cur),))
 
3066
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
 
3067
 
 
3068
        elif c_type == 'missing parent':
 
3069
            trans_id = conflict[1]
 
3070
            if trans_id in tt._removed_contents:
 
3071
                cancel_deletion = True
 
3072
                orphans = tt._get_potential_orphans(trans_id)
 
3073
                if orphans:
 
3074
                    cancel_deletion = False
 
3075
                    # All children are orphans
 
3076
                    for o in orphans:
 
3077
                        try:
 
3078
                            tt.new_orphan(o, trans_id)
 
3079
                        except OrphaningError:
 
3080
                            # Something bad happened so we cancel the directory
 
3081
                            # deletion which will leave it in place with a
 
3082
                            # conflict. The user can deal with it from there.
 
3083
                            # Note that this also catch the case where we don't
 
3084
                            # want to create orphans and leave the directory in
 
3085
                            # place.
 
3086
                            cancel_deletion = True
 
3087
                            break
 
3088
                if cancel_deletion:
 
3089
                    # Cancel the directory deletion
 
3090
                    tt.cancel_deletion(trans_id)
 
3091
                    new_conflicts.add(('deleting parent', 'Not deleting',
 
3092
                                       trans_id))
 
3093
            else:
 
3094
                create = True
 
3095
                try:
 
3096
                    tt.final_name(trans_id)
 
3097
                except NoFinalPath:
 
3098
                    if path_tree is not None:
 
3099
                        file_id = tt.final_file_id(trans_id)
 
3100
                        if file_id is None:
 
3101
                            file_id = tt.inactive_file_id(trans_id)
 
3102
                        _, entry = next(path_tree.iter_entries_by_dir(
 
3103
                            specific_files=[path_tree.id2path(file_id)]))
 
3104
                        # special-case the other tree root (move its
 
3105
                        # children to current root)
 
3106
                        if entry.parent_id is None:
 
3107
                            create = False
 
3108
                            moved = _reparent_transform_children(
 
3109
                                tt, trans_id, tt.root)
 
3110
                            for child in moved:
 
3111
                                new_conflicts.add((c_type, 'Moved to root',
 
3112
                                                   child))
 
3113
                        else:
 
3114
                            parent_trans_id = tt.trans_id_file_id(
 
3115
                                entry.parent_id)
 
3116
                            tt.adjust_path(entry.name, parent_trans_id,
 
3117
                                           trans_id)
 
3118
                if create:
 
3119
                    tt.create_directory(trans_id)
 
3120
                    new_conflicts.add((c_type, 'Created directory', trans_id))
 
3121
        elif c_type == 'unversioned parent':
 
3122
            file_id = tt.inactive_file_id(conflict[1])
 
3123
            # special-case the other tree root (move its children instead)
 
3124
            if path_tree and path_tree.path2id('') == file_id:
 
3125
                # This is the root entry, skip it
 
3126
                continue
 
3127
            tt.version_file(file_id, conflict[1])
 
3128
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
3129
        elif c_type == 'non-directory parent':
 
3130
            parent_id = conflict[1]
 
3131
            parent_parent = tt.final_parent(parent_id)
 
3132
            parent_name = tt.final_name(parent_id)
 
3133
            parent_file_id = tt.final_file_id(parent_id)
 
3134
            new_parent_id = tt.new_directory(parent_name + '.new',
 
3135
                                             parent_parent, parent_file_id)
 
3136
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
3137
            if parent_file_id is not None:
 
3138
                tt.unversion_file(parent_id)
 
3139
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
 
3140
        elif c_type == 'versioning no contents':
 
3141
            tt.cancel_versioning(conflict[1])
1278
3142
    return new_conflicts
1279
3143
 
1280
3144
 
 
3145
def cook_conflicts(raw_conflicts, tt):
 
3146
    """Generate a list of cooked conflicts, sorted by file path"""
 
3147
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
 
3148
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
3149
 
 
3150
 
 
3151
def iter_cook_conflicts(raw_conflicts, tt):
 
3152
    fp = FinalPaths(tt)
 
3153
    for conflict in raw_conflicts:
 
3154
        c_type = conflict[0]
 
3155
        action = conflict[1]
 
3156
        modified_path = fp.get_path(conflict[2])
 
3157
        modified_id = tt.final_file_id(conflict[2])
 
3158
        if len(conflict) == 3:
 
3159
            yield conflicts.Conflict.factory(
 
3160
                c_type, action=action, path=modified_path, file_id=modified_id)
 
3161
 
 
3162
        else:
 
3163
            conflicting_path = fp.get_path(conflict[3])
 
3164
            conflicting_id = tt.final_file_id(conflict[3])
 
3165
            yield conflicts.Conflict.factory(
 
3166
                c_type, action=action, path=modified_path,
 
3167
                file_id=modified_id,
 
3168
                conflict_path=conflicting_path,
 
3169
                conflict_file_id=conflicting_id)
 
3170
 
 
3171
 
1281
3172
class _FileMover(object):
1282
3173
    """Moves and deletes files for TreeTransform, tracking operations"""
1283
3174
 
1294
3185
                raise errors.FileExists(to, str(e))
1295
3186
            # normal OSError doesn't include filenames so it's hard to see where
1296
3187
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
1297
 
            raise TransformRenameFailed(from_, to, str(e), e.errno)
 
3188
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
1298
3189
        self.past_renames.append((from_, to))
1299
3190
 
1300
3191
    def pre_delete(self, from_, to):
1313
3204
            try:
1314
3205
                os.rename(to, from_)
1315
3206
            except OSError as e:
1316
 
                raise TransformRenameFailed(to, from_, str(e), e.errno)
 
3207
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
1317
3208
        # after rollback, don't reuse _FileMover
1318
3209
        self.past_renames = None
1319
3210
        self.pending_deletions = None
1333
3224
    :param target_tree: Tree to change
1334
3225
    :param source_tree: Tree to hard-link from
1335
3226
    """
1336
 
    with target_tree.transform() as tt:
1337
 
        for change in target_tree.iter_changes(source_tree, include_unchanged=True):
1338
 
            if change.changed_content:
1339
 
                continue
1340
 
            if change.kind != ('file', 'file'):
1341
 
                continue
1342
 
            if change.executable[0] != change.executable[1]:
1343
 
                continue
1344
 
            trans_id = tt.trans_id_tree_path(change.path[1])
 
3227
    tt = TreeTransform(target_tree)
 
3228
    try:
 
3229
        for (file_id, paths, changed_content, versioned, parent, name, kind,
 
3230
             executable) in target_tree.iter_changes(source_tree,
 
3231
                                                     include_unchanged=True):
 
3232
            if changed_content:
 
3233
                continue
 
3234
            if kind != ('file', 'file'):
 
3235
                continue
 
3236
            if executable[0] != executable[1]:
 
3237
                continue
 
3238
            trans_id = tt.trans_id_tree_path(paths[1])
1345
3239
            tt.delete_contents(trans_id)
1346
 
            tt.create_hardlink(source_tree.abspath(change.path[0]), trans_id)
 
3240
            tt.create_hardlink(source_tree.abspath(paths[0]), trans_id)
1347
3241
        tt.apply()
1348
 
 
1349
 
 
1350
 
class PreviewTree(object):
1351
 
    """Preview tree."""
1352
 
 
1353
 
    def __init__(self, transform):
1354
 
        self._transform = transform
1355
 
        self._parent_ids = []
1356
 
        self.__by_parent = None
1357
 
        self._path2trans_id_cache = {}
1358
 
        self._all_children_cache = {}
1359
 
        self._final_name_cache = {}
1360
 
 
1361
 
    def supports_setting_file_ids(self):
1362
 
        raise NotImplementedError(self.supports_setting_file_ids)
1363
 
 
1364
 
    @property
1365
 
    def _by_parent(self):
1366
 
        if self.__by_parent is None:
1367
 
            self.__by_parent = self._transform.by_parent()
1368
 
        return self.__by_parent
1369
 
 
1370
 
    def get_parent_ids(self):
1371
 
        return self._parent_ids
1372
 
 
1373
 
    def set_parent_ids(self, parent_ids):
1374
 
        self._parent_ids = parent_ids
1375
 
 
1376
 
    def get_revision_tree(self, revision_id):
1377
 
        return self._transform._tree.get_revision_tree(revision_id)
1378
 
 
1379
 
    def is_locked(self):
1380
 
        return False
1381
 
 
1382
 
    def lock_read(self):
1383
 
        # Perhaps in theory, this should lock the TreeTransform?
1384
 
        return lock.LogicalLockResult(self.unlock)
1385
 
 
1386
 
    def unlock(self):
1387
 
        pass
1388
 
 
1389
 
    def _path2trans_id(self, path):
1390
 
        """Look up the trans id associated with a path.
1391
 
 
1392
 
        :param path: path to look up, None when the path does not exist
1393
 
        :return: trans_id
1394
 
        """
1395
 
        # We must not use None here, because that is a valid value to store.
1396
 
        trans_id = self._path2trans_id_cache.get(path, object)
1397
 
        if trans_id is not object:
1398
 
            return trans_id
1399
 
        segments = osutils.splitpath(path)
1400
 
        cur_parent = self._transform.root
1401
 
        for cur_segment in segments:
1402
 
            for child in self._all_children(cur_parent):
1403
 
                final_name = self._final_name_cache.get(child)
1404
 
                if final_name is None:
1405
 
                    final_name = self._transform.final_name(child)
1406
 
                    self._final_name_cache[child] = final_name
1407
 
                if final_name == cur_segment:
1408
 
                    cur_parent = child
1409
 
                    break
1410
 
            else:
1411
 
                self._path2trans_id_cache[path] = None
1412
 
                return None
1413
 
        self._path2trans_id_cache[path] = cur_parent
1414
 
        return cur_parent
1415
 
 
1416
 
    def _all_children(self, trans_id):
1417
 
        children = self._all_children_cache.get(trans_id)
1418
 
        if children is not None:
1419
 
            return children
1420
 
        children = set(self._transform.iter_tree_children(trans_id))
1421
 
        # children in the _new_parent set are provided by _by_parent.
1422
 
        children.difference_update(self._transform._new_parent)
1423
 
        children.update(self._by_parent.get(trans_id, []))
1424
 
        self._all_children_cache[trans_id] = children
1425
 
        return children
1426
 
 
1427
 
    def get_file_with_stat(self, path):
1428
 
        return self.get_file(path), None
1429
 
 
1430
 
    def is_executable(self, path):
1431
 
        trans_id = self._path2trans_id(path)
1432
 
        if trans_id is None:
1433
 
            return False
1434
 
        try:
1435
 
            return self._transform._new_executability[trans_id]
1436
 
        except KeyError:
1437
 
            try:
1438
 
                return self._transform._tree.is_executable(path)
1439
 
            except OSError as e:
1440
 
                if e.errno == errno.ENOENT:
1441
 
                    return False
1442
 
                raise
1443
 
            except errors.NoSuchFile:
1444
 
                return False
1445
 
 
1446
 
    def has_filename(self, path):
1447
 
        trans_id = self._path2trans_id(path)
1448
 
        if trans_id in self._transform._new_contents:
1449
 
            return True
1450
 
        elif trans_id in self._transform._removed_contents:
1451
 
            return False
1452
 
        else:
1453
 
            return self._transform._tree.has_filename(path)
1454
 
 
1455
 
    def get_file_sha1(self, path, stat_value=None):
1456
 
        trans_id = self._path2trans_id(path)
1457
 
        if trans_id is None:
1458
 
            raise errors.NoSuchFile(path)
1459
 
        kind = self._transform._new_contents.get(trans_id)
1460
 
        if kind is None:
1461
 
            return self._transform._tree.get_file_sha1(path)
1462
 
        if kind == 'file':
1463
 
            with self.get_file(path) as fileobj:
1464
 
                return osutils.sha_file(fileobj)
1465
 
 
1466
 
    def get_file_verifier(self, path, stat_value=None):
1467
 
        trans_id = self._path2trans_id(path)
1468
 
        if trans_id is None:
1469
 
            raise errors.NoSuchFile(path)
1470
 
        kind = self._transform._new_contents.get(trans_id)
1471
 
        if kind is None:
1472
 
            return self._transform._tree.get_file_verifier(path)
1473
 
        if kind == 'file':
1474
 
            with self.get_file(path) as fileobj:
1475
 
                return ("SHA1", osutils.sha_file(fileobj))
1476
 
 
1477
 
    def kind(self, path):
1478
 
        trans_id = self._path2trans_id(path)
1479
 
        if trans_id is None:
1480
 
            raise errors.NoSuchFile(path)
1481
 
        return self._transform.final_kind(trans_id)
1482
 
 
1483
 
    def stored_kind(self, path):
1484
 
        trans_id = self._path2trans_id(path)
1485
 
        if trans_id is None:
1486
 
            raise errors.NoSuchFile(path)
1487
 
        try:
1488
 
            return self._transform._new_contents[trans_id]
1489
 
        except KeyError:
1490
 
            return self._transform._tree.stored_kind(path)
1491
 
 
1492
 
    def _get_repository(self):
1493
 
        repo = getattr(self._transform._tree, '_repository', None)
1494
 
        if repo is None:
1495
 
            repo = self._transform._tree.branch.repository
1496
 
        return repo
1497
 
 
1498
 
    def _iter_parent_trees(self):
1499
 
        for revision_id in self.get_parent_ids():
1500
 
            try:
1501
 
                yield self.revision_tree(revision_id)
1502
 
            except errors.NoSuchRevisionInTree:
1503
 
                yield self._get_repository().revision_tree(revision_id)
1504
 
 
1505
 
    def get_file_size(self, path):
1506
 
        """See Tree.get_file_size"""
1507
 
        trans_id = self._path2trans_id(path)
1508
 
        if trans_id is None:
1509
 
            raise errors.NoSuchFile(path)
1510
 
        kind = self._transform.final_kind(trans_id)
1511
 
        if kind != 'file':
1512
 
            return None
1513
 
        if trans_id in self._transform._new_contents:
1514
 
            return self._stat_limbo_file(trans_id).st_size
1515
 
        if self.kind(path) == 'file':
1516
 
            return self._transform._tree.get_file_size(path)
1517
 
        else:
1518
 
            return None
1519
 
 
1520
 
    def get_reference_revision(self, path):
1521
 
        trans_id = self._path2trans_id(path)
1522
 
        if trans_id is None:
1523
 
            raise errors.NoSuchFile(path)
1524
 
        reference_revision = self._transform._new_reference_revision.get(trans_id)
1525
 
        if reference_revision is None:
1526
 
            return self._transform._tree.get_reference_revision(path)
1527
 
        return reference_revision
1528
 
 
1529
 
    def tree_kind(self, trans_id):
1530
 
        path = self._tree_id_paths.get(trans_id)
1531
 
        if path is None:
1532
 
            return None
1533
 
        kind = self._tree.path_content_summary(path)[0]
1534
 
        if kind == 'missing':
1535
 
            kind = None
1536
 
        return kind
 
3242
    finally:
 
3243
        tt.finalize()