/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 17:35:34 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-20080813173534-0kb0kr70q505ihph
Fix up NEWS and version info to prepare 1.6rc2

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
                kind_changes = 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, kind_changes)
 
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
        kind_changes = set()
 
1249
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1250
        try:
 
1251
            for num, data in enumerate(tree_paths):
 
1252
                path, trans_id = data
 
1253
                child_pb.update('removing file', num, len(tree_paths))
 
1254
                full_path = self._tree.abspath(path)
 
1255
                if trans_id in self._removed_contents:
 
1256
                    try:
 
1257
                        if (self.tree_kind(trans_id)
 
1258
                                != self.final_kind(trans_id)):
 
1259
                            kind_changes.add(trans_id)
 
1260
                    except NoSuchFile:
 
1261
                        pass
 
1262
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1263
                                     trans_id))
 
1264
                elif trans_id in self._new_name or trans_id in \
 
1265
                    self._new_parent:
 
1266
                    try:
 
1267
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1268
                    except OSError, e:
 
1269
                        if e.errno != errno.ENOENT:
 
1270
                            raise
 
1271
                    else:
 
1272
                        self.rename_count += 1
 
1273
                if (trans_id in self._removed_id
 
1274
                    and inventory_delta is not None):
 
1275
                    if trans_id == self._new_root:
 
1276
                        file_id = self._tree.get_root_id()
 
1277
                    else:
 
1278
                        file_id = self.tree_file_id(trans_id)
 
1279
                    # File-id isn't really being deleted, just moved
 
1280
                    if file_id in self._r_new_id:
 
1281
                        continue
 
1282
                    inventory_delta.append((path, None, file_id, None))
 
1283
        finally:
 
1284
            child_pb.finished()
 
1285
        return kind_changes
 
1286
 
 
1287
    def _apply_insertions(self, inventory_delta, mover, kind_changes):
 
1288
        """Perform tree operations that insert directory/inventory names.
 
1289
 
 
1290
        That is, create any files that need to be created, and restore from
 
1291
        limbo any files that needed renaming.  This must be done in strict
 
1292
        parent-to-child order.
 
1293
 
 
1294
        If inventory_delta is None, no inventory delta is calculated, and
 
1295
        no list of modified paths is returned.
 
1296
 
 
1297
        kind_changes is a set of trans ids where the entry has changed
 
1298
        kind, and so an inventory delta entry should be created for them.
 
1299
        """
 
1300
        new_paths = self.new_paths(filesystem_only=(inventory_delta is None))
 
1301
        modified_paths = []
 
1302
        completed_new = []
 
1303
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1304
                                 new_paths)
 
1305
        if inventory_delta is not None:
 
1306
            entries = self._tree.iter_entries_by_dir(
 
1307
                new_path_file_ids.values())
 
1308
            old_paths = dict((e.file_id, p) for p, e in entries)
 
1309
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1310
        try:
 
1311
            for num, (path, trans_id) in enumerate(new_paths):
 
1312
                new_entry = None
 
1313
                if (num % 10) == 0:
 
1314
                    child_pb.update('adding file', num, len(new_paths))
 
1315
                full_path = self._tree.abspath(path)
 
1316
                if trans_id in self._needs_rename:
 
1317
                    try:
 
1318
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1319
                    except OSError, e:
 
1320
                        # We may be renaming a dangling inventory id
 
1321
                        if e.errno != errno.ENOENT:
 
1322
                            raise
 
1323
                    else:
 
1324
                        self.rename_count += 1
 
1325
                if inventory_delta is not None:
 
1326
                    if (trans_id in self._new_contents or
 
1327
                        self.path_changed(trans_id)):
 
1328
                        if trans_id in self._new_contents:
 
1329
                            modified_paths.append(full_path)
 
1330
                            completed_new.append(trans_id)
 
1331
                    file_id = new_path_file_ids[trans_id]
 
1332
                    if file_id is not None and (trans_id in self._new_id or
 
1333
                        trans_id in self._new_name or
 
1334
                        trans_id in self._new_parent
 
1335
                        or trans_id in self._new_executability
 
1336
                        or trans_id in kind_changes):
 
1337
                        try:
 
1338
                            kind = self.final_kind(trans_id)
 
1339
                        except NoSuchFile:
 
1340
                            kind = self._tree.stored_kind(file_id)
 
1341
                        parent_trans_id = self.final_parent(trans_id)
 
1342
                        parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1343
                        if parent_file_id is None:
 
1344
                            parent_file_id = self.final_file_id(
 
1345
                                parent_trans_id)
 
1346
                        if trans_id in self._new_reference_revision:
 
1347
                            new_entry = inventory.TreeReference(
 
1348
                                file_id,
 
1349
                                self._new_name[trans_id],
 
1350
                                self.final_file_id(self._new_parent[trans_id]),
 
1351
                                None, self._new_reference_revision[trans_id])
 
1352
                        else:
 
1353
                            new_entry = inventory.make_entry(kind,
 
1354
                                self.final_name(trans_id),
 
1355
                                parent_file_id, file_id)
 
1356
                        old_path = old_paths.get(new_entry.file_id)
 
1357
                        inventory_delta.append(
 
1358
                            (old_path, path, new_entry.file_id, new_entry))
 
1359
 
 
1360
                if trans_id in self._new_executability:
 
1361
                    self._set_executability(path, new_entry, trans_id)
 
1362
        finally:
 
1363
            child_pb.finished()
 
1364
        if inventory_delta is None:
 
1365
            self._new_contents.clear()
 
1366
        else:
 
1367
            for trans_id in completed_new:
 
1368
                del self._new_contents[trans_id]
 
1369
        return modified_paths
 
1370
 
 
1371
 
 
1372
class TransformPreview(TreeTransformBase):
 
1373
    """A TreeTransform for generating preview trees.
 
1374
 
 
1375
    Unlike TreeTransform, this version works when the input tree is a
 
1376
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1377
    unversioned files in the input tree.
 
1378
    """
 
1379
 
 
1380
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
 
1381
        tree.lock_read()
 
1382
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1383
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1384
 
 
1385
    def canonical_path(self, path):
 
1386
        return path
 
1387
 
 
1388
    def tree_kind(self, trans_id):
 
1389
        path = self._tree_id_paths.get(trans_id)
 
