/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: John Arbash Meinel
  • Date: 2008-08-13 16:07:10 UTC
  • mto: (3606.2.4 1.6)
  • mto: This revision was merged to the branch mainline in revision 3625.
  • Revision ID: john@arbash-meinel.com-20080813160710-ns4og8r4y6xcmp0b
Factor out the common exception handling looking for ENOTDIR and use it
for osutils.walkdirs() and tree transform code.

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