/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: Ian Clatworthy
  • Date: 2008-12-18 06:58:37 UTC
  • mto: (3915.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3916.
  • Revision ID: ian.clatworthy@canonical.com-20081218065837-5rvhmsp4a24nlmxy
add Tree.supports_content_filtering

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