1390
        if path is None:
 
1391
            raise NoSuchFile(None)
 
1392
        file_id = self._tree.path2id(path)
 
1393
        return self._tree.kind(file_id)
 
1394
 
 
1395
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1396
        """Set the mode of new file contents.
 
1397
        The mode_id is the existing file to get the mode from (often the same
 
1398
        as trans_id).  The operation is only performed if there's a mode match
 
1399
        according to typefunc.
 
1400
        """
 
1401
        # is it ok to ignore this?  probably
 
1402
        pass
 
1403
 
 
1404
    def iter_tree_children(self, parent_id):
 
1405
        """Iterate through the entry's tree children, if any"""
 
1406
        try:
 
1407
            path = self._tree_id_paths[parent_id]
 
1408
        except KeyError:
 
1409
            return
 
1410
        file_id = self.tree_file_id(parent_id)
 
1411
        if file_id is None:
 
1412
            return
 
1413
        children = getattr(self._tree.inventory[file_id], 'children', {})
 
1414
        for child in children:
 
1415
            childpath = joinpath(path, child)
 
1416
            yield self.trans_id_tree_path(childpath)
 
1417
 
 
1418
 
 
1419
class _PreviewTree(tree.Tree):
 
1420
    """Partial implementation of Tree to support show_diff_trees"""
 
1421
 
 
1422
    def __init__(self, transform):
 
1423
        self._transform = transform
 
1424
        self._final_paths = FinalPaths(transform)
 
1425
        self.__by_parent = None
 
1426
        self._parent_ids = []
 
1427
 
 
1428
    def _changes(self, file_id):
 
1429
        for changes in self._transform.iter_changes():
 
1430
            if changes[0] == file_id:
 
1431
                return changes
 
1432
 
 
1433
    def _content_change(self, file_id):
 
1434
        """Return True if the content of this file changed"""
 
1435
        changes = self._changes(file_id)
 
1436
        # changes[2] is true if the file content changed.  See
 
1437
        # InterTree.iter_changes.
 
1438
        return (changes is not None and changes[2])
 
1439
 
 
1440
    def _get_repository(self):
 
1441
        repo = getattr(self._transform._tree, '_repository', None)
 
1442
        if repo is None:
 
1443
            repo = self._transform._tree.branch.repository
 
1444
        return repo
 
1445
 
 
1446
    def _iter_parent_trees(self):
 
1447
        for revision_id in self.get_parent_ids():
 
1448
            try:
 
1449
                yield self.revision_tree(revision_id)
 
1450
            except errors.NoSuchRevisionInTree:
 
1451
                yield self._get_repository().revision_tree(revision_id)
 
1452
 
 
1453
    def _get_file_revision(self, file_id, vf, tree_revision):
 
1454
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
1455
                       self._iter_parent_trees()]
 
1456
        vf.add_lines((file_id, tree_revision), parent_keys,
 
1457
                     self.get_file(file_id).readlines())
 
1458
        repo = self._get_repository()
 
1459
        base_vf = repo.texts
 
1460
        if base_vf not in vf.fallback_versionedfiles:
 
1461
            vf.fallback_versionedfiles.append(base_vf)
 
1462
        return tree_revision
 
1463
 
 
1464
    def _stat_limbo_file(self, file_id):
 
1465
        trans_id = self._transform.trans_id_file_id(file_id)
 
1466
        name = self._transform._limbo_name(trans_id)
 
1467
        return os.lstat(name)
 
1468
 
 
1469
    @property
 
1470
    def _by_parent(self):
 
1471
        if self.__by_parent is None:
 
1472
            self.__by_parent = self._transform.by_parent()
 
1473
        return self.__by_parent
 
1474
 
 
1475
    def lock_read(self):
 
1476
        # Perhaps in theory, this should lock the TreeTransform?
 
1477
        pass
 
1478
 
 
1479
    def unlock(self):
 
1480
        pass
 
1481
 
 
1482
    @property
 
1483
    def inventory(self):
 
1484
        """This Tree does not use inventory as its backing data."""
 
1485
        raise NotImplementedError(_PreviewTree.inventory)
 
1486
 
 
1487
    def get_root_id(self):
 
1488
        return self._transform.final_file_id(self._transform.root)
 
1489
 
 
1490
    def all_file_ids(self):
 
1491
        tree_ids = set(self._transform._tree.all_file_ids())
 
1492
        tree_ids.difference_update(self._transform.tree_file_id(t)
 
1493
                                   for t in self._transform._removed_id)
 
1494
        tree_ids.update(self._transform._new_id.values())
 
1495
        return tree_ids
 
1496
 
 
1497
    def __iter__(self):
 
1498
        return iter(self.all_file_ids())
 
1499
 
 
1500
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1501
        """See Tree.paths2ids"""
 
1502
        to_find = set(specific_files)
 
1503
        result = set()
 
1504
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1505
             executable) in self._transform.iter_changes():
 
1506
            if paths[1] in to_find:
 
1507
                result.append(file_id)
 
1508
                to_find.remove(paths[1])
 
1509
        result.update(self._transform._tree.paths2ids(to_find,
 
1510
                      trees=[], require_versioned=require_versioned))
 
1511
        return result
 
1512
 
 
1513
    def _path2trans_id(self, path):
 
1514
        segments = splitpath(path)
 
1515
        cur_parent = self._transform.root
 
1516
        for cur_segment in segments:
 
1517
            for child in self._all_children(cur_parent):
 
1518
                if self._transform.final_name(child) == cur_segment:
 
1519
                    cur_parent = child
 
1520
                    break
 
1521
            else:
 
1522
                return None
 
1523
        return cur_parent
 
1524
 
 
1525
    def path2id(self, path):
 
1526
        return self._transform.final_file_id(self._path2trans_id(path))
 
1527
 
 
1528
    def id2path(self, file_id):
 
1529
        trans_id = self._transform.trans_id_file_id(file_id)
 
1530
        try:
 
1531
            return self._final_paths._determine_path(trans_id)
 
1532
        except NoFinalPath:
 
1533
            raise errors.NoSuchId(self, file_id)
 
1534
 
 
1535
    def _all_children(self, trans_id):
 
1536
        children = set(self._transform.iter_tree_children(trans_id))
 
