~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

Don't encode unicode messages to UTF-8 in mutter() (the stream writer does it).

Use a codec wrapped log file in tests to match the real environment.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007 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
20
 
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
from bzrlib import (
24
 
    bzrdir,
25
 
    delta,
26
 
    errors,
27
 
    inventory
28
 
    )
29
 
""")
30
 
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
31
 
                           ReusingTransform, NotVersionedError, CantMoveRoot,
32
 
                           ExistingLimbo, ImmortalLimbo, NoFinalPath)
33
 
from bzrlib.inventory import InventoryEntry
34
 
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
35
 
                            delete_any)
36
 
from bzrlib.progress import DummyProgress, ProgressPhase
37
 
from bzrlib.symbol_versioning import deprecated_function, zero_fifteen
38
 
from bzrlib.trace import mutter, warning
39
 
from bzrlib import tree
40
 
import bzrlib.ui
41
 
import bzrlib.urlutils as urlutils
42
 
 
43
 
 
44
 
ROOT_PARENT = "root-parent"
45
 
 
46
 
 
47
 
def unique_add(map, key, value):
48
 
    if key in map:
49
 
        raise DuplicateKey(key=key)
50
 
    map[key] = value
51
 
 
52
 
 
53
 
class _TransformResults(object):
54
 
    def __init__(self, modified_paths, rename_count):
55
 
        object.__init__(self)
56
 
        self.modified_paths = modified_paths
57
 
        self.rename_count = rename_count
58
 
 
59
 
 
60
 
class TreeTransform(object):
61
 
    """Represent a tree transformation.
62
 
    
63
 
    This object is designed to support incremental generation of the transform,
64
 
    in any order.
65
 
 
66
 
    However, it gives optimum performance when parent directories are created
67
 
    before their contents.  The transform is then able to put child files
68
 
    directly in their parent directory, avoiding later renames.
69
 
    
70
 
    It is easy to produce malformed transforms, but they are generally
71
 
    harmless.  Attempting to apply a malformed transform will cause an
72
 
    exception to be raised before any modifications are made to the tree.  
73
 
 
74
 
    Many kinds of malformed transforms can be corrected with the 
75
 
    resolve_conflicts function.  The remaining ones indicate programming error,
76
 
    such as trying to create a file with no path.
77
 
 
78
 
    Two sets of file creation methods are supplied.  Convenience methods are:
79
 
     * new_file
80
 
     * new_directory
81
 
     * new_symlink
82
 
 
83
 
    These are composed of the low-level methods:
84
 
     * create_path
85
 
     * create_file or create_directory or create_symlink
86
 
     * version_file
87
 
     * set_executability
88
 
    """
89
 
    def __init__(self, tree, pb=DummyProgress()):
90
 
        """Note: a tree_write lock is taken on the tree.
91
 
        
92
 
        Use TreeTransform.finalize() to release the lock (can be omitted if
93
 
        TreeTransform.apply() called).
94
 
        """
95
 
        object.__init__(self)
96
 
        self._tree = tree
97
 
        self._tree.lock_tree_write()
98
 
        try:
99
 
            control_files = self._tree._control_files
100
 
            self._limbodir = urlutils.local_path_from_url(
101
 
                control_files.controlfilename('limbo'))
102
 
            try:
103
 
                os.mkdir(self._limbodir)
104
 
            except OSError, e:
105
 
                if e.errno == errno.EEXIST:
106
 
                    raise ExistingLimbo(self._limbodir)
107
 
        except: 
108
 
            self._tree.unlock()
109
 
            raise
110
 
 
111
 
        self._id_number = 0
112
 
        self._new_name = {}
113
 
        self._new_parent = {}
114
 
        self._new_contents = {}
115
 
        # A mapping of transform ids to their limbo filename
116
 
        self._limbo_files = {}
117
 
        # A mapping of transform ids to a set of the transform ids of children
118
 
        # that their limbo directory has
119
 
        self._limbo_children = {}
120
 
        # Map transform ids to maps of child filename to child transform id
121
 
        self._limbo_children_names = {}
122
 
        # List of transform ids that need to be renamed from limbo into place
123
 
        self._needs_rename = set()
124
 
        self._removed_contents = set()
125
 
        self._new_executability = {}
126
 
        self._new_reference_revision = {}
127
 
        self._new_id = {}
128
 
        self._non_present_ids = {}
129
 
        self._r_new_id = {}
130
 
        self._removed_id = set()
131
 
        self._tree_path_ids = {}
132
 
        self._tree_id_paths = {}
133
 
        # Cache of realpath results, to speed up canonical_path
134
 
        self._realpaths = {}
135
 
        # Cache of relpath results, to speed up canonical_path
136
 
        self._relpaths = {}
137
 
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
138
 
        self.__done = False
139
 
        self._pb = pb
140
 
        self.rename_count = 0
141
 
 
142
 
    def __get_root(self):
143
 
        return self._new_root
144
 
 
145
 
    root = property(__get_root)
146
 
 
147
 
    def finalize(self):
148
 
        """Release the working tree lock, if held, clean up limbo dir.
149
 
 
150
 
        This is required if apply has not been invoked, but can be invoked
151
 
        even after apply.
152
 
        """
153
 
        if self._tree is None:
154
 
            return
155
 
        try:
156
 
            entries = [(self._limbo_name(t), t, k) for t, k in
157
 
                       self._new_contents.iteritems()]
158
 
            entries.sort(reverse=True)
159
 
            for path, trans_id, kind in entries:
160
 
                if kind == "directory":
161
 
                    os.rmdir(path)
162
 
                else:
163
 
                    os.unlink(path)
164
 
            try:
165
 
                os.rmdir(self._limbodir)
166
 
            except OSError:
167
 
                # We don't especially care *why* the dir is immortal.
168
 
                raise ImmortalLimbo(self._limbodir)
169
 
        finally:
170
 
            self._tree.unlock()
171
 
            self._tree = None
172
 
 
173
 
    def _assign_id(self):
174
 
        """Produce a new tranform id"""
175
 
        new_id = "new-%s" % self._id_number
176
 
        self._id_number +=1
177
 
        return new_id
178
 
 
179
 
    def create_path(self, name, parent):
180
 
        """Assign a transaction id to a new path"""
181
 
        trans_id = self._assign_id()
182
 
        unique_add(self._new_name, trans_id, name)
183
 
        unique_add(self._new_parent, trans_id, parent)
184
 
        return trans_id
185
 
 
186
 
    def adjust_path(self, name, parent, trans_id):
187
 
        """Change the path that is assigned to a transaction id."""
188
 
        if trans_id == self._new_root:
189
 
            raise CantMoveRoot
190
 
        previous_parent = self._new_parent.get(trans_id)
191
 
        previous_name = self._new_name.get(trans_id)
192
 
        self._new_name[trans_id] = name
193
 
        self._new_parent[trans_id] = parent
194
 
        if (trans_id in self._limbo_files and
195
 
            trans_id not in self._needs_rename):
196
 
            self._rename_in_limbo([trans_id])
197
 
            self._limbo_children[previous_parent].remove(trans_id)
198
 
            del self._limbo_children_names[previous_parent][previous_name]
199
 
 
200
 
    def _rename_in_limbo(self, trans_ids):
201
 
        """Fix limbo names so that the right final path is produced.
202
 
 
203
 
        This means we outsmarted ourselves-- we tried to avoid renaming
204
 
        these files later by creating them with their final names in their
205
 
        final parents.  But now the previous name or parent is no longer
206
 
        suitable, so we have to rename them.
207
 
 
208
 
        Even for trans_ids that have no new contents, we must remove their
209
 
        entries from _limbo_files, because they are now stale.
210
 
        """
211
 
        for trans_id in trans_ids:
212
 
            old_path = self._limbo_files.pop(trans_id)
213
 
            if trans_id not in self._new_contents:
214
 
                continue
215
 
            new_path = self._limbo_name(trans_id)
216
 
            os.rename(old_path, new_path)
217
 
 
218
 
    def adjust_root_path(self, name, parent):
219
 
        """Emulate moving the root by moving all children, instead.
220
 
        
221
 
        We do this by undoing the association of root's transaction id with the
222
 
        current tree.  This allows us to create a new directory with that
223
 
        transaction id.  We unversion the root directory and version the 
224
 
        physically new directory, and hope someone versions the tree root
225
 
        later.
226
 
        """
227
 
        old_root = self._new_root
228
 
        old_root_file_id = self.final_file_id(old_root)
229
 
        # force moving all children of root
230
 
        for child_id in self.iter_tree_children(old_root):
231
 
            if child_id != parent:
232
 
                self.adjust_path(self.final_name(child_id), 
233
 
                                 self.final_parent(child_id), child_id)
234
 
            file_id = self.final_file_id(child_id)
235
 
            if file_id is not None:
236
 
                self.unversion_file(child_id)
237
 
            self.version_file(file_id, child_id)
238
 
        
239
 
        # the physical root needs a new transaction id
240
 
        self._tree_path_ids.pop("")
241
 
        self._tree_id_paths.pop(old_root)
242
 
        self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
243
 
        if parent == old_root:
244
 
            parent = self._new_root
245
 
        self.adjust_path(name, parent, old_root)
246
 
        self.create_directory(old_root)
247
 
        self.version_file(old_root_file_id, old_root)
248
 
        self.unversion_file(self._new_root)
249
 
 
250
 
    def trans_id_tree_file_id(self, inventory_id):
251
 
        """Determine the transaction id of a working tree file.
