/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2020-09-02 16:35:18 UTC
  • mto: (7490.40.109 work)
  • mto: This revision was merged to the branch mainline in revision 7526.
  • Revision ID: jelmer@jelmer.uk-20200902163518-sy9f4unbboljphgu
Handle duplicate directories entries for git.

Show diffs side-by-side

added added

removed removed

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