1537
        # children in the _new_parent set are provided by _by_parent.
 
1538
        children.difference_update(self._transform._new_parent.keys())
 
1539
        children.update(self._by_parent.get(trans_id, []))
 
1540
        return children
 
1541
 
 
1542
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
 
1543
        for trans_id, parent_file_id in ordered_entries:
 
1544
            file_id = self._transform.final_file_id(trans_id)
 
1545
            if file_id is None:
 
1546
                continue
 
1547
            if (specific_file_ids is not None
 
1548
                and file_id not in specific_file_ids):
 
1549
                continue
 
1550
            try:
 
1551
                kind = self._transform.final_kind(trans_id)
 
1552
            except NoSuchFile:
 
1553
                kind = self._transform._tree.stored_kind(file_id)
 
1554
            new_entry = inventory.make_entry(
 
1555
                kind,
 
1556
                self._transform.final_name(trans_id),
 
1557
                parent_file_id, file_id)
 
1558
            yield new_entry, trans_id
 
1559
 
 
1560
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1561
        # This may not be a maximally efficient implementation, but it is
 
1562
        # reasonably straightforward.  An implementation that grafts the
 
1563
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
1564
        # might be more efficient, but requires tricky inferences about stack
 
1565
        # position.
 
1566
        todo = [ROOT_PARENT]
 
1567
        ordered_ids = []
 
1568
        while len(todo) > 0:
 
1569
            parent = todo.pop()
 
1570
            parent_file_id = self._transform.final_file_id(parent)
 
1571
            children = list(self._all_children(parent))
 
1572
            paths = dict(zip(children, self._final_paths.get_paths(children)))
 
1573
            children.sort(key=paths.get)
 
1574
            todo.extend(reversed(children))
 
1575
            for trans_id in children:
 
1576
                ordered_ids.append((trans_id, parent_file_id))
 
1577
        for entry, trans_id in self._make_inv_entries(ordered_ids,
 
1578
                                                      specific_file_ids):
 
1579
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1580
 
 
1581
    def kind(self, file_id):
 
1582
        trans_id = self._transform.trans_id_file_id(file_id)
 
1583
        return self._transform.final_kind(trans_id)
 
1584
 
 
1585
    def stored_kind(self, file_id):
 
1586
        trans_id = self._transform.trans_id_file_id(file_id)
 
1587
        try:
 
1588
            return self._transform._new_contents[trans_id]
 
1589
        except KeyError:
 
1590
            return self._transform._tree.stored_kind(file_id)
 
1591
 
 
1592
    def get_file_mtime(self, file_id, path=None):
 
1593
        """See Tree.get_file_mtime"""
 
1594
        if not self._content_change(file_id):
 
1595
            return self._transform._tree.get_file_mtime(file_id, path)
 
1596
        return self._stat_limbo_file(file_id).st_mtime
 
1597
 
 
1598
    def get_file_size(self, file_id):
 
1599
        """See Tree.get_file_size"""
 
1600
        if self.kind(file_id) == 'file':
 
1601
            return self._transform._tree.get_file_size(file_id)
 
1602
        else:
 
1603
            return None
 
1604
 
 
1605
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
1606
        return self._transform._tree.get_file_sha1(file_id)
 
1607
 
 
1608
    def is_executable(self, file_id, path=None):
 
1609
        trans_id = self._transform.trans_id_file_id(file_id)
 
1610
        try:
 
1611
            return self._transform._new_executability[trans_id]
 
1612
        except KeyError:
 
1613
            return self._transform._tree.is_executable(file_id, path)
 
1614
 
 
1615
    def path_content_summary(self, path):
 
1616
        trans_id = self._path2trans_id(path)
 
1617
        tt = self._transform
 
1618
        tree_path = tt._tree_id_paths.get(trans_id)
 
1619
        kind = tt._new_contents.get(trans_id)
 
1620
        if kind is None:
 
1621
            if tree_path is None or trans_id in tt._removed_contents:
 
1622
                return 'missing', None, None, None
 
1623
            summary = tt._tree.path_content_summary(tree_path)
 
1624
            kind, size, executable, link_or_sha1 = summary
 
1625
        else:
 
1626
            link_or_sha1 = None
 
1627
            limbo_name = tt._limbo_name(trans_id)
 
1628
            if trans_id in tt._new_reference_revision:
 
1629
                kind = 'tree-reference'
 
1630
            if kind == 'file':
 
1631
                statval = os.lstat(limbo_name)
 
1632
                size = statval.st_size
 
1633
                if not supports_executable():
 
1634
                    executable = None
 
1635
                else:
 
1636
                    executable = statval.st_mode & S_IEXEC
 
1637
            else:
 
1638
                size = None
 
1639
                executable = None
 
1640
            if kind == 'symlink':
 
1641
                link_or_sha1 = os.readlink(limbo_name)
 
1642
        if supports_executable():
 
1643
            executable = tt._new_executability.get(trans_id, executable)
 
1644
        return kind, size, executable, link_or_sha1
 
1645
 
 
1646
    def iter_changes(self, from_tree, include_unchanged=False,
 
1647
                      specific_files=None, pb=None, extra_trees=None,
 
1648
                      require_versioned=True, want_unversioned=False):
 
1649
        """See InterTree.iter_changes.
 
1650
 
 
1651
        This implementation does not support include_unchanged, specific_files,
 
1652
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1653
        ignored.
 
1654
        """
 
1655
        if from_tree is not self._transform._tree:
 
1656
            raise ValueError('from_tree must be transform source tree.')
 
1657
        if include_unchanged:
 
1658
            raise ValueError('include_unchanged is not supported')
 
1659
        if specific_files is not None:
 
1660
            raise ValueError('specific_files is not supported')
 
1661
        if want_unversioned:
 
1662
            raise ValueError('want_unversioned is not supported')
 
1663
        return self._transform.iter_changes()
 
1664
 
 
1665
    def get_file(self, file_id, path=None):
 
1666
        """See Tree.get_file"""
 
1667
        if not self._content_change(file_id):
 
1668
            return self._transform._tree.get_file(file_id, path)
 
1669
        trans_id = self._transform.trans_id_file_id(file_id)
 
1670
        name = self._transform._limbo_name(trans_id)
 
1671
        return open(name, 'rb')
 
