/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Richard Wilbur
  • Date: 2016-02-04 19:07:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6618.
  • Revision ID: richard.wilbur@gmail.com-20160204190728-p0zvfii6zase0fw7
Update COPYING.txt from the original http://www.gnu.org/licenses/gpl-2.0.txt  (Only differences were in whitespace.)  Thanks to Petr Stodulka for pointing out the discrepancy.

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