/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: Jelmer Vernooij
  • Date: 2008-09-02 00:29:28 UTC
  • mto: (3680.1.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 3689.
  • Revision ID: jelmer@samba.org-20080902002928-qp0m5mq97t5zm414
Eliminate more uses of Repository.revision_tree(None).

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import errno
19
19
from stat import S_ISREG, S_IEXEC
20
 
import time
 
20
import tempfile
21
21
 
22
22
from bzrlib.lazy_import import lazy_import
23
23
lazy_import(globals(), """
24
24
from bzrlib import (
25
25
    annotate,
26
 
    bencode,
27
26
    bzrdir,
28
27
    delta,
29
28
    errors,
30
29
    inventory,
31
 
    multiparent,
32
30
    osutils,
33
31
    revision as _mod_revision,
34
 
    ui,
35
32
    )
36
33
""")
37
34
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
38
 
                           ReusingTransform, CantMoveRoot,
 
35
                           ReusingTransform, NotVersionedError, CantMoveRoot,
39
36
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
40
37
                           UnableCreateSymlink)
41
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
42
38
from bzrlib.inventory import InventoryEntry
43
39
from bzrlib.osutils import (
44
40
    delete_any,
46
42
    has_symlinks,
47
43
    lexists,
48
44
    pathjoin,
49
 
    sha_file,
50
45
    splitpath,
51
46
    supports_executable,
52
47
)
53
 
from bzrlib.progress import ProgressPhase
 
48
from bzrlib.progress import DummyProgress, ProgressPhase
54
49
from bzrlib.symbol_versioning import (
55
50
        deprecated_function,
56
 
        deprecated_in,
57
51
        )
58
52
from bzrlib.trace import mutter, warning
59
53
from bzrlib import tree
78
72
 
79
73
 
80
74
class TreeTransformBase(object):
81
 
    """The base class for TreeTransform and its kin."""
 
75
    """The base class for TreeTransform and TreeTransformBase"""
82
76
 
