/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

Review feedback.

Show diffs side-by-side

added added

removed removed

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