1672
 
 
1673
    def get_file_text(self, file_id):
 
1674
        text_file = self.get_file(file_id)
 
1675
        try:
 
1676
            return text_file.read()
 
1677
        finally:
 
1678
            text_file.close()
 
1679
 
 
1680
    def annotate_iter(self, file_id,
 
1681
                      default_revision=_mod_revision.CURRENT_REVISION):
 
1682
        changes = self._changes(file_id)
 
1683
        if changes is None:
 
1684
            get_old = True
 
1685
        else:
 
1686
            changed_content, versioned, kind = (changes[2], changes[3],
 
1687
                                                changes[6])
 
1688
            if kind[1] is None:
 
1689
                return None
 
1690
            get_old = (kind[0] == 'file' and versioned[0])
 
1691
        if get_old:
 
1692
            old_annotation = self._transform._tree.annotate_iter(file_id,
 
1693
                default_revision=default_revision)
 
1694
        else:
 
1695
            old_annotation = []
 
1696
        if changes is None:
 
1697
            return old_annotation
 
1698
        if not changed_content:
 
1699
            return old_annotation
 
1700
        return annotate.reannotate([old_annotation],
 
1701
                                   self.get_file(file_id).readlines(),
 
1702
                                   default_revision)
 
1703
 
 
1704
    def get_symlink_target(self, file_id):
 
1705
        """See Tree.get_symlink_target"""
 
1706
        if not self._content_change(file_id):
 
1707
            return self._transform._tree.get_symlink_target(file_id)
 
1708
        trans_id = self._transform.trans_id_file_id(file_id)
 
1709
        name = self._transform._limbo_name(trans_id)
 
1710
        return os.readlink(name)
 
1711
 
 
1712
    def list_files(self, include_root=False):
 
1713
        return self._transform._tree.list_files(include_root)
 
1714
 
 
1715
    def walkdirs(self, prefix=""):
 
1716
        return self._transform._tree.walkdirs(prefix)
 
1717
 
 
1718
    def get_parent_ids(self):
 
1719
        return self._parent_ids
 
1720
 
 
1721
    def set_parent_ids(self, parent_ids):
 
1722
        self._parent_ids = parent_ids
 
1723
 
 
1724
    def get_revision_tree(self, revision_id):
 
1725
        return self._transform._tree.get_revision_tree(revision_id)
 
1726
 
 
1727
 
 
1728
def joinpath(parent, child):
 
1729
    """Join tree-relative paths, handling the tree root specially"""
 
1730
    if parent is None or parent == "":
 
1731
        return child
 
1732
    else:
 
1733
        return pathjoin(parent, child)
 
1734
 
 
1735
 
 
1736
class FinalPaths(object):
 
1737
    """Make path calculation cheap by memoizing paths.
 
1738
 
 
1739
    The underlying tree must not be manipulated between calls, or else
 
1740
    the results will likely be incorrect.
 
1741
    """
 
1742
    def __init__(self, transform):
 
1743
        object.__init__(self)
 
1744
        self._known_paths = {}
 
1745
        self.transform = transform
 
1746
 
 
1747
    def _determine_path(self, trans_id):
 
1748
        if trans_id == self.transform.root:
 
1749
            return ""
 
1750
        name = self.transform.final_name(trans_id)
 
1751
        parent_id = self.transform.final_parent(trans_id)
 
1752
        if parent_id == self.transform.root:
 
1753
            return name
 
1754
        else:
 
1755
            return pathjoin(self.get_path(parent_id), name)
 
1756
 
 
1757
    def get_path(self, trans_id):
 
1758
        """Find the final path associated with a trans_id"""
 
1759
        if trans_id not in self._known_paths:
 
1760
            self._known_paths[trans_id] = self._determine_path(trans_id)
 
1761
        return self._known_paths[trans_id]
 
1762
 
 
1763
    def get_paths(self, trans_ids):
 
1764
        return [(self.get_path(t), t) for t in trans_ids]
 
1765
 
 
1766
 
 
1767
 
 
1768
def topology_sorted_ids(tree):
 
1769
    """Determine the topological order of the ids in a tree"""
 
1770
    file_ids = list(tree)
 
1771
    file_ids.sort(key=tree.id2path)
 
1772
    return file_ids
 
1773
 
 
1774
 
 
1775
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
 
1776
               delta_from_tree=False):
 
1777
    """Create working tree for a branch, using a TreeTransform.
 
1778
    
 
1779
    This function should be used on empty trees, having a tree root at most.
 
1780
    (see merge and revert functionality for working with existing trees)
 
1781
 
 
1782
    Existing files are handled like so:
 
1783
    
 
1784
    - Existing bzrdirs take precedence over creating new items.  They are
 
1785
      created as '%s.diverted' % name.
 
1786
    - Otherwise, if the content on disk matches the content we are building,
 
1787
      it is silently replaced.
 
1788
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
1789
 
 
1790
    :param tree: The tree to convert wt into a copy of
 
1791
    :param wt: The working tree that files will be placed into
 
1792
    :param accelerator_tree: A tree which can be used for retrieving file
 
1793
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
1794
        will be used for cases where accelerator_tree's content is different.
 
1795
    :param hardlink: If true, hard-link files to accelerator_tree, where
 
1796
        possible.  accelerator_tree must implement abspath, i.e. be a
 
1797
        working tree.
 
1798
    :param delta_from_tree: If true, build_tree may use the input Tree to
 
1799
        generate the inventory delta.
 
1800
    """
 
1801
    wt.lock_tree_write()
 
1802
    try:
 
1803
        tree.lock_read()
 
1804
        try:
 
1805
            if accelerator_tree is not None:
 
1806
                accelerator_tree.lock_read()
 
1807
            try:
 
1808
                return _build_tree(tree, wt, accelerator_tree, hardlink,
 
1809
                                   delta_from_tree)
 
1810
            finally:
 
1811
                if accelerator_tree is not None:
 
1812
                    accelerator_tree.unlock()
 
1813
        finally:
 
1814
            tree.unlock()
 
1815
    finally:
 
1816
        wt.unlock()
 
1817
 
 
1818
 
 
1819
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1820
    """See build_tree."""
 
1821
    for num, _unused in enumerate(wt.all_file_ids()):
 
