/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: 2018-02-18 21:42:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6859.
  • Revision ID: jelmer@jelmer.uk-20180218214257-jpevutp1wa30tz3v
Update TODO to reference Breezy, not Bazaar.

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