~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Martin Pool
  • Date: 2009-09-14 01:19:11 UTC
  • mto: This revision was merged to the branch mainline in revision 4688.
  • Revision ID: mbp@sourcefrog.net-20090914011911-llu9ujul97k8f8s7
News for fix of 406113

Show diffs side-by-side

added added

removed removed

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