83
 
    def __init__(self, tree, pb=None,
 
77
    def __init__(self, tree, limbodir, pb=DummyProgress(),
84
78
                 case_sensitive=True):
85
79
        """Constructor.
86
80
 
87
81
        :param tree: The tree that will be transformed, but not necessarily
88
82
            the output tree.
89
 
        :param pb: ignored
 
83
        :param limbodir: A directory where new files can be stored until
 
84
            they are installed in their proper places
 
85
        :param pb: A ProgressBar indicating how much progress is being made
90
86
        :param case_sensitive: If True, the target of the transform is
91
87
            case sensitive, not just case preserving.
92
88
        """
93
89
        object.__init__(self)
94
90
        self._tree = tree
 
91
        self._limbodir = limbodir
 
92
        self._deletiondir = None
95
93
        self._id_number = 0
96
94
        # mapping of trans_id -> new basename
97
95
        self._new_name = {}
99
97
        self._new_parent = {}
100
98
        # mapping of trans_id with new contents -> new file_kind
101
99
        self._new_contents = {}
 
100
        # A mapping of transform ids to their limbo filename
 
101
        self._limbo_files = {}
 
102
        # A mapping of transform ids to a set of the transform ids of children
 
103
        # that their limbo directory has
 
104
        self._limbo_children = {}
 
105
        # Map transform ids to maps of child filename to child transform id
 
106
        self._limbo_children_names = {}
 
107
        # List of transform ids that need to be renamed from limbo into place
 
108
        self._needs_rename = set()
102
109
        # Set of trans_ids whose contents will be removed
103
110
        self._removed_contents = set()
104
111
        # Mapping of trans_id -> new execute-bit value
111
118
        self._non_present_ids = {}
112
119
        # Mapping of new file_id -> trans_id
113
120
        self._r_new_id = {}
114
 
        # Set of trans_ids that will be removed
 
121
        # Set of file_ids that will be removed
115
122
        self._removed_id = set()
116
123
        # Mapping of path in old tree -> trans_id
117
124
        self._tree_path_ids = {}
118
125
        # Mapping trans_id -> path in old tree
119
126
        self._tree_id_paths = {}
 
127
        # Cache of realpath results, to speed up canonical_path
 
128
        self._realpaths = {}
 
129
        # Cache of relpath results, to speed up canonical_path
 
130
        self._relpaths = {}
120
131
        # The trans_id that will be used as the tree root
121
132
        root_id = tree.get_root_id()
122
133
        if root_id is not None:
132
143
        # A counter of how many files have been renamed
133
144
        self.rename_count = 0
134
145
 
135
 
    def finalize(self):
136
 
        """Release the working tree lock, if held.
137
 
 
138
 
        This is required if apply has not been invoked, but can be invoked
139
 
        even after apply.
140
 
        """
141
 
        if self._tree is None:
142
 
            return
143
 
        self._tree.unlock()
144
 
        self._tree = None
145
 
 
146
146
    def __get_root(self):
147
147
        return self._new_root
148
148
 
149
149
    root = property(__get_root)
150
150
 
 
151
    def finalize(self):
 
152
        """Release the working tree lock, if held, clean up limbo dir.
 
153
 
 
154
        This is required if apply has not been invoked, but can be invoked
 
155
        even after apply.
 
156
        """
 
157
        if self._tree is None:
 
158
            return
 
159
        try:
 
160
            entries = [(self._limbo_name(t), t, k) for t, k in
 
161
                       self._new_contents.iteritems()]
 
162
            entries.sort(reverse=True)
 
163
            for path, trans_id, kind in entries:
 
164
                if kind == "directory":
 
165
                    os.rmdir(path)
 
166
                else:
 
167
                    os.unlink(path)
 
168
            try:
 
169
                os.rmdir(self._limbodir)
 
170
            except OSError:
 
171
                # We don't especially care *why* the dir is immortal.
 
172
                raise ImmortalLimbo(self._limbodir)
 
173
            try:
 
174
                if self._deletiondir is not None:
 
175
                    os.rmdir(self._deletiondir)
 
176
            except OSError:
 
177
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
178
        finally:
 
179
            self._tree.unlock()
 
180
            self._tree = None
 
181
 
151
182
    def _assign_id(self):
152
183
        """Produce a new tranform id"""
153
184
        new_id = "new-%s" % self._id_number
163
194
 
164
195
    def adjust_path(self, name, parent, trans_id):
165
196
        """Change the path that is assigned to a transaction id."""
166
 
        if parent is None:
167
 
            raise ValueError("Parent trans-id may not be None")
168
197
        if trans_id == self._new_root:
169
198
            raise CantMoveRoot
 
199
        previous_parent = self._new_parent.get(trans_id)
 
200
        previous_name = self._new_name.get(trans_id)
170
201
        self._new_name[trans_id] = name
171
202
        self._new_parent[trans_id] = parent
 
203
        if parent == ROOT_PARENT:
 
204
            if self._new_root is not None:
 
205
                raise ValueError("Cannot have multiple roots.")
 
206
            self._new_root = trans_id
 
207
        if (trans_id in self._limbo_files and
 
208
            trans_id not in self._needs_rename):
 
209
            self._rename_in_limbo([trans_id])
 
210
            self._limbo_children[previous_parent].remove(trans_id)
 
211
            del self._limbo_children_names[previous_parent][previous_name]
 
212
 
 
213
    def _rename_in_limbo(self, trans_ids):
 
214
        """Fix limbo names so that the right final path is produced.
 
215
 
 
216
        This means we outsmarted ourselves-- we tried to avoid renaming
 
217
        these files later by creating them with their final names in their
 
218
        final parents.  But now the previous name or parent is no longer
 
219
        suitable, so we have to rename them.
 
220
 
 
221
        Even for trans_ids that have no new contents, we must remove their
 
222
        entries from _limbo_files, because they are now stale.
 
223
        """
 
224
        for trans_id in trans_ids:
 
225
            old_path = self._limbo_files.pop(trans_id)
 
226
            if trans_id not in self._new_contents:
 
227
                continue
 
228
            new_path = self._limbo_name(trans_id)
 
229
            os.rename(old_path, new_path)
172
230
 
173
231
    def adjust_root_path(self, name, parent):
174
232
        """Emulate moving the root by moving all children, instead.
175
 
 
 
233
        
176
234
        We do this by undoing the association of root's transaction id with the
177
235
        current tree.  This allows us to create a new directory with that
178
 
        transaction id.  We unversion the root directory and version the
 
236
        transaction id.  We unversion the root directory and version the 
179
237
        physically new directory, and hope someone versions the tree root
180
238
        later.
181
239
        """
184
242
        # force moving all children of root
185
243
        for child_id in self.iter_tree_children(old_root):
186
244
            if child_id != parent:
187
 
                self.adjust_path(self.final_name(child_id),
 
245
                self.adjust_path(self.final_name(child_id), 
188
246
                                 self.final_parent(child_id), child_id)
189
247
            file_id = self.final_file_id(child_id)
190
248
            if file_id is not None:
191
249
                self.unversion_file(child_id)
192
250
            self.version_file(file_id, child_id)
193
 
 
 
251
        
194
252
        # the physical root needs a new transaction id
195
253
        self._tree_path_ids.pop("")
196
254
        self._tree_id_paths.pop(old_root)
202
260
        self.version_file(old_root_file_id, old_root)
203
261
        self.unversion_file(self._new_root)
204
262
 
205
 
    def fixup_new_roots(self):
206
 
        """Reinterpret requests to change the root directory
207
 
 
208
 
        Instead of creating a root directory, or moving an existing directory,
209
 
        all the attributes and children of the new root are applied to the
210
 
        existing root directory.
211
 
 
212
 
        This means that the old root trans-id becomes obsolete, so it is
213
 
        recommended only to invoke this after the root trans-id has become
214
 
        irrelevant.
215
 
        """
216
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
217
 
                     ROOT_PARENT]
218
 
        if len(new_roots) < 1:
219
 
            return
220
 
        if len(new_roots) != 1:
221
 
            raise ValueError('A tree cannot have two roots!')
222
 
        if self._new_root is None:
223
 
            self._new_root = new_roots[0]
224
 
            return
225
 
        old_new_root = new_roots[0]
226
 
        # TODO: What to do if a old_new_root is present, but self._new_root is
227
 
        #       not listed as being removed? This code explicitly unversions
228
 
        #       the old root and versions it with the new file_id. Though that
229
 
        #       seems like an incomplete delta
230
 
 
231
 
        # unversion the new root's directory.
232
 
        file_id = self.final_file_id(old_new_root)
233
 
        if old_new_root in self._new_id:
234
 
            self.cancel_versioning(old_new_root)
235
 
        else:
236
 
            self.unversion_file(old_new_root)
237
 
        # if, at this stage, root still has an old file_id, zap it so we can
238
 
        # stick a new one in.
239
 
        if (self.tree_file_id(self._new_root) is not None and
240
 
            self._new_root not in self._removed_id):
241
 
            self.unversion_file(self._new_root)
242
 
        self.version_file(file_id, self._new_root)
243
 
 
244
 
        # Now move children of new root into old root directory.
245
 
        # Ensure all children are registered with the transaction, but don't
246
 
        # use directly-- some tree children have new parents
247
 
        list(self.iter_tree_children(old_new_root))
248
 
        # Move all children of new root into old root directory.
249
 
        for child in self.by_parent().get(old_new_root, []):
250
 
            self.adjust_path(self.final_name(child), self._new_root, child)
251
 
 
252
 
        # Ensure old_new_root has no directory.
253
 
        if old_new_root in self._new_contents:
254
 
            self.cancel_creation(old_new_root)
255
 
        else:
256
 
            self.delete_contents(old_new_root)
257
 
 
258
 
        # prevent deletion of root directory.
259
 
        if self._new_root in self._removed_contents:
260
 
            self.cancel_deletion(self._new_root)
261
 
 
262
 
        # destroy path info for old_new_root.
263
 
        del self._new_parent[old_new_root]
264
 
        del self._new_name[old_new_root]
265
 
 
266
263
    def trans_id_tree_file_id(self, inventory_id):
267
264
        """Determine the transaction id of a working tree file.
268
 
 
 
265
        
269
266
        This reflects only files that already exist, not ones that will be
270
267
        added by transactions.
271
268
        """
284
281
            raise ValueError('None is not a valid file id')
285
282
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
286
283
            return self._r_new_id[file_id]
287
 
        else:
288
 
            try:
289
 
                self._tree.iter_entries_by_dir([file_id]).next()
290
 
            except StopIteration:
291
 
                if file_id in self._non_present_ids:
292
 
                    return self._non_present_ids[file_id]
293
 
                else:
294
 
                    trans_id = self._assign_id()
295
 
                    self._non_present_ids[file_id] = trans_id
296
 
                    return trans_id
297
 
            else:
298
 
                return self.trans_id_tree_file_id(file_id)
 
284
        elif file_id in self._tree.inventory:
 
285
            return self.trans_id_tree_file_id(file_id)
 
286
        elif file_id in self._non_present_ids:
 
287
            return self._non_present_ids[file_id]
 
288
        else:
 
289
            trans_id = self._assign_id()
 
290
            self._non_present_ids[file_id] = trans_id
 
291
            return trans_id
 
292
 
 
293
    def canonical_path(self, path):
 
294
        """Get the canonical tree-relative path"""
 
295
        # don't follow final symlinks
 
296
        abs = self._tree.abspath(path)
 
297
        if abs in self._relpaths:
 
298
            return self._relpaths[abs]
 
299
        dirname, basename = os.path.split(abs)
 
300
        if dirname not in self._realpaths:
 
301
            self._realpaths[dirname] = os.path.realpath(dirname)
 
302
        dirname = self._realpaths[dirname]
 
303
        abs = pathjoin(dirname, basename)
 
304
        if dirname in self._relpaths:
 
305
            relpath = pathjoin(self._relpaths[dirname], basename)
 
306
            relpath = relpath.rstrip('/\\')
 
307
        else:
 
308
            relpath = self._tree.relpath(abs)
 
309
        self._relpaths[abs] = relpath
 
310
        return relpath
299
311
 
300
312
    def trans_id_tree_path(self, path):
301
313
        """Determine (and maybe set) the transaction ID for a tree path."""
312
324
            return ROOT_PARENT
313
325
        return self.trans_id_tree_path(os.path.dirname(path))
314
326
 
 
327
    def create_file(self, contents, trans_id, mode_id=None):
 
328
        """Schedule creation of a new file.
 
329
 
 
330
        See also new_file.
 
331
        
 
332
        Contents is an iterator of strings, all of which will be written
 
333
        to the target destination.
 
334
 
 
335
        New file takes the permissions of any existing file with that id,
 
336
        unless mode_id is specified.
 
337
        """
 
338
        name = self._limbo_name(trans_id)
 
339
        f = open(name, 'wb')
 
340
        try:
 
341
            try:
 
342
                unique_add(self._new_contents, trans_id, 'file')
 
343
            except:
 
344
                # Clean up the file, it never got registered so
 
345
                # TreeTransform.finalize() won't clean it up.
 
346
                f.close()
 
347
                os.unlink(name)
 
348
                raise
 
349
 
 
350
            f.writelines(contents)
 
351
        finally:
 
352
            f.close()
 
353
        self._set_mode(trans_id, mode_id, S_ISREG)
 
354
 
 
355
    def _set_mode(self, trans_id, mode_id, typefunc):
 
356
        """Set the mode of new file contents.
 
357
        The mode_id is the existing file to get the mode from (often the same
 
358
        as trans_id).  The operation is only performed if there's a mode match
 
359
        according to typefunc.
 
360
        """
 
361
        if mode_id is None:
 
362
            mode_id = trans_id
 
363
        try:
 
364
            old_path = self._tree_id_paths[mode_id]
 
365
        except KeyError:
 
366
            return
 
367
        try:
 
368
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
369
        except OSError, e:
 
370
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
371
                # Either old_path doesn't exist, or the parent of the
 
372
                # target is not a directory (but will be one eventually)
 
373
                # Either way, we know it doesn't exist *right now*
 
374
                # See also bug #248448
 
375
                return
 
376
            else:
 
377
                raise
 
378
        if typefunc(mode):
 
379
            os.chmod(self._limbo_name(trans_id), mode)
 
380
 
 
381
    def create_hardlink(self, path, trans_id):
 
382
        """Schedule creation of a hard link"""
 
383
        name = self._limbo_name(trans_id)
 
384
        try:
 
385
            os.link(path, name)
 
386
        except OSError, e:
 
387
            if e.errno != errno.EPERM:
 
388
                raise
 
389
            raise errors.HardLinkNotSupported(path)
 
390
        try:
 
391
            unique_add(self._new_contents, trans_id, 'file')
 
392
        except:
 
393
            # Clean up the file, it never got registered so
 
394
            # TreeTransform.finalize() won't clean it up.
 
395
            os.unlink(name)
 
396
            raise
 
397
 
 
398
    def create_directory(self, trans_id):
 
399
        """Schedule creation of a new directory.
 
400
        
 
401
        See also new_directory.
 
402
        """
 
403
        os.mkdir(self._limbo_name(trans_id))
 
404
        unique_add(self._new_contents, trans_id, 'directory')
 
405
 
 
406
    def create_symlink(self, target, trans_id):
 
407
        """Schedule creation of a new symbolic link.
 
408
 
 
409
        target is a bytestring.
 
410
        See also new_symlink.
 
411
        """
 
412
        if has_symlinks():
 
413
            os.symlink(target, self._limbo_name(trans_id))
 
414
            unique_add(self._new_contents, trans_id, 'symlink')
 
415
        else:
 
416
            try:
 
417
                path = FinalPaths(self).get_path(trans_id)
 
418
            except KeyError:
 
419
                path = None
 
420
            raise UnableCreateSymlink(path=path)
 
421
 
 
422
    def cancel_creation(self, trans_id):
 
423
        """Cancel the creation of new file contents."""
 
424
        del self._new_contents[trans_id]
 
425
        children = self._limbo_children.get(trans_id)
 
426
        # if this is a limbo directory with children, move them before removing
 
427
        # the directory
 
428
        if children is not None:
 
429
            self._rename_in_limbo(children)
 
430
            del self._limbo_children[trans_id]
 
431
            del self._limbo_children_names[trans_id]
 
432
        delete_any(self._limbo_name(trans_id))
 
433
 
315
434
    def delete_contents(self, trans_id):
316
435
        """Schedule the contents of a path entry for deletion"""
317
 
        # Ensure that the object exists in the WorkingTree, this will raise an
318
 
        # exception if there is a problem
319
436
        self.tree_kind(trans_id)
320
437
        self._removed_contents.add(trans_id)
321
438
 
393
510
        new_ids.update(changed_kind)
394
511
        return sorted(FinalPaths(self).get_paths(new_ids))
395
512
 
 
513
    def tree_kind(self, trans_id):
 
514
        """Determine the file kind in the working tree.
 
515
 
 
516
        Raises NoSuchFile if the file does not exist
 
517
        """
 
518
        path = self._tree_id_paths.get(trans_id)
 
519
        if path is None:
 
520
            raise NoSuchFile(None)
 
521
        try:
 
522
            return file_kind(self._tree.abspath(path))
 
523
        except OSError, e:
 
524
            if e.errno != errno.ENOENT:
 
525
                raise
 
526
            else:
 
527
                raise NoSuchFile(path)
 
528
 
396
529
    def final_kind(self, trans_id):
397
530
        """Determine the final file kind, after any changes applied.
398
 
 
 
531
        
399
532
        Raises NoSuchFile if the file does not exist/has no contents.
400
533
        (It is conceivable that a path would be created without the
401
534
        corresponding contents insertion command)
417
550
        # the file is old; the old id is still valid
418
551
        if self._new_root == trans_id:
419
552
            return self._tree.get_root_id()
420
 
        return self._tree.path2id(path)
 
553
        return self._tree.inventory.path2id(path)
421
554
 
422
555
    def final_file_id(self, trans_id):
423
556
        """Determine the file id after any changes are applied, or None.
424
 
 
 
557
        
425
558
        None indicates that the file will not be versioned after changes are
426
559
        applied.
427
560
        """
466
599
 
467
600
    def by_parent(self):
468
601
        """Return a map of parent: children for known parents.
469
 
 
 
602
        
470
603
        Only new paths and parents of tree files with assigned ids are used.
471
604
        """
472
605
        by_parent = {}
473
606
        items = list(self._new_parent.iteritems())
474
 
        items.extend((t, self.final_parent(t)) for t in
 
607
        items.extend((t, self.final_parent(t)) for t in 
475
608
                      self._tree_id_paths.keys())
476
609
        for trans_id, parent_id in items:
477
610
            if parent_id not in by_parent:
505
638
        conflicts.extend(self._overwrite_conflicts())
506
639
        return conflicts
507
640
 
508
 
    def _check_malformed(self):
509
 
        conflicts = self.find_conflicts()
510
 
        if len(conflicts) != 0:
511
 
            raise MalformedTransform(conflicts=conflicts)
512
 
 
513
641
    def _add_tree_children(self):
514
642
        """Add all the children of all active parents to the known paths.
515
643
 
517
645
        removed.  This is a necessary first step in detecting conflicts.
518
646
        """
519
647
        parents = self.by_parent().keys()
520
 
        parents.extend([t for t in self._removed_contents if
 
648
        parents.extend([t for t in self._removed_contents if 
521
649
                        self.tree_kind(t) == 'directory'])
522
650
        for trans_id in self._removed_id:
523
651
            file_id = self.tree_file_id(trans_id)
531
659
            # ensure that all children are registered with the transaction
532
660
            list(self.iter_tree_children(parent_id))
533
661
 
 
662
    def iter_tree_children(self, parent_id):
 
663
        """Iterate through the entry's tree children, if any"""
 
664
        try:
 
665
            path = self._tree_id_paths[parent_id]
 
666
        except KeyError:
 
667
            return
 
668
        try:
 
669
            children = os.listdir(self._tree.abspath(path))
 
670
        except OSError, e:
 
671
            if not (osutils._is_error_enotdir(e)
 
672
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
673
                raise
 
674
            return
 
675
 
 
676
        for child in children:
 
677
            childpath = joinpath(path, child)
 
678
            if self._tree.is_control_filename(childpath):
 
679
                continue
 
680
            yield self.trans_id_tree_path(childpath)
 
681
 
534
682
    def has_named_child(self, by_parent, parent_id, name):
535
683
        try:
536
684
            children = by_parent[parent_id]
590
738
 
591
739
    def _improper_versioning(self):
592
740
        """Cannot version a file with no contents, or a bad type.
593
 
 
 
741
        
594
742
        However, existing entries with no contents are okay.
595
743
        """
596
744
        conflicts = []
606
754
 
607
755
    def _executability_conflicts(self):
608
756
        """Check for bad executability changes.
609
 
 
 
757
        
610
758
        Only versioned files may have their executability set, because
611
759
        1. only versioned entries can have executability under windows
612
760
        2. only files can be executable.  (The execute bit on a directory
711
859
            return True
712
860
        return False
713
861
 
 
862
    def _limbo_name(self, trans_id):
 
863
        """Generate the limbo name of a file"""
 
864
        limbo_name = self._limbo_files.get(trans_id)
 
865
        if limbo_name is not None:
 
866
            return limbo_name
 
867
        parent = self._new_parent.get(trans_id)
 
868
        # if the parent directory is already in limbo (e.g. when building a
 
869
        # tree), choose a limbo name inside the parent, to reduce further
 
870
        # renames.
 
871
        use_direct_path = False
 
872
        if self._new_contents.get(parent) == 'directory':
 
873
            filename = self._new_name.get(trans_id)
 
874
            if filename is not None:
 
875
                if parent not in self._limbo_children:
 
876
                    self._limbo_children[parent] = set()
 
877
                    self._limbo_children_names[parent] = {}
 
878
                    use_direct_path = True
 
879
                # the direct path can only be used if no other file has
 
880
                # already taken this pathname, i.e. if the name is unused, or
 
881
                # if it is already associated with this trans_id.
 
882
                elif self._case_sensitive_target:
 
883
                    if (self._limbo_children_names[parent].get(filename)
 
884
                        in (trans_id, None)):
 
885
                        use_direct_path = True
 
886
                else:
 
887
                    for l_filename, l_trans_id in\
 
888
                        self._limbo_children_names[parent].iteritems():
 
889
                        if l_trans_id == trans_id:
 
890
                            continue
 
891
                        if l_filename.lower() == filename.lower():
 
892
                            break
 
893
                    else:
 
894
                        use_direct_path = True
 
895
 
 
896
        if use_direct_path:
 
897
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
898
            self._limbo_children[parent].add(trans_id)
 
899
            self._limbo_children_names[parent][filename] = trans_id
 
900
        else:
 
901
            limbo_name = pathjoin(self._limbodir, trans_id)
 
902
            self._needs_rename.add(trans_id)
 
903
        self._limbo_files[trans_id] = limbo_name
 
904
        return limbo_name
 
905
 
714
906
    def _set_executability(self, path, trans_id):
715
907
        """Set the executability of versioned files """
716
908
        if supports_executable():
737
929
            self.version_file(file_id, trans_id)
738
930
        return trans_id
739
931
 
740
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
932
    def new_file(self, name, parent_id, contents, file_id=None, 
741
933
                 executable=None):
742
934
        """Convenience method to create files.
743
 
 
 
935
        
744
936
        name is the name of the file to create.
745
937
        parent_id is the transaction id of the parent directory of the file.
746
938
        contents is an iterator of bytestrings, which will be used to produce
766
958
        """
767
959
        trans_id = self._new_entry(name, parent_id, file_id)
768
960
        self.create_directory(trans_id)
769
 
        return trans_id
 
961
        return trans_id 
770
962
 
771
963
    def new_symlink(self, name, parent_id, target, file_id=None):
772
964
        """Convenience method to create symbolic link.
773
 
 
 
965
        
774
966
        name is the name of the symlink to create.
775
967
        parent_id is the transaction id of the parent directory of the symlink.
776
968
        target is a bytestring of the target of the symlink.
815
1007
        from_path = self._tree_id_paths.get(from_trans_id)
816
1008
        if from_versioned:
817
1009
            # get data from working tree if versioned
818
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1010
            from_entry = self._tree.inventory[file_id]
819
1011
            from_name = from_entry.name
820
1012
            from_parent = from_entry.parent_id
821
1013
        else:
922
1114
    def get_preview_tree(self):
923
1115
        """Return a tree representing the result of the transform.
924
1116
 
925
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
926
 
        it.
 
1117
        This tree only supports the subset of Tree functionality required
 
1118
        by show_diff_trees.  It must only be compared to tt._tree.
927
1119
        """
928
1120
        return _PreviewTree(self)
929
1121
 
930
 
    def commit(self, branch, message, merge_parents=None, strict=False):
931
 
        """Commit the result of this TreeTransform to a branch.
932
 
 
933
 
        :param branch: The branch to commit to.
934
 
        :param message: The message to attach to the commit.
935
 
        :param merge_parents: Additional parents specified by pending merges.
936
 
        :return: The revision_id of the revision committed.
937
 
        """
938
 
        self._check_malformed()
939
 
        if strict:
940
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
941
 
            for trans_id in unversioned:
942
 
                if self.final_file_id(trans_id) is None:
943
 
                    raise errors.StrictCommitFailed()
944
 
 
945
 
        revno, last_rev_id = branch.last_revision_info()
946
 
        if last_rev_id == _mod_revision.NULL_REVISION:
947
 
            if merge_parents is not None:
948
 
                raise ValueError('Cannot supply merge parents for first'
949
 
                                 ' commit.')
950
 
            parent_ids = []
951
 
        else:
952
 
            parent_ids = [last_rev_id]
953
 
            if merge_parents is not None:
954
 
                parent_ids.extend(merge_parents)
955
 
        if self._tree.get_revision_id() != last_rev_id:
956
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
957
 
                             self._tree.get_revision_id())
958
 
        builder = branch.get_commit_builder(parent_ids)
959
 
        preview = self.get_preview_tree()
960
 
        list(builder.record_iter_changes(preview, last_rev_id,
961
 
                                         self.iter_changes()))
962
 
        builder.finish_inventory()
963
 
        revision_id = builder.commit(message)
964
 
        branch.set_last_revision_info(revno + 1, revision_id)
965
 
        return revision_id
966
 
 
967
 
    def _text_parent(self, trans_id):
968
 
        file_id = self.tree_file_id(trans_id)
969
 
        try:
970
 
            if file_id is None or self._tree.kind(file_id) != 'file':
971
 
                return None
972
 
        except errors.NoSuchFile:
973
 
            return None
974
 
        return file_id
975
 
 
976
 
    def _get_parents_texts(self, trans_id):
977
 
        """Get texts for compression parents of this file."""
978
 
        file_id = self._text_parent(trans_id)
979
 
        if file_id is None:
980
 
            return ()
981
 
        return (self._tree.get_file_text(file_id),)
982
 
 
983
 
    def _get_parents_lines(self, trans_id):
984
 
        """Get lines for compression parents of this file."""
985
 
        file_id = self._text_parent(trans_id)
986
 
        if file_id is None:
987
 
            return ()
988
 
        return (self._tree.get_file_lines(file_id),)
989
 
 
990
 
    def serialize(self, serializer):
991
 
        """Serialize this TreeTransform.
992
 
 
993
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
994
 
        """
995
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
996
 
                        self._new_name.items())