1822
        if num > 0:  # more than just a root
 
1823
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
1824
    existing_files = set()
 
1825
    for dir, files in wt.walkdirs():
 
1826
        existing_files.update(f[0] for f in files)
 
1827
    file_trans_id = {}
 
1828
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1829
    pp = ProgressPhase("Build phase", 2, top_pb)
 
1830
    if tree.inventory.root is not None:
 
1831
        # This is kind of a hack: we should be altering the root
 
1832
        # as part of the regular tree shape diff logic.
 
1833
        # The conditional test here is to avoid doing an
 
1834
        # expensive operation (flush) every time the root id
 
1835
        # is set within the tree, nor setting the root and thus
 
1836
        # marking the tree as dirty, because we use two different
 
1837
        # idioms here: tree interfaces and inventory interfaces.
 
1838
        if wt.get_root_id() != tree.get_root_id():
 
1839
            wt.set_root_id(tree.get_root_id())
 
1840
            wt.flush()
 
1841
    tt = TreeTransform(wt)
 
1842
    divert = set()
 
1843
    try:
 
1844
        pp.next_phase()
 
1845
        file_trans_id[wt.get_root_id()] = \
 
1846
            tt.trans_id_tree_file_id(wt.get_root_id())
 
1847
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1848
        try:
 
1849
            deferred_contents = []
 
1850
            num = 0
 
1851
            total = len(tree.inventory)
 
1852
            if delta_from_tree:
 
1853
                precomputed_delta = []
 
1854
            else:
 
1855
                precomputed_delta = None
 
1856
            for num, (tree_path, entry) in \
 
1857
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1858
                pb.update("Building tree", num - len(deferred_contents), total)
 
1859
                if entry.parent_id is None:
 
1860
                    continue
 
1861
                reparent = False
 
1862
                file_id = entry.file_id
 
1863
                if delta_from_tree:
 
1864
                    precomputed_delta.append((None, tree_path, file_id, entry))
 
1865
                if tree_path in existing_files:
 
1866
                    target_path = wt.abspath(tree_path)
 
1867
                    kind = file_kind(target_path)
 
1868
                    if kind == "directory":
 
1869
                        try:
 
1870
                            bzrdir.BzrDir.open(target_path)
 
1871
                        except errors.NotBranchError:
 
1872
                            pass
 
1873
                        else:
 
1874
                            divert.add(file_id)
 
1875
                    if (file_id not in divert and
 
1876
                        _content_match(tree, entry, file_id, kind,
 
1877
                        target_path)):
 
1878
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
 
1879
                        if kind == 'directory':
 
1880
                            reparent = True
 
1881
                parent_id = file_trans_id[entry.parent_id]
 
1882
                if entry.kind == 'file':
 
1883
                    # We *almost* replicate new_by_entry, so that we can defer
 
1884
                    # getting the file text, and get them all at once.
 
1885
                    trans_id = tt.create_path(entry.name, parent_id)
 
1886
                    file_trans_id[file_id] = trans_id
 
1887
                    tt.version_file(file_id, trans_id)
 
1888
                    executable = tree.is_executable(file_id, tree_path)
 
1889
                    if executable:
 
1890
                        tt.set_executability(executable, trans_id)
 
1891
                    deferred_contents.append((file_id, trans_id))
 
1892
                else:
 
1893
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
1894
                                                          tree)
 
1895
                if reparent:
 
1896
                    new_trans_id = file_trans_id[file_id]
 
1897
                    old_parent = tt.trans_id_tree_path(tree_path)
 
1898
                    _reparent_children(tt, old_parent, new_trans_id)
 
1899
            offset = num + 1 - len(deferred_contents)
 
1900
            _create_files(tt, tree, deferred_contents, pb, offset,
 
1901
                          accelerator_tree, hardlink)
 
1902
        finally:
 
1903
            pb.finished()
 
1904
        pp.next_phase()
 
1905
        divert_trans = set(file_trans_id[f] for f in divert)
 
1906
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
 
1907
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
1908
        if len(raw_conflicts) > 0:
 
1909
            precomputed_delta = None
 
1910
        conflicts = cook_conflicts(raw_conflicts, tt)
 
1911
        for conflict in conflicts:
 
1912
            warning(conflict)
 
1913
        try:
 
1914
            wt.add_conflicts(conflicts)
 
1915
        except errors.UnsupportedOperation:
 
1916
            pass
 
1917
        result = tt.apply(no_conflicts=True,
 
1918
                          precomputed_delta=precomputed_delta)
 
1919
    finally:
 
1920
        tt.finalize()
 
1921
        top_pb.finished()
 
1922
    return result
 
1923
 
 
1924
 
 
1925
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
 
1926
                  hardlink):
 
1927
    total = len(desired_files) + offset
 
1928
    if accelerator_tree is None:
 
1929
        new_desired_files = desired_files
 
1930
    else:
 
1931
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
 
1932
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1933
                         in iter if not (c or e[0] != e[1]))
 
1934
        new_desired_files = []
 
1935
        count = 0
 
1936
        for file_id, trans_id in desired_files:
 
1937
            accelerator_path = unchanged.get(file_id)
 
1938
            if accelerator_path is None:
 
1939
                new_desired_files.append((file_id, trans_id))
 
1940
                continue
 
1941
            pb.update('Adding file contents', count + offset, total)
 
1942
            if hardlink:
 
1943
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
 
1944
                                   trans_id)
 
1945
            else:
 
1946
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
1947
                try:
 
1948
                    tt.create_file(contents, trans_id)
 
1949
                finally:
 
1950
                    contents.close()
 
1951
            count += 1
 
1952
        offset += count
 
1953
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1954
                                                 new_desired_files)):
 
1955
        tt.create_file(contents, trans_id)
 
1956
        pb.update('Adding file contents', count + offset, total)
 
1957
 
 
1958
 
 
1959
def _reparent_children(tt, old_parent, new_parent):
 
1960
    for child in tt.iter_tree_children(old_parent):
 
1961
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1962
 
 
1963
def _reparent_transform_children(tt, old_parent, new_parent):
 
1964
    by_parent = tt.by_parent()
 
1965
    for child in by_parent[old_parent]:
 
1966
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1967
    return by_parent[old_parent]
 
