~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-07-30 01:00:50 UTC
  • mfrom: (3591.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080730010050-yt2pf2kmm4x4c033
do not export things in the .bzr* namespace including .bzrrules (Ian
        Clatworthy)

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 e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
 
640
                raise
 
641
            return
 
642
            
 
643
        for child in children:
 
644
            childpath = joinpath(path, child)
 
645
            if self._tree.is_control_filename(childpath):
 
646
                continue
 
647
            yield self.trans_id_tree_path(childpath)
 
648
 
 
649
    def has_named_child(self, by_parent, parent_id, name):
 
650
        try:
 
651
            children = by_parent[parent_id]
 
652
        except KeyError:
 
653
            children = []
 
654
        for child in children:
 
655
            if self.final_name(child) == name:
 
656
                return True
 
657
        try:
 
658
            path = self._tree_id_paths[parent_id]
 
659
        except KeyError:
 
660
            return False
 
661
        childpath = joinpath(path, name)
 
662
        child_id = self._tree_path_ids.get(childpath)
 
663
        if child_id is None:
 
664
            return lexists(self._tree.abspath(childpath))
 
665
        else:
 
666
            if self.final_parent(child_id) != parent_id:
 
667
                return False
 
668
            if child_id in self._removed_contents:
 
669
                # XXX What about dangling file-ids?
 
670
                return False
 
671
            else:
 
672
                return True
 
673
 
 
674
    def _parent_loops(self):
 
675
        """No entry should be its own ancestor"""
 
676
        conflicts = []
 
677
        for trans_id in self._new_parent:
 
678
            seen = set()
 
679
            parent_id = trans_id
 
680
            while parent_id is not ROOT_PARENT:
 
681
                seen.add(parent_id)
 
682
                try:
 
683
                    parent_id = self.final_parent(parent_id)
 
684
                except KeyError:
 
685
                    break
 
686
                if parent_id == trans_id:
 
687
                    conflicts.append(('parent loop', trans_id))
 
688
                if parent_id in seen:
 
689
                    break
 
690
        return conflicts
 
691
 
 
692
    def _unversioned_parents(self, by_parent):
 
693
        """If parent directories are versioned, children must be versioned."""
 
694
        conflicts = []
 
695
        for parent_id, children in by_parent.iteritems():
 
696
            if parent_id is ROOT_PARENT:
 
697
                continue
 
698
            if self.final_file_id(parent_id) is not None:
 
699
                continue
 
700
            for child_id in children:
 
701
                if self.final_file_id(child_id) is not None:
 
702
                    conflicts.append(('unversioned parent', parent_id))
 
703
                    break;
 
704
        return conflicts
 
705
 
 
706
    def _improper_versioning(self):
 
707
        """Cannot version a file with no contents, or a bad type.
 
708
        
 
709
        However, existing entries with no contents are okay.
 
710
        """
 
711
        conflicts = []
 
712
        for trans_id in self._new_id.iterkeys():
 
713
            try:
 
714
                kind = self.final_kind(trans_id)
 
715
            except NoSuchFile:
 
716
                conflicts.append(('versioning no contents', trans_id))
 
717
                continue
 
718
            if not InventoryEntry.versionable_kind(kind):
 
719
                conflicts.append(('versioning bad kind', trans_id, kind))
 
720
        return conflicts
 
721
 
 
722
    def _executability_conflicts(self):
 
723
        """Check for bad executability changes.
 
724
        
 
725
        Only versioned files may have their executability set, because
 
726
        1. only versioned entries can have executability under windows
 
727
        2. only files can be executable.  (The execute bit on a directory
 
728
           does not indicate searchability)
 
729
        """
 
730
        conflicts = []
 
731
        for trans_id in self._new_executability:
 
732
            if self.final_file_id(trans_id) is None:
 
733
                conflicts.append(('unversioned executability', trans_id))
 
734
            else:
 
735
                try:
 
736
                    non_file = self.final_kind(trans_id) != "file"
 
737
                except NoSuchFile:
 
738
                    non_file = True
 
739
                if non_file is True:
 
740
                    conflicts.append(('non-file executability', trans_id))
 
741
        return conflicts
 
742
 
 
743
    def _overwrite_conflicts(self):
 
744
        """Check for overwrites (not permitted on Win32)"""
 
745
        conflicts = []
 
746
        for trans_id in self._new_contents:
 
747
            try:
 
748
                self.tree_kind(trans_id)
 
749
            except NoSuchFile:
 
750
                continue
 
751
            if trans_id not in self._removed_contents:
 
752
                conflicts.append(('overwrite', trans_id,
 
753
                                 self.final_name(trans_id)))
 
754
        return conflicts
 
755
 
 
756
    def _duplicate_entries(self, by_parent):
 
757
        """No directory may have two entries with the same name."""
 
758
        conflicts = []
 
759
        if (self._new_name, self._new_parent) == ({}, {}):
 
760
            return conflicts
 
761
        for children in by_parent.itervalues():
 
762
            name_ids = [(self.final_name(t), t) for t in children]
 
763
            if not self._case_sensitive_target:
 
764
                name_ids = [(n.lower(), t) for n, t in name_ids]
 
765
            name_ids.sort()
 
766
            last_name = None
 
767
            last_trans_id = None
 
768
            for name, trans_id in name_ids:
 
769
                try:
 
770
                    kind = self.final_kind(trans_id)
 
771
                except NoSuchFile:
 
772
                    kind = None
 
773
                file_id = self.final_file_id(trans_id)
 
774
                if kind is None and file_id is None:
 
775
                    continue
 
776
                if name == last_name:
 
777
                    conflicts.append(('duplicate', last_trans_id, trans_id,
 
778
                    name))
 
779
                last_name = name
 
780
                last_trans_id = trans_id
 
781
        return conflicts
 
782
 
 
783
    def _duplicate_ids(self):
 
784
        """Each inventory id may only be used once"""
 
785
        conflicts = []
 
786
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
 
787
                                self._removed_id))
 
788
        all_ids = self._tree.all_file_ids()
 
789
        active_tree_ids = all_ids.difference(removed_tree_ids)
 
790
        for trans_id, file_id in self._new_id.iteritems():
 
791
            if file_id in active_tree_ids:
 
792
                old_trans_id = self.trans_id_tree_file_id(file_id)
 
793
                conflicts.append(('duplicate id', old_trans_id, trans_id))
 
794
        return conflicts
 
795
 
 
796
    def _parent_type_conflicts(self, by_parent):
 
797
        """parents must have directory 'contents'."""
 
798
        conflicts = []
 
799
        for parent_id, children in by_parent.iteritems():
 
800
            if parent_id is ROOT_PARENT:
 
801
                continue
 
802
            if not self._any_contents(children):
 
803
                continue
 
804
            for child in children:
 
805
                try:
 
806
                    self.final_kind(child)
 
807
                except NoSuchFile:
 
808
                    continue
 
809
            try:
 
810
                kind = self.final_kind(parent_id)
 
811
            except NoSuchFile:
 
812
                kind = None
 
813
            if kind is None:
 
814
                conflicts.append(('missing parent', parent_id))
 
815
            elif kind != "directory":
 
816
                conflicts.append(('non-directory parent', parent_id))
 
817
        return conflicts
 
818
 
 
819
    def _any_contents(self, trans_ids):
 
820
        """Return true if any of the trans_ids, will have contents."""
 
821
        for trans_id in trans_ids:
 
822
            try:
 
823
                kind = self.final_kind(trans_id)
 
824
            except NoSuchFile:
 
825
                continue
 
826
            return True
 
827
        return False
 
828
 
 
829
    def _limbo_name(self, trans_id):
 
830
        """Generate the limbo name of a file"""
 
831
        limbo_name = self._limbo_files.get(trans_id)
 
832
        if limbo_name is not None:
 
833
            return limbo_name
 
834
        parent = self._new_parent.get(trans_id)
 
835
        # if the parent directory is already in limbo (e.g. when building a
 
836
        # tree), choose a limbo name inside the parent, to reduce further
 
837
        # renames.
 
838
        use_direct_path = False
 
839
        if self._new_contents.get(parent) == 'directory':
 
840
            filename = self._new_name.get(trans_id)
 
841
            if filename is not None:
 
842
                if parent not in self._limbo_children:
 
843
                    self._limbo_children[parent] = set()
 
844
                    self._limbo_children_names[parent] = {}
 
845
                    use_direct_path = True
 
846
                # the direct path can only be used if no other file has
 
847
                # already taken this pathname, i.e. if the name is unused, or
 
848
                # if it is already associated with this trans_id.
 
849
                elif self._case_sensitive_target:
 
850
                    if (self._limbo_children_names[parent].get(filename)
 
851
                        in (trans_id, None)):
 
852
                        use_direct_path = True
 
853
                else:
 
854
                    for l_filename, l_trans_id in\
 
855
                        self._limbo_children_names[parent].iteritems():
 
856
                        if l_trans_id == trans_id:
 
857
                            continue
 
858
                        if l_filename.lower() == filename.lower():
 
859
                            break
 
860
                    else:
 
861
                        use_direct_path = True
 
862
 
 
863
        if use_direct_path:
 
864
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
865
            self._limbo_children[parent].add(trans_id)
 
866
            self._limbo_children_names[parent][filename] = trans_id
 