997
 
        new_executability = dict((k, int(v)) for k, v in
998
 
                                 self._new_executability.items())
999
 
        tree_path_ids = dict((k.encode('utf-8'), v)
1000
 
                             for k, v in self._tree_path_ids.items())
1001
 
        attribs = {
1002
 
            '_id_number': self._id_number,
1003
 
            '_new_name': new_name,
1004
 
            '_new_parent': self._new_parent,
1005
 
            '_new_executability': new_executability,
1006
 
            '_new_id': self._new_id,
1007
 
            '_tree_path_ids': tree_path_ids,
1008
 
            '_removed_id': list(self._removed_id),
1009
 
            '_removed_contents': list(self._removed_contents),
1010
 
            '_non_present_ids': self._non_present_ids,
1011
 
            }
1012
 
        yield serializer.bytes_record(bencode.bencode(attribs),
1013
 
                                      (('attribs',),))
1014
 
        for trans_id, kind in self._new_contents.items():
1015
 
            if kind == 'file':
1016
 
                lines = osutils.chunks_to_lines(
1017
 
                    self._read_file_chunks(trans_id))
1018
 
                parents = self._get_parents_lines(trans_id)
1019
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1020
 
                content = ''.join(mpdiff.to_patch())
1021
 
            if kind == 'directory':