252
 
        
253
 
        This reflects only files that already exist, not ones that will be
254
 
        added by transactions.
255
 
        """
256
 
        path = self._tree.inventory.id2path(inventory_id)
257
 
        return self.trans_id_tree_path(path)
258
 
 
259
 
    def trans_id_file_id(self, file_id):
260
 
        """Determine or set the transaction id associated with a file ID.
261
 
        A new id is only created for file_ids that were never present.  If
262
 
        a transaction has been unversioned, it is deliberately still returned.
263
 
        (this will likely lead to an unversioned parent conflict.)
264
 
        """
265
 
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
266
 
            return self._r_new_id[file_id]
267
 
        elif file_id in self._tree.inventory:
268
 
            return self.trans_id_tree_file_id(file_id)
269
 
        elif file_id in self._non_present_ids:
270
 
            return self._non_present_ids[file_id]
271
 
        else:
272
 
            trans_id = self._assign_id()
273
 
            self._non_present_ids[file_id] = trans_id
274
 
            return trans_id
275
 
 
276
 
    def canonical_path(self, path):
277
 
        """Get the canonical tree-relative path"""
278
 
        # don't follow final symlinks
279
 
        abs = self._tree.abspath(path)
280
 
        if abs in self._relpaths:
281
 
            return self._relpaths[abs]
282
 
        dirname, basename = os.path.split(abs)
283
 
        if dirname not in self._realpaths:
284
 
            self._realpaths[dirname] = os.path.realpath(dirname)
285
 
        dirname = self._realpaths[dirname]
286
 
        abs = pathjoin(dirname, basename)
287
 
        if dirname in self._relpaths:
288
 
            relpath = pathjoin(self._relpaths[dirname], basename)
289
 
            relpath = relpath.rstrip('/\\')
290
 
        else:
291
 
            relpath = self._tree.relpath(abs)
292
 
        self._relpaths[abs] = relpath
293
 
        return relpath
294
 
 
295
 
    def trans_id_tree_path(self, path):
296
 
        """Determine (and maybe set) the transaction ID for a tree path."""
297
 
        path = self.canonical_path(path)
298
 
        if path not in self._tree_path_ids:
299
 
            self._tree_path_ids[path] = self._assign_id()
300
 
            self._tree_id_paths[self._tree_path_ids[path]] = path
301
 
        return self._tree_path_ids[path]
302
 
 
303
 
    def get_tree_parent(self, trans_id):
304
 
        """Determine id of the parent in the tree."""
305
 
        path = self._tree_id_paths[trans_id]
306
 
        if path == "":
307
 
            return ROOT_PARENT
308
 
        return self.trans_id_tree_path(os.path.dirname(path))
309
 
 
310
 
    def create_file(self, contents, trans_id, mode_id=None):
311
 
        """Schedule creation of a new file.
312
 
 
313
 
        See also new_file.
314
 
        
315
 
        Contents is an iterator of strings, all of which will be written
316
 
        to the target destination.
317
 
 
318
 
        New file takes the permissions of any existing file with that id,
319
 
        unless mode_id is specified.
320
 
        """
321
 
        name = self._limbo_name(trans_id)
322
 
        f = open(name, 'wb')
323
 
        try:
324
 
            try:
325
 
                unique_add(self._new_contents, trans_id, 'file')
326
 
            except:
327
 
                # Clean up the file, it never got registered so
328
 
                # TreeTransform.finalize() won't clean it up.
329
 
                f.close()
330
 
                os.unlink(name)
331
 
                raise
332
 
 
333
 
            f.writelines(contents)
334
 
        finally:
335
 
            f.close()
336
 
        self._set_mode(trans_id, mode_id, S_ISREG)
337
 
 
338
 
    def _set_mode(self, trans_id, mode_id, typefunc):
339
 
        """Set the mode of new file contents.
340
 
        The mode_id is the existing file to get the mode from (often the same
341
 
        as trans_id).  The operation is only performed if there's a mode match
342
 
        according to typefunc.
343
 
        """
344
 
        if mode_id is None:
345
 
            mode_id = trans_id
346
 
        try:
347
 
            old_path = self._tree_id_paths[mode_id]
348
 
        except KeyError:
349
 
            return
350
 
        try:
351
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
352
 
        except OSError, e:
353
 
            if e.errno == errno.ENOENT:
354
 
                return
355
 
            else:
356
 
                raise
357
 
        if typefunc(mode):
358
 
            os.chmod(self._limbo_name(trans_id), mode)
359
 
 
360
 
    def create_directory(self, trans_id):
361
 
        """Schedule creation of a new directory.
362
 
        
363
 
        See also new_directory.
364
 
        """
365
 
        os.mkdir(self._limbo_name(trans_id))
366
 
        unique_add(self._new_contents, trans_id, 'directory')
367
 
 
368
 
    def create_symlink(self, target, trans_id):
369
 
        """Schedule creation of a new symbolic link.
370
 
 
371
 
        target is a bytestring.
372
 
        See also new_symlink.
373
 
        """
374
 
        os.symlink(target, self._limbo_name(trans_id))
375
 
        unique_add(self._new_contents, trans_id, 'symlink')
376
 
 
377
 
    def cancel_creation(self, trans_id):
378
 
        """Cancel the creation of new file contents."""
379
 
        del self._new_contents[trans_id]
380
 
        children = self._limbo_children.get(trans_id)
381
 
        # if this is a limbo directory with children, move them before removing
382
 
        # the directory
383
 
        if children is not None:
384
 
            self._rename_in_limbo(children)
385
 
            del self._limbo_children[trans_id]
386
 
            del self._limbo_children_names[trans_id]
387
 
        delete_any(self._limbo_name(trans_id))
388
 
 
389
 
    def delete_contents(self, trans_id):
390
 
        """Schedule the contents of a path entry for deletion"""
391
 
        self.tree_kind(trans_id)
392
 
        self._removed_contents.add(trans_id)
393
 
 
394
 
    def cancel_deletion(self, trans_id):
395
 
        """Cancel a scheduled deletion"""
396
 
        self._removed_contents.remove(trans_id)
397
 
 
398
 
    def unversion_file(self, trans_id):
399
 
        """Schedule a path entry to become unversioned"""
400
 
        self._removed_id.add(trans_id)
401
 
 
402
 
    def delete_versioned(self, trans_id):
403
 
        """Delete and unversion a versioned file"""
404
 
        self.delete_contents(trans_id)
405
 
        self.unversion_file(trans_id)
406
 
 
407
 
    def set_executability(self, executability, trans_id):
408
 
        """Schedule setting of the 'execute' bit
409
 
        To unschedule, set to None
410
 
        """
411
 
        if executability is None:
412
 
            del self._new_executability[trans_id]
413
 
        else:
414
 
            unique_add(self._new_executability, trans_id, executability)
415
 
 
416
 
    def set_tree_reference(self, revision_id, trans_id):
417
 
        """Set the reference associated with a directory"""
418
 
        unique_add(self._new_reference_revision, trans_id, revision_id)
419
 
 
420
 
    def version_file(self, file_id, trans_id):
421
 
        """Schedule a file to become versioned."""
422
 
        assert file_id is not None
423
 
        unique_add(self._new_id, trans_id, file_id)
424
 
        unique_add(self._r_new_id, file_id, trans_id)
425
 
 
426
 
    def cancel_versioning(self, trans_id):
427
 
        """Undo a previous versioning of a file"""
428
 
        file_id = self._new_id[trans_id]
429
 
        del self._new_id[trans_id]
430
 
        del self._r_new_id[file_id]
431
 
 
432
 
    def new_paths(self):
433
 
        """Determine the paths of all new and changed files"""
434
 
        new_ids = set()
435
 
        fp = FinalPaths(self)
436
 
        for id_set in (self._new_name, self._new_parent, self._new_contents,
437
 
                       self._new_id, self._new_executability):
438
 
            new_ids.update(id_set)
439
 
        new_paths = [(fp.get_path(t), t) for t in new_ids]
440
 
        new_paths.sort()
441
 
        return new_paths
442
 
 
443
 
    def tree_kind(self, trans_id):
444
 
        """Determine the file kind in the working tree.
445
 
 
446
 
        Raises NoSuchFile if the file does not exist
447
 
        """
448
 
        path = self._tree_id_paths.get(trans_id)
449
 
        if path is None:
450
 
            raise NoSuchFile(None)
451
 
        try:
452
 
            return file_kind(self._tree.abspath(path))
453
 
        except OSError, e:
454
 
            if e.errno != errno.ENOENT:
455
 
                raise
456
 
            else:
457
 
                raise NoSuchFile(path)
458
 
 
459
 
    def final_kind(self, trans_id):
460
 
        """Determine the final file kind, after any changes applied.
