/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: Canonical.com Patch Queue Manager
  • Date: 2008-09-29 23:51:44 UTC
  • mfrom: (3363.17.14 merge-into)
  • Revision ID: pqm@pqm.ubuntu.com-20080929235144-2jweo1007kh31723
Enable merging into PreviewTrees

Show diffs side-by-side

added added

removed removed

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