867
        else:
 
868
            limbo_name = pathjoin(self._limbodir, trans_id)
 
869
            self._needs_rename.add(trans_id)
 
870
        self._limbo_files[trans_id] = limbo_name
 
871
        return limbo_name
 
872
 
 
873
    def _set_executability(self, path, entry, trans_id):
 
874
        """Set the executability of versioned files """
 
875
        new_executability = self._new_executability[trans_id]
 
876
        if entry is not None:
 
877
            entry.executable = new_executability
 
878
        if supports_executable():
 
879
            abspath = self._tree.abspath(path)
 
880
            current_mode = os.stat(abspath).st_mode
 
881
            if new_executability:
 
882
                umask = os.umask(0)
 
883
                os.umask(umask)
 
884
                to_mode = current_mode | (0100 & ~umask)
 
885
                # Enable x-bit for others only if they can read it.
 
886
                if current_mode & 0004:
 
887
                    to_mode |= 0001 & ~umask
 
888
                if current_mode & 0040:
 
889
                    to_mode |= 0010 & ~umask
 
890
            else:
 
891
                to_mode = current_mode & ~0111
 
892
            os.chmod(abspath, to_mode)
 
893
 
 
894
    def _new_entry(self, name, parent_id, file_id):
 
895
        """Helper function to create a new filesystem entry."""
 
896
        trans_id = self.create_path(name, parent_id)
 
897
        if file_id is not None:
 
898
            self.version_file(file_id, trans_id)
 
899
        return trans_id
 
900
 
 
901
    def new_file(self, name, parent_id, contents, file_id=None, 
 
902
                 executable=None):
 
903
        """Convenience method to create files.
 
904
        
 
905
        name is the name of the file to create.
 
906
        parent_id is the transaction id of the parent directory of the file.
 
907
        contents is an iterator of bytestrings, which will be used to produce
 
908
        the file.
 
909
        :param file_id: The inventory ID of the file, if it is to be versioned.
 
910
        :param executable: Only valid when a file_id has been supplied.
 
911
        """
 
912
        trans_id = self._new_entry(name, parent_id, file_id)
 
913
        # TODO: rather than scheduling a set_executable call,
 
914
        # have create_file create the file with the right mode.
 
915
        self.create_file(contents, trans_id)
 
916
        if executable is not None:
 
917
            self.set_executability(executable, trans_id)
 
918
        return trans_id
 
919
 
 
920
    def new_directory(self, name, parent_id, file_id=None):
 
921
        """Convenience method to create directories.
 
922
 
 
923
        name is the name of the directory to create.
 
924
        parent_id is the transaction id of the parent directory of the
 
925
        directory.
 
926
        file_id is the inventory ID of the directory, if it is to be versioned.
 
927
        """
 
928
        trans_id = self._new_entry(name, parent_id, file_id)
 
929
        self.create_directory(trans_id)
 
930
        return trans_id 
 
931
 
 
932
    def new_symlink(self, name, parent_id, target, file_id=None):
 
933
        """Convenience method to create symbolic link.
 
934
        
 
935
        name is the name of the symlink to create.
 
936
        parent_id is the transaction id of the parent directory of the symlink.
 
937
        target is a bytestring of the target of the symlink.
 
938
        file_id is the inventory ID of the file, if it is to be versioned.
 
939
        """
 
940
        trans_id = self._new_entry(name, parent_id, file_id)
 
941
        self.create_symlink(target, trans_id)
 
942
        return trans_id
 
943
 
 
944
    def _affected_ids(self):
 
945
        """Return the set of transform ids affected by the transform"""
 
946
        trans_ids = set(self._removed_id)
 
947
        trans_ids.update(self._new_id.keys())
 
948
        trans_ids.update(self._removed_contents)
 
949
        trans_ids.update(self._new_contents.keys())
 
950
        trans_ids.update(self._new_executability.keys())
 
951
        trans_ids.update(self._new_name.keys())
 
952
        trans_ids.update(self._new_parent.keys())
 
953
        return trans_ids
 
954
 
 
955
    def _get_file_id_maps(self):
 
956
        """Return mapping of file_ids to trans_ids in the to and from states"""
 
957
        trans_ids = self._affected_ids()
 
958
        from_trans_ids = {}
 
959
        to_trans_ids = {}
 
960
        # Build up two dicts: trans_ids associated with file ids in the
 
961
        # FROM state, vs the TO state.
 
962
        for trans_id in trans_ids:
 
963
            from_file_id = self.tree_file_id(trans_id)
 
964
            if from_file_id is not None:
 
965
                from_trans_ids[from_file_id] = trans_id
 
966
            to_file_id = self.final_file_id(trans_id)
 
967
            if to_file_id is not None:
 
968
                to_trans_ids[to_file_id] = trans_id
 
969
        return from_trans_ids, to_trans_ids
 
970
 
 
971
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
 
972
        """Get data about a file in the from (tree) state
 
973
 
 
974
        Return a (name, parent, kind, executable) tuple
 
975
        """
 
976
        from_path = self._tree_id_paths.get(from_trans_id)
 
977
        if from_versioned:
 
978
            # get data from working tree if versioned
 
979
            from_entry = self._tree.inventory[file_id]
 
980
            from_name = from_entry.name
 
981
            from_parent = from_entry.parent_id
 
982
        else:
 
983
            from_entry = None
 
984
            if from_path is None:
 
985
                # File does not exist in FROM state
 
986
                from_name = None
 
987
                from_parent = None
 
988
            else:
 
989
                # File exists, but is not versioned.  Have to use path-
 
990
                # splitting stuff
 
991
                from_name = os.path.basename(from_path)
 
992
                tree_parent = self.get_tree_parent(from_trans_id)
 
993
                from_parent = self.tree_file_id(tree_parent)
 
994
        if from_path is not None:
 
995
            from_kind, from_executable, from_stats = \
 
996
                self._tree._comparison_data(from_entry, from_path)
 
997
        else:
 
998
            from_kind = None
 
999
            from_executable = False
 
1000
        return from_name, from_parent, from_kind, from_executable
 
1001
 
 
1002
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
 
1003
        """Get data about a file in the to (target) state
 
1004
 
 
1005
        Return a (name, parent, kind, executable) tuple
 
1006
        """
 
1007
        to_name = self.final_name(to_trans_id)
 
1008
        try:
 
1009
            to_kind = self.final_kind(to_trans_id)
 
1010
        except NoSuchFile:
 
1011
            to_kind = None
 
1012
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
 
1013
        if to_trans_id in self._new_executability:
 
1014
            to_executable = self._new_executability[to_trans_id]
 
1015
        elif to_trans_id == from_trans_id:
 
1016
            to_executable = from_executable
 
1017
        else:
 
1018
            to_executable = False
 
1019
        return to_name, to_parent, to_kind, to_executable
 
1020
 
 
1021
    def iter_changes(self):
 
1022
        """Produce output in the same format as Tree.iter_changes.
 
1023
 
 
1024
        Will produce nonsensical results if invoked while inventory/filesystem
 
1025
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
 
1026
 
 
1027
        This reads the Transform, but only reproduces changes involving a
 
1028
        file_id.  Files that are not versioned in either of the FROM or TO
 
1029
        states are not reflected.
 
1030
        """
 
1031
        final_paths = FinalPaths(self)
 
1032
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
 
1033
        results = []
 
1034
        # Now iterate through all active file_ids
 
1035
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
 
1036
            modified = False
 
1037
            from_trans_id = from_trans_ids.get(file_id)
 
1038
            # find file ids, and determine versioning state
 
1039
            if from_trans_id is None:
 
1040
                from_versioned = False
 
1041
                from_trans_id = to_trans_ids[file_id]
 
1042
            else:
 
1043
                from_versioned = True
 
1044
            to_trans_id = to_trans_ids.get(file_id)
 
1045
            if to_trans_id is None:
 
1046
                to_versioned = False
 
1047
                to_trans_id = from_trans_id
 
1048
            else:
 
1049
                to_versioned = True
 
1050
 
 
1051
            from_name, from_parent, from_kind, from_executable = \
 
1052
                self._from_file_data(from_trans_id, from_versioned, file_id)
 
1053
 
 
1054
            to_name, to_parent, to_kind, to_executable = \
 
1055
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
1056
 
 
1057
            if not from_versioned:
 
1058
                from_path = None
 
1059
            else:
 
1060
                from_path = self._tree_id_paths.get(from_trans_id)
 
1061
            if not to_versioned:
 
1062
                to_path = None
 
1063
            else:
 
1064
                to_path = final_paths.get_path(to_trans_id)
 
1065
            if from_kind != to_kind:
 
1066
                modified = True
 
1067
            elif to_kind in ('file', 'symlink') and (
 
1068
                to_trans_id != from_trans_id or
 
1069
                to_trans_id in self._new_contents):
 
1070
                modified = True
 
1071
            if (not modified and from_versioned == to_versioned and
 
1072
                from_parent==to_parent and from_name == to_name and
 
1073
                from_executable == to_executable):
 
1074
                continue
 
1075
            results.append((file_id, (from_path, to_path), modified,
 
1076
                   (from_versioned, to_versioned),
 
1077
                   (from_parent, to_parent),
 
1078
                   (from_name, to_name),
 
1079
                   (from_kind, to_kind),
 
1080
                   (from_executable, to_executable)))
 