1022
 
                content = ''
1023
 
            if kind == 'symlink':
1024
 
                content = self._read_symlink_target(trans_id)
1025
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
1026
 
 
1027
 
    def deserialize(self, records):
1028
 
        """Deserialize a stored TreeTransform.
1029
 
 
1030
 
        :param records: An iterable of (names, content) tuples, as per
1031
 
            pack.ContainerPushParser.
1032
 
        """
1033
 
        names, content = records.next()
1034
 
        attribs = bencode.bdecode(content)
1035
 
        self._id_number = attribs['_id_number']
1036
 
        self._new_name = dict((k, v.decode('utf-8'))
1037
 
                            for k, v in attribs['_new_name'].items())
1038
 
        self._new_parent = attribs['_new_parent']
1039
 
        self._new_executability = dict((k, bool(v)) for k, v in
1040
 
            attribs['_new_executability'].items())
1041
 
        self._new_id = attribs['_new_id']
1042
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1043
 
        self._tree_path_ids = {}
1044
 
        self._tree_id_paths = {}
1045
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
1046
 
            path = bytepath.decode('utf-8')
1047
 
            self._tree_path_ids[path] = trans_id
1048
 
            self._tree_id_paths[trans_id] = path
1049
 
        self._removed_id = set(attribs['_removed_id'])
1050
 
        self._removed_contents = set(attribs['_removed_contents'])
1051
 
        self._non_present_ids = attribs['_non_present_ids']
1052
 
        for ((trans_id, kind),), content in records:
1053
 
            if kind == 'file':
1054
 
                mpdiff = multiparent.MultiParent.from_patch(content)
1055
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1056
 
                self.create_file(lines, trans_id)
1057
 
            if kind == 'directory':
1058
 
                self.create_directory(trans_id)
1059
 
            if kind == 'symlink':
1060
 
                self.create_symlink(content.decode('utf-8'), trans_id)
1061
 
 
1062
 
 
1063
 
class DiskTreeTransform(TreeTransformBase):
1064
 
    """Tree transform storing its contents on disk."""
1065
 
 
1066
 
    def __init__(self, tree, limbodir, pb=None,
1067
 
                 case_sensitive=True):
1068
 
        """Constructor.
1069
 
        :param tree: The tree that will be transformed, but not necessarily
1070
 
            the output tree.
1071
 
        :param limbodir: A directory where new files can be stored until
1072
 
            they are installed in their proper places
1073
 
        :param pb: ignored
1074
 
        :param case_sensitive: If True, the target of the transform is
1075
 
            case sensitive, not just case preserving.
1076
 
        """
1077
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1078
 
        self._limbodir = limbodir
1079
 
        self._deletiondir = None
1080
 
        # A mapping of transform ids to their limbo filename
1081
 
        self._limbo_files = {}
1082
 
        # A mapping of transform ids to a set of the transform ids of children
1083
 
        # that their limbo directory has
1084
 
        self._limbo_children = {}
1085
 
        # Map transform ids to maps of child filename to child transform id
1086
 
        self._limbo_children_names = {}
1087
 
        # List of transform ids that need to be renamed from limbo into place
1088
 
        self._needs_rename = set()
1089
 
        self._creation_mtime = None
1090
 
 
1091
 
    def finalize(self):
1092
 
        """Release the working tree lock, if held, clean up limbo dir.
1093
 
 
1094
 
        This is required if apply has not been invoked, but can be invoked
1095
 
        even after apply.
1096
 
        """
1097
 
        if self._tree is None:
1098
 
            return
1099
 
        try:
1100
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1101
 
                       self._new_contents.iteritems()]
1102
 
            entries.sort(reverse=True)
1103
 
            for path, trans_id, kind in entries:
1104
 
                delete_any(path)
1105
 
            try:
1106
 
                delete_any(self._limbodir)
1107
 
            except OSError:
1108
 
                # We don't especially care *why* the dir is immortal.
1109
 
                raise ImmortalLimbo(self._limbodir)
1110
 
            try:
1111
 
                if self._deletiondir is not None:
1112
 
                    delete_any(self._deletiondir)
1113
 
            except OSError:
1114
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1115
 
        finally:
1116
 
            TreeTransformBase.finalize(self)
1117
 
 
1118
 
    def _limbo_name(self, trans_id):
1119
 
        """Generate the limbo name of a file"""
1120
 
        limbo_name = self._limbo_files.get(trans_id)
1121
 
        if limbo_name is None:
1122
 
            limbo_name = self._generate_limbo_path(trans_id)
1123
 
            self._limbo_files[trans_id] = limbo_name
1124
 
        return limbo_name
1125
 
 
1126
 
    def _generate_limbo_path(self, trans_id):
1127
 
        """Generate a limbo path using the trans_id as the relative path.
1128
 
 
1129
 
        This is suitable as a fallback, and when the transform should not be
1130
 
        sensitive to the path encoding of the limbo directory.
1131
 
        """
1132
 
        self._needs_rename.add(trans_id)
1133
 
        return pathjoin(self._limbodir, trans_id)
1134
 
 
1135
 
    def adjust_path(self, name, parent, trans_id):
1136
 
        previous_parent = self._new_parent.get(trans_id)
1137
 
        previous_name = self._new_name.get(trans_id)
1138
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1139
 
        if (trans_id in self._limbo_files and
1140
 
            trans_id not in self._needs_rename):
1141
 
            self._rename_in_limbo([trans_id])
1142
 
            if previous_parent != parent:
1143
 
                self._limbo_children[previous_parent].remove(trans_id)
1144
 
            if previous_parent != parent or previous_name != name:
1145
 
                del self._limbo_children_names[previous_parent][previous_name]
1146
 
 
1147
 
    def _rename_in_limbo(self, trans_ids):
1148
 
        """Fix limbo names so that the right final path is produced.
1149
 
 
1150
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1151
 
        these files later by creating them with their final names in their
1152
 
        final parents.  But now the previous name or parent is no longer
1153
 
        suitable, so we have to rename them.
1154
 
 
1155
 
        Even for trans_ids that have no new contents, we must remove their
1156
 
        entries from _limbo_files, because they are now stale.
1157
 
        """
1158
 
        for trans_id in trans_ids:
1159
 
            old_path = self._limbo_files.pop(trans_id)
1160
 
            if trans_id not in self._new_contents:
1161
 
                continue
1162
 
            new_path = self._limbo_name(trans_id)
1163
 
            osutils.rename(old_path, new_path)
1164
 
            for descendant in self._limbo_descendants(trans_id):
1165
 
                desc_path = self._limbo_files[descendant]
1166
 
                desc_path = new_path + desc_path[len(old_path):]
1167
 
                self._limbo_files[descendant] = desc_path
1168
 
 
1169
 
    def _limbo_descendants(self, trans_id):
1170
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1171
 
        descendants = set(self._limbo_children.get(trans_id, []))
1172
 
        for descendant in list(descendants):
1173
 
            descendants.update(self._limbo_descendants(descendant))
1174
 
        return descendants
1175
 
 
1176
 
    def create_file(self, contents, trans_id, mode_id=None):
1177
 
        """Schedule creation of a new file.
1178
 
 
1179
 
        See also new_file.
1180
 
 
1181
 
        Contents is an iterator of strings, all of which will be written
1182
 
        to the target destination.
1183
 
 
1184
 
        New file takes the permissions of any existing file with that id,
1185
 
        unless mode_id is specified.
1186
 
        """
1187
 
        name = self._limbo_name(trans_id)
1188
 
        f = open(name, 'wb')
1189
 
        try:
1190
 
            try:
1191
 
                unique_add(self._new_contents, trans_id, 'file')
1192
 
            except:
1193
 
                # Clean up the file, it never got registered so
1194
 
                # TreeTransform.finalize() won't clean it up.
1195
 
                f.close()
1196
 
                os.unlink(name)
1197
 
                raise