461
 
        
462
 
        Raises NoSuchFile if the file does not exist/has no contents.
463
 
        (It is conceivable that a path would be created without the
464
 
        corresponding contents insertion command)
465
 
        """
466
 
        if trans_id in self._new_contents:
467
 
            return self._new_contents[trans_id]
468
 
        elif trans_id in self._removed_contents:
469
 
            raise NoSuchFile(None)
470
 
        else:
471
 
            return self.tree_kind(trans_id)
472
 
 
473
 
    def tree_file_id(self, trans_id):
474
 
        """Determine the file id associated with the trans_id in the tree"""
475
 
        try:
476
 
            path = self._tree_id_paths[trans_id]
477
 
        except KeyError:
478
 
            # the file is a new, unversioned file, or invalid trans_id
479
 
            return None
480
 
        # the file is old; the old id is still valid
481
 
        if self._new_root == trans_id:
482
 
            return self._tree.inventory.root.file_id
483
 
        return self._tree.inventory.path2id(path)
484
 
 
485
 
    def final_file_id(self, trans_id):
486
 
        """Determine the file id after any changes are applied, or None.
487
 
        
488
 
        None indicates that the file will not be versioned after changes are
489
 
        applied.
490
 
        """
491
 
        try:
492
 
            # there is a new id for this file
493
 
            assert self._new_id[trans_id] is not None
494
 
            return self._new_id[trans_id]
495
 
        except KeyError:
496
 
            if trans_id in self._removed_id:
497
 
                return None
498
 
        return self.tree_file_id(trans_id)
499
 
 
500
 
    def inactive_file_id(self, trans_id):
501
 
        """Return the inactive file_id associated with a transaction id.
502
 
        That is, the one in the tree or in non_present_ids.
503
 
        The file_id may actually be active, too.
504
 
        """
505
 
        file_id = self.tree_file_id(trans_id)
506
 
        if file_id is not None:
507
 
            return file_id
508
 
        for key, value in self._non_present_ids.iteritems():
509
 
            if value == trans_id:
510
 
                return key
511
 
 
512
 
    def final_parent(self, trans_id):
513
 
        """Determine the parent file_id, after any changes are applied.
514
 
 
515
 
        ROOT_PARENT is returned for the tree root.
516
 
        """
517
 
        try:
518
 
            return self._new_parent[trans_id]
519
 
        except KeyError:
520
 
            return self.get_tree_parent(trans_id)
521
 
 
522
 
    def final_name(self, trans_id):
523
 
        """Determine the final filename, after all changes are applied."""
524
 
        try:
525
 
            return self._new_name[trans_id]
526
 
        except KeyError:
527
 
            try:
528
 
                return os.path.basename(self._tree_id_paths[trans_id])
529
 
            except KeyError:
530
 
                raise NoFinalPath(trans_id, self)
531
 
 
532
 
    def by_parent(self):
533
 
        """Return a map of parent: children for known parents.
534
 
        
535
 
        Only new paths and parents of tree files with assigned ids are used.
536
 
        """
537
 
        by_parent = {}
538
 
        items = list(self._new_parent.iteritems())
539
 
        items.extend((t, self.final_parent(t)) for t in 
540
 
                      self._tree_id_paths.keys())
541
 
        for trans_id, parent_id in items:
542
 
            if parent_id not in by_parent:
543
 
                by_parent[parent_id] = set()
544
 
            by_parent[parent_id].add(trans_id)
545
 
        return by_parent
546
 
 
547
 
    def path_changed(self, trans_id):
548
 
        """Return True if a trans_id's path has changed."""
549
 
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
550
 
 
551
 
    def new_contents(self, trans_id):
552
 
        return (trans_id in self._new_contents)
553
 
 
554
 
    def find_conflicts(self):
555
 
        """Find any violations of inventory or filesystem invariants"""
556
 
        if self.__done is True:
557
 
            raise ReusingTransform()
558
 
        conflicts = []
559
 
        # ensure all children of all existent parents are known
560
 
        # all children of non-existent parents are known, by definition.
561
 
        self._add_tree_children()
562
 
        by_parent = self.by_parent()
563
 
        conflicts.extend(self._unversioned_parents(by_parent))
564
 
        conflicts.extend(self._parent_loops())
565
 
        conflicts.extend(self._duplicate_entries(by_parent))
566
 
        conflicts.extend(self._duplicate_ids())
567
 
        conflicts.extend(self._parent_type_conflicts(by_parent))
568
 
        conflicts.extend(self._improper_versioning())
569
 
        conflicts.extend(self._executability_conflicts())
570
 
        conflicts.extend(self._overwrite_conflicts())
571
 
        return conflicts
572
 
 
573
 
    def _add_tree_children(self):
574
 
        """Add all the children of all active parents to the known paths.
575
 
 
576
 
        Active parents are those which gain children, and those which are
577
 
        removed.  This is a necessary first step in detecting conflicts.
578
 
        """
579
 
        parents = self.by_parent().keys()
580
 
        parents.extend([t for t in self._removed_contents if 
581
 
                        self.tree_kind(t) == 'directory'])
582
 
        for trans_id in self._removed_id:
583
 
            file_id = self.tree_file_id(trans_id)
584
 
            if self._tree.inventory[file_id].kind == 'directory':
585
 
                parents.append(trans_id)
586
 
 
587
 
        for parent_id in parents:
588
 
            # ensure that all children are registered with the transaction
589
 
            list(self.iter_tree_children(parent_id))
590
 
 
591
 
    def iter_tree_children(self, parent_id):
592
 
        """Iterate through the entry's tree children, if any"""
593
 
        try:
594
 
            path = self._tree_id_paths[parent_id]
595
 
        except KeyError:
596
 
            return
597
 
        try:
598
 
            children = os.listdir(self._tree.abspath(path))
599
 
        except OSError, e:
600
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
601
 
                raise
602
 
            return
603
 
            
604
 
        for child in children:
605
 
            childpath = joinpath(path, child)
606
 
            if self._tree.is_control_filename(childpath):
607
 
                continue
608
 
            yield self.trans_id_tree_path(childpath)
609
 
 
610
 
    def has_named_child(self, by_parent, parent_id, name):
611
 
        try:
612
 
            children = by_parent[parent_id]
613
 
        except KeyError:
614
 
            children = []
615
 
        for child in children:
616
 
            if self.final_name(child) == name:
617
 
                return True
618
 
        try:
619
 
            path = self._tree_id_paths[parent_id]
620
 
        except KeyError:
621
 
            return False
622
 
        childpath = joinpath(path, name)
623
 
        child_id = self._tree_path_ids.get(childpath)
624
 
        if child_id is None:
625
 
            return lexists(self._tree.abspath(childpath))
626
 
        else:
627
 
            if self.final_parent(child_id) != parent_id:
628
 
                return False
629
 
            if child_id in self._removed_contents:
630
 
                # XXX What about dangling file-ids?
631
 
                return False
632
 
            else:
633
 
                return True
634
 
 
635
 
    def _parent_loops(self):
636
 
        """No entry should be its own ancestor"""
637
 
        conflicts = []
638
 
        for trans_id in self._new_parent:
639
 
            seen = set()
640
 
            parent_id = trans_id
641
 
            while parent_id is not ROOT_PARENT:
642
 
                seen.add(parent_id)
643
 
                try:
644
 
                    parent_id = self.final_parent(parent_id)
645
 
                except KeyError:
646
 
                    break
647
 
                if parent_id == trans_id:
648
 
                    conflicts.append(('parent loop', trans_id))
649
 
                if parent_id in seen:
650
 
                    break
651
 
        return conflicts
652
 
 
653
 
    def _unversioned_parents(self, by_parent):
654
 
        """If parent directories are versioned, children must be versioned."""
655
 
        conflicts = []
656
 
        for parent_id, children in by_parent.iteritems():
657
 
            if parent_id is ROOT_PARENT:
658
 
                continue
659
 
            if self.final_file_id(parent_id) is not None:
660
 
                continue
661
 
            for child_id in children:
662
 
                if self.final_file_id(child_id) is not None:
663
 
                    conflicts.append(('unversioned parent', parent_id))
664
 
                    break;
665
 
        return conflicts
666
 
 
667
 
    def _improper_versioning(self):
668
 
        """Cannot version a file with no contents, or a bad type.
669
 
        
670
 
        However, existing entries with no contents are okay.
671
 
        """
672
 
        conflicts = []
673
 
        for trans_id in self._new_id.iterkeys():
674
 
            try:
675
 
                kind = self.final_kind(trans_id)
676
 
            except NoSuchFile:
677
 
                conflicts.append(('versioning no contents', trans_id))
678
 
                continue
679
 
            if not InventoryEntry.versionable_kind(kind):
680
 
                conflicts.append(('versioning bad kind', trans_id, kind))