1081
        return iter(sorted(results, key=lambda x:x[1]))
 
1082
 
 
1083
    def get_preview_tree(self):
 
1084
        """Return a tree representing the result of the transform.
 
1085
 
 
1086
        This tree only supports the subset of Tree functionality required
 
1087
        by show_diff_trees.  It must only be compared to tt._tree.
 
1088
        """
 
1089
        return _PreviewTree(self)
 
1090
 
 
1091
 
 
1092
class TreeTransform(TreeTransformBase):
 
1093
    """Represent a tree transformation.
 
1094
 
 
1095
    This object is designed to support incremental generation of the transform,
 
1096
    in any order.
 
1097
 
 
1098
    However, it gives optimum performance when parent directories are created
 
1099
    before their contents.  The transform is then able to put child files
 
1100
    directly in their parent directory, avoiding later renames.
 
1101
 
 
1102
    It is easy to produce malformed transforms, but they are generally
 
1103
    harmless.  Attempting to apply a malformed transform will cause an
 
1104
    exception to be raised before any modifications are made to the tree.
 
1105
 
 
1106
    Many kinds of malformed transforms can be corrected with the
 
1107
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1108
    such as trying to create a file with no path.
 
1109
 
 
1110
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1111
     * new_file
 
1112
     * new_directory
 
1113
     * new_symlink
 
1114
 
 
1115
    These are composed of the low-level methods:
 
1116
     * create_path
 
1117
     * create_file or create_directory or create_symlink
 
1118
     * version_file
 
1119
     * set_executability
 
1120
 
 
1121
    Transform/Transaction ids
 
1122
    -------------------------
 
1123
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1124
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1125
 
 
1126
    trans_ids are used because filenames and file_ids are not good enough
 
1127
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1128
    are also associated with trans-ids, so that moving a file moves its
 
1129
    file-id.
 
1130
 
 
1131
    trans_ids are only valid for the TreeTransform that generated them.
 
1132
 
 
1133
    Limbo
 
1134
    -----
 
1135
    Limbo is a temporary directory use to hold new versions of files.
 
1136
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1137
    and their convenience variants (new_*).  Files may be removed from limbo
 
1138
    using cancel_creation.  Files are renamed from limbo into their final
 
1139
    location as part of TreeTransform.apply
 
1140
 
 
1141
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1142
    calling TreeTransform.finalize.
 
1143
 
 
1144
    Files are placed into limbo inside their parent directories, where
 
1145
    possible.  This reduces subsequent renames, and makes operations involving
 
1146
    lots of files faster.  This optimization is only possible if the parent
 
1147
    directory is created *before* creating any of its children, so avoid
 
1148
    creating children before parents, where possible.
 
1149
 
 
1150
    Pending-deletion
 
1151
    ----------------
 
1152
    This temporary directory is used by _FileMover for storing files that are
 
1153
    about to be deleted.  In case of rollback, the files will be restored.
 
1154
    FileMover does not delete files until it is sure that a rollback will not
 
1155
    happen.
 
1156
    """
 
1157
    def __init__(self, tree, pb=DummyProgress()):
 
1158
        """Note: a tree_write lock is taken on the tree.
 
1159
 
 
1160
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1161
        TreeTransform.apply() called).
 
1162
        """
 
1163
        tree.lock_tree_write()
 
1164
 
 
1165
        try:
 
1166
            limbodir = urlutils.local_path_from_url(
 
1167
                tree._transport.abspath('limbo'))
 
1168
            try:
 
1169
                os.mkdir(limbodir)
 
1170
            except OSError, e:
 
1171
                if e.errno == errno.EEXIST:
 
1172
                    raise ExistingLimbo(limbodir)
 
1173
            deletiondir = urlutils.local_path_from_url(
 
1174
                tree._transport.abspath('pending-deletion'))
 
1175
            try:
 
1176
                os.mkdir(deletiondir)
 
1177
            except OSError, e:
 
1178
                if e.errno == errno.EEXIST:
 
1179
                    raise errors.ExistingPendingDeletion(deletiondir)
 
1180
        except:
 
1181
            tree.unlock()
 
1182
            raise
 
1183
 
 
1184
        TreeTransformBase.__init__(self, tree, limbodir, pb,
 
1185
                                   tree.case_sensitive)
 
1186
        self._deletiondir = deletiondir
 
1187
 
 
1188
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1189
        """Apply all changes to the inventory and filesystem.
 
1190
 
 
1191
        If filesystem or inventory conflicts are present, MalformedTransform
 
1192
        will be thrown.
 
1193
 
 
1194
        If apply succeeds, finalize is not necessary.
 
1195
 
 
1196
        :param no_conflicts: if True, the caller guarantees there are no
 
1197
            conflicts, so no check is made.
 
1198
        :param precomputed_delta: An inventory delta to use instead of
 
1199
            calculating one.
 
1200
        :param _mover: Supply an alternate FileMover, for testing
 
1201
        """
 
1202
        if not no_conflicts:
 
1203
            conflicts = self.find_conflicts()
 
1204
            if len(conflicts) != 0:
 
1205
                raise MalformedTransform(conflicts=conflicts)
 
1206
        if precomputed_delta is None:
 
1207
            new_inventory_delta = []
 
1208
            inventory_delta = new_inventory_delta
 
1209
        else:
 
1210
            new_inventory_delta = None
 
1211
            inventory_delta = precomputed_delta
 
1212
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1213
        try:
 
1214
            if _mover is None:
 
1215
                mover = _FileMover()
 
1216
            else:
 
1217
                mover = _mover
 
1218
            try:
 
1219
                child_pb.update('Apply phase', 0, 2)
 
1220
                self._apply_removals(new_inventory_delta, mover)
 
1221
                child_pb.update('Apply phase', 1, 2)
 
1222
                modified_paths = self._apply_insertions(new_inventory_delta,
 
1223
                                                        mover)
 
1224
            except:
 
1225
                mover.rollback()
 
1226
                raise
 
1227
            else:
 
1228
                mover.apply_deletions()
 
1229
        finally:
 
1230
            child_pb.finished()
 
1231
        self._tree.apply_inventory_delta(inventory_delta)
 
1232
        self._done = True
 
1233
        self.finalize()
 
1234
        return _TransformResults(modified_paths, self.rename_count)
 
1235
 
 
1236
    def _apply_removals(self, inventory_delta, mover):
 
1237
        """Perform tree operations that remove directory/inventory names.
 
1238
 
 
1239
        That is, delete files that are to be deleted, and put any files that
 
1240
        need renaming into limbo.  This must be done in strict child-to-parent
 
1241
        order.
 
1242
 
 
1243
        If inventory_delta is None, no inventory delta generation is performed.
 
1244
        """
 
1245
        tree_paths = list(self._tree_path_ids.iteritems())
 
1246
        tree_paths.sort(reverse=True)
 
1247
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1248
        try:
 
1249
            for num, data in enumerate(tree_paths):
 
1250
                path, trans_id = data
 
1251
                child_pb.update('removing file', num, len(tree_paths))
 
1252
                full_path = self._tree.abspath(path)
 
1253
                if trans_id in self._removed_contents:
 
1254
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1255
                                     trans_id))
 
1256
                elif trans_id in self._new_name or trans_id in \
 
1257
                    self._new_parent:
 
1258
                    try:
 
1259
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1260
                    except OSError, e:
 
1261
                        if e.errno != errno.ENOENT:
 
1262
                            raise
 
1263
                    else:
 
1264
                        self.rename_count += 1
 
1265
                if (trans_id in self._removed_id
 
1266
                    and inventory_delta is not None):
 
1267
                    if trans_id == self._new_root:
 
1268
                        file_id = self._tree.get_root_id()
 
1269
                    else:
 
1270
                        file_id = self.tree_file_id(trans_id)
 
1271
                    # File-id isn't really being deleted, just moved
 
1272
                    if file_id in self._r_new_id:
 
1273
                        continue
 
1274
                    inventory_delta.append((path, None, file_id, None))
 
1275
        finally:
 
1276
            child_pb.finished()
 
1277
 
 
1278
    def _apply_insertions(self, inventory_delta, mover):
 
1279
        """Perform tree operations that insert directory/inventory names.
 
1280
 
 
1281
        That is, create any files that need to be created, and restore from
 
1282
        limbo any files that needed renaming.  This must be done in strict
 
1283
        parent-to-child order.
 
1284
 
 
1285
        If inventory_delta is None, no inventory delta is calculated, and
 
1286
        no list of modified paths is returned.
 
1287
        """
 
1288
        new_paths = self.new_paths(filesystem_only=(inventory_delta is None))
 
1289
        modified_paths = []
 
1290
        completed_new = []
 
1291
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1292
                                 new_paths)
 
1293
        if inventory_delta is not None:
 
1294
            entries = self._tree.iter_entries_by_dir(
 
1295
                new_path_file_ids.values())
 
1296
            old_paths = dict((e.file_id, p) for p, e in entries)
 
1297
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1298
        try:
 
1299
            for num, (path, trans_id) in enumerate(new_paths):
 
1300
                new_entry = None
 
1301
                if (num % 10) == 0:
 
1302
                    child_pb.update('adding file', num, len(new_paths))
 
1303
                full_path = self._tree.abspath(path)
 
