/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2008-09-02 00:29:28 UTC
  • mto: (3680.1.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 3689.
  • Revision ID: jelmer@samba.org-20080902002928-qp0m5mq97t5zm414
Eliminate more uses of Repository.revision_tree(None).

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