1968
 
 
1969
def _content_match(tree, entry, file_id, kind, target_path):
 
1970
    if entry.kind != kind:
 
1971
        return False
 
1972
    if entry.kind == "directory":
 
1973
        return True
 
1974
    if entry.kind == "file":
 
1975
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1976
            return True
 
1977
    elif entry.kind == "symlink":
 
1978
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
 
1979
            return True
 
1980
    return False
 
1981
 
 
1982
 
 
1983
def resolve_checkout(tt, conflicts, divert):
 
1984
    new_conflicts = set()
 
1985
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
1986
        # Anything but a 'duplicate' would indicate programmer error
 
1987
        if c_type != 'duplicate':
 
1988
            raise AssertionError(c_type)
 
1989
        # Now figure out which is new and which is old
 
1990
        if tt.new_contents(conflict[1]):
 
1991
            new_file = conflict[1]
 
1992
            old_file = conflict[2]
 
1993
        else:
 
1994
            new_file = conflict[2]
 
1995
            old_file = conflict[1]
 
1996
 
 
1997
        # We should only get here if the conflict wasn't completely
 
1998
        # resolved
 
1999
        final_parent = tt.final_parent(old_file)
 
2000
        if new_file in divert:
 
2001
            new_name = tt.final_name(old_file)+'.diverted'
 
2002
            tt.adjust_path(new_name, final_parent, new_file)
 
2003
            new_conflicts.add((c_type, 'Diverted to',
 
2004
                               new_file, old_file))
 
2005
        else:
 
2006
            new_name = tt.final_name(old_file)+'.moved'
 
2007
            tt.adjust_path(new_name, final_parent, old_file)
 
2008
            new_conflicts.add((c_type, 'Moved existing file to',
 
2009
                               old_file, new_file))
 
2010
    return new_conflicts
 
2011
 
 
2012
 
 
2013
def new_by_entry(tt, entry, parent_id, tree):
 
2014
    """Create a new file according to its inventory entry"""
 
2015
    name = entry.name
 
2016
    kind = entry.kind
 
2017
    if kind == 'file':
 
2018
        contents = tree.get_file(entry.file_id).readlines()
 
2019
        executable = tree.is_executable(entry.file_id)
 
2020
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
2021
                           executable)
 
2022
    elif kind in ('directory', 'tree-reference'):
 
2023
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
 
2024
        if kind == 'tree-reference':
 
2025
            tt.set_tree_reference(entry.reference_revision, trans_id)
 
2026
        return trans_id 
 
2027
    elif kind == 'symlink':
 
2028
        target = tree.get_symlink_target(entry.file_id)
 
2029
        return tt.new_symlink(name, parent_id, target, entry.file_id)
 
2030
    else:
 
2031
        raise errors.BadFileKindError(name, kind)
 
2032
 
 
2033
 
 
2034
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
2035
    """Create new file contents according to an inventory entry."""
 
2036
    if entry.kind == "file":
 
2037
        if lines is None:
 
2038
            lines = tree.get_file(entry.file_id).readlines()
 
2039
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
2040
    elif entry.kind == "symlink":
 
2041
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
2042
    elif entry.kind == "directory":
 
2043
        tt.create_directory(trans_id)
 
2044
 
 
2045
 
 
2046
def create_entry_executability(tt, entry, trans_id):
 
2047
    """Set the executability of a trans_id according to an inventory entry"""
 
2048
    if entry.kind == "file":
 
2049
        tt.set_executability(entry.executable, trans_id)
 
2050
 
 
2051
 
 
2052
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
2053
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
2054
 
 
2055
 
 
2056
def _get_backup_name(name, by_parent, parent_trans_id, tt):
 
2057
    """Produce a backup-style name that appears to be available"""
 
2058
    def name_gen():
 
2059
        counter = 1
 
2060
        while True:
 
2061
            yield "%s.~%d~" % (name, counter)
 
2062
            counter += 1
 
2063
    for new_name in name_gen():
 
2064
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
2065
            return new_name
 
2066
 
 
2067
 
 
2068
def _entry_changes(file_id, entry, working_tree):
 
2069
    """Determine in which ways the inventory entry has changed.
 
2070
 
 
2071
    Returns booleans: has_contents, content_mod, meta_mod
 
2072
    has_contents means there are currently contents, but they differ
 
2073
    contents_mod means contents need to be modified
 
2074
    meta_mod means the metadata needs to be modified
 
2075
    """
 
2076
    cur_entry = working_tree.inventory[file_id]
 
2077
    try:
 
2078
        working_kind = working_tree.kind(file_id)
 
2079
        has_contents = True
 
2080
    except NoSuchFile:
 
2081
        has_contents = False
 
2082
        contents_mod = True
 
2083
        meta_mod = False
 
2084
    if has_contents is True:
 
2085
        if entry.kind != working_kind:
 
2086
            contents_mod, meta_mod = True, False
 
2087
        else:
 
2088
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2089
                                       working_tree)
 
2090
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
 
2091
            cur_entry._forget_tree_state()
 
2092
    return has_contents, contents_mod, meta_mod
 
2093
 
 
2094
 
 
2095
def revert(working_tree, target_tree, filenames, backups=False,
 
2096
           pb=DummyProgress(), change_reporter=None):
 
2097
    """Revert a working tree's contents to those of a target tree."""
 
2098
    target_tree.lock_read()
 
2099
    tt = TreeTransform(working_tree, pb)
 
2100
    try:
 
2101
        pp = ProgressPhase("Revert phase", 3, pb)
 
2102
        pp.next_phase()
 
2103
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2104
        try:
 
2105
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
2106
                                          child_pb, filenames, backups)
 
2107
        finally:
 
2108
            child_pb.finished()
 
2109
        pp.next_phase()
 
2110
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2111
        try:
 
2112
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
2113
                lambda t, c: conflict_pass(t, c, target_tree))
 
2114
        finally:
 
2115
            child_pb.finished()
 
2116
        conflicts = cook_conflicts(raw_conflicts, tt)
 
2117
        if change_reporter:
 
2118
            change_reporter = delta._ChangeReporter(
 
2119
                unversioned_filter=working_tree.is_ignored)
 
2120
            delta.report_changes(tt.iter_changes(), change_reporter)
 
2121
        for conflict in conflicts:
 