1304
                if trans_id in self._needs_rename:
 
1305
                    try:
 
1306
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1307
                    except OSError, e:
 
1308
                        # We may be renaming a dangling inventory id
 
1309
                        if e.errno != errno.ENOENT:
 
1310
                            raise
 
1311
                    else:
 
1312
                        self.rename_count += 1
 
1313
                if inventory_delta is not None:
 
1314
                    if (trans_id in self._new_contents or
 
1315
                        self.path_changed(trans_id)):
 
1316
                        if trans_id in self._new_contents:
 
1317
                            modified_paths.append(full_path)
 
1318
                            completed_new.append(trans_id)
 
1319
                    file_id = new_path_file_ids[trans_id]
 
1320
                    if file_id is not None and (trans_id in self._new_id or
 
1321
                        trans_id in self._new_name or
 
1322
                        trans_id in self._new_parent
 
1323
                        or trans_id in self._new_executability):
 
1324
                        try:
 
1325
                            kind = self.final_kind(trans_id)
 
1326
                        except NoSuchFile:
 
1327
                            kind = self._tree.stored_kind(file_id)
 
1328
                        parent_trans_id = self.final_parent(trans_id)
 
1329
                        parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1330
                        if parent_file_id is None:
 
1331
                            parent_file_id = self.final_file_id(
 
1332
                                parent_trans_id)
 
1333
                        if trans_id in self._new_reference_revision:
 
1334
                            new_entry = inventory.TreeReference(
 
1335
                                file_id,
 
1336
                                self._new_name[trans_id],
 
1337
                                self.final_file_id(self._new_parent[trans_id]),
 
1338
                                None, self._new_reference_revision[trans_id])
 
1339
                        else:
 
1340
                            new_entry = inventory.make_entry(kind,
 
1341
                                self.final_name(trans_id),
 
1342
                                parent_file_id, file_id)
 
1343
                        old_path = old_paths.get(new_entry.file_id)
 
1344
                        inventory_delta.append(
 
1345
                            (old_path, path, new_entry.file_id, new_entry))
 
1346
 
 
1347
                if trans_id in self._new_executability:
 
1348
                    self._set_executability(path, new_entry, trans_id)
 
1349
        finally:
 
1350
            child_pb.finished()
 
1351
        if inventory_delta is None:
 
1352
            self._new_contents.clear()
 
1353
        else:
 
1354
            for trans_id in completed_new:
 
1355
                del self._new_contents[trans_id]
 
1356
        return modified_paths
 
1357
 
 
1358
 
 
1359
class TransformPreview(TreeTransformBase):
 
1360
    """A TreeTransform for generating preview trees.
 
1361
 
 
1362
    Unlike TreeTransform, this version works when the input tree is a
 
1363
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1364
    unversioned files in the input tree.
 
1365
    """
 
1366
 
 
1367
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
 
1368
        tree.lock_read()
 
1369
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1370
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1371
 
 
1372
    def canonical_path(self, path):
 
1373
        return path
 
1374
 
 
1375
    def tree_kind(self, trans_id):
 
1376
        path = self._tree_id_paths.get(trans_id)
 
1377
        if path is None:
 
1378
            raise NoSuchFile(None)
 
1379
        file_id = self._tree.path2id(path)
 
1380
        return self._tree.kind(file_id)
 
1381
 
 
1382
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1383
        """Set the mode of new file contents.
 
1384
        The mode_id is the existing file to get the mode from (often the same
 
1385
        as trans_id).  The operation is only performed if there's a mode match
 
1386
        according to typefunc.
 
1387
        """
 
1388
        # is it ok to ignore this?  probably
 
1389
        pass
 
1390
 
 
1391
    def iter_tree_children(self, parent_id):
 
1392
        """Iterate through the entry's tree children, if any"""
 
1393
        try:
 
1394
            path = self._tree_id_paths[parent_id]
 
1395
        except KeyError:
 
1396
            return
 
1397
        file_id = self.tree_file_id(parent_id)
 
1398
        if file_id is None:
 
1399
            return
 
1400
        children = getattr(self._tree.inventory[file_id], 'children', {})
 
1401
        for child in children:
 
1402
            childpath = joinpath(path, child)
 
1403
            yield self.trans_id_tree_path(childpath)
 
1404
 
 
1405
 
 
1406
class _PreviewTree(tree.Tree):
 
1407
    """Partial implementation of Tree to support show_diff_trees"""
 
1408
 
 
1409
    def __init__(self, transform):
 
1410
        self._transform = transform
 
1411
        self._final_paths = FinalPaths(transform)
 
1412
        self.__by_parent = None
 
1413
        self._parent_ids = []
 
1414
 
 
1415
    def _changes(self, file_id):
 
1416
        for changes in self._transform.iter_changes():
 
1417
            if changes[0] == file_id:
 
1418
                return changes
 
1419
 
 
1420
    def _content_change(self, file_id):
 
1421
        """Return True if the content of this file changed"""
 
1422
        changes = self._changes(file_id)
 
1423
        # changes[2] is true if the file content changed.  See
 
1424
        # InterTree.iter_changes.
 
1425
        return (changes is not None and changes[2])
 
1426
 
 
1427
    def _get_repository(self):
 
1428
        repo = getattr(self._transform._tree, '_repository', None)
 
1429
        if repo is None:
 
1430
            repo = self._transform._tree.branch.repository
 
1431
        return repo
 
1432
 
 
1433
    def _iter_parent_trees(self):
 
1434
        for revision_id in self.get_parent_ids():
 
1435
            try:
 
1436
                yield self.revision_tree(revision_id)
 
1437
            except errors.NoSuchRevisionInTree:
 
1438
                yield self._get_repository().revision_tree(revision_id)
 
1439
 
 
1440
    def _get_file_revision(self, file_id, vf, tree_revision):
 
1441
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
1442
                       self._iter_parent_trees()]
 
1443
        vf.add_lines((file_id, tree_revision), parent_keys,
 
1444
                     self.get_file(file_id).readlines())
 
1445
        repo = self._get_repository()
 
1446
        base_vf = repo.texts
 
1447
        if base_vf not in vf.fallback_versionedfiles:
 
1448
            vf.fallback_versionedfiles.append(base_vf)
 
1449
        return tree_revision
 
1450
 
 
1451
    def _stat_limbo_file(self, file_id):
 
1452
        trans_id = self._transform.trans_id_file_id(file_id)
 
1453
        name = self._transform._limbo_name(trans_id)
 
1454
        return os.lstat(name)
 
1455
 
 
1456
    @property
 
1457
    def _by_parent(self):
 
1458
        if self.__by_parent is None:
 
1459
            self.__by_parent = self._transform.by_parent()
 
1460
        return self.__by_parent
 
1461
 
 
1462
    def lock_read(self):
 
1463
        # Perhaps in theory, this should lock the TreeTransform?
 
1464
        pass
 
1465
 
 
1466
    def unlock(self):
 
1467
        pass
 
1468
 
 
1469
    @property
 
1470
    def inventory(self):
 
1471
        """This Tree does not use inventory as its backing data."""
 
1472
        raise NotImplementedError(_PreviewTree.inventory)
 
1473
 
 
1474
    def get_root_id(self):
 
1475
        return self._transform.final_file_id(self._transform.root)
 
1476
 
 
1477
    def all_file_ids(self):
 
1478
        tree_ids = set(self._transform._tree.all_file_ids())
 
1479
        tree_ids.difference_update(self._transform.tree_file_id(t)
 
1480
                                   for t in self._transform._removed_id)
 
1481
        tree_ids.update(self._transform._new_id.values())
 
1482
        return tree_ids
 
1483
 
 
1484
    def __iter__(self):
 
1485
        return iter(self.all_file_ids())
 
1486
 
 
1487
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1488
        """See Tree.paths2ids"""
 
1489
        to_find = set(specific_files)
 
1490
        result = set()
 
1491
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1492
             executable) in self._transform.iter_changes():
 
1493
            if paths[1] in to_find:
 
1494
                result.append(file_id)
 
1495
                to_find.remove(paths[1])
 
1496
        result.update(self._transform._tree.paths2ids(to_find,
 
1497
                      trees=[], require_versioned=require_versioned))
 
1498
        return result
 
1499
 
 
1500
    def _path2trans_id(self, path):
 
1501
        segments = splitpath(path)
 
1502
        cur_parent = self._transform.root
 
1503
        for cur_segment in segments:
 
1504
            for child in self._all_children(cur_parent):
 
1505
                if self._transform.final_name(child) == cur_segment:
 
1506
                    cur_parent = child
 
1507
                    break
 
1508
            else:
 
1509
                return None
 
1510
        return cur_parent
 
1511
 
 
1512
    def path2id(self, path):
 
1513
        return self._transform.final_file_id(self._path2trans_id(path))
 
1514
 
 
1515
    def id2path(self, file_id):
 
1516
        trans_id = self._transform.trans_id_file_id(file_id)
 
1517
        try:
 
1518
            return self._final_paths._determine_path(trans_id)
 
1519
        except NoFinalPath:
 
1520
            raise errors.NoSuchId(self, file_id)
 
1521
 
 
1522
    def _all_children(self, trans_id):
 
1523
        children = set(self._transform.iter_tree_children(trans_id))
 
1524
        # children in the _new_parent set are provided by _by_parent.
 