1198
 
 
1199
 
            f.writelines(contents)
1200
 
        finally:
1201
 
            f.close()
1202
 
        self._set_mtime(name)
1203
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1204
 
 
1205
 
    def _read_file_chunks(self, trans_id):
1206
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1207
 
        try:
1208
 
            return cur_file.readlines()
1209
 
        finally:
1210
 
            cur_file.close()
1211
 
 
1212
 
    def _read_symlink_target(self, trans_id):
1213
 
        return os.readlink(self._limbo_name(trans_id))
1214
 
 
1215
 
    def _set_mtime(self, path):
1216
 
        """All files that are created get the same mtime.
1217
 
 
1218
 
        This time is set by the first object to be created.
1219
 
        """
1220
 
        if self._creation_mtime is None:
1221
 
            self._creation_mtime = time.time()
1222
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1223
 
 
1224
 
    def create_hardlink(self, path, trans_id):
1225
 
        """Schedule creation of a hard link"""
1226
 
        name = self._limbo_name(trans_id)
1227
 
        try:
1228
 
            os.link(path, name)
1229
 
        except OSError, e:
1230
 
            if e.errno != errno.EPERM:
1231
 
                raise
1232
 
            raise errors.HardLinkNotSupported(path)
1233
 
        try:
1234
 
            unique_add(self._new_contents, trans_id, 'file')
1235
 
        except:
1236
 
            # Clean up the file, it never got registered so
1237
 
            # TreeTransform.finalize() won't clean it up.
1238
 
            os.unlink(name)
1239
 
            raise
1240
 
 
1241
 
    def create_directory(self, trans_id):
1242
 
        """Schedule creation of a new directory.
1243
 
 
1244
 
        See also new_directory.
1245
 
        """
1246
 
        os.mkdir(self._limbo_name(trans_id))
1247
 
        unique_add(self._new_contents, trans_id, 'directory')
1248
 
 
1249
 
    def create_symlink(self, target, trans_id):
1250
 
        """Schedule creation of a new symbolic link.
1251
 
 
1252
 
        target is a bytestring.
1253
 
        See also new_symlink.
1254
 
        """
1255
 
        if has_symlinks():
1256
 
            os.symlink(target, self._limbo_name(trans_id))
1257
 
            unique_add(self._new_contents, trans_id, 'symlink')
1258
 
        else:
1259
 
            try:
1260
 
                path = FinalPaths(self).get_path(trans_id)
1261
 
            except KeyError:
1262
 
                path = None
1263
 
            raise UnableCreateSymlink(path=path)
1264
 
 
1265
 
    def cancel_creation(self, trans_id):
1266
 
        """Cancel the creation of new file contents."""
1267
 
        del self._new_contents[trans_id]
1268
 
        children = self._limbo_children.get(trans_id)
1269
 
        # if this is a limbo directory with children, move them before removing
1270
 
        # the directory
1271
 
        if children is not None:
1272
 
            self._rename_in_limbo(children)
1273
 
            del self._limbo_children[trans_id]
1274
 
            del self._limbo_children_names[trans_id]
1275
 
        delete_any(self._limbo_name(trans_id))
1276
 
 
1277
 
 
1278
 
class TreeTransform(DiskTreeTransform):
 
1122
 
 
1123
class TreeTransform(TreeTransformBase):
1279
1124
    """Represent a tree transformation.
1280
1125
 
1281
1126
    This object is designed to support incremental generation of the transform,
1340
1185
    FileMover does not delete files until it is sure that a rollback will not
1341
1186
    happen.
1342
1187
    """
1343
 
    def __init__(self, tree, pb=None):
 
1188
    def __init__(self, tree, pb=DummyProgress()):
1344
1189
        """Note: a tree_write lock is taken on the tree.
1345
1190
 
1346
1191
        Use TreeTransform.finalize() to release the lock (can be omitted if
1367
1212
            tree.unlock()
1368
1213
            raise
1369
1214
 
1370
 
        # Cache of realpath results, to speed up canonical_path
1371
 
        self._realpaths = {}
1372
 
        # Cache of relpath results, to speed up canonical_path
1373
 
        self._relpaths = {}
1374
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1215
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1375
1216
                                   tree.case_sensitive)
1376
1217
        self._deletiondir = deletiondir
1377
1218
 
1378
 
    def canonical_path(self, path):
1379
 
        """Get the canonical tree-relative path"""
1380
 
        # don't follow final symlinks
1381
 
        abs = self._tree.abspath(path)
1382
 
        if abs in self._relpaths:
1383
 
            return self._relpaths[abs]
1384
 
        dirname, basename = os.path.split(abs)
1385
 
        if dirname not in self._realpaths:
1386
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1387
 
        dirname = self._realpaths[dirname]
1388
 
        abs = pathjoin(dirname, basename)
1389
 
        if dirname in self._relpaths:
1390
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1391
 
            relpath = relpath.rstrip('/\\')
1392
 
        else:
1393
 
            relpath = self._tree.relpath(abs)
1394
 
        self._relpaths[abs] = relpath
1395
 
        return relpath
1396
 
 
1397
 
    def tree_kind(self, trans_id):
1398
 
        """Determine the file kind in the working tree.
1399
 
 
1400
 
        Raises NoSuchFile if the file does not exist
1401
 
        """
1402
 
        path = self._tree_id_paths.get(trans_id)
1403
 
        if path is None:
1404
 
            raise NoSuchFile(None)
1405
 
        try:
1406
 
            return file_kind(self._tree.abspath(path))
1407
 
        except OSError, e:
1408
 
            if e.errno != errno.ENOENT:
1409
 
                raise
1410
 
            else:
1411
 
                raise NoSuchFile(path)
1412
 
 
1413
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1414
 
        """Set the mode of new file contents.
1415
 
        The mode_id is the existing file to get the mode from (often the same
1416
 
        as trans_id).  The operation is only performed if there's a mode match
1417
 
        according to typefunc.
1418
 
        """
1419
 
        if mode_id is None:
1420
 
            mode_id = trans_id
1421
 
        try:
1422
 
            old_path = self._tree_id_paths[mode_id]
1423
 
        except KeyError:
1424
 
            return
1425
 
        try:
1426
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1427
 
        except OSError, e:
1428
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1429
 
                # Either old_path doesn't exist, or the parent of the
1430
 
                # target is not a directory (but will be one eventually)
1431
 
                # Either way, we know it doesn't exist *right now*
1432
 
                # See also bug #248448
1433
 
                return
1434
 
            else:
1435
 
                raise
1436
 
        if typefunc(mode):
1437
 
            os.chmod(self._limbo_name(trans_id), mode)
1438
 
 
1439
 
    def iter_tree_children(self, parent_id):
1440
 
        """Iterate through the entry's tree children, if any"""
1441
 
        try:
1442
 
            path = self._tree_id_paths[parent_id]
1443
 
        except KeyError:
1444
 
            return
1445
 
        try:
1446
 
            children = os.listdir(self._tree.abspath(path))
1447
 
        except OSError, e:
1448
 
            if not (osutils._is_error_enotdir(e)
1449
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1450
 
                raise
1451
 
            return
1452
 
 
1453
 
        for child in children:
1454
 
            childpath = joinpath(path, child)
1455
 
            if self._tree.is_control_filename(childpath):
1456
 
                continue
1457
 
            yield self.trans_id_tree_path(childpath)
1458
 
 
1459
 
    def _generate_limbo_path(self, trans_id):
1460
 
        """Generate a limbo path using the final path if possible.
1461
 
 
1462
 
        This optimizes the performance of applying the tree transform by
1463
 
        avoiding renames.  These renames can be avoided only when the parent
1464
 
        directory is already scheduled for creation.
1465
 
 
1466
 
        If the final path cannot be used, falls back to using the trans_id as
1467
 
        the relpath.
1468
 
        """
1469
 
        parent = self._new_parent.get(trans_id)
1470
 
        # if the parent directory is already in limbo (e.g. when building a
1471
 
        # tree), choose a limbo name inside the parent, to reduce further
1472
 
        # renames.
1473
 
        use_direct_path = False
1474
 
        if self._new_contents.get(parent) == 'directory':
1475
 
            filename = self._new_name.get(trans_id)
1476
 
            if filename is not None:
1477
 
                if parent not in self._limbo_children:
1478
 
                    self._limbo_children[parent] = set()
1479
 
                    self._limbo_children_names[parent] = {}
1480
 
                    use_direct_path = True
1481
 
                # the direct path can only be used if no other file has
1482
 
                # already taken this pathname, i.e. if the name is unused, or
1483
 
                # if it is already associated with this trans_id.
1484
 
                elif self._case_sensitive_target:
1485
 
                    if (self._limbo_children_names[parent].get(filename)
1486
 
                        in (trans_id, None)):
1487
 
                        use_direct_path = True
1488
 
                else:
1489
 
                    for l_filename, l_trans_id in\
1490
 
                        self._limbo_children_names[parent].iteritems():
1491
 
                        if l_trans_id == trans_id:
1492
 
                            continue
1493
 
                        if l_filename.lower() == filename.lower():
1494
 
                            break
1495
 
                    else:
1496
 
                        use_direct_path = True
1497
 
 
1498
 
        if not use_direct_path:
1499
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1500
 
 
1501
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1502
 
        self._limbo_children[parent].add(trans_id)
1503
 
        self._limbo_children_names[parent][filename] = trans_id
1504
 
        return limbo_name
1505
 
 
1506
 
 
1507
1219
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1508
1220
        """Apply all changes to the inventory and filesystem.
1509
1221
 
1519
1231
        :param _mover: Supply an alternate FileMover, for testing
1520
1232
        """
1521
1233
        if not no_conflicts:
1522
 
            self._check_malformed()
 
1234
            conflicts = self.find_conflicts()
 
1235
            if len(conflicts) != 0:
 
1236
                raise MalformedTransform(conflicts=conflicts)
1523
1237
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
1238
        try:
1525
1239
            if precomputed_delta is None:
1629
1343
                child_pb.update('removing file', num, len(tree_paths))
1630
1344
                full_path = self._tree.abspath(path)
1631
1345
                if trans_id in self._removed_contents:
1632
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1633
 
                    mover.pre_delete(full_path, delete_path)
1634
 
                elif (trans_id in self._new_name
1635
 
                      or trans_id in self._new_parent):
 
1346
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1347
                                     trans_id))
 