2122
            warning(conflict)
 
2123
        pp.next_phase()
 
2124
        tt.apply()
 
2125
        working_tree.set_merge_modified(merge_modified)
 
2126
    finally:
 
2127
        target_tree.unlock()
 
2128
        tt.finalize()
 
2129
        pb.clear()
 
2130
    return conflicts
 
2131
 
 
2132
 
 
2133
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
 
2134
                 backups):
 
2135
    merge_modified = working_tree.merge_modified()
 
2136
    change_list = target_tree.iter_changes(working_tree,
 
2137
        specific_files=specific_files, pb=pb)
 
2138
    if target_tree.inventory.root is None:
 
2139
        skip_root = True
 
2140
    else:
 
2141
        skip_root = False
 
2142
    basis_tree = None
 
2143
    try:
 
2144
        deferred_files = []
 
2145
        for id_num, (file_id, path, changed_content, versioned, parent, name,
 
2146
                kind, executable) in enumerate(change_list):
 
2147
            if skip_root and file_id[0] is not None and parent[0] is None:
 
2148
                continue
 
2149
            trans_id = tt.trans_id_file_id(file_id)
 
2150
            mode_id = None
 
2151
            if changed_content:
 
2152
                keep_content = False
 
2153
                if kind[0] == 'file' and (backups or kind[1] is None):
 
2154
                    wt_sha1 = working_tree.get_file_sha1(file_id)
 
2155
                    if merge_modified.get(file_id) != wt_sha1:
 
2156
                        # acquire the basis tree lazily to prevent the
 
2157
                        # expense of accessing it when it's not needed ?
 
2158
                        # (Guessing, RBC, 200702)
 
2159
                        if basis_tree is None:
 
2160
                            basis_tree = working_tree.basis_tree()
 
2161
                            basis_tree.lock_read()
 
2162
                        if file_id in basis_tree:
 
2163
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
 
2164
                                keep_content = True
 
2165
                        elif kind[1] is None and not versioned[1]:
 
2166
                            keep_content = True
 
2167
                if kind[0] is not None:
 
2168
                    if not keep_content:
 
2169
                        tt.delete_contents(trans_id)
 
2170
                    elif kind[1] is not None:
 
2171
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2172
                        by_parent = tt.by_parent()
 
2173
                        backup_name = _get_backup_name(name[0], by_parent,
 
2174
                                                       parent_trans_id, tt)
 
2175
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
 
2176
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2177
                        if versioned == (True, True):
 
2178
                            tt.unversion_file(trans_id)
 
2179
                            tt.version_file(file_id, new_trans_id)
 
2180
                        # New contents should have the same unix perms as old
 
2181
                        # contents
 
2182
                        mode_id = trans_id
 
2183
                        trans_id = new_trans_id
 
2184
                if kind[1] == 'directory':
 
2185
                    tt.create_directory(trans_id)
 
2186
                elif kind[1] == 'symlink':
 
2187
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
 
2188
                                      trans_id)
 
2189
                elif kind[1] == 'file':
 
2190
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
2191
                    if basis_tree is None:
 
2192
                        basis_tree = working_tree.basis_tree()
 
2193
                        basis_tree.lock_read()
 
2194
                    new_sha1 = target_tree.get_file_sha1(file_id)
 
2195
                    if (file_id in basis_tree and new_sha1 ==
 
2196
                        basis_tree.get_file_sha1(file_id)):
 
2197
                        if file_id in merge_modified:
 
2198
                            del merge_modified[file_id]
 
2199
                    else:
 
2200
                        merge_modified[file_id] = new_sha1
 
2201
 
 
2202
                    # preserve the execute bit when backing up
 
2203
                    if keep_content and executable[0] == executable[1]:
 
2204
                        tt.set_executability(executable[1], trans_id)
 
2205
                elif kind[1] is not None:
 
2206
                    raise AssertionError(kind[1])
 
2207
            if versioned == (False, True):
 
2208
                tt.version_file(file_id, trans_id)
 
2209
            if versioned == (True, False):
 
2210
                tt.unversion_file(trans_id)
 
2211
            if (name[1] is not None and 
 
2212
                (name[0] != name[1] or parent[0] != parent[1])):
 
2213
                tt.adjust_path(
 
2214
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
2215
            if executable[0] != executable[1] and kind[1] == "file":
 
2216
                tt.set_executability(executable[1], trans_id)
 
2217
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2218
            deferred_files):
 
2219
            tt.create_file(bytes, trans_id, mode_id)
 
2220
    finally:
 
2221
        if basis_tree is not None:
 
2222
            basis_tree.unlock()
 
2223
    return merge_modified
 
2224
 
 
2225
 
 
2226
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
2227
    """Make many conflict-resolution attempts, but die if they fail"""
 
2228
    if pass_func is None:
 
2229
        pass_func = conflict_pass
 
2230
    new_conflicts = set()
 
2231
    try:
 
2232
        for n in range(10):
 
2233
            pb.update('Resolution pass', n+1, 10)
 
2234
            conflicts = tt.find_conflicts()
 
2235
            if len(conflicts) == 0:
 
2236
                return new_conflicts
 
2237
            new_conflicts.update(pass_func(tt, conflicts))
 
2238
        raise MalformedTransform(conflicts=conflicts)
 
2239
    finally:
 
2240
        pb.clear()
 
2241
 
 
2242
 
 
2243
def conflict_pass(tt, conflicts, path_tree=None):
 
2244
    """Resolve some classes of conflicts.
 
2245
 
 
2246
    :param tt: The transform to resolve conflicts in
 
2247
    :param conflicts: The conflicts to resolve
 
2248
    :param path_tree: A Tree to get supplemental paths from
 
2249
    """
 
2250
    new_conflicts = set()
 
2251
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
2252
        if c_type == 'duplicate id':
 
2253
            tt.unversion_file(conflict[1])
 
2254
            new_conflicts.add((c_type, 'Unversioned existing file',
 
2255
                               conflict[1], conflict[2], ))
 
2256
        elif c_type == 'duplicate':
 
2257
            # files that were renamed take precedence
 
2258
            final_parent = tt.final_parent(conflict[1])
 
2259
            if tt.path_changed(conflict[1]):
 
2260
                existing_file, new_file = conflict[2], conflict[1]
 