1525
        children.difference_update(self._transform._new_parent.keys())
 
1526
        children.update(self._by_parent.get(trans_id, []))
 
1527
        return children
 
1528
 
 
1529
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
 
1530
        for trans_id, parent_file_id in ordered_entries:
 
1531
            file_id = self._transform.final_file_id(trans_id)
 
1532
            if file_id is None:
 
1533
                continue
 
1534
            if (specific_file_ids is not None
 
1535
                and file_id not in specific_file_ids):
 
1536
                continue
 
1537
            try:
 
1538
                kind = self._transform.final_kind(trans_id)
 
1539
            except NoSuchFile:
 
1540
                kind = self._transform._tree.stored_kind(file_id)
 
1541
            new_entry = inventory.make_entry(
 
1542
                kind,
 
1543
                self._transform.final_name(trans_id),
 
1544
                parent_file_id, file_id)
 
1545
            yield new_entry, trans_id
 
1546
 
 
1547
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1548
        # This may not be a maximally efficient implementation, but it is
 
1549
        # reasonably straightforward.  An implementation that grafts the
 
1550
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
1551
        # might be more efficient, but requires tricky inferences about stack
 
1552
        # position.
 
1553
        todo = [ROOT_PARENT]
 
1554
        ordered_ids = []
 
1555
        while len(todo) > 0:
 
1556
            parent = todo.pop()
 
1557
            parent_file_id = self._transform.final_file_id(parent)
 
1558
            children = list(self._all_children(parent))
 
1559
            paths = dict(zip(children, self._final_paths.get_paths(children)))
 
1560
            children.sort(key=paths.get)
 
1561
            todo.extend(reversed(children))
 
1562
            for trans_id in children:
 
1563
                ordered_ids.append((trans_id, parent_file_id))
 
1564
        for entry, trans_id in self._make_inv_entries(ordered_ids,
 
1565
                                                      specific_file_ids):
 
1566
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1567
 
 
1568
    def kind(self, file_id):
 
1569
        trans_id = self._transform.trans_id_file_id(file_id)
 
1570
        return self._transform.final_kind(trans_id)
 
1571
 
 
1572
    def stored_kind(self, file_id):
 
1573
        trans_id = self._transform.trans_id_file_id(file_id)
 
1574
        try:
 
1575
            return self._transform._new_contents[trans_id]
 
1576
        except KeyError:
 
1577
            return self._transform._tree.stored_kind(file_id)
 
1578
 
 
1579
    def get_file_mtime(self, file_id, path=None):
 
1580
        """See Tree.get_file_mtime"""
 
1581
        if not self._content_change(file_id):
 
1582
            return self._transform._tree.get_file_mtime(file_id, path)
 
1583
        return self._stat_limbo_file(file_id).st_mtime
 
1584
 
 
1585
    def get_file_size(self, file_id):
 
1586
        """See Tree.get_file_size"""
 
1587
        if self.kind(file_id) == 'file':
 
1588
            return self._transform._tree.get_file_size(file_id)
 
1589
        else:
 
1590
            return None
 
1591
 
 
1592
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
1593
        return self._transform._tree.get_file_sha1(file_id)
 
1594
 
 
1595
    def is_executable(self, file_id, path=None):
 
1596
        trans_id = self._transform.trans_id_file_id(file_id)
 
1597
        try:
 
1598
            return self._transform._new_executability[trans_id]
 
1599
        except KeyError:
 
1600
            return self._transform._tree.is_executable(file_id, path)
 
1601
 
 
1602
    def path_content_summary(self, path):
 
1603
        trans_id = self._path2trans_id(path)
 
1604
        tt = self._transform
 
1605
        tree_path = tt._tree_id_paths.get(trans_id)
 
1606
        kind = tt._new_contents.get(trans_id)
 
1607
        if kind is None:
 
1608
            if tree_path is None or trans_id in tt._removed_contents:
 
1609
                return 'missing', None, None, None
 
1610
            summary = tt._tree.path_content_summary(tree_path)
 
1611
            kind, size, executable, link_or_sha1 = summary
 
1612
        else:
 
1613
            link_or_sha1 = None
 
1614
            limbo_name = tt._limbo_name(trans_id)
 
1615
            if trans_id in tt._new_reference_revision:
 
1616
                kind = 'tree-reference'
 
1617
            if kind == 'file':
 
1618
                statval = os.lstat(limbo_name)
 
1619
                size = statval.st_size
 
1620
                if not supports_executable():
 
1621
                    executable = None
 
1622
                else:
 
1623
                    executable = statval.st_mode & S_IEXEC
 
1624
            else:
 
1625
                size = None
 
1626
                executable = None
 
1627
            if kind == 'symlink':
 
1628
                link_or_sha1 = os.readlink(limbo_name)
 
1629
        if supports_executable():
 
1630
            executable = tt._new_executability.get(trans_id, executable)
 
1631
        return kind, size, executable, link_or_sha1
 
1632
 
 
1633
    def iter_changes(self, from_tree, include_unchanged=False,
 
1634
                      specific_files=None, pb=None, extra_trees=None,
 
1635
                      require_versioned=True, want_unversioned=False):
 
1636
        """See InterTree.iter_changes.
 
1637
 
 
1638
        This implementation does not support include_unchanged, specific_files,
 
1639
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1640
        ignored.
 
1641
        """
 
1642
        if from_tree is not self._transform._tree:
 
1643
            raise ValueError('from_tree must be transform source tree.')
 
1644
        if include_unchanged:
 
1645
            raise ValueError('include_unchanged is not supported')
 
1646
        if specific_files is not None:
 
1647
            raise ValueError('specific_files is not supported')
 
1648
        if want_unversioned:
 
1649
            raise ValueError('want_unversioned is not supported')
 
1650
        return self._transform.iter_changes()
 
1651
 
 
1652
    def get_file(self, file_id, path=None):
 
1653
        """See Tree.get_file"""
 
1654
        if not self._content_change(file_id):
 
1655
            return self._transform._tree.get_file(file_id, path)
 
1656
        trans_id = self._transform.trans_id_file_id(file_id)
 
1657
        name = self._transform._limbo_name(trans_id)
 
1658
        return open(name, 'rb')
 
1659
 
 
1660
    def get_file_text(self, file_id):
 
1661
        text_file = self.get_file(file_id)
 
1662
        try:
 
1663
            return text_file.read()
 
1664
        finally:
 
1665
            text_file.close()
 
1666
 
 
1667
    def annotate_iter(self, file_id,
 
1668
                      default_revision=_mod_revision.CURRENT_REVISION):
 
1669
        changes = self._changes(file_id)
 
1670
        if changes is None:
 
1671
            get_old = True
 
1672
        else:
 
1673
            changed_content, versioned, kind = (changes[2], changes[3],
 
1674
                                                changes[6])
 
1675
            if kind[1] is None:
 
1676
                return None
 
1677
            get_old = (kind[0] == 'file' and versioned[0])
 
1678
        if get_old:
 
1679
            old_annotation = self._transform._tree.annotate_iter(file_id,
 
1680
                default_revision=default_revision)
 
1681
        else:
 
1682
            old_annotation = []
 
1683
        if changes is None:
 
1684
            return old_annotation
 
1685
        if not changed_content:
 
1686
            return old_annotation
 
1687
        return annotate.reannotate([old_annotation],
 
1688
                                   self.get_file(file_id).readlines(),
 
1689
                                   default_revision)
 
1690
 
 
1691
    def get_symlink_target(self, file_id):
 
1692
        """See Tree.get_symlink_target"""
 
1693
        if not self._content_change(file_id):
 
1694
            return self._transform._tree.get_symlink_target(file_id)
 
1695
        trans_id = self._transform.trans_id_file_id(file_id)
 
1696
        name = self._transform._limbo_name(trans_id)
 
1697
        return os.readlink(name)
 
1698
 
 
1699
    def list_files(self, include_root=False):
 
1700
        return self._transform._tree.list_files(include_root)
 
1701
 
 
1702
    def walkdirs(self, prefix=""):
 
1703
        return self._transform._tree.walkdirs(prefix)
 
1704
 
 
1705
    def get_parent_ids(self):
 
1706
        return self._parent_ids
 
1707
 
 
1708
    def set_parent_ids(self, parent_ids):
 
1709
        self._parent_ids = parent_ids
 
1710
 
 
1711
    def get_revision_tree(self, revision_id):
 
1712
        return self._transform._tree.get_revision_tree(revision_id)
 
1713
 
 
1714
 
 
1715
def joinpath(parent, child):
 
1716
    """Join tree-relative paths, handling the tree root specially"""
 
1717
    if parent is None or parent == "":
 
1718
        return child
 
1719
    else:
 
1720
        return pathjoin(parent, child)
 
1721
 
 
1722
 
 
1723
class FinalPaths(object):
 
1724
    """Make path calculation cheap by memoizing paths.
 
1725
 
 
1726
    The underlying tree must not be manipulated between calls, or else
 
1727
    the results will likely be incorrect.
 
1728
    """
 
1729
    def __init__(self, transform):
 
1730
        object.__init__(self)
 
1731
        self._known_paths = {}
 
1732
        self.transform = transform
 
1733
 
 
1734
    def _determine_path(self, trans_id):
 
1735
        if trans_id == self.transform.root:
 
