/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-06-14 17:59:16 UTC
  • mto: This revision was merged to the branch mainline in revision 7065.
  • Revision ID: jelmer@jelmer.uk-20180614175916-a2e2xh5k533guq1x
Move breezy.plugins.git to breezy.git.

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