1348
                elif trans_id in self._new_name or trans_id in \
 
1349
                    self._new_parent:
1636
1350
                    try:
1637
1351
                        mover.rename(full_path, self._limbo_name(trans_id))
1638
1352
                    except OSError, e:
1684
1398
        return modified_paths
1685
1399
 
1686
1400
 
1687
 
class TransformPreview(DiskTreeTransform):
 
1401
class TransformPreview(TreeTransformBase):
1688
1402
    """A TreeTransform for generating preview trees.
1689
1403
 
1690
1404
    Unlike TreeTransform, this version works when the input tree is a
1692
1406
    unversioned files in the input tree.
1693
1407
    """
1694
1408
 
1695
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1409
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1696
1410
        tree.lock_read()
1697
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1698
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1411
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1412
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1699
1413
 
1700
1414
    def canonical_path(self, path):
1701
1415
        return path
1725
1439
        file_id = self.tree_file_id(parent_id)
1726
1440
        if file_id is None:
1727
1441
            return
1728
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1729
 
        children = getattr(entry, 'children', {})
 
1442
        children = getattr(self._tree.inventory[file_id], 'children', {})
1730
1443
        for child in children:
1731
1444
            childpath = joinpath(path, child)
1732
1445
            yield self.trans_id_tree_path(childpath)
1740
1453
        self._final_paths = FinalPaths(transform)
1741
1454
        self.__by_parent = None
1742
1455
        self._parent_ids = []
1743
 
        self._all_children_cache = {}
1744
 
        self._path2trans_id_cache = {}
1745
 
        self._final_name_cache = {}
1746
 
        self._iter_changes_cache = dict((c[0], c) for c in
1747
 
                                        self._transform.iter_changes())
 
1456
 
 
1457
    def _changes(self, file_id):
 
1458
        for changes in self._transform.iter_changes():
 
1459
            if changes[0] == file_id:
 
1460
                return changes
1748
1461
 
1749
1462
    def _content_change(self, file_id):
1750
1463
        """Return True if the content of this file changed"""
1751
 
        changes = self._iter_changes_cache.get(file_id)
 
1464
        changes = self._changes(file_id)
1752
1465
        # changes[2] is true if the file content changed.  See
1753
1466
        # InterTree.iter_changes.
1754
1467
        return (changes is not None and changes[2])
1788
1501
            self.__by_parent = self._transform.by_parent()
1789
1502
        return self.__by_parent
1790
1503
 
1791
 
    def _comparison_data(self, entry, path):
1792
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1793
 
        if kind == 'missing':
1794
 
            kind = None
1795
 
            executable = False
1796
 
        else:
1797
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
1798
 
            executable = self.is_executable(file_id, path)
1799
 
        return kind, executable, None
1800
 
 
1801
1504
    def lock_read(self):
1802
1505
        # Perhaps in theory, this should lock the TreeTransform?
1803
1506
        pass
1823
1526
    def __iter__(self):
1824
1527
        return iter(self.all_file_ids())
1825
1528
 
1826
 
    def _has_id(self, file_id, fallback_check):
1827
 
        if file_id in self._transform._r_new_id:
1828
 
            return True
1829
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1830
 
            trans_id in self._transform._removed_id]):
1831
 
            return False
1832
 
        else:
1833
 
            return fallback_check(file_id)
1834
 
 
1835
 
    def has_id(self, file_id):
1836
 
        return self._has_id(file_id, self._transform._tree.has_id)
1837
 
 
1838
 
    def has_or_had_id(self, file_id):
1839
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
1529
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1530
        """See Tree.paths2ids"""
 
1531
        to_find = set(specific_files)
 
1532
        result = set()
 
1533
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1534
             executable) in self._transform.iter_changes():
 
1535
            if paths[1] in to_find:
 
1536
                result.add(file_id)
 
1537
                to_find.remove(paths[1])
 
1538
        result.update(self._transform._tree.paths2ids(to_find,
 
1539
                      trees=[], require_versioned=require_versioned))
 
1540
        return result
1840
1541
 
1841
1542
    def _path2trans_id(self, path):
1842
 
        # We must not use None here, because that is a valid value to store.
1843
 
        trans_id = self._path2trans_id_cache.get(path, object)
1844
 
        if trans_id is not object:
1845
 
            return trans_id
1846
1543
        segments = splitpath(path)
1847
1544
        cur_parent = self._transform.root
1848
1545
        for cur_segment in segments:
1849
1546
            for child in self._all_children(cur_parent):
1850
 
                final_name = self._final_name_cache.get(child)
1851
 
                if final_name is None:
1852
 
                    final_name = self._transform.final_name(child)
1853
 
                    self._final_name_cache[child] = final_name
1854
 
                if final_name == cur_segment:
 
1547
                if self._transform.final_name(child) == cur_segment:
1855
1548
                    cur_parent = child
1856
1549
                    break
1857
1550
            else:
1858
 
                self._path2trans_id_cache[path] = None
1859
1551
                return None
1860
 
        self._path2trans_id_cache[path] = cur_parent
1861
1552
        return cur_parent
1862
1553
 
1863
1554
    def path2id(self, path):
1871
1562
            raise errors.NoSuchId(self, file_id)
1872
1563
 
1873
1564
    def _all_children(self, trans_id):
1874
 
        children = self._all_children_cache.get(trans_id)
1875
 
        if children is not None:
1876
 
            return children
1877
1565
        children = set(self._transform.iter_tree_children(trans_id))
1878
1566
        # children in the _new_parent set are provided by _by_parent.
1879
1567
        children.difference_update(self._transform._new_parent.keys())
1880
1568
        children.update(self._by_parent.get(trans_id, []))
1881
 
        self._all_children_cache[trans_id] = children
1882
1569
        return children
1883
1570
 
1884
 
    def iter_children(self, file_id):
1885
 
        trans_id = self._transform.trans_id_file_id(file_id)
1886
 
        for child_trans_id in self._all_children(trans_id):
1887
 
            yield self._transform.final_file_id(child_trans_id)
1888
 
 
1889
 
    def extras(self):
1890
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
1891
 
                              in self._transform._tree.extras())
1892
 
        possible_extras.update(self._transform._new_contents)
1893
 
        possible_extras.update(self._transform._removed_id)
1894
 
        for trans_id in possible_extras:
1895
 
            if self._transform.final_file_id(trans_id) is None:
1896
 
                yield self._final_paths._determine_path(trans_id)
1897
 
 
1898
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1899
 
        yield_parents=False):
 
1571
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
1900
1572
        for trans_id, parent_file_id in ordered_entries:
1901
1573
            file_id = self._transform.final_file_id(trans_id)
1902
1574
            if file_id is None:
1928
1600
                ordered_ids.append((trans_id, parent_file_id))
1929
1601
        return ordered_ids
1930
1602
 
1931
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
1603
    def iter_entries_by_dir(self, specific_file_ids=None):
1932
1604
        # This may not be a maximally efficient implementation, but it is
1933
1605
        # reasonably straightforward.  An implementation that grafts the
1934
1606
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1936
1608
        # position.
1937
1609
        ordered_ids = self._list_files_by_dir()
1938
1610
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1939
 
            specific_file_ids, yield_parents=yield_parents):
1940
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1941
 
 
1942
 
    def _iter_entries_for_dir(self, dir_path):
1943
 
        """Return path, entry for items in a directory without recursing down."""
1944
 
        dir_file_id = self.path2id(dir_path)
1945
 
        ordered_ids = []
1946
 
        for file_id in self.iter_children(dir_file_id):
1947
 
            trans_id = self._transform.trans_id_file_id(file_id)
1948
 
            ordered_ids.append((trans_id, file_id))
1949
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1950
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1951
 
 
1952
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1953
 
        """See WorkingTree.list_files."""
 
1611
                                                      specific_file_ids):
 
1612
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1613
 
 
1614
    def list_files(self, include_root=False):
 
1615
        """See Tree.list_files."""
1954
1616
        # XXX This should behave like WorkingTree.list_files, but is really
1955
1617
        # more like RevisionTree.list_files.
1956
 
        if recursive:
1957
 
            prefix = None
1958
 
            if from_dir:
1959
 
                prefix = from_dir + '/'
1960
 
            entries = self.iter_entries_by_dir()
1961
 
            for path, entry in entries:
1962
 
                if entry.name == '' and not include_root:
1963
 
                    continue
1964
 
                if prefix:
1965
 
                    if not path.startswith(prefix):
1966
 
                        continue
1967
 
                    path = path[len(prefix):]
1968
 
                yield path, 'V', entry.kind, entry.file_id, entry
1969
 
        else:
1970
 
            if from_dir is None and include_root is True:
1971
 
                root_entry = inventory.make_entry('directory', '',
1972
 
                    ROOT_PARENT, self.get_root_id())
1973
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1974
 
            entries = self._iter_entries_for_dir(from_dir or '')
1975
 
            for path, entry in entries:
1976
 
                yield path, 'V', entry.kind, entry.file_id, entry
 
1618
        for path, entry in self.iter_entries_by_dir():
 
1619
            if entry.name == '' and not include_root:
 