1736
            return ""
 
1737
        name = self.transform.final_name(trans_id)
 
1738
        parent_id = self.transform.final_parent(trans_id)
 
1739
        if parent_id == self.transform.root:
 
1740
            return name
 
1741
        else:
 
1742
            return pathjoin(self.get_path(parent_id), name)
 
1743
 
 
1744
    def get_path(self, trans_id):
 
1745
        """Find the final path associated with a trans_id"""
 
1746
        if trans_id not in self._known_paths:
 
1747
            self._known_paths[trans_id] = self._determine_path(trans_id)
 
1748
        return self._known_paths[trans_id]
 
1749
 
 
1750
    def get_paths(self, trans_ids):
 
1751
        return [(self.get_path(t), t) for t in trans_ids]
 
1752
 
 
1753
 
 
1754
 
 
1755
def topology_sorted_ids(tree):
 
1756
    """Determine the topological order of the ids in a tree"""
 
1757
    file_ids = list(tree)
 
1758
    file_ids.sort(key=tree.id2path)
 
1759
    return file_ids
 
1760
 
 
1761
 
 
1762
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
 
1763
               delta_from_tree=False):
 
1764
    """Create working tree for a branch, using a TreeTransform.
 
1765
    
 
1766
    This function should be used on empty trees, having a tree root at most.
 
1767
    (see merge and revert functionality for working with existing trees)
 
1768
 
 
1769
    Existing files are handled like so:
 
1770
    
 
1771
    - Existing bzrdirs take precedence over creating new items.  They are
 
1772
      created as '%s.diverted' % name.
 
1773
    - Otherwise, if the content on disk matches the content we are building,
 
1774
      it is silently replaced.
 
1775
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
1776
 
 
1777
    :param tree: The tree to convert wt into a copy of
 
1778
    :param wt: The working tree that files will be placed into
 
1779
    :param accelerator_tree: A tree which can be used for retrieving file
 
1780
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
1781
        will be used for cases where accelerator_tree's content is different.
 
1782
    :param hardlink: If true, hard-link files to accelerator_tree, where
 
1783
        possible.  accelerator_tree must implement abspath, i.e. be a
 
1784
        working tree.
 
1785
    :param delta_from_tree: If true, build_tree may use the input Tree to
 
1786
        generate the inventory delta.
 
1787
    """
 
1788
    wt.lock_tree_write()
 
1789
    try:
 
1790
        tree.lock_read()
 
1791
        try:
 
1792
            if accelerator_tree is not None:
 
1793
                accelerator_tree.lock_read()
 
1794
            try:
 
1795
                return _build_tree(tree, wt, accelerator_tree, hardlink,
 
1796
                                   delta_from_tree)
 
1797
            finally:
 
1798
                if accelerator_tree is not None:
 
1799
                    accelerator_tree.unlock()
 
1800
        finally:
 
1801
            tree.unlock()
 
1802
    finally:
 
1803
        wt.unlock()
 
1804
 
 
1805
 
 
1806
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1807
    """See build_tree."""
 
1808
    for num, _unused in enumerate(wt.all_file_ids()):
 
1809
        if num > 0:  # more than just a root
 
1810
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
1811
    existing_files = set()
 
1812
    for dir, files in wt.walkdirs():
 
1813
        existing_files.update(f[0] for f in files)
 
1814
    file_trans_id = {}
 
1815
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1816
    pp = ProgressPhase("Build phase", 2, top_pb)
 
1817
    if tree.inventory.root is not None:
 
1818
        # This is kind of a hack: we should be altering the root
 
1819
        # as part of the regular tree shape diff logic.
 
1820
        # The conditional test here is to avoid doing an
 
1821
        # expensive operation (flush) every time the root id
 
1822
        # is set within the tree, nor setting the root and thus
 
1823
        # marking the tree as dirty, because we use two different
 
1824
        # idioms here: tree interfaces and inventory interfaces.
 
1825
        if wt.get_root_id() != tree.get_root_id():
 
1826
            wt.set_root_id(tree.get_root_id())
 
1827
            wt.flush()
 
1828
    tt = TreeTransform(wt)
 
1829
    divert = set()
 
1830
    try:
 
1831
        pp.next_phase()
 
1832
        file_trans_id[wt.get_root_id()] = \
 
1833
            tt.trans_id_tree_file_id(wt.get_root_id())
 
1834
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1835
        try:
 
1836
            deferred_contents = []
 
1837
            num = 0
 
1838
            total = len(tree.inventory)
 
1839
            if delta_from_tree:
 
1840
                precomputed_delta = []
 
1841
            else:
 
1842
                precomputed_delta = None
 
1843
            for num, (tree_path, entry) in \
 
1844
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1845
                pb.update("Building tree", num - len(deferred_contents), total)
 
1846
                if entry.parent_id is None:
 
1847
                    continue
 
1848
                reparent = False
 
1849
                file_id = entry.file_id
 
1850
                if delta_from_tree:
 
1851
                    precomputed_delta.append((None, tree_path, file_id, entry))
 
1852
                if tree_path in existing_files:
 
1853
                    target_path = wt.abspath(tree_path)
 
1854
                    kind = file_kind(target_path)
 
1855
                    if kind == "directory":
 
1856
                        try:
 
1857
                            bzrdir.BzrDir.open(target_path)
 
1858
                        except errors.NotBranchError:
 
1859
                            pass
 
1860
                        else:
 
1861
                            divert.add(file_id)
 
1862
                    if (file_id not in divert and
 
1863
                        _content_match(tree, entry, file_id, kind,
 
1864
                        target_path)):
 
1865
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
 
1866
                        if kind == 'directory':
 
1867
                            reparent = True
 
1868
                parent_id = file_trans_id[entry.parent_id]
 
1869
                if entry.kind == 'file':
 
1870
                    # We *almost* replicate new_by_entry, so that we can defer
 
1871
                    # getting the file text, and get them all at once.
 
1872
                    trans_id = tt.create_path(entry.name, parent_id)
 
1873
                    file_trans_id[file_id] = trans_id
 
1874
                    tt.version_file(file_id, trans_id)
 
1875
                    executable = tree.is_executable(file_id, tree_path)
 
1876
                    if executable:
 
1877
                        tt.set_executability(executable, trans_id)
 
1878
                    deferred_contents.append((file_id, trans_id))
 
1879
                else:
 
1880
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
1881
                                                          tree)
 
1882
                if reparent:
 
1883
                    new_trans_id = file_trans_id[file_id]
 
1884
                    old_parent = tt.trans_id_tree_path(tree_path)
 
1885
                    _reparent_children(tt, old_parent, new_trans_id)
 
1886
            offset = num + 1 - len(deferred_contents)
 
1887
            _create_files(tt, tree, deferred_contents, pb, offset,
 
1888
                          accelerator_tree, hardlink)
 
1889
        finally:
 
1890
            pb.finished()
 
1891
        pp.next_phase()
 
1892
        divert_trans = set(file_trans_id[f] for f in divert)
 
1893
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
 
1894
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
1895
        if len(raw_conflicts) > 0:
 
1896
            precomputed_delta = None
 
1897
        conflicts = cook_conflicts(raw_conflicts, tt)
 
1898
        for conflict in conflicts:
 
1899
            warning(conflict)
 
1900
        try:
 
1901
            wt.add_conflicts(conflicts)
 
1902
        except errors.UnsupportedOperation:
 
1903
            pass
 
1904
        result = tt.apply(no_conflicts=True,
 
1905
                          precomputed_delta=precomputed_delta)
 
1906
    finally:
 
1907
        tt.finalize()
 
1908
        top_pb.finished()
 
1909
    return result
 
1910
 
 
1911
 
 
1912
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
 
1913
                  hardlink):
 
1914
    total = len(desired_files) + offset
 
1915
    if accelerator_tree is None:
 
1916
        new_desired_files = desired_files
 
1917
    else:
 
1918
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
 
1919
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1920
                         in iter if not (c or e[0] != e[1]))
 
1921
        new_desired_files = []
 
1922
        count = 0
 
1923
        for file_id, trans_id in desired_files:
 
1924
            accelerator_path = unchanged.get(file_id)
 
1925
            if accelerator_path is None:
 
1926
                new_desired_files.append((file_id, trans_id))
 
1927
                continue
 
1928
            pb.update('Adding file contents', count + offset, total)
 
1929
            if hardlink:
 
1930
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
 
1931
                                   trans_id)
 
1932
            else:
 
1933
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
1934
                try:
 
1935
                    tt.create_file(contents, trans_id)
 
1936
                finally:
 
1937
                    contents.close()
 
1938
            count += 1
 
1939
        offset += count
 
1940
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1941
                                                 new_desired_files)):
 
1942
        tt.create_file(contents, trans_id)
 
1943
        pb.update('Adding file contents', count + offset, total)
 
1944
 
 
1945
 
 
1946
def _reparent_children(tt, old_parent, new_parent):
 
1947
    for child in tt.iter_tree_children(old_parent):
 
1948
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1949
 
 
1950
def _reparent_transform_children(tt, old_parent, new_parent):
 
1951
    by_parent = tt.by_parent()
 
1952
    for child in by_parent[old_parent]:
 
1953
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1954
    return by_parent[old_parent]
 
1955
 
 
1956
def _content_match(tree, entry, file_id, kind, target_path):
 