681
 
        return conflicts
682
 
 
683
 
    def _executability_conflicts(self):
684
 
        """Check for bad executability changes.
685
 
        
686
 
        Only versioned files may have their executability set, because
687
 
        1. only versioned entries can have executability under windows
688
 
        2. only files can be executable.  (The execute bit on a directory
689
 
           does not indicate searchability)
690
 
        """
691
 
        conflicts = []
692
 
        for trans_id in self._new_executability:
693
 
            if self.final_file_id(trans_id) is None:
694
 
                conflicts.append(('unversioned executability', trans_id))
695
 
            else:
696
 
                try:
697
 
                    non_file = self.final_kind(trans_id) != "file"
698
 
                except NoSuchFile:
699
 
                    non_file = True
700
 
                if non_file is True:
701
 
                    conflicts.append(('non-file executability', trans_id))
702
 
        return conflicts
703
 
 
704
 
    def _overwrite_conflicts(self):
705
 
        """Check for overwrites (not permitted on Win32)"""
706
 
        conflicts = []
707
 
        for trans_id in self._new_contents:
708
 
            try:
709
 
                self.tree_kind(trans_id)
710
 
            except NoSuchFile:
711
 
                continue
712
 
            if trans_id not in self._removed_contents:
713
 
                conflicts.append(('overwrite', trans_id,
714
 
                                 self.final_name(trans_id)))
715
 
        return conflicts
716
 
 
717
 
    def _duplicate_entries(self, by_parent):
718
 
        """No directory may have two entries with the same name."""
719
 
        conflicts = []
720
 
        for children in by_parent.itervalues():
721
 
            name_ids = [(self.final_name(t), t) for t in children]
722
 
            name_ids.sort()
723
 
            last_name = None
724
 
            last_trans_id = None
725
 
            for name, trans_id in name_ids:
726
 
                try:
727
 
                    kind = self.final_kind(trans_id)
728
 
                except NoSuchFile:
729
 
                    kind = None
730
 
                file_id = self.final_file_id(trans_id)
731
 
                if kind is None and file_id is None:
732
 
                    continue
733
 
                if name == last_name:
734
 
                    conflicts.append(('duplicate', last_trans_id, trans_id,
735
 
                    name))
736
 
                last_name = name
737
 
                last_trans_id = trans_id
738
 
        return conflicts
739
 
 
740
 
    def _duplicate_ids(self):
741
 
        """Each inventory id may only be used once"""
742
 
        conflicts = []
743
 
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
744
 
                                self._removed_id))
745
 
        active_tree_ids = set((f for f in self._tree.inventory if
746
 
                               f not in removed_tree_ids))
747
 
        for trans_id, file_id in self._new_id.iteritems():
748
 
            if file_id in active_tree_ids:
749
 
                old_trans_id = self.trans_id_tree_file_id(file_id)
750
 
                conflicts.append(('duplicate id', old_trans_id, trans_id))
751
 
        return conflicts
752
 
 
753
 
    def _parent_type_conflicts(self, by_parent):
754
 
        """parents must have directory 'contents'."""
755
 
        conflicts = []
756
 
        for parent_id, children in by_parent.iteritems():
757
 
            if parent_id is ROOT_PARENT:
758
 
                continue
759
 
            if not self._any_contents(children):
760
 
                continue
761
 
            for child in children:
762
 
                try:
763
 
                    self.final_kind(child)
764
 
                except NoSuchFile:
765
 
                    continue
766
 
            try:
767
 
                kind = self.final_kind(parent_id)
768
 
            except NoSuchFile:
769
 
                kind = None
770
 
            if kind is None:
771
 
                conflicts.append(('missing parent', parent_id))
772
 
            elif kind != "directory":
773
 
                conflicts.append(('non-directory parent', parent_id))
774
 
        return conflicts
775
 
 
776
 
    def _any_contents(self, trans_ids):
777
 
        """Return true if any of the trans_ids, will have contents."""
778
 
        for trans_id in trans_ids:
779
 
            try:
780
 
                kind = self.final_kind(trans_id)
781
 
            except NoSuchFile:
782
 
                continue
783
 
            return True
784
 
        return False
785
 
            
786
 
    def apply(self):
787
 
        """Apply all changes to the inventory and filesystem.
788
 
        
789
 
        If filesystem or inventory conflicts are present, MalformedTransform
790
 
        will be thrown.
791
 
 
792
 
        If apply succeeds, finalize is not necessary.
793
 
        """
794
 
        conflicts = self.find_conflicts()
795
 
        if len(conflicts) != 0:
796
 
            raise MalformedTransform(conflicts=conflicts)
797
 
        inv = self._tree.inventory
798
 
        inventory_delta = []
799
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
800
 
        try:
801
 
            child_pb.update('Apply phase', 0, 2)
802
 
            self._apply_removals(inv, inventory_delta)
803
 
            child_pb.update('Apply phase', 1, 2)
804
 
            modified_paths = self._apply_insertions(inv, inventory_delta)
805
 
        finally:
806
 
            child_pb.finished()
807
 
        self._tree.apply_inventory_delta(inventory_delta)
808
 
        self.__done = True
809
 
        self.finalize()
810
 
        return _TransformResults(modified_paths, self.rename_count)
811
 
 
812
 
    def _limbo_name(self, trans_id):
813
 
        """Generate the limbo name of a file"""
814
 
        limbo_name = self._limbo_files.get(trans_id)
815
 
        if limbo_name is not None:
816
 
            return limbo_name
817
 
        parent = self._new_parent.get(trans_id)
818
 
        # if the parent directory is already in limbo (e.g. when building a
819
 
        # tree), choose a limbo name inside the parent, to reduce further
820
 
        # renames.
821
 
        use_direct_path = False
822
 
        if self._new_contents.get(parent) == 'directory':
823
 
            filename = self._new_name.get(trans_id)
824
 
            if filename is not None:
825
 
                if parent not in self._limbo_children:
826
 
                    self._limbo_children[parent] = set()
827
 
                    self._limbo_children_names[parent] = {}
828
 
                    use_direct_path = True
829
 
                # the direct path can only be used if no other file has
830
 
                # already taken this pathname, i.e. if the name is unused, or
831
 
                # if it is already associated with this trans_id.
832
 
                elif (self._limbo_children_names[parent].get(filename)
833
 
                      in (trans_id, None)):
834
 
                    use_direct_path = True
835
 
        if use_direct_path:
836
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
837
 
            self._limbo_children[parent].add(trans_id)
838
 
            self._limbo_children_names[parent][filename] = trans_id
839
 
        else:
840
 
            limbo_name = pathjoin(self._limbodir, trans_id)
841
 
            self._needs_rename.add(trans_id)
842
 
        self._limbo_files[trans_id] = limbo_name
843
 
        return limbo_name
844
 
 
845
 
    def _apply_removals(self, inv, inventory_delta):
846
 
        """Perform tree operations that remove directory/inventory names.
847
 
        
848
 
        That is, delete files that are to be deleted, and put any files that
849
 
        need renaming into limbo.  This must be done in strict child-to-parent
850
 
        order.
851
 
        """
852
 
        tree_paths = list(self._tree_path_ids.iteritems())
853
 
        tree_paths.sort(reverse=True)
854
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
855
 
        try:
856
 
            for num, data in enumerate(tree_paths):
857
 
                path, trans_id = data
858
 
                child_pb.update('removing file', num, len(tree_paths))
859
 
                full_path = self._tree.abspath(path)
860
 
                if trans_id in self._removed_contents:
861
 
                    delete_any(full_path)
862
 
                elif trans_id in self._new_name or trans_id in \
863
 
                    self._new_parent:
864
 
                    try:
865
 
                        os.rename(full_path, self._limbo_name(trans_id))
866
 
                    except OSError, e:
867
 
                        if e.errno != errno.ENOENT:
868
 
                            raise
869
 
                    else:
870
 
                        self.rename_count += 1
871
 
                if trans_id in self._removed_id:
872
 
                    if trans_id == self._new_root:
873
 
                        file_id = self._tree.inventory.root.file_id
874
 
                    else:
875
 
                        file_id = self.tree_file_id(trans_id)
876
 
                    assert file_id is not None
877
 
                    inventory_delta.append((path, None, file_id, None))
878
 
        finally:
879
 
            child_pb.finished()
880
 
 
881
 
    def _apply_insertions(self, inv, inventory_delta):
882
 
        """Perform tree operations that insert directory/inventory names.
883
 
        
884
 
        That is, create any files that need to be created, and restore from
885
 
        limbo any files that needed renaming.  This must be done in strict
886
 
        parent-to-child order.
887
 
        """
888
 
        new_paths = self.new_paths()
889
 
        modified_paths = []
890
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
891
 
        try:
892
 
            for num, (path, trans_id) in enumerate(new_paths):
893
 
                new_entry = None
894
 
                child_pb.update('adding file', num, len(new_paths))
895
 
                try:
896
 
                    kind = self._new_contents[trans_id]