1620
                continue
 
1621
            yield path, 'V', entry.kind, entry.file_id, entry
1977
1622
 
1978
1623
    def kind(self, file_id):
1979
1624
        trans_id = self._transform.trans_id_file_id(file_id)
1989
1634
    def get_file_mtime(self, file_id, path=None):
1990
1635
        """See Tree.get_file_mtime"""
1991
1636
        if not self._content_change(file_id):
1992
 
            return self._transform._tree.get_file_mtime(file_id)
 
1637
            return self._transform._tree.get_file_mtime(file_id, path)
1993
1638
        return self._stat_limbo_file(file_id).st_mtime
1994
1639
 
1995
 
    def _file_size(self, entry, stat_value):
1996
 
        return self.get_file_size(entry.file_id)
1997
 
 
1998
1640
    def get_file_size(self, file_id):
1999
1641
        """See Tree.get_file_size"""
2000
1642
        if self.kind(file_id) == 'file':
2003
1645
            return None
2004
1646
 
2005
1647
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2006
 
        trans_id = self._transform.trans_id_file_id(file_id)
2007
 
        kind = self._transform._new_contents.get(trans_id)
2008
 
        if kind is None:
2009
 
            return self._transform._tree.get_file_sha1(file_id)
2010
 
        if kind == 'file':
2011
 
            fileobj = self.get_file(file_id)
2012
 
            try:
2013
 
                return sha_file(fileobj)
2014
 
            finally:
2015
 
                fileobj.close()
 
1648
        return self._transform._tree.get_file_sha1(file_id)
2016
1649
 
2017
1650
    def is_executable(self, file_id, path=None):
2018
 
        if file_id is None:
2019
 
            return False
2020
1651
        trans_id = self._transform.trans_id_file_id(file_id)
2021
1652
        try:
2022
1653
            return self._transform._new_executability[trans_id]
2023
1654
        except KeyError:
2024
 
            try:
2025
 
                return self._transform._tree.is_executable(file_id, path)
2026
 
            except OSError, e:
2027
 
                if e.errno == errno.ENOENT:
2028
 
                    return False
2029
 
                raise
2030
 
            except errors.NoSuchId:
2031
 
                return False
 
1655
            return self._transform._tree.is_executable(file_id, path)
2032
1656
 
2033
1657
    def path_content_summary(self, path):
2034
1658
        trans_id = self._path2trans_id(path)
2049
1673
                statval = os.lstat(limbo_name)
2050
1674
                size = statval.st_size
2051
1675
                if not supports_executable():
2052
 
                    executable = False
 
1676
                    executable = None
2053
1677
                else:
2054
1678
                    executable = statval.st_mode & S_IEXEC
2055
1679
            else:
2056
1680
                size = None
2057
1681
                executable = None
2058
1682
            if kind == 'symlink':
2059
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2060
 
        executable = tt._new_executability.get(trans_id, executable)
 
1683
                link_or_sha1 = os.readlink(limbo_name)
 
1684
        if supports_executable():
 
1685
            executable = tt._new_executability.get(trans_id, executable)
2061
1686
        return kind, size, executable, link_or_sha1
2062
1687
 
2063
1688
    def iter_changes(self, from_tree, include_unchanged=False,
2065
1690
                      require_versioned=True, want_unversioned=False):
2066
1691
        """See InterTree.iter_changes.
2067
1692
 
2068
 
        This has a fast path that is only used when the from_tree matches
2069
 
        the transform tree, and no fancy options are supplied.
 
1693
        This implementation does not support include_unchanged, specific_files,
 
1694
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1695
        ignored.
2070
1696
        """
2071
 
        if (from_tree is not self._transform._tree or include_unchanged or
2072
 
            specific_files or want_unversioned):
2073
 
            return tree.InterTree(from_tree, self).iter_changes(
2074
 
                include_unchanged=include_unchanged,
2075
 
                specific_files=specific_files,
2076
 
                pb=pb,
2077
 
                extra_trees=extra_trees,
2078
 
                require_versioned=require_versioned,
2079
 
                want_unversioned=want_unversioned)
 
1697
        if from_tree is not self._transform._tree:
 
1698
            raise ValueError('from_tree must be transform source tree.')
 
1699
        if include_unchanged:
 
1700
            raise ValueError('include_unchanged is not supported')
 
1701
        if specific_files is not None:
 
1702
            raise ValueError('specific_files is not supported')
2080
1703
        if want_unversioned:
2081
1704
            raise ValueError('want_unversioned is not supported')
2082
1705
        return self._transform.iter_changes()
2089
1712
        name = self._transform._limbo_name(trans_id)
2090
1713
        return open(name, 'rb')
2091
1714
 
2092
 
    def get_file_with_stat(self, file_id, path=None):
2093
 
        return self.get_file(file_id, path), None
 
1715
    def get_file_text(self, file_id):
 
1716
        text_file = self.get_file(file_id)
 
1717
        try:
 
1718
            return text_file.read()
 
1719
        finally:
 
1720
            text_file.close()
2094
1721
 
2095
1722
    def annotate_iter(self, file_id,
2096
1723
                      default_revision=_mod_revision.CURRENT_REVISION):
2097
 
        changes = self._iter_changes_cache.get(file_id)
 
1724
        changes = self._changes(file_id)
2098
1725
        if changes is None:
2099
1726
            get_old = True
2100
1727
        else:
2112
1739
            return old_annotation
2113
1740
        if not changed_content:
2114
1741
            return old_annotation
2115
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2116
 
        #       doing, however it fails slightly because it doesn't know what
2117
 
        #       the *other* revision_id is, so it doesn't know how to give the
2118
 
        #       other as the origin for some lines, they all get
2119
 
        #       'default_revision'
2120
 
        #       It would be nice to be able to use the new Annotator based
2121
 
        #       approach, as well.
2122
1742
        return annotate.reannotate([old_annotation],
2123
1743
                                   self.get_file(file_id).readlines(),
2124
1744
                                   default_revision)
2129
1749
            return self._transform._tree.get_symlink_target(file_id)
2130
1750
        trans_id = self._transform.trans_id_file_id(file_id)
2131
1751
        name = self._transform._limbo_name(trans_id)
2132
 
        return osutils.readlink(name)
 
1752
        return os.readlink(name)
2133
1753
 
2134
1754
    def walkdirs(self, prefix=''):
2135
1755
        pending = [self._transform.root]
2190
1810
        self.transform = transform
2191
1811
 
2192
1812
    def _determine_path(self, trans_id):
2193
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1813
        if trans_id == self.transform.root:
2194
1814
            return ""
2195
1815
        name = self.transform.final_name(trans_id)
2196
1816
        parent_id = self.transform.final_parent(trans_id)
2220
1840
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2221
1841
               delta_from_tree=False):
2222
1842
    """Create working tree for a branch, using a TreeTransform.
2223
 
 
 
1843
    
2224
1844
    This function should be used on empty trees, having a tree root at most.
2225
1845
    (see merge and revert functionality for working with existing trees)
2226
1846
 
2227
1847
    Existing files are handled like so:
2228
 
 
 
1848
    
2229
1849
    - Existing bzrdirs take precedence over creating new items.  They are
2230
1850
      created as '%s.diverted' % name.
2231
1851
    - Otherwise, if the content on disk matches the content we are building,
2333
1953
                    executable = tree.is_executable(file_id, tree_path)
2334
1954
                    if executable:
2335
1955
                        tt.set_executability(executable, trans_id)
2336
 
                    trans_data = (trans_id, tree_path)
2337
 
                    deferred_contents.append((file_id, trans_data))
 
1956
                    deferred_contents.append((file_id, trans_id))
2338
1957
                else:
2339
1958
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2340
1959
                                                          tree)
2371
1990
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2372
1991
                  hardlink):
2373
1992
    total = len(desired_files) + offset
2374
 
    wt = tt._tree
2375
1993
    if accelerator_tree is None:
2376
1994
        new_desired_files = desired_files
2377
1995
    else:
2378
1996
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2379
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2380
 
                     in iter if not (c or e[0] != e[1])]
2381
 
        if accelerator_tree.supports_content_filtering():
2382
 
            unchanged = [(f, p) for (f, p) in unchanged
2383
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2384
 
        unchanged = dict(unchanged)
 
1997
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1998
                         in iter if not (c or e[0] != e[1]))
2385
1999
        new_desired_files = []
2386
2000
        count = 0
2387
 
        for file_id, (trans_id, tree_path) in desired_files:
 
2001
        for file_id, trans_id in desired_files:
2388
2002
            accelerator_path = unchanged.get(file_id)
2389
2003
            if accelerator_path is None:
2390
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
2004
                new_desired_files.append((file_id, trans_id))
2391
2005
                continue
2392
2006
            pb.update('Adding file contents', count + offset, total)
2393
2007
            if hardlink:
2395
2009
                                   trans_id)
2396
2010
            else:
2397
2011
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2398
 
                if wt.supports_content_filtering():
2399
 
                    filters = wt._content_filter_stack(tree_path)
2400
 
                    contents = filtered_output_bytes(contents, filters,
2401
 
                        ContentFilterContext(tree_path, tree))
2402
2012
                try:
2403
2013
                    tt.create_file(contents, trans_id)
2404
2014
                finally:
2405
 
                    try:
2406
 
                        contents.close()
2407
 
                    except AttributeError:
2408
 
                        # after filtering, contents may no longer be file-like
2409
 
                        pass
 
2015
                    contents.close()
2410
2016
            count += 1
2411
2017
        offset += count
2412
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2413
 
            tree.iter_files_bytes(new_desired_files)):
2414
 
        if wt.supports_content_filtering():
2415
 
            filters = wt._content_filter_stack(tree_path)
2416
 
            contents = filtered_output_bytes(contents, filters,
2417
 
                ContentFilterContext(tree_path, tree))
 
2018
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
2019
                                                 new_desired_files)):
2418
2020
        tt.create_file(contents, trans_id)
2419
2021
        pb.update('Adding file contents', count + offset, total)
2420
2022
 
2480
2082
    if kind == 'file':
2481
2083
        contents = tree.get_file(entry.file_id).readlines()
2482
2084
        executable = tree.is_executable(entry.file_id)
2483
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
2085
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2484
2086
                           executable)
2485
2087
    elif kind in ('directory', 'tree-reference'):
2486
2088
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2487
2089
        if kind == 'tree-reference':
2488
2090
            tt.set_tree_reference(entry.reference_revision, trans_id)
2489
 
        return trans_id
 
2091
        return trans_id 
2490
2092
    elif kind == 'symlink':
2491
2093
        target = tree.get_symlink_target(entry.file_id)
2492
2094
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2494
2096
        raise errors.BadFileKindError(name, kind)
2495
2097
 
2496
2098
 
2497
 
@deprecated_function(deprecated_in((1, 9, 0)))
2498
2099
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2499
 
    """Create new file contents according to an inventory entry.