1957
    if entry.kind != kind:
 
1958
        return False
 
1959
    if entry.kind == "directory":
 
1960
        return True
 
1961
    if entry.kind == "file":
 
1962
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1963
            return True
 
1964
    elif entry.kind == "symlink":
 
1965
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
 
1966
            return True
 
1967
    return False
 
1968
 
 
1969
 
 
1970
def resolve_checkout(tt, conflicts, divert):
 
1971
    new_conflicts = set()
 
1972
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
1973
        # Anything but a 'duplicate' would indicate programmer error
 
1974
        if c_type != 'duplicate':
 
1975
            raise AssertionError(c_type)
 
1976
        # Now figure out which is new and which is old
 
1977
        if tt.new_contents(conflict[1]):
 
1978
            new_file = conflict[1]
 
1979
            old_file = conflict[2]
 
1980
        else:
 
1981
            new_file = conflict[2]
 
1982
            old_file = conflict[1]
 
1983
 
 
1984
        # We should only get here if the conflict wasn't completely
 
1985
        # resolved
 
1986
        final_parent = tt.final_parent(old_file)
 
1987
        if new_file in divert:
 
1988
            new_name = tt.final_name(old_file)+'.diverted'
 
1989
            tt.adjust_path(new_name, final_parent, new_file)
 
1990
            new_conflicts.add((c_type, 'Diverted to',
 
1991
                               new_file, old_file))
 
1992
        else:
 
1993
            new_name = tt.final_name(old_file)+'.moved'
 
1994
            tt.adjust_path(new_name, final_parent, old_file)
 
1995
            new_conflicts.add((c_type, 'Moved existing file to',
 
1996
                               old_file, new_file))
 
1997
    return new_conflicts
 
1998
 
 
1999
 
 
2000
def new_by_entry(tt, entry, parent_id, tree):
 
2001
    """Create a new file according to its inventory entry"""
 
2002
    name = entry.name
 
2003
    kind = entry.kind
 
2004
    if kind == 'file':
 
2005
        contents = tree.get_file(entry.file_id).readlines()
 
2006
        executable = tree.is_executable(entry.file_id)
 
2007
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
2008
                           executable)
 
2009
    elif kind in ('directory', 'tree-reference'):
 
2010
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
 
2011
        if kind == 'tree-reference':
 
2012
            tt.set_tree_reference(entry.reference_revision, trans_id)
 
2013
        return trans_id 
 
2014
    elif kind == 'symlink':
 
2015
        target = tree.get_symlink_target(entry.file_id)
 
2016
        return tt.new_symlink(name, parent_id, target, entry.file_id)
 
2017
    else:
 
2018
        raise errors.BadFileKindError(name, kind)
 
2019
 
 
2020
 
 
2021
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
2022
    """Create new file contents according to an inventory entry."""
 
2023
    if entry.kind == "file":
 
2024
        if lines is None:
 
2025
            lines = tree.get_file(entry.file_id).readlines()
 
2026
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
2027
    elif entry.kind == "symlink":
 
2028
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
2029
    elif entry.kind == "directory":
 
2030
        tt.create_directory(trans_id)
 
2031
 
 
2032
 
 
2033
def create_entry_executability(tt, entry, trans_id):
 
2034
    """Set the executability of a trans_id according to an inventory entry"""
 
2035
    if entry.kind == "file":
 
2036
        tt.set_executability(entry.executable, trans_id)
 
2037
 
 
2038
 
 
2039
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
2040
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
2041
 
 
2042
 
 
2043
def _get_backup_name(name, by_parent, parent_trans_id, tt):
 
2044
    """Produce a backup-style name that appears to be available"""
 
2045
    def name_gen():
 
2046
        counter = 1
 
2047
        while True:
 
2048
            yield "%s.~%d~" % (name, counter)
 
2049
            counter += 1
 
2050
    for new_name in name_gen():
 
2051
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
2052
            return new_name
 
2053
 
 
2054
 
 
2055
def _entry_changes(file_id, entry, working_tree):
 
2056
    """Determine in which ways the inventory entry has changed.
 
2057
 
 
2058
    Returns booleans: has_contents, content_mod, meta_mod
 
2059
    has_contents means there are currently contents, but they differ
 
2060
    contents_mod means contents need to be modified
 
2061
    meta_mod means the metadata needs to be modified
 
2062
    """
 
2063
    cur_entry = working_tree.inventory[file_id]
 
2064
    try:
 
2065
        working_kind = working_tree.kind(file_id)
 
2066
        has_contents = True
 
2067
    except NoSuchFile:
 
2068
        has_contents = False
 
2069
        contents_mod = True
 
2070
        meta_mod = False
 
2071
    if has_contents is True:
 
2072
        if entry.kind != working_kind:
 
2073
            contents_mod, meta_mod = True, False
 
2074
        else:
 
2075
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2076
                                       working_tree)
 
2077
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
 
2078
            cur_entry._forget_tree_state()
 
2079
    return has_contents, contents_mod, meta_mod
 
2080
 
 
2081
 
 
2082
def revert(working_tree, target_tree, filenames, backups=False,
 
2083
           pb=DummyProgress(), change_reporter=None):
 
2084
    """Revert a working tree's contents to those of a target tree."""
 
2085
    target_tree.lock_read()
 
2086
    tt = TreeTransform(working_tree, pb)
 
2087
    try:
 
2088
        pp = ProgressPhase("Revert phase", 3, pb)
 
2089
        pp.next_phase()
 
2090
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2091
        try:
 
2092
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
2093
                                          child_pb, filenames, backups)
 
2094
        finally:
 
2095
            child_pb.finished()
 
2096
        pp.next_phase()
 
2097
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2098
        try:
 
2099
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
2100
                lambda t, c: conflict_pass(t, c, target_tree))
 
2101
        finally:
 
2102
            child_pb.finished()
 
2103
        conflicts = cook_conflicts(raw_conflicts, tt)
 
2104
        if change_reporter:
 
2105
            change_reporter = delta._ChangeReporter(
 
2106
                unversioned_filter=working_tree.is_ignored)
 
2107
            delta.report_changes(tt.iter_changes(), change_reporter)
 
2108
        for conflict in conflicts:
 
2109
            warning(conflict)
 
2110
        pp.next_phase()
 
2111
        tt.apply()
 
2112
        working_tree.set_merge_modified(merge_modified)
 
2113
    finally:
 
2114
        target_tree.unlock()
 
2115
        tt.finalize()
 
2116
        pb.clear()
 
2117
    return conflicts
 
2118
 
 
2119
 
 
2120
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
 
2121
                 backups):
 
2122
    merge_modified = working_tree.merge_modified()
 
2123
    change_list = target_tree.iter_changes(working_tree,
 
2124
        specific_files=specific_files, pb=pb)
 
2125
    if target_tree.inventory.root is None:
 
2126
        skip_root = True
 
2127
    else:
 
2128
        skip_root = False
 
2129
    basis_tree = None
 
2130
    try:
 
2131
        deferred_files = []
 
2132
        for id_num, (file_id, path, changed_content, versioned, parent, name,
 
2133
                kind, executable) in enumerate(change_list):
 
2134
            if skip_root and file_id[0] is not None and parent[0] is None:
 
2135
                continue
 
2136
            trans_id = tt.trans_id_file_id(file_id)
 
2137
            mode_id = None
 
2138
            if changed_content:
 
2139
                keep_content = False
 
2140
                if kind[0] == 'file' and (backups or kind[1] is None):
 
2141
                    wt_sha1 = working_tree.get_file_sha1(file_id)
 
2142
                    if merge_modified.get(file_id) != wt_sha1:
 
2143
                        # acquire the basis tree lazily to prevent the
 
2144
                        # expense of accessing it when it's not needed ?
 
2145
                        # (Guessing, RBC, 200702)
 
2146
                        if basis_tree is None:
 
2147
                            basis_tree = working_tree.basis_tree()
 
2148
                            basis_tree.lock_read()
 
2149
                        if file_id in basis_tree:
 
2150
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
 
2151
                                keep_content = True
 
2152
                        elif kind[1] is None and not versioned[1]:
 
2153
                            keep_content = True
 
2154
                if kind[0] is not None:
 
2155
                    if not keep_content:
 
2156
                        tt.delete_contents(trans_id)
 
2157
                    elif kind[1] is not None:
 
2158
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2159
                        by_parent = tt.by_parent()
 
2160
                        backup_name = _get_backup_name(name[0], by_parent,
 
2161
                                                       parent_trans_id, tt)
 
2162
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
 
2163
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2164
                        if versioned == (True, True):
 
2165
                            tt.unversion_file(trans_id)
 
2166
                            tt.version_file(file_id, new_trans_id)
 
2167
                        # New contents should have the same unix perms as old
 
2168
                        # contents
 
2169
                        mode_id = trans_id
 
2170
                        trans_id = new_trans_id
 
2171
                if kind[1] == 'directory':
 
2172
                    tt.create_directory(trans_id)
 
2173
                elif kind[1] == 'symlink':
 
2174
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
 
2175
                                      trans_id)
 
2176
                elif kind[1] == 'file':
 
2177
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
2178
                    if basis_tree is None:
 
2179
                        basis_tree = working_tree.basis_tree()
 
2180
                        basis_tree.lock_read()
 