897
 
                except KeyError:
898
 
                    kind = contents = None
899
 
                if trans_id in self._new_contents or \
900
 
                    self.path_changed(trans_id):
901
 
                    full_path = self._tree.abspath(path)
902
 
                    if trans_id in self._needs_rename:
903
 
                        try:
904
 
                            os.rename(self._limbo_name(trans_id), full_path)
905
 
                        except OSError, e:
906
 
                            # We may be renaming a dangling inventory id
907
 
                            if e.errno != errno.ENOENT:
908
 
                                raise
909
 
                        else:
910
 
                            self.rename_count += 1
911
 
                    if trans_id in self._new_contents:
912
 
                        modified_paths.append(full_path)
913
 
                        del self._new_contents[trans_id]
914
 
 
915
 
                if trans_id in self._new_id:
916
 
                    if kind is None:
917
 
                        kind = file_kind(self._tree.abspath(path))
918
 
                    if trans_id in self._new_reference_revision:
919
 
                        new_entry = inventory.TreeReference(
920
 
                            self._new_id[trans_id],
921
 
                            self._new_name[trans_id], 
922
 
                            self.final_file_id(self._new_parent[trans_id]),
923
 
                            None, self._new_reference_revision[trans_id])
924
 
                    else:
925
 
                        new_entry = inventory.make_entry(kind,
926
 
                            self.final_name(trans_id),
927
 
                            self.final_file_id(self.final_parent(trans_id)),
928
 
                            self._new_id[trans_id])
929
 
                else:
930
 
                    if trans_id in self._new_name or trans_id in\
931
 
                        self._new_parent or\
932
 
                        trans_id in self._new_executability:
933
 
                        file_id = self.final_file_id(trans_id)
934
 
                        if file_id is not None:
935
 
                            entry = inv[file_id]
936
 
                            new_entry = entry.copy()
937
 
 
938
 
                    if trans_id in self._new_name or trans_id in\
939
 
                        self._new_parent:
940
 
                            if new_entry is not None:
941
 
                                new_entry.name = self.final_name(trans_id)
942
 
                                parent = self.final_parent(trans_id)
943
 
                                parent_id = self.final_file_id(parent)
944
 
                                new_entry.parent_id = parent_id
945
 
 
946
 
                if trans_id in self._new_executability:
947
 
                    self._set_executability(path, new_entry, trans_id)
948
 
                if new_entry is not None:
949
 
                    if new_entry.file_id in inv:
950
 
                        old_path = inv.id2path(new_entry.file_id)
951
 
                    else:
952
 
                        old_path = None
953
 
                    inventory_delta.append((old_path, path,
954
 
                                            new_entry.file_id,
955
 
                                            new_entry))
956
 
        finally:
957
 
            child_pb.finished()
958
 
        return modified_paths
959
 
 
960
 
    def _set_executability(self, path, entry, trans_id):
961
 
        """Set the executability of versioned files """
962
 
        new_executability = self._new_executability[trans_id]
963
 
        entry.executable = new_executability
964
 
        if supports_executable():
965
 
            abspath = self._tree.abspath(path)
966
 
            current_mode = os.stat(abspath).st_mode
967
 
            if new_executability:
968
 
                umask = os.umask(0)
969
 
                os.umask(umask)
970
 
                to_mode = current_mode | (0100 & ~umask)
971
 
                # Enable x-bit for others only if they can read it.
972
 
                if current_mode & 0004:
973
 
                    to_mode |= 0001 & ~umask
974
 
                if current_mode & 0040:
975
 
                    to_mode |= 0010 & ~umask
976
 
            else:
977
 
                to_mode = current_mode & ~0111
978
 
            os.chmod(abspath, to_mode)
979
 
 
980
 
    def _new_entry(self, name, parent_id, file_id):
981
 
        """Helper function to create a new filesystem entry."""
982
 
        trans_id = self.create_path(name, parent_id)
983
 
        if file_id is not None:
984
 
            self.version_file(file_id, trans_id)
985
 
        return trans_id
986
 
 
987
 
    def new_file(self, name, parent_id, contents, file_id=None, 
988
 
                 executable=None):
989
 
        """Convenience method to create files.
990
 
        
991
 
        name is the name of the file to create.
992
 
        parent_id is the transaction id of the parent directory of the file.
993
 
        contents is an iterator of bytestrings, which will be used to produce
994
 
        the file.
995
 
        :param file_id: The inventory ID of the file, if it is to be versioned.
996
 
        :param executable: Only valid when a file_id has been supplied.
997
 
        """
998
 
        trans_id = self._new_entry(name, parent_id, file_id)
999
 
        # TODO: rather than scheduling a set_executable call,
1000
 
        # have create_file create the file with the right mode.
1001
 
        self.create_file(contents, trans_id)
1002
 
        if executable is not None:
1003
 
            self.set_executability(executable, trans_id)
1004
 
        return trans_id
1005
 
 
1006
 
    def new_directory(self, name, parent_id, file_id=None):
1007
 
        """Convenience method to create directories.
1008
 
 
1009
 
        name is the name of the directory to create.
1010
 
        parent_id is the transaction id of the parent directory of the
1011
 
        directory.
1012
 
        file_id is the inventory ID of the directory, if it is to be versioned.
1013
 
        """
1014
 
        trans_id = self._new_entry(name, parent_id, file_id)
1015
 
        self.create_directory(trans_id)
1016
 
        return trans_id 
1017
 
 
1018
 
    def new_symlink(self, name, parent_id, target, file_id=None):
1019
 
        """Convenience method to create symbolic link.
1020
 
        
1021
 
        name is the name of the symlink to create.
1022
 
        parent_id is the transaction id of the parent directory of the symlink.
1023
 
        target is a bytestring of the target of the symlink.
1024
 
        file_id is the inventory ID of the file, if it is to be versioned.
1025
 
        """
1026
 
        trans_id = self._new_entry(name, parent_id, file_id)
1027
 
        self.create_symlink(target, trans_id)
1028
 
        return trans_id
1029
 
 
1030
 
    def _affected_ids(self):
1031
 
        """Return the set of transform ids affected by the transform"""
1032
 
        trans_ids = set(self._removed_id)
1033
 
        trans_ids.update(self._new_id.keys())
1034
 
        trans_ids.update(self._removed_contents)
1035
 
        trans_ids.update(self._new_contents.keys())
1036
 
        trans_ids.update(self._new_executability.keys())
1037
 
        trans_ids.update(self._new_name.keys())
1038
 
        trans_ids.update(self._new_parent.keys())
1039
 
        return trans_ids
1040
 
 
1041
 
    def _get_file_id_maps(self):
1042
 
        """Return mapping of file_ids to trans_ids in the to and from states"""
1043
 
        trans_ids = self._affected_ids()
1044
 
        from_trans_ids = {}
1045
 
        to_trans_ids = {}
1046
 
        # Build up two dicts: trans_ids associated with file ids in the
1047
 
        # FROM state, vs the TO state.
1048
 
        for trans_id in trans_ids:
1049
 
            from_file_id = self.tree_file_id(trans_id)
1050
 
            if from_file_id is not None:
1051
 
                from_trans_ids[from_file_id] = trans_id
1052
 
            to_file_id = self.final_file_id(trans_id)
1053
 
            if to_file_id is not None:
1054
 
                to_trans_ids[to_file_id] = trans_id
1055
 
        return from_trans_ids, to_trans_ids
1056
 
 
1057
 
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
1058
 
        """Get data about a file in the from (tree) state
1059
 
 
1060
 
        Return a (name, parent, kind, executable) tuple
1061
 
        """
1062
 
        from_path = self._tree_id_paths.get(from_trans_id)
1063
 
        if from_versioned:
1064
 
            # get data from working tree if versioned
1065
 
            from_entry = self._tree.inventory[file_id]
1066
 
            from_name = from_entry.name
1067
 
            from_parent = from_entry.parent_id
1068
 
        else:
1069
 
            from_entry = None
1070
 
            if from_path is None:
1071
 
                # File does not exist in FROM state
1072
 
                from_name = None
1073
 
                from_parent = None
1074
 
            else:
1075
 
                # File exists, but is not versioned.  Have to use path-
1076
 
                # splitting stuff
1077
 
                from_name = os.path.basename(from_path)
1078
 
                tree_parent = self.get_tree_parent(from_trans_id)
1079
 
                from_parent = self.tree_file_id(tree_parent)
1080
 
        if from_path is not None:
1081
 
            from_kind, from_executable, from_stats = \
1082
 
                self._tree._comparison_data(from_entry, from_path)
1083
 
        else:
1084
 
            from_kind = None
1085
 
            from_executable = False
1086
 
        return from_name, from_parent, from_kind, from_executable
1087
 
 
1088
 
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
1089
 
        """Get data about a file in the to (target) state
1090
 
 
1091
 
        Return a (name, parent, kind, executable) tuple
1092
 
        """
1093
 
        to_name = self.final_name(to_trans_id)
1094
 
        try:
1095
 
            to_kind = self.final_kind(to_trans_id)
