/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: Eric Siegerman
  • Date: 2009-03-25 16:53:14 UTC
  • mto: (4204.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4205.
  • Revision ID: pub08@davor.org-20090325165314-1n3wv0ig2knf44xx
Another broken link.

Show diffs side-by-side

added added

removed removed

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