2181
                    new_sha1 = target_tree.get_file_sha1(file_id)
 
2182
                    if (file_id in basis_tree and new_sha1 ==
 
2183
                        basis_tree.get_file_sha1(file_id)):
 
2184
                        if file_id in merge_modified:
 
2185
                            del merge_modified[file_id]
 
2186
                    else:
 
2187
                        merge_modified[file_id] = new_sha1
 
2188
 
 
2189
                    # preserve the execute bit when backing up
 
2190
                    if keep_content and executable[0] == executable[1]:
 
2191
                        tt.set_executability(executable[1], trans_id)
 
2192
                elif kind[1] is not None:
 
2193
                    raise AssertionError(kind[1])
 
2194
            if versioned == (False, True):
 
2195
                tt.version_file(file_id, trans_id)
 
2196
            if versioned == (True, False):
 
2197
                tt.unversion_file(trans_id)
 
2198
            if (name[1] is not None and 
 
2199
                (name[0] != name[1] or parent[0] != parent[1])):
 
2200
                tt.adjust_path(
 
2201
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
2202
            if executable[0] != executable[1] and kind[1] == "file":
 
2203
                tt.set_executability(executable[1], trans_id)
 
2204
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2205
            deferred_files):
 
2206
            tt.create_file(bytes, trans_id, mode_id)
 
2207
    finally:
 
2208
        if basis_tree is not None:
 
2209
            basis_tree.unlock()
 
2210
    return merge_modified
 
2211
 
 
2212
 
 
2213
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
2214
    """Make many conflict-resolution attempts, but die if they fail"""
 
2215
    if pass_func is None:
 
2216
        pass_func = conflict_pass
 
2217
    new_conflicts = set()
 
2218
    try:
 
2219
        for n in range(10):
 
2220
            pb.update('Resolution pass', n+1, 10)
 
2221
            conflicts = tt.find_conflicts()
 
2222
            if len(conflicts) == 0:
 
2223
                return new_conflicts
 
2224
            new_conflicts.update(pass_func(tt, conflicts))
 
2225
        raise MalformedTransform(conflicts=conflicts)
 
2226
    finally:
 
2227
        pb.clear()
 
2228
 
 
2229
 
 
2230
def conflict_pass(tt, conflicts, path_tree=None):
 
2231
    """Resolve some classes of conflicts.
 
2232
 
 
2233
    :param tt: The transform to resolve conflicts in
 
2234
    :param conflicts: The conflicts to resolve
 
2235
    :param path_tree: A Tree to get supplemental paths from
 
2236
    """
 
2237
    new_conflicts = set()
 
2238
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
2239
        if c_type == 'duplicate id':
 
2240
            tt.unversion_file(conflict[1])
 
2241
            new_conflicts.add((c_type, 'Unversioned existing file',
 
2242
                               conflict[1], conflict[2], ))
 
2243
        elif c_type == 'duplicate':
 
2244
            # files that were renamed take precedence
 
2245
            final_parent = tt.final_parent(conflict[1])
 
2246
            if tt.path_changed(conflict[1]):
 
2247
                existing_file, new_file = conflict[2], conflict[1]
 
2248
            else:
 
2249
                existing_file, new_file = conflict[1], conflict[2]
 
2250
            new_name = tt.final_name(existing_file)+'.moved'
 
2251
            tt.adjust_path(new_name, final_parent, existing_file)
 
2252
            new_conflicts.add((c_type, 'Moved existing file to', 
 
2253
                               existing_file, new_file))
 
2254
        elif c_type == 'parent loop':
 
2255
            # break the loop by undoing one of the ops that caused the loop
 
2256
            cur = conflict[1]
 
2257
            while not tt.path_changed(cur):
 
2258
                cur = tt.final_parent(cur)
 
2259
            new_conflicts.add((c_type, 'Cancelled move', cur,
 
2260
                               tt.final_parent(cur),))
 
2261
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
 
2262
            
 
2263
        elif c_type == 'missing parent':
 
2264
            trans_id = conflict[1]
 
2265
            try:
 
2266
                tt.cancel_deletion(trans_id)
 
2267
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2268
                                   trans_id))
 
2269
            except KeyError:
 
2270
                create = True
 
2271
                try:
 
2272
                    tt.final_name(trans_id)
 
2273
                except NoFinalPath:
 
2274
                    if path_tree is not None:
 
2275
                        file_id = tt.final_file_id(trans_id)
 
2276
                        if file_id is None:
 
2277
                            file_id = tt.inactive_file_id(trans_id)
 
2278
                        entry = path_tree.inventory[file_id]
 
2279
                        # special-case the other tree root (move its
 
2280
                        # children to current root)
 
2281
                        if entry.parent_id is None:
 
2282
                            create=False
 
2283
                            moved = _reparent_transform_children(
 
2284
                                tt, trans_id, tt.root)
 
2285
                            for child in moved:
 
2286
                                new_conflicts.add((c_type, 'Moved to root',
 
2287
                                                   child))
 
2288
                        else:
 
2289
                            parent_trans_id = tt.trans_id_file_id(
 
2290
                                entry.parent_id)
 
2291
                            tt.adjust_path(entry.name, parent_trans_id,
 
2292
                                           trans_id)
 
2293
                if create:
 
2294
                    tt.create_directory(trans_id)
 
2295
                    new_conflicts.add((c_type, 'Created directory', trans_id))
 
2296
        elif c_type == 'unversioned parent':
 
2297
            file_id = tt.inactive_file_id(conflict[1])
 
2298
            # special-case the other tree root (move its children instead)
 
2299
            if path_tree and file_id in path_tree:
 
2300
                if path_tree.inventory[file_id].parent_id is None:
 
2301
                    continue
 
2302
            tt.version_file(file_id, conflict[1])
 
2303
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
2304
        elif c_type == 'non-directory parent':
 
2305
            parent_id = conflict[1]
 
2306
            parent_parent = tt.final_parent(parent_id)
 
2307
            parent_name = tt.final_name(parent_id)
 
2308
            parent_file_id = tt.final_file_id(parent_id)
 
2309
            new_parent_id = tt.new_directory(parent_name + '.new',
 
2310
                parent_parent, parent_file_id)
 
2311
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
2312
            if parent_file_id is not None:
 
2313
                tt.unversion_file(parent_id)
 
2314
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
 
2315
    return new_conflicts
 
2316
 
 
2317
 
 
2318
def cook_conflicts(raw_conflicts, tt):
 
2319
    """Generate a list of cooked conflicts, sorted by file path"""
 
2320
    from bzrlib.conflicts import Conflict
 
2321
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
 
2322
    return sorted(conflict_iter, key=Conflict.sort_key)
 
2323
 
 
2324
 
 
2325
def iter_cook_conflicts(raw_conflicts, tt):
 
2326
    from bzrlib.conflicts import Conflict
 
2327
    fp = FinalPaths(tt)
 
2328
    for conflict in raw_conflicts:
 
2329
        c_type = conflict[0]
 
2330
        action = conflict[1]
 
2331
        modified_path = fp.get_path(conflict[2])
 
2332
        modified_id = tt.final_file_id(conflict[2])
 
2333
        if len(conflict) == 3:
 
2334
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2335
                                     file_id=modified_id)
 
2336
             
 
2337
        else:
 
2338
            conflicting_path = fp.get_path(conflict[3])
 
2339
            conflicting_id = tt.final_file_id(conflict[3])
 
2340
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2341
                                   file_id=modified_id, 
 
2342
                                   conflict_path=conflicting_path,
 
2343
                                   conflict_file_id=conflicting_id)
 
2344
 
 
2345
 
 
2346
class _FileMover(object):
 
2347
    """Moves and deletes files for TreeTransform, tracking operations"""
 
2348
 
 
2349
    def __init__(self):
 
2350
        self.past_renames = []
 
2351
        self.pending_deletions = []
 
2352
 
 
2353
    def rename(self, from_, to):
 
2354
        """Rename a file from one path to another.  Functions like os.rename"""
 
2355
        try:
 
2356
            os.rename(from_, to)
 
2357
        except OSError, e:
 
2358
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
 
2359
                raise errors.FileExists(to, str(e))
 
2360
            raise
 
2361
        self.past_renames.append((from_, to))
 
2362
 
 
2363
    def pre_delete(self, from_, to):
 
2364
        """Rename a file out of the way and mark it for deletion.
 
2365
 
 
2366
        Unlike os.unlink, this works equally well for files and directories.
 
2367
        :param from_: The current file path
 
2368
        :param to: A temporary path for the file
 
2369
        """
 
2370
        self.rename(from_, to)
 
2371
        self.pending_deletions.append(to)
 
2372
 
 
2373
    def rollback(self):
 
2374
        """Reverse all renames that have been performed"""
 
2375
        for from_, to in reversed(self.past_renames):
 
2376
            os.rename(to, from_)
 
2377
        # after rollback, don't reuse _FileMover
 
2378
        past_renames = None
 
2379
        pending_deletions = None
 
2380
 
 
2381
    def apply_deletions(self):
 
2382
        """Apply all marked deletions"""
 
2383
        for path in self.pending_deletions:
 
2384
            delete_any(path)
 
2385
        # after apply_deletions, don't reuse _FileMover
 
2386
        past_renames = None
 
2387
        pending_deletions = None