1096
 
        except NoSuchFile:
1097
 
            to_kind = None
1098
 
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
1099
 
        if to_trans_id in self._new_executability:
1100
 
            to_executable = self._new_executability[to_trans_id]
1101
 
        elif to_trans_id == from_trans_id:
1102
 
            to_executable = from_executable
1103
 
        else:
1104
 
            to_executable = False
1105
 
        return to_name, to_parent, to_kind, to_executable
1106
 
 
1107
 
    def _iter_changes(self):
1108
 
        """Produce output in the same format as Tree._iter_changes.
1109
 
 
1110
 
        Will produce nonsensical results if invoked while inventory/filesystem
1111
 
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
1112
 
 
1113
 
        This reads the Transform, but only reproduces changes involving a
1114
 
        file_id.  Files that are not versioned in either of the FROM or TO
1115
 
        states are not reflected.
1116
 
        """
1117
 
        final_paths = FinalPaths(self)
1118
 
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
1119
 
        results = []
1120
 
        # Now iterate through all active file_ids
1121
 
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1122
 
            modified = False
1123
 
            from_trans_id = from_trans_ids.get(file_id)
1124
 
            # find file ids, and determine versioning state
1125
 
            if from_trans_id is None:
1126
 
                from_versioned = False
1127
 
                from_trans_id = to_trans_ids[file_id]
1128
 
            else:
1129
 
                from_versioned = True
1130
 
            to_trans_id = to_trans_ids.get(file_id)
1131
 
            if to_trans_id is None:
1132
 
                to_versioned = False
1133
 
                to_trans_id = from_trans_id
1134
 
            else:
1135
 
                to_versioned = True
1136
 
 
1137
 
            from_name, from_parent, from_kind, from_executable = \
1138
 
                self._from_file_data(from_trans_id, from_versioned, file_id)
1139
 
 
1140
 
            to_name, to_parent, to_kind, to_executable = \
1141
 
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
1142
 
 
1143
 
            if not from_versioned:
1144
 
                from_path = None
1145
 
            else:
1146
 
                from_path = self._tree_id_paths.get(from_trans_id)
1147
 
            if not to_versioned:
1148
 
                to_path = None
1149
 
            else:
1150
 
                to_path = final_paths.get_path(to_trans_id)
1151
 
            if from_kind != to_kind:
1152
 
                modified = True
1153
 
            elif to_kind in ('file', 'symlink') and (
1154
 
                to_trans_id != from_trans_id or
1155
 
                to_trans_id in self._new_contents):
1156
 
                modified = True
1157
 
            if (not modified and from_versioned == to_versioned and
1158
 
                from_parent==to_parent and from_name == to_name and
1159
 
                from_executable == to_executable):
1160
 
                continue
1161
 
            results.append((file_id, (from_path, to_path), modified,
1162
 
                   (from_versioned, to_versioned),
1163
 
                   (from_parent, to_parent),
1164
 
                   (from_name, to_name),
1165
 
                   (from_kind, to_kind),
1166
 
                   (from_executable, to_executable)))
1167
 
        return iter(sorted(results, key=lambda x:x[1]))
1168
 
 
1169
 
 
1170
 
def joinpath(parent, child):
1171
 
    """Join tree-relative paths, handling the tree root specially"""
1172
 
    if parent is None or parent == "":
1173
 
        return child
1174
 
    else:
1175
 
        return pathjoin(parent, child)
1176
 
 
1177
 
 
1178
 
class FinalPaths(object):
1179
 
    """Make path calculation cheap by memoizing paths.
1180
 
 
1181
 
    The underlying tree must not be manipulated between calls, or else
1182
 
    the results will likely be incorrect.
1183
 
    """
1184
 
    def __init__(self, transform):
1185
 
        object.__init__(self)
1186
 
        self._known_paths = {}
1187
 
        self.transform = transform
1188
 
 
1189
 
    def _determine_path(self, trans_id):
1190
 
        if trans_id == self.transform.root:
1191
 
            return ""
1192
 
        name = self.transform.final_name(trans_id)
1193
 
        parent_id = self.transform.final_parent(trans_id)
1194
 
        if parent_id == self.transform.root:
1195
 
            return name
1196
 
        else:
1197
 
            return pathjoin(self.get_path(parent_id), name)
1198
 
 
1199
 
    def get_path(self, trans_id):
1200
 
        """Find the final path associated with a trans_id"""
1201
 
        if trans_id not in self._known_paths:
1202
 
            self._known_paths[trans_id] = self._determine_path(trans_id)
1203
 
        return self._known_paths[trans_id]
1204
 
 
1205
 
def topology_sorted_ids(tree):
1206
 
    """Determine the topological order of the ids in a tree"""
1207
 
    file_ids = list(tree)
1208
 
    file_ids.sort(key=tree.id2path)
1209
 
    return file_ids
1210
 
 
1211
 
 
1212
 
def build_tree(tree, wt):
1213
 
    """Create working tree for a branch, using a TreeTransform.
1214
 
    
1215
 
    This function should be used on empty trees, having a tree root at most.
1216
 
    (see merge and revert functionality for working with existing trees)
1217
 
 
1218
 
    Existing files are handled like so:
1219
 
    
1220
 
    - Existing bzrdirs take precedence over creating new items.  They are
1221
 
      created as '%s.diverted' % name.
1222
 
    - Otherwise, if the content on disk matches the content we are building,
1223
 
      it is silently replaced.
1224
 
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1225
 
    """
1226
 
    wt.lock_tree_write()
1227
 
    try:
1228
 
        tree.lock_read()
1229
 
        try:
1230
 
            return _build_tree(tree, wt)
1231
 
        finally:
1232
 
            tree.unlock()
1233
 
    finally:
1234
 
        wt.unlock()
1235
 
 
1236
 
def _build_tree(tree, wt):
1237
 
    """See build_tree."""
1238
 
    if len(wt.inventory) > 1:  # more than just a root
1239
 
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1240
 
    file_trans_id = {}
1241
 
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1242
 
    pp = ProgressPhase("Build phase", 2, top_pb)
1243
 
    if tree.inventory.root is not None:
1244
 
        # This is kind of a hack: we should be altering the root
1245
 
        # as part of the regular tree shape diff logic.
1246
 
        # The conditional test here is to avoid doing an
1247
 
        # expensive operation (flush) every time the root id
1248
 
        # is set within the tree, nor setting the root and thus
1249
 
        # marking the tree as dirty, because we use two different
1250
 
        # idioms here: tree interfaces and inventory interfaces.
1251
 
        if wt.path2id('') != tree.inventory.root.file_id:
1252
 
            wt.set_root_id(tree.inventory.root.file_id)
1253
 
            wt.flush()
1254
 
    tt = TreeTransform(wt)
1255
 
    divert = set()
1256
 
    try:
1257
 
        pp.next_phase()
1258
 
        file_trans_id[wt.get_root_id()] = \
1259
 
            tt.trans_id_tree_file_id(wt.get_root_id())
1260
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
1261
 
        try:
1262
 
            for num, (tree_path, entry) in \
1263
 
                enumerate(tree.inventory.iter_entries_by_dir()):
1264
 
                pb.update("Building tree", num, len(tree.inventory))
1265
 
                if entry.parent_id is None:
1266
 
                    continue
1267
 
                reparent = False
1268
 
                file_id = entry.file_id
1269
 
                target_path = wt.abspath(tree_path)
1270
 
                try:
1271
 
                    kind = file_kind(target_path)
1272
 
                except NoSuchFile:
1273
 
                    pass
1274
 
                else:
1275
 
                    if kind == "directory":
1276
 
                        try:
1277
 
                            bzrdir.BzrDir.open(target_path)
1278
 
                        except errors.NotBranchError:
1279
 
                            pass
1280
 
                        else:
1281
 
                            divert.add(file_id)
1282
 
                    if (file_id not in divert and
1283
 
                        _content_match(tree, entry, file_id, kind,
1284
 
                        target_path)):
1285
 
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
1286
 
                        if kind == 'directory':
1287
 
                            reparent = True
1288
 
                if entry.parent_id not in file_trans_id:
1289
 
                    raise AssertionError(
1290
 
                        'entry %s parent id %r is not in file_trans_id %r'
1291
 
                        % (entry, entry.parent_id, file_trans_id))
1292
 
                parent_id = file_trans_id[entry.parent_id]
1293
 
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1294
 
                                                      tree)
1295
 
                if reparent:
1296
 
                    new_trans_id = file_trans_id[file_id]
1297
 
                    old_parent = tt.trans_id_tree_path(tree_path)
1298
 
                    _reparent_children(tt, old_parent, new_trans_id)
1299
 
        finally:
1300
 
            pb.finished()
1301
 
        pp.next_phase()
1302
 
        divert_trans = set(file_trans_id[f] for f in divert)
1303
 
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1304
 
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1305
 
        conflicts = cook_conflicts(raw_conflicts, tt)
1306
 
        for conflict in conflicts:
1307
 
            warning(conflict)
