/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: John Arbash Meinel
  • Date: 2008-08-18 22:34:21 UTC
  • mto: (3606.5.6 1.6)
  • mto: This revision was merged to the branch mainline in revision 3641.
  • Revision ID: john@arbash-meinel.com-20080818223421-todjny24vj4faj4t
Add tests for the fetching behavior.

The proper parameter passed is 'unordered' add an assert for it, and
fix callers that were passing 'unsorted' instead.
Add tests that we make the right get_record_stream call based
on the value of _fetch_uses_deltas.
Fix the fetch request for signatures.

Show diffs side-by-side

added added

removed removed

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