2500
 
 
2501
 
    DEPRECATED.  Use create_from_tree instead.
2502
 
    """
 
2100
    """Create new file contents according to an inventory entry."""
2503
2101
    if entry.kind == "file":
2504
2102
        if lines is None:
2505
2103
            lines = tree.get_file(entry.file_id).readlines()
2510
2108
        tt.create_directory(trans_id)
2511
2109
 
2512
2110
 
2513
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2514
 
    filter_tree_path=None):
2515
 
    """Create new file contents according to tree contents.
2516
 
    
2517
 
    :param filter_tree_path: the tree path to use to lookup
2518
 
      content filters to apply to the bytes output in the working tree.
2519
 
      This only applies if the working tree supports content filtering.
2520
 
    """
2521
 
    kind = tree.kind(file_id)
2522
 
    if kind == 'directory':
2523
 
        tt.create_directory(trans_id)
2524
 
    elif kind == "file":
2525
 
        if bytes is None:
2526
 
            tree_file = tree.get_file(file_id)
2527
 
            try:
2528
 
                bytes = tree_file.readlines()
2529
 
            finally:
2530
 
                tree_file.close()
2531
 
        wt = tt._tree
2532
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2533
 
            filters = wt._content_filter_stack(filter_tree_path)
2534
 
            bytes = filtered_output_bytes(bytes, filters,
2535
 
                ContentFilterContext(filter_tree_path, tree))
2536
 
        tt.create_file(bytes, trans_id)
2537
 
    elif kind == "symlink":
2538
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2539
 
    else:
2540
 
        raise AssertionError('Unknown kind %r' % kind)
2541
 
 
2542
 
 
2543
2111
def create_entry_executability(tt, entry, trans_id):
2544
2112
    """Set the executability of a trans_id according to an inventory entry"""
2545
2113
    if entry.kind == "file":
2582
2150
        if entry.kind != working_kind:
2583
2151
            contents_mod, meta_mod = True, False
2584
2152
        else:
2585
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
2153
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2586
2154
                                       working_tree)
2587
2155
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2588
2156
            cur_entry._forget_tree_state()
2590
2158
 
2591
2159
 
2592
2160
def revert(working_tree, target_tree, filenames, backups=False,
2593
 
           pb=None, change_reporter=None):
 
2161
           pb=DummyProgress(), change_reporter=None):
2594
2162
    """Revert a working tree's contents to those of a target tree."""
2595
2163
    target_tree.lock_read()
2596
 
    pb = ui.ui_factory.nested_progress_bar()
2597
2164
    tt = TreeTransform(working_tree, pb)
2598
2165
    try:
2599
2166
        pp = ProgressPhase("Revert phase", 3, pb)
2618
2185
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2619
2186
                              backups, pp, basis_tree=None,
2620
2187
                              merge_modified=None):
 
2188
    pp.next_phase()
2621
2189
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2622
2190
    try:
2623
2191
        if merge_modified is None:
2627
2195
                                      merge_modified, basis_tree)
2628
2196
    finally:
2629
2197
        child_pb.finished()
 
2198
    pp.next_phase()
2630
2199
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2631
2200
    try:
2632
2201
        raw_conflicts = resolve_conflicts(tt, child_pb,
2725
2294
                    parent_trans = ROOT_PARENT
2726
2295
                else:
2727
2296
                    parent_trans = tt.trans_id_file_id(parent[1])
2728
 
                if parent[0] is None and versioned[0]:
2729
 
                    tt.adjust_root_path(name[1], parent_trans)
2730
 
                else:
2731
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
 
2297
                tt.adjust_path(name[1], parent_trans, trans_id)
2732
2298
            if executable[0] != executable[1] and kind[1] == "file":
2733
2299
                tt.set_executability(executable[1], trans_id)
2734
 
        if working_tree.supports_content_filtering():
2735
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2736
 
                target_tree.iter_files_bytes(deferred_files)):
2737
 
                file_id = deferred_files[index][0]
2738
 
                # We're reverting a tree to the target tree so using the
2739
 
                # target tree to find the file path seems the best choice
2740
 
                # here IMO - Ian C 27/Oct/2009
2741
 
                filter_tree_path = target_tree.id2path(file_id)
2742
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2743
 
                bytes = filtered_output_bytes(bytes, filters,
2744
 
                    ContentFilterContext(filter_tree_path, working_tree))
2745
 
                tt.create_file(bytes, trans_id, mode_id)
2746
 
        else:
2747
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2748
 
                deferred_files):
2749
 
                tt.create_file(bytes, trans_id, mode_id)
2750
 
        tt.fixup_new_roots()
 
2300
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2301
            deferred_files):
 
2302
            tt.create_file(bytes, trans_id, mode_id)
2751
2303
    finally:
2752
2304
        if basis_tree is not None:
2753
2305
            basis_tree.unlock()
2754
2306
    return merge_modified
2755
2307
 
2756
2308
 
2757
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2309
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2758
2310
    """Make many conflict-resolution attempts, but die if they fail"""
2759
2311
    if pass_func is None:
2760
2312
        pass_func = conflict_pass
2761
2313
    new_conflicts = set()
2762
 
    pb = ui.ui_factory.nested_progress_bar()
2763
2314
    try:
2764
2315
        for n in range(10):
2765
2316
            pb.update('Resolution pass', n+1, 10)
2769
2320
            new_conflicts.update(pass_func(tt, conflicts))
2770
2321
        raise MalformedTransform(conflicts=conflicts)
2771
2322
    finally:
2772
 
        pb.finished()
 
2323
        pb.clear()
2773
2324
 
2774
2325
 
2775
2326
def conflict_pass(tt, conflicts, path_tree=None):
2794
2345
                existing_file, new_file = conflict[1], conflict[2]
2795
2346
            new_name = tt.final_name(existing_file)+'.moved'
2796
2347
            tt.adjust_path(new_name, final_parent, existing_file)
2797
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2348
            new_conflicts.add((c_type, 'Moved existing file to', 
2798
2349
                               existing_file, new_file))
2799
2350
        elif c_type == 'parent loop':
2800
2351
            # break the loop by undoing one of the ops that caused the loop
2804
2355
            new_conflicts.add((c_type, 'Cancelled move', cur,
2805
2356
                               tt.final_parent(cur),))
2806
2357
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2807
 
 
 
2358
            
2808
2359
        elif c_type == 'missing parent':
2809
2360
            trans_id = conflict[1]
2810
2361
            try:
2811
2362
                tt.cancel_deletion(trans_id)
2812
 
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2363
                new_conflicts.add(('deleting parent', 'Not deleting', 
2813
2364
                                   trans_id))
2814
2365
            except KeyError:
2815
2366
                create = True
2824
2375
                        # special-case the other tree root (move its
2825
2376
                        # children to current root)
2826
2377
                        if entry.parent_id is None:
2827
 
                            create = False
 
2378
                            create=False
2828
2379
                            moved = _reparent_transform_children(
2829
2380
                                tt, trans_id, tt.root)
2830
2381
                            for child in moved:
2880
2431
        if len(conflict) == 3:
2881
2432
            yield Conflict.factory(c_type, action=action, path=modified_path,
2882
2433
                                     file_id=modified_id)
2883
 
 
 
2434
             
2884
2435
        else:
2885
2436
            conflicting_path = fp.get_path(conflict[3])
2886
2437
            conflicting_id = tt.final_file_id(conflict[3])
2887
2438
            yield Conflict.factory(c_type, action=action, path=modified_path,
2888
 
                                   file_id=modified_id,
 
2439
                                   file_id=modified_id, 
2889
2440
                                   conflict_path=conflicting_path,
2890
2441
                                   conflict_file_id=conflicting_id)
2891
2442
 
2898
2449
        self.pending_deletions = []
2899
2450
 
2900
2451
    def rename(self, from_, to):
2901
 
        """Rename a file from one path to another."""
 
2452
        """Rename a file from one path to another.  Functions like os.rename"""
2902
2453
        try:
2903
 
            osutils.rename(from_, to)
 
2454
            os.rename(from_, to)
2904
2455
        except OSError, e:
2905
2456
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2906
2457
                raise errors.FileExists(to, str(e))
2920
2471
    def rollback(self):
2921
2472
        """Reverse all renames that have been performed"""
2922
2473
        for from_, to in reversed(self.past_renames):
2923
 
            osutils.rename(to, from_)
 
2474
            os.rename(to, from_)
2924
2475
        # after rollback, don't reuse _FileMover
2925
2476
        past_renames = None
2926
2477
        pending_deletions = None