2261
            else:
 
2262
                existing_file, new_file = conflict[1], conflict[2]
 
2263
            new_name = tt.final_name(existing_file)+'.moved'
 
2264
            tt.adjust_path(new_name, final_parent, existing_file)
 
2265
            new_conflicts.add((c_type, 'Moved existing file to', 
 
2266
                               existing_file, new_file))
 
2267
        elif c_type == 'parent loop':
 
2268
            # break the loop by undoing one of the ops that caused the loop
 
2269
            cur = conflict[1]
 
2270
            while not tt.path_changed(cur):
 
2271
                cur = tt.final_parent(cur)
 
2272
            new_conflicts.add((c_type, 'Cancelled move', cur,
 
2273
                               tt.final_parent(cur),))
 
2274
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
 
2275
            
 
2276
        elif c_type == 'missing parent':
 
2277
            trans_id = conflict[1]
 
2278
            try:
 
2279
                tt.cancel_deletion(trans_id)
 
2280
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2281
                                   trans_id))
 
2282
            except KeyError:
 
2283
                create = True
 
2284
                try:
 
2285
                    tt.final_name(trans_id)
 
2286
                except NoFinalPath:
 
2287
                    if path_tree is not None:
 
2288
                        file_id = tt.final_file_id(trans_id)
 
2289
                        if file_id is None:
 
2290
                            file_id = tt.inactive_file_id(trans_id)
 
2291
                        entry = path_tree.inventory[file_id]
 
2292
                        # special-case the other tree root (move its
 
2293
                        # children to current root)
 
2294
                        if entry.parent_id is None:
 
2295
                            create=False
 
2296
                            moved = _reparent_transform_children(
 
2297
                                tt, trans_id, tt.root)
 
2298
                            for child in moved:
 
2299
                                new_conflicts.add((c_type, 'Moved to root',
 
2300
                                                   child))
 
2301
                        else:
 
2302
                            parent_trans_id = tt.trans_id_file_id(
 
2303
                                entry.parent_id)
 
2304
                            tt.adjust_path(entry.name, parent_trans_id,
 
2305
                                           trans_id)
 
2306
                if create:
 
2307
                    tt.create_directory(trans_id)
 
2308
                    new_conflicts.add((c_type, 'Created directory', trans_id))
 
2309
        elif c_type == 'unversioned parent':
 
2310
            file_id = tt.inactive_file_id(conflict[1])
 
2311
            # special-case the other tree root (move its children instead)
 
2312
            if path_tree and file_id in path_tree:
 
2313
                if path_tree.inventory[file_id].parent_id is None:
 
2314
                    continue
 
2315
            tt.version_file(file_id, conflict[1])
 
2316
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
2317
        elif c_type == 'non-directory parent':
 
2318
            parent_id = conflict[1]
 
2319
            parent_parent = tt.final_parent(parent_id)
 
2320
            parent_name = tt.final_name(parent_id)
 
2321
            parent_file_id = tt.final_file_id(parent_id)
 
2322
            new_parent_id = tt.new_directory(parent_name + '.new',
 
2323
                parent_parent, parent_file_id)
 
2324
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
2325
            if parent_file_id is not None:
 
2326
                tt.unversion_file(parent_id)
 
2327
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
 
2328
    return new_conflicts
 
2329
 
 
2330
 
 
2331
def cook_conflicts(raw_conflicts, tt):
 
2332
    """Generate a list of cooked conflicts, sorted by file path"""
 
2333
    from bzrlib.conflicts import Conflict
 
2334
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
 
2335
    return sorted(conflict_iter, key=Conflict.sort_key)
 
2336
 
 
2337
 
 
2338
def iter_cook_conflicts(raw_conflicts, tt):
 
2339
    from bzrlib.conflicts import Conflict
 
2340
    fp = FinalPaths(tt)
 
2341
    for conflict in raw_conflicts:
 
2342
        c_type = conflict[0]
 
2343
        action = conflict[1]
 
2344
        modified_path = fp.get_path(conflict[2])
 
2345
        modified_id = tt.final_file_id(conflict[2])
 
2346
        if len(conflict) == 3:
 
2347
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2348
                                     file_id=modified_id)
 
2349
             
 
2350
        else:
 
2351
            conflicting_path = fp.get_path(conflict[3])
 
2352
            conflicting_id = tt.final_file_id(conflict[3])
 
2353
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2354
                                   file_id=modified_id, 
 
2355
                                   conflict_path=conflicting_path,
 
2356
                                   conflict_file_id=conflicting_id)
 
2357
 
 
2358
 
 
2359
class _FileMover(object):
 
2360
    """Moves and deletes files for TreeTransform, tracking operations"""
 
2361
 
 
2362
    def __init__(self):
 
2363
        self.past_renames = []
 
2364
        self.pending_deletions = []
 
2365
 
 
2366
    def rename(self, from_, to):
 
2367
        """Rename a file from one path to another.  Functions like os.rename"""
 
2368
        try:
 
2369
            os.rename(from_, to)
 
2370
        except OSError, e:
 
2371
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
 
2372
                raise errors.FileExists(to, str(e))
 
2373
            raise
 
2374
        self.past_renames.append((from_, to))
 
2375
 
 
2376
    def pre_delete(self, from_, to):
 
2377
        """Rename a file out of the way and mark it for deletion.
 
2378
 
 
2379
        Unlike os.unlink, this works equally well for files and directories.
 
2380
        :param from_: The current file path
 
2381
        :param to: A temporary path for the file
 
2382
        """
 
2383
        self.rename(from_, to)
 
2384
        self.pending_deletions.append(to)
 
2385
 
 
2386
    def rollback(self):
 
2387
        """Reverse all renames that have been performed"""
 
2388
        for from_, to in reversed(self.past_renames):
 
2389
            os.rename(to, from_)
 
2390
        # after rollback, don't reuse _FileMover
 
2391
        past_renames = None
 
2392
        pending_deletions = None
 
2393
 
 
2394
    def apply_deletions(self):
 
2395
        """Apply all marked deletions"""
 
2396
        for path in self.pending_deletions:
 
2397
            delete_any(path)
 
2398
        # after apply_deletions, don't reuse _FileMover
 
2399
        past_renames = None
 
2400
        pending_deletions = None