1308
 
        try:
1309
 
            wt.add_conflicts(conflicts)
1310
 
        except errors.UnsupportedOperation:
1311
 
            pass
1312
 
        result = tt.apply()
1313
 
    finally:
1314
 
        tt.finalize()
1315
 
        top_pb.finished()
1316
 
    return result
1317
 
 
1318
 
 
1319
 
def _reparent_children(tt, old_parent, new_parent):
1320
 
    for child in tt.iter_tree_children(old_parent):
1321
 
        tt.adjust_path(tt.final_name(child), new_parent, child)
1322
 
 
1323
 
 
1324
 
def _content_match(tree, entry, file_id, kind, target_path):
1325
 
    if entry.kind != kind:
1326
 
        return False
1327
 
    if entry.kind == "directory":
1328
 
        return True
1329
 
    if entry.kind == "file":
1330
 
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1331
 
            return True
1332
 
    elif entry.kind == "symlink":
1333
 
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
1334
 
            return True
1335
 
    return False
1336
 
 
1337
 
 
1338
 
def resolve_checkout(tt, conflicts, divert):
1339
 
    new_conflicts = set()
1340
 
    for c_type, conflict in ((c[0], c) for c in conflicts):
1341
 
        # Anything but a 'duplicate' would indicate programmer error
1342
 
        assert c_type == 'duplicate', c_type
1343
 
        # Now figure out which is new and which is old
1344
 
        if tt.new_contents(conflict[1]):
1345
 
            new_file = conflict[1]
1346
 
            old_file = conflict[2]
1347
 
        else:
1348
 
            new_file = conflict[2]
1349
 
            old_file = conflict[1]
1350
 
 
1351
 
        # We should only get here if the conflict wasn't completely
1352
 
        # resolved
1353
 
        final_parent = tt.final_parent(old_file)
1354
 
        if new_file in divert:
1355
 
            new_name = tt.final_name(old_file)+'.diverted'
1356
 
            tt.adjust_path(new_name, final_parent, new_file)
1357
 
            new_conflicts.add((c_type, 'Diverted to',
1358
 
                               new_file, old_file))
1359
 
        else:
1360
 
            new_name = tt.final_name(old_file)+'.moved'
1361
 
            tt.adjust_path(new_name, final_parent, old_file)
1362
 
            new_conflicts.add((c_type, 'Moved existing file to',
1363
 
                               old_file, new_file))
1364
 
    return new_conflicts
1365
 
 
1366
 
 
1367
 
def new_by_entry(tt, entry, parent_id, tree):
1368
 
    """Create a new file according to its inventory entry"""
1369
 
    name = entry.name
1370
 
    kind = entry.kind
1371
 
    if kind == 'file':
1372
 
        contents = tree.get_file(entry.file_id).readlines()
1373
 
        executable = tree.is_executable(entry.file_id)
1374
 
        return tt.new_file(name, parent_id, contents, entry.file_id, 
1375
 
                           executable)
1376
 
    elif kind in ('directory', 'tree-reference'):
1377
 
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
1378
 
        if kind == 'tree-reference':
1379
 
            tt.set_tree_reference(entry.reference_revision, trans_id)
1380
 
        return trans_id 
1381
 
    elif kind == 'symlink':
1382
 
        target = tree.get_symlink_target(entry.file_id)
1383
 
        return tt.new_symlink(name, parent_id, target, entry.file_id)
1384
 
    else:
1385
 
        raise errors.BadFileKindError(name, kind)
1386
 
 
1387
 
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1388
 
    """Create new file contents according to an inventory entry."""
1389
 
    if entry.kind == "file":
1390
 
        if lines is None:
1391
 
            lines = tree.get_file(entry.file_id).readlines()
1392
 
        tt.create_file(lines, trans_id, mode_id=mode_id)
1393
 
    elif entry.kind == "symlink":
1394
 
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1395
 
    elif entry.kind == "directory":
1396
 
        tt.create_directory(trans_id)
1397
 
 
1398
 
def create_entry_executability(tt, entry, trans_id):
1399
 
    """Set the executability of a trans_id according to an inventory entry"""
1400
 
    if entry.kind == "file":
1401
 
        tt.set_executability(entry.executable, trans_id)
1402
 
 
1403
 
 
1404
 
@deprecated_function(zero_fifteen)
1405
 
def find_interesting(working_tree, target_tree, filenames):
1406
 
    """Find the ids corresponding to specified filenames.
1407
 
    
1408
 
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1409
 
    """
1410
 
    working_tree.lock_read()
1411
 
    try:
1412
 
        target_tree.lock_read()
1413
 
        try:
1414
 
            return working_tree.paths2ids(filenames, [target_tree])
1415
 
        finally:
1416
 
            target_tree.unlock()
1417
 
    finally:
1418
 
        working_tree.unlock()
1419
 
 
1420
 
 
1421
 
def change_entry(tt, file_id, working_tree, target_tree, 
1422
 
                 trans_id_file_id, backups, trans_id, by_parent):
1423
 
    """Replace a file_id's contents with those from a target tree."""
1424
 
    e_trans_id = trans_id_file_id(file_id)
1425
 
    entry = target_tree.inventory[file_id]
1426
 
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1427
 
                                                           working_tree)
1428
 
    if contents_mod:
1429
 
        mode_id = e_trans_id
1430
 
        if has_contents:
1431
 
            if not backups:
1432
 
                tt.delete_contents(e_trans_id)
1433
 
            else:
1434
 
                parent_trans_id = trans_id_file_id(entry.parent_id)
1435
 
                backup_name = get_backup_name(entry, by_parent,
1436
 
                                              parent_trans_id, tt)
1437
 
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1438
 
                tt.unversion_file(e_trans_id)
1439
 
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
1440
 
                tt.version_file(file_id, e_trans_id)
1441
 
                trans_id[file_id] = e_trans_id
1442
 
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1443
 
        create_entry_executability(tt, entry, e_trans_id)
1444
 
 
1445
 
    elif meta_mod:
1446
 
        tt.set_executability(entry.executable, e_trans_id)
1447
 
    if tt.final_name(e_trans_id) != entry.name:
1448
 
        adjust_path  = True
1449
 
    else:
1450
 
        parent_id = tt.final_parent(e_trans_id)
1451
 
        parent_file_id = tt.final_file_id(parent_id)
1452
 
        if parent_file_id != entry.parent_id:
1453
 
            adjust_path = True
1454
 
        else:
1455
 
            adjust_path = False
1456
 
    if adjust_path:
1457
 
        parent_trans_id = trans_id_file_id(entry.parent_id)
1458
 
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1459
 
 
1460
 
 
1461
 
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1462
 
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1463
 
 
1464
 
 
1465
 
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1466
 
    """Produce a backup-style name that appears to be available"""
1467
 
    def name_gen():
1468
 
        counter = 1
1469
 
        while True:
1470
 
            yield "%s.~%d~" % (name, counter)
1471
 
            counter += 1
1472
 
    for new_name in name_gen():
1473
 
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1474
 
            return new_name
1475
 
 
1476
 
 
1477
 
def _entry_changes(file_id, entry, working_tree):
1478
 
    """Determine in which ways the inventory entry has changed.
1479
 
 
1480
 
    Returns booleans: has_contents, content_mod, meta_mod
1481
 
    has_contents means there are currently contents, but they differ
1482
 
    contents_mod means contents need to be modified
1483
 
    meta_mod means the metadata needs to be modified
1484
 
    """
1485
 
    cur_entry = working_tree.inventory[file_id]
1486
 
    try:
1487
 
        working_kind = working_tree.kind(file_id)
1488
 
        has_contents = True
1489
 
    except NoSuchFile:
1490
 
        has_contents = False
1491
 
        contents_mod = True
1492
 
        meta_mod = False
1493
 
    if has_contents is True:
1494
 
        if entry.kind != working_kind:
1495
 
            contents_mod, meta_mod = True, False
1496
 
        else:
1497
 
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
1498
 
                                       working_tree)
1499
 
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
1500
 
            cur_entry._forget_tree_state()
1501
 
    return has_contents, contents_mod, meta_mod
1502
 
 
1503
 
 
1504
 
def revert(working_tree, target_tree, filenames, backups=False,
1505
 
           pb=DummyProgress(), change_reporter=None):
1506
 
    """Revert a working tree's contents to those of a target tree."""
1507
 
    target_tree.lock_read()
1508
 
    tt = TreeTransform(working_tree, pb)
1509
 
    try:
1510
 
        pp = ProgressPhase("Revert phase", 3, pb)
1511
 
        pp.next_phase()
1512
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1513
 
        try:
1514
 
            merge_modified = _alter_files(working_tree, target_tree, tt,
1515
 
                                          child_pb, filenames, backups)
1516
 
        finally:
1517
 
            child_pb.finished()
1518
 
        pp.next_phase()
1519
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1520
 
        try:
1521
 
            raw_conflicts = resolve_conflicts(tt, child_pb)
1522
 
        finally:
1523
 
            child_pb.finished()
1524
 
        conflicts = cook_conflicts(raw_conflicts, tt)
1525
 
        if change_reporter:
1526
 
            change_reporter = delta._ChangeReporter(
1527
 
                unversioned_filter=working_tree.is_ignored)
1528
 
            delta.report_changes(tt._iter_changes(), change_reporter)
1529
 
        for conflict in conflicts:
1530
 
            warning(conflict)
1531
 
        pp.next_phase()
1532
 
        tt.apply()
1533
 
        working_tree.set_merge_modified(merge_modified)
1534
 
    finally:
1535
 
        target_tree.unlock()
1536
 
        tt.finalize()
1537
 
        pb.clear()
1538
 
    return conflicts
1539
 
 
1540
 
 
1541
 
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1542
 
                 backups):
1543
 
    merge_modified = working_tree.merge_modified()
1544
 
    change_list = target_tree._iter_changes(working_tree,
1545
 
        specific_files=specific_files, pb=pb)
1546
 
    if target_tree.inventory.root is None:
1547
 
        skip_root = True
1548
 
    else:
1549
 
        skip_root = False
1550
 
    basis_tree = None
1551
 
    try:
1552
 
        for id_num, (file_id, path, changed_content, versioned, parent, name,
1553
 
                kind, executable) in enumerate(change_list):
1554
 
            if skip_root and file_id[0] is not None and parent[0] is None:
1555
 
                continue
1556
 
            trans_id = tt.trans_id_file_id(file_id)
1557
 
            mode_id = None
1558
 
            if changed_content:
1559
 
                keep_content = False
1560
 
                if kind[0] == 'file' and (backups or kind[1] is None):
1561
 
                    wt_sha1 = working_tree.get_file_sha1(file_id)
1562
 
                    if merge_modified.get(file_id) != wt_sha1:
1563
 
                        # acquire the basis tree lazily to prevent the
1564
 
                        # expense of accessing it when it's not needed ?
1565
 
                        # (Guessing, RBC, 200702)
1566
 
                        if basis_tree is None:
1567
 
                            basis_tree = working_tree.basis_tree()
1568
 
                            basis_tree.lock_read()
1569
 
                        if file_id in basis_tree:
1570
 
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
1571
 
                                keep_content = True
1572
 
                        elif kind[1] is None and not versioned[1]:
1573
 
                            keep_content = True
1574
 
                if kind[0] is not None:
1575
 
                    if not keep_content:
1576
 
                        tt.delete_contents(trans_id)
1577
 
                    elif kind[1] is not None:
1578
 
                        parent_trans_id = tt.trans_id_file_id(parent[0])
1579
 
                        by_parent = tt.by_parent()
1580
 
                        backup_name = _get_backup_name(name[0], by_parent,
1581
 
                                                       parent_trans_id, tt)
1582
 
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
1583
 
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
1584
 
                        if versioned == (True, True):
1585
 
                            tt.unversion_file(trans_id)
1586
 
                            tt.version_file(file_id, new_trans_id)
1587
 
                        # New contents should have the same unix perms as old
1588
 
                        # contents
1589
 
                        mode_id = trans_id
1590
 
                        trans_id = new_trans_id
1591
 
                if kind[1] == 'directory':
1592
 
                    tt.create_directory(trans_id)
1593
 
                elif kind[1] == 'symlink':
1594
 
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
1595
 
                                      trans_id)
1596
 
                elif kind[1] == 'file':
1597
 
                    tt.create_file(target_tree.get_file_lines(file_id),
1598
 
                                   trans_id, mode_id)
1599
 
                    if basis_tree is None:
1600
 
                        basis_tree = working_tree.basis_tree()
1601
 
                        basis_tree.lock_read()
1602
 
                    new_sha1 = target_tree.get_file_sha1(file_id)
1603
 
                    if (file_id in basis_tree and new_sha1 ==
1604
 
                        basis_tree.get_file_sha1(file_id)):
1605
 
                        if file_id in merge_modified:
1606
 
                            del merge_modified[file_id]
1607
 
                    else:
1608
 
                        merge_modified[file_id] = new_sha1
1609
 
 
1610
 
                    # preserve the execute bit when backing up
1611
 
                    if keep_content and executable[0] == executable[1]:
1612
 
                        tt.set_executability(executable[1], trans_id)
1613
 
                else:
1614
 
                    assert kind[1] is None
1615
 
            if versioned == (False, True):
1616
 
                tt.version_file(file_id, trans_id)
1617
 
            if versioned == (True, False):
1618
 
                tt.unversion_file(trans_id)
1619
 
            if (name[1] is not None and 
1620
 
                (name[0] != name[1] or parent[0] != parent[1])):
1621
 
                tt.adjust_path(
1622
 
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
1623
 
            if executable[0] != executable[1] and kind[1] == "file":
1624
 
                tt.set_executability(executable[1], trans_id)
1625
 
    finally:
1626
 
        if basis_tree is not None:
1627
 
            basis_tree.unlock()
1628
 
    return merge_modified
1629
 
 
1630
 
 
1631
 
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1632
 
    """Make many conflict-resolution attempts, but die if they fail"""
1633
 
    if pass_func is None:
1634
 
        pass_func = conflict_pass
1635
 
    new_conflicts = set()
1636
 
    try:
1637
 
        for n in range(10):
1638
 
            pb.update('Resolution pass', n+1, 10)
1639
 
            conflicts = tt.find_conflicts()
1640
 
            if len(conflicts) == 0:
1641
 
                return new_conflicts
1642
 
            new_conflicts.update(pass_func(tt, conflicts))
1643
 
        raise MalformedTransform(conflicts=conflicts)
1644
 
    finally:
1645
 
        pb.clear()
1646
 
 
1647
 
 
1648
 
def conflict_pass(tt, conflicts):
1649
 
    """Resolve some classes of conflicts."""
1650
 
    new_conflicts = set()
1651
 
    for c_type, conflict in ((c[0], c) for c in conflicts):
1652
 
        if c_type == 'duplicate id':
1653
 
            tt.unversion_file(conflict[1])
1654
 
            new_conflicts.add((c_type, 'Unversioned existing file',
1655
 
                               conflict[1], conflict[2], ))
1656
 
        elif c_type == 'duplicate':
1657
 
            # files that were renamed take precedence
1658
 
            new_name = tt.final_name(conflict[1])+'.moved'
1659
 
            final_parent = tt.final_parent(conflict[1])
1660
 
            if tt.path_changed(conflict[1]):
1661
 
                tt.adjust_path(new_name, final_parent, conflict[2])
1662
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1663
 
                                   conflict[2], conflict[1]))
1664
 
            else:
1665
 
                tt.adjust_path(new_name, final_parent, conflict[1])
1666
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1667
 
                                  conflict[1], conflict[2]))
1668
 
        elif c_type == 'parent loop':
1669
 
            # break the loop by undoing one of the ops that caused the loop
1670
 
            cur = conflict[1]
1671
 
            while not tt.path_changed(cur):
1672
 
                cur = tt.final_parent(cur)
1673
 
            new_conflicts.add((c_type, 'Cancelled move', cur,
1674
 
                               tt.final_parent(cur),))
1675
 
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1676
 
            
1677
 
        elif c_type == 'missing parent':
1678
 
            trans_id = conflict[1]
1679
 
            try:
1680
 
                tt.cancel_deletion(trans_id)
1681
 
                new_conflicts.add(('deleting parent', 'Not deleting', 
1682
 
                                   trans_id))
1683
 
            except KeyError:
1684
 
                tt.create_directory(trans_id)
1685
 
                new_conflicts.add((c_type, 'Created directory', trans_id))
1686
 
        elif c_type == 'unversioned parent':
1687
 
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
1688
 
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
1689
 
    return new_conflicts
1690
 
 
1691
 
 
1692
 
def cook_conflicts(raw_conflicts, tt):
1693
 
    """Generate a list of cooked conflicts, sorted by file path"""
1694
 
    from bzrlib.conflicts import Conflict
1695
 
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
1696
 
    return sorted(conflict_iter, key=Conflict.sort_key)
1697
 
 
1698
 
 
1699
 
def iter_cook_conflicts(raw_conflicts, tt):
1700
 
    from bzrlib.conflicts import Conflict
1701
 
    fp = FinalPaths(tt)
1702
 
    for conflict in raw_conflicts:
1703
 
        c_type = conflict[0]
1704
 
        action = conflict[1]
1705
 
        modified_path = fp.get_path(conflict[2])
1706
 
        modified_id = tt.final_file_id(conflict[2])
1707
 
        if len(conflict) == 3:
1708
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
1709
 
                                     file_id=modified_id)
1710
 
             
1711
 
        else:
1712
 
            conflicting_path = fp.get_path(conflict[3])
1713
 
            conflicting_id = tt.final_file_id(conflict[3])
1714
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
1715
 
                                   file_id=modified_id, 
1716
 
                                   conflict_path=conflicting_path,
1717
 
                                   conflict_file_id=conflicting_id)