← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-18 09:13:28 UTC
  • mfrom: (5096.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100318091328-8fo347hq4at1usky
(vila) Get better feedback about why
        TestGetFileMTime.test_get_file_mtime is failing

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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
19
from stat import S_ISREG, S_IEXEC
 
20
import time
20
21
 
21
22
from bzrlib.lazy_import import lazy_import
22
23
lazy_import(globals(), """
23
24
from bzrlib import (
24
25
    annotate,
 
26
    bencode,
25
27
    bzrdir,
26
28
    delta,
27
29
    errors,
28
30
    inventory,
 
31
    multiparent,
29
32
    osutils,
30
33
    revision as _mod_revision,
 
34
    ui,
31
35
    )
32
36
""")
33
37
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
34
38
                           ReusingTransform, NotVersionedError, CantMoveRoot,
35
39
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
36
40
                           UnableCreateSymlink)
 
41
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
37
42
from bzrlib.inventory import InventoryEntry
38
43
from bzrlib.osutils import (
39
44
    delete_any,
41
46
    has_symlinks,
42
47
    lexists,
43
48
    pathjoin,
 
49
    sha_file,
44
50
    splitpath,
45
51
    supports_executable,
46
52
)
47
 
from bzrlib.progress import DummyProgress, ProgressPhase
 
53
from bzrlib.progress import ProgressPhase
48
54
from bzrlib.symbol_versioning import (
49
55
        deprecated_function,
 
56
        deprecated_in,
50
57
        )
51
58
from bzrlib.trace import mutter, warning
52
59
from bzrlib import tree
71
78
 
72
79
 
73
80
class TreeTransformBase(object):
74
 
    """The base class for TreeTransform and TreeTransformBase"""
 
81
    """The base class for TreeTransform and its kin."""
75
82
 
76
 
    def __init__(self, tree, limbodir, pb=DummyProgress(),
 
83
    def __init__(self, tree, pb=None,
77
84
                 case_sensitive=True):
78
85
        """Constructor.
79
86
 
80
87
        :param tree: The tree that will be transformed, but not necessarily
81
88
            the output tree.
82
 
        :param limbodir: A directory where new files can be stored until
83
 
            they are installed in their proper places
84
 
        :param pb: A ProgressBar indicating how much progress is being made
 
89
        :param pb: ignored
85
90
        :param case_sensitive: If True, the target of the transform is
86
91
            case sensitive, not just case preserving.
87
92
        """
88
93
        object.__init__(self)
89
94
        self._tree = tree
90
 
        self._limbodir = limbodir
91
 
        self._deletiondir = None
92
95
        self._id_number = 0
93
96
        # mapping of trans_id -> new basename
94
97
        self._new_name = {}
96
99
        self._new_parent = {}
97
100
        # mapping of trans_id with new contents -> new file_kind
98
101
        self._new_contents = {}
99
 
        # A mapping of transform ids to their limbo filename
100
 
        self._limbo_files = {}
101
 
        # A mapping of transform ids to a set of the transform ids of children
102
 
        # that their limbo directory has
103
 
        self._limbo_children = {}
104
 
        # Map transform ids to maps of child filename to child transform id
105
 
        self._limbo_children_names = {}
106
 
        # List of transform ids that need to be renamed from limbo into place
107
 
        self._needs_rename = set()
108
102
        # Set of trans_ids whose contents will be removed
109
103
        self._removed_contents = set()
110
104
        # Mapping of trans_id -> new execute-bit value
117
111
        self._non_present_ids = {}
118
112
        # Mapping of new file_id -> trans_id
119
113
        self._r_new_id = {}
120
 
        # Set of file_ids that will be removed
 
114
        # Set of trans_ids that will be removed
121
115
        self._removed_id = set()
122
116
        # Mapping of path in old tree -> trans_id
123
117
        self._tree_path_ids = {}
124
118
        # Mapping trans_id -> path in old tree
125
119
        self._tree_id_paths = {}
126
 
        # Cache of realpath results, to speed up canonical_path
127
 
        self._realpaths = {}
128
 
        # Cache of relpath results, to speed up canonical_path
129
 
        self._relpaths = {}
130
120
        # The trans_id that will be used as the tree root
131
121
        root_id = tree.get_root_id()
132
122
        if root_id is not None:
142
132
        # A counter of how many files have been renamed
143
133
        self.rename_count = 0
144
134
 
 
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
 
145
146
    def __get_root(self):
146
147
        return self._new_root
147
148
 
148
149
    root = property(__get_root)
149
150
 
150
 
    def finalize(self):
151
 
        """Release the working tree lock, if held, clean up limbo dir.
152
 
 
153
 
        This is required if apply has not been invoked, but can be invoked
154
 
        even after apply.
155
 
        """
156
 
        if self._tree is None:
157
 
            return
158
 
        try:
159
 
            entries = [(self._limbo_name(t), t, k) for t, k in
160
 
                       self._new_contents.iteritems()]
161
 
            entries.sort(reverse=True)
162
 
            for path, trans_id, kind in entries:
163
 
                if kind == "directory":
164
 
                    os.rmdir(path)
165
 
                else:
166
 
                    os.unlink(path)
167
 
            try:
168
 
                os.rmdir(self._limbodir)
169
 
            except OSError:
170
 
                # We don't especially care *why* the dir is immortal.
171
 
                raise ImmortalLimbo(self._limbodir)
172
 
            try:
173
 
                if self._deletiondir is not None:
174
 
                    os.rmdir(self._deletiondir)
175
 
            except OSError:
176
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
177
 
        finally:
178
 
            self._tree.unlock()
179
 
            self._tree = None
180
 
 
181
151
    def _assign_id(self):
182
152
        """Produce a new tranform id"""
183
153
        new_id = "new-%s" % self._id_number
193
163
 
194
164
    def adjust_path(self, name, parent, trans_id):
195
165
        """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")
196
168
        if trans_id == self._new_root:
197
169
            raise CantMoveRoot
198
 
        previous_parent = self._new_parent.get(trans_id)
199
 
        previous_name = self._new_name.get(trans_id)
200
170
        self._new_name[trans_id] = name
201
171
        self._new_parent[trans_id] = parent
202
 
        if parent == ROOT_PARENT:
203
 
            if self._new_root is not None:
204
 
                raise ValueError("Cannot have multiple roots.")
205
 
            self._new_root = trans_id
206
 
        if (trans_id in self._limbo_files and
207
 
            trans_id not in self._needs_rename):
208
 
            self._rename_in_limbo([trans_id])
209
 
            self._limbo_children[previous_parent].remove(trans_id)
210
 
            del self._limbo_children_names[previous_parent][previous_name]
211
 
 
212
 
    def _rename_in_limbo(self, trans_ids):
213
 
        """Fix limbo names so that the right final path is produced.
214
 
 
215
 
        This means we outsmarted ourselves-- we tried to avoid renaming
216
 
        these files later by creating them with their final names in their
217
 
        final parents.  But now the previous name or parent is no longer
218
 
        suitable, so we have to rename them.
219
 
 
220
 
        Even for trans_ids that have no new contents, we must remove their
221
 
        entries from _limbo_files, because they are now stale.
222
 
        """
223
 
        for trans_id in trans_ids:
224
 
            old_path = self._limbo_files.pop(trans_id)
225
 
            if trans_id not in self._new_contents:
226
 
                continue
227
 
            new_path = self._limbo_name(trans_id)
228
 
            os.rename(old_path, new_path)
229
172
 
230
173
    def adjust_root_path(self, name, parent):
231
174
        """Emulate moving the root by moving all children, instead.
232
 
        
 
175
 
233
176
        We do this by undoing the association of root's transaction id with the
234
177
        current tree.  This allows us to create a new directory with that
235
 
        transaction id.  We unversion the root directory and version the 
 
178
        transaction id.  We unversion the root directory and version the
236
179
        physically new directory, and hope someone versions the tree root
237
180
        later.
238
181
        """
241
184
        # force moving all children of root
242
185
        for child_id in self.iter_tree_children(old_root):
243
186
            if child_id != parent:
244
 
                self.adjust_path(self.final_name(child_id), 
 
187
                self.adjust_path(self.final_name(child_id),
245
188
                                 self.final_parent(child_id), child_id)
246
189
            file_id = self.final_file_id(child_id)
247
190
            if file_id is not None:
248
191
                self.unversion_file(child_id)
249
192
            self.version_file(file_id, child_id)
250
 
        
 
193
 
251
194
        # the physical root needs a new transaction id
252
195
        self._tree_path_ids.pop("")
253
196
        self._tree_id_paths.pop(old_root)
259
202
        self.version_file(old_root_file_id, old_root)
260
203
        self.unversion_file(self._new_root)
261
204
 
 
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
 
262
266
    def trans_id_tree_file_id(self, inventory_id):
263
267
        """Determine the transaction id of a working tree file.
264
 
        
 
268
 
265
269
        This reflects only files that already exist, not ones that will be
266
270
        added by transactions.
267
271
        """
280
284
            raise ValueError('None is not a valid file id')
281
285
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
282
286
            return self._r_new_id[file_id]
283
 
        elif file_id in self._tree.inventory:
284
 
            return self.trans_id_tree_file_id(file_id)
285
 
        elif file_id in self._non_present_ids:
286
 
            return self._non_present_ids[file_id]
287
 
        else:
288
 
            trans_id = self._assign_id()
289
 
            self._non_present_ids[file_id] = trans_id
290
 
            return trans_id
291
 
 
292
 
    def canonical_path(self, path):
293
 
        """Get the canonical tree-relative path"""
294
 
        # don't follow final symlinks
295
 
        abs = self._tree.abspath(path)
296
 
        if abs in self._relpaths:
297
 
            return self._relpaths[abs]
298
 
        dirname, basename = os.path.split(abs)
299
 
        if dirname not in self._realpaths:
300
 
            self._realpaths[dirname] = os.path.realpath(dirname)
301
 
        dirname = self._realpaths[dirname]
302
 
        abs = pathjoin(dirname, basename)
303
 
        if dirname in self._relpaths:
304
 
            relpath = pathjoin(self._relpaths[dirname], basename)
305
 
            relpath = relpath.rstrip('/\\')
306
 
        else:
307
 
            relpath = self._tree.relpath(abs)
308
 
        self._relpaths[abs] = relpath
309
 
        return relpath
 
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)
310
299
 
311
300
    def trans_id_tree_path(self, path):
312
301
        """Determine (and maybe set) the transaction ID for a tree path."""
323
312
            return ROOT_PARENT
324
313
        return self.trans_id_tree_path(os.path.dirname(path))
325
314
 
326
 
    def create_file(self, contents, trans_id, mode_id=None):
327
 
        """Schedule creation of a new file.
328
 
 
329
 
        See also new_file.
330
 
        
331
 
        Contents is an iterator of strings, all of which will be written
332
 
        to the target destination.
333
 
 
334
 
        New file takes the permissions of any existing file with that id,
335
 
        unless mode_id is specified.
336
 
        """
337
 
        name = self._limbo_name(trans_id)
338
 
        f = open(name, 'wb')
339
 
        try:
340
 
            try:
341
 
                unique_add(self._new_contents, trans_id, 'file')
342
 
            except:
343
 
                # Clean up the file, it never got registered so
344
 
                # TreeTransform.finalize() won't clean it up.
345
 
                f.close()
346
 
                os.unlink(name)
347
 
                raise
348
 
 
349
 
            f.writelines(contents)
350
 
        finally:
351
 
            f.close()
352
 
        self._set_mode(trans_id, mode_id, S_ISREG)
353
 
 
354
 
    def _set_mode(self, trans_id, mode_id, typefunc):
355
 
        """Set the mode of new file contents.
356
 
        The mode_id is the existing file to get the mode from (often the same
357
 
        as trans_id).  The operation is only performed if there's a mode match
358
 
        according to typefunc.
359
 
        """
360
 
        if mode_id is None:
361
 
            mode_id = trans_id
362
 
        try:
363
 
            old_path = self._tree_id_paths[mode_id]
364
 
        except KeyError:
365
 
            return
366
 
        try:
367
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
368
 
        except OSError, e:
369
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
370
 
                # Either old_path doesn't exist, or the parent of the
371
 
                # target is not a directory (but will be one eventually)
372
 
                # Either way, we know it doesn't exist *right now*
373
 
                # See also bug #248448
374
 
                return
375
 
            else:
376
 
                raise
377
 
        if typefunc(mode):
378
 
            os.chmod(self._limbo_name(trans_id), mode)
379
 
 
380
 
    def create_hardlink(self, path, trans_id):
381
 
        """Schedule creation of a hard link"""
382
 
        name = self._limbo_name(trans_id)
383
 
        try:
384
 
            os.link(path, name)
385
 
        except OSError, e:
386
 
            if e.errno != errno.EPERM:
387
 
                raise
388
 
            raise errors.HardLinkNotSupported(path)
389
 
        try:
390
 
            unique_add(self._new_contents, trans_id, 'file')
391
 
        except:
392
 
            # Clean up the file, it never got registered so
393
 
            # TreeTransform.finalize() won't clean it up.
394
 
            os.unlink(name)
395
 
            raise
396
 
 
397
 
    def create_directory(self, trans_id):
398
 
        """Schedule creation of a new directory.
399
 
        
400
 
        See also new_directory.
401
 
        """
402
 
        os.mkdir(self._limbo_name(trans_id))
403
 
        unique_add(self._new_contents, trans_id, 'directory')
404
 
 
405
 
    def create_symlink(self, target, trans_id):
406
 
        """Schedule creation of a new symbolic link.
407
 
 
408
 
        target is a bytestring.
409
 
        See also new_symlink.
410
 
        """
411
 
        if has_symlinks():
412
 
            os.symlink(target, self._limbo_name(trans_id))
413
 
            unique_add(self._new_contents, trans_id, 'symlink')
414
 
        else:
415
 
            try:
416
 
                path = FinalPaths(self).get_path(trans_id)
417
 
            except KeyError:
418
 
                path = None
419
 
            raise UnableCreateSymlink(path=path)
420
 
 
421
 
    def cancel_creation(self, trans_id):
422
 
        """Cancel the creation of new file contents."""
423
 
        del self._new_contents[trans_id]
424
 
        children = self._limbo_children.get(trans_id)
425
 
        # if this is a limbo directory with children, move them before removing
426
 
        # the directory
427
 
        if children is not None:
428
 
            self._rename_in_limbo(children)
429
 
            del self._limbo_children[trans_id]
430
 
            del self._limbo_children_names[trans_id]
431
 
        delete_any(self._limbo_name(trans_id))
432
 
 
433
315
    def delete_contents(self, trans_id):
434
316
        """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
435
319
        self.tree_kind(trans_id)
436
320
        self._removed_contents.add(trans_id)
437
321
 
509
393
        new_ids.update(changed_kind)
510
394
        return sorted(FinalPaths(self).get_paths(new_ids))
511
395
 
512
 
    def tree_kind(self, trans_id):
513
 
        """Determine the file kind in the working tree.
514
 
 
515
 
        Raises NoSuchFile if the file does not exist
516
 
        """
517
 
        path = self._tree_id_paths.get(trans_id)
518
 
        if path is None:
519
 
            raise NoSuchFile(None)
520
 
        try:
521
 
            return file_kind(self._tree.abspath(path))
522
 
        except OSError, e:
523
 
            if e.errno != errno.ENOENT:
524
 
                raise
525
 
            else:
526
 
                raise NoSuchFile(path)
527
 
 
528
396
    def final_kind(self, trans_id):
529
397
        """Determine the final file kind, after any changes applied.
530
 
        
 
398
 
531
399
        Raises NoSuchFile if the file does not exist/has no contents.
532
400
        (It is conceivable that a path would be created without the
533
401
        corresponding contents insertion command)
549
417
        # the file is old; the old id is still valid
550
418
        if self._new_root == trans_id:
551
419
            return self._tree.get_root_id()
552
 
        return self._tree.inventory.path2id(path)
 
420
        return self._tree.path2id(path)
553
421
 
554
422
    def final_file_id(self, trans_id):
555
423
        """Determine the file id after any changes are applied, or None.
556
 
        
 
424
 
557
425
        None indicates that the file will not be versioned after changes are
558
426
        applied.
559
427
        """
598
466
 
599
467
    def by_parent(self):
600
468
        """Return a map of parent: children for known parents.
601
 
        
 
469
 
602
470
        Only new paths and parents of tree files with assigned ids are used.
603
471
        """
604
472
        by_parent = {}
605
473
        items = list(self._new_parent.iteritems())
606
 
        items.extend((t, self.final_parent(t)) for t in 
 
474
        items.extend((t, self.final_parent(t)) for t in
607
475
                      self._tree_id_paths.keys())
608
476
        for trans_id, parent_id in items:
609
477
            if parent_id not in by_parent:
637
505
        conflicts.extend(self._overwrite_conflicts())
638
506
        return conflicts
639
507
 
 
508
    def _check_malformed(self):
 
509
        conflicts = self.find_conflicts()
 
510
        if len(conflicts) != 0:
 
511
            raise MalformedTransform(conflicts=conflicts)
 
512
 
640
513
    def _add_tree_children(self):
641
514
        """Add all the children of all active parents to the known paths.
642
515
 
644
517
        removed.  This is a necessary first step in detecting conflicts.
645
518
        """
646
519
        parents = self.by_parent().keys()
647
 
        parents.extend([t for t in self._removed_contents if 
 
520
        parents.extend([t for t in self._removed_contents if
648
521
                        self.tree_kind(t) == 'directory'])
649
522
        for trans_id in self._removed_id:
650
523
            file_id = self.tree_file_id(trans_id)
658
531
            # ensure that all children are registered with the transaction
659
532
            list(self.iter_tree_children(parent_id))
660
533
 
661
 
    def iter_tree_children(self, parent_id):
662
 
        """Iterate through the entry's tree children, if any"""
663
 
        try:
664
 
            path = self._tree_id_paths[parent_id]
665
 
        except KeyError:
666
 
            return
667
 
        try:
668
 
            children = os.listdir(self._tree.abspath(path))
669
 
        except OSError, e:
670
 
            if not (osutils._is_error_enotdir(e)
671
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
672
 
                raise
673
 
            return
674
 
 
675
 
        for child in children:
676
 
            childpath = joinpath(path, child)
677
 
            if self._tree.is_control_filename(childpath):
678
 
                continue
679
 
            yield self.trans_id_tree_path(childpath)
680
 
 
681
534
    def has_named_child(self, by_parent, parent_id, name):
682
535
        try:
683
536
            children = by_parent[parent_id]
737
590
 
738
591
    def _improper_versioning(self):
739
592
        """Cannot version a file with no contents, or a bad type.
740
 
        
 
593
 
741
594
        However, existing entries with no contents are okay.
742
595
        """
743
596
        conflicts = []
753
606
 
754
607
    def _executability_conflicts(self):
755
608
        """Check for bad executability changes.
756
 
        
 
609
 
757
610
        Only versioned files may have their executability set, because
758
611
        1. only versioned entries can have executability under windows
759
612
        2. only files can be executable.  (The execute bit on a directory
858
711
            return True
859
712
        return False
860
713
 
861
 
    def _limbo_name(self, trans_id):
862
 
        """Generate the limbo name of a file"""
863
 
        limbo_name = self._limbo_files.get(trans_id)
864
 
        if limbo_name is not None:
865
 
            return limbo_name
866
 
        parent = self._new_parent.get(trans_id)
867
 
        # if the parent directory is already in limbo (e.g. when building a
868
 
        # tree), choose a limbo name inside the parent, to reduce further
869
 
        # renames.
870
 
        use_direct_path = False
871
 
        if self._new_contents.get(parent) == 'directory':
872
 
            filename = self._new_name.get(trans_id)
873
 
            if filename is not None:
874
 
                if parent not in self._limbo_children:
875
 
                    self._limbo_children[parent] = set()
876
 
                    self._limbo_children_names[parent] = {}
877
 
                    use_direct_path = True
878
 
                # the direct path can only be used if no other file has
879
 
                # already taken this pathname, i.e. if the name is unused, or
880
 
                # if it is already associated with this trans_id.
881
 
                elif self._case_sensitive_target:
882
 
                    if (self._limbo_children_names[parent].get(filename)
883
 
                        in (trans_id, None)):
884
 
                        use_direct_path = True
885
 
                else:
886
 
                    for l_filename, l_trans_id in\
887
 
                        self._limbo_children_names[parent].iteritems():
888
 
                        if l_trans_id == trans_id:
889
 
                            continue
890
 
                        if l_filename.lower() == filename.lower():
891
 
                            break
892
 
                    else:
893
 
                        use_direct_path = True
894
 
 
895
 
        if use_direct_path:
896
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
897
 
            self._limbo_children[parent].add(trans_id)
898
 
            self._limbo_children_names[parent][filename] = trans_id
899
 
        else:
900
 
            limbo_name = pathjoin(self._limbodir, trans_id)
901
 
            self._needs_rename.add(trans_id)
902
 
        self._limbo_files[trans_id] = limbo_name
903
 
        return limbo_name
904
 
 
905
714
    def _set_executability(self, path, trans_id):
906
715
        """Set the executability of versioned files """
907
716
        if supports_executable():
928
737
            self.version_file(file_id, trans_id)
929
738
        return trans_id
930
739
 
931
 
    def new_file(self, name, parent_id, contents, file_id=None, 
 
740
    def new_file(self, name, parent_id, contents, file_id=None,
932
741
                 executable=None):
933
742
        """Convenience method to create files.
934
 
        
 
743
 
935
744
        name is the name of the file to create.
936
745
        parent_id is the transaction id of the parent directory of the file.
937
746
        contents is an iterator of bytestrings, which will be used to produce
957
766
        """
958
767
        trans_id = self._new_entry(name, parent_id, file_id)
959
768
        self.create_directory(trans_id)
960
 
        return trans_id 
 
769
        return trans_id
961
770
 
962
771
    def new_symlink(self, name, parent_id, target, file_id=None):
963
772
        """Convenience method to create symbolic link.
964
 
        
 
773
 
965
774
        name is the name of the symlink to create.
966
775
        parent_id is the transaction id of the parent directory of the symlink.
967
776
        target is a bytestring of the target of the symlink.
1006
815
        from_path = self._tree_id_paths.get(from_trans_id)
1007
816
        if from_versioned:
1008
817
            # get data from working tree if versioned
1009
 
            from_entry = self._tree.inventory[file_id]
 
818
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1010
819
            from_name = from_entry.name
1011
820
            from_parent = from_entry.parent_id
1012
821
        else:
1113
922
    def get_preview_tree(self):
1114
923
        """Return a tree representing the result of the transform.
1115
924
 
1116
 
        This tree only supports the subset of Tree functionality required
1117
 
        by show_diff_trees.  It must only be compared to tt._tree.
 
925
        The tree is a snapshot, and altering the TreeTransform will invalidate
 
926
        it.
1118
927
        """
1119
928
        return _PreviewTree(self)
1120
929
 
1121
 
 
1122
 
class TreeTransform(TreeTransformBase):
 
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
            os.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):
1123
1279
    """Represent a tree transformation.
1124
1280
 
1125
1281
    This object is designed to support incremental generation of the transform,
1184
1340
    FileMover does not delete files until it is sure that a rollback will not
1185
1341
    happen.
1186
1342
    """
1187
 
    def __init__(self, tree, pb=DummyProgress()):
 
1343
    def __init__(self, tree, pb=None):
1188
1344
        """Note: a tree_write lock is taken on the tree.
1189
1345
 
1190
1346
        Use TreeTransform.finalize() to release the lock (can be omitted if
1211
1367
            tree.unlock()
1212
1368
            raise
1213
1369
 
1214
 
        TreeTransformBase.__init__(self, tree, limbodir, pb,
 
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
1375
                                   tree.case_sensitive)
1216
1376
        self._deletiondir = deletiondir
1217
1377
 
 
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
 
1218
1507
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1219
1508
        """Apply all changes to the inventory and filesystem.
1220
1509
 
1230
1519
        :param _mover: Supply an alternate FileMover, for testing
1231
1520
        """
1232
1521
        if not no_conflicts:
1233
 
            conflicts = self.find_conflicts()
1234
 
            if len(conflicts) != 0:
1235
 
                raise MalformedTransform(conflicts=conflicts)
 
1522
            self._check_malformed()
1236
1523
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1237
1524
        try:
1238
1525
            if precomputed_delta is None:
1342
1629
                child_pb.update('removing file', num, len(tree_paths))
1343
1630
                full_path = self._tree.abspath(path)
1344
1631
                if trans_id in self._removed_contents:
1345
 
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
1346
 
                                     trans_id))
1347
 
                elif trans_id in self._new_name or trans_id in \
1348
 
                    self._new_parent:
 
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):
1349
1636
                    try:
1350
1637
                        mover.rename(full_path, self._limbo_name(trans_id))
1351
1638
                    except OSError, e:
1397
1684
        return modified_paths
1398
1685
 
1399
1686
 
1400
 
class TransformPreview(TreeTransformBase):
 
1687
class TransformPreview(DiskTreeTransform):
1401
1688
    """A TreeTransform for generating preview trees.
1402
1689
 
1403
1690
    Unlike TreeTransform, this version works when the input tree is a
1405
1692
    unversioned files in the input tree.
1406
1693
    """
1407
1694
 
1408
 
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
 
1695
    def __init__(self, tree, pb=None, case_sensitive=True):
1409
1696
        tree.lock_read()
1410
1697
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1411
 
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1698
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1412
1699
 
1413
1700
    def canonical_path(self, path):
1414
1701
        return path
1438
1725
        file_id = self.tree_file_id(parent_id)
1439
1726
        if file_id is None:
1440
1727
            return
1441
 
        children = getattr(self._tree.inventory[file_id], 'children', {})
 
1728
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1729
        children = getattr(entry, 'children', {})
1442
1730
        for child in children:
1443
1731
            childpath = joinpath(path, child)
1444
1732
            yield self.trans_id_tree_path(childpath)
1452
1740
        self._final_paths = FinalPaths(transform)
1453
1741
        self.__by_parent = None
1454
1742
        self._parent_ids = []
1455
 
 
1456
 
    def _changes(self, file_id):
1457
 
        for changes in self._transform.iter_changes():
1458
 
            if changes[0] == file_id:
1459
 
                return changes
 
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())
1460
1748
 
1461
1749
    def _content_change(self, file_id):
1462
1750
        """Return True if the content of this file changed"""
1463
 
        changes = self._changes(file_id)
 
1751
        changes = self._iter_changes_cache.get(file_id)
1464
1752
        # changes[2] is true if the file content changed.  See
1465
1753
        # InterTree.iter_changes.
1466
1754
        return (changes is not None and changes[2])
1500
1788
            self.__by_parent = self._transform.by_parent()
1501
1789
        return self.__by_parent
1502
1790
 
 
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
 
1503
1801
    def lock_read(self):
1504
1802
        # Perhaps in theory, this should lock the TreeTransform?
1505
1803
        pass
1525
1823
    def __iter__(self):
1526
1824
        return iter(self.all_file_ids())
1527
1825
 
1528
 
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
1529
 
        """See Tree.paths2ids"""
1530
 
        to_find = set(specific_files)
1531
 
        result = set()
1532
 
        for (file_id, paths, changed, versioned, parent, name, kind,
1533
 
             executable) in self._transform.iter_changes():
1534
 
            if paths[1] in to_find:
1535
 
                result.add(file_id)
1536
 
                to_find.remove(paths[1])
1537
 
        result.update(self._transform._tree.paths2ids(to_find,
1538
 
                      trees=[], require_versioned=require_versioned))
1539
 
        return result
 
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)
1540
1840
 
1541
1841
    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
1542
1846
        segments = splitpath(path)
1543
1847
        cur_parent = self._transform.root
1544
1848
        for cur_segment in segments:
1545
1849
            for child in self._all_children(cur_parent):
1546
 
                if self._transform.final_name(child) == cur_segment:
 
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
1855
                    cur_parent = child
1548
1856
                    break
1549
1857
            else:
 
1858
                self._path2trans_id_cache[path] = None
1550
1859
                return None
 
1860
        self._path2trans_id_cache[path] = cur_parent
1551
1861
        return cur_parent
1552
1862
 
1553
1863
    def path2id(self, path):
1561
1871
            raise errors.NoSuchId(self, file_id)
1562
1872
 
1563
1873
    def _all_children(self, trans_id):
 
1874
        children = self._all_children_cache.get(trans_id)
 
1875
        if children is not None:
 
1876
            return children
1564
1877
        children = set(self._transform.iter_tree_children(trans_id))
1565
1878
        # children in the _new_parent set are provided by _by_parent.
1566
1879
        children.difference_update(self._transform._new_parent.keys())
1567
1880
        children.update(self._by_parent.get(trans_id, []))
 
1881
        self._all_children_cache[trans_id] = children
1568
1882
        return children
1569
1883
 
1570
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
 
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
1900
        for trans_id, parent_file_id in ordered_entries:
1572
1901
            file_id = self._transform.final_file_id(trans_id)
1573
1902
            if file_id is None:
1599
1928
                ordered_ids.append((trans_id, parent_file_id))
1600
1929
        return ordered_ids
1601
1930
 
1602
 
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1931
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1603
1932
        # This may not be a maximally efficient implementation, but it is
1604
1933
        # reasonably straightforward.  An implementation that grafts the
1605
1934
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1607
1936
        # position.
1608
1937
        ordered_ids = self._list_files_by_dir()
1609
1938
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1610
 
                                                      specific_file_ids):
1611
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1612
 
 
1613
 
    def list_files(self, include_root=False):
1614
 
        """See Tree.list_files."""
 
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."""
1615
1954
        # XXX This should behave like WorkingTree.list_files, but is really
1616
1955
        # more like RevisionTree.list_files.
1617
 
        for path, entry in self.iter_entries_by_dir():
1618
 
            if entry.name == '' and not include_root:
1619
 
                continue
1620
 
            yield path, 'V', entry.kind, entry.file_id, entry
 
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
1621
1977
 
1622
1978
    def kind(self, file_id):
1623
1979
        trans_id = self._transform.trans_id_file_id(file_id)
1633
1989
    def get_file_mtime(self, file_id, path=None):
1634
1990
        """See Tree.get_file_mtime"""
1635
1991
        if not self._content_change(file_id):
1636
 
            return self._transform._tree.get_file_mtime(file_id, path)
 
1992
            return self._transform._tree.get_file_mtime(file_id)
1637
1993
        return self._stat_limbo_file(file_id).st_mtime
1638
1994
 
 
1995
    def _file_size(self, entry, stat_value):
 
1996
        return self.get_file_size(entry.file_id)
 
1997
 
1639
1998
    def get_file_size(self, file_id):
1640
1999
        """See Tree.get_file_size"""
1641
2000
        if self.kind(file_id) == 'file':
1644
2003
            return None
1645
2004
 
1646
2005
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1647
 
        return self._transform._tree.get_file_sha1(file_id)
 
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
2016
 
1649
2017
    def is_executable(self, file_id, path=None):
 
2018
        if file_id is None:
 
2019
            return False
1650
2020
        trans_id = self._transform.trans_id_file_id(file_id)
1651
2021
        try:
1652
2022
            return self._transform._new_executability[trans_id]
1653
2023
        except KeyError:
1654
 
            return self._transform._tree.is_executable(file_id, path)
 
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
2032
 
1656
2033
    def path_content_summary(self, path):
1657
2034
        trans_id = self._path2trans_id(path)
1672
2049
                statval = os.lstat(limbo_name)
1673
2050
                size = statval.st_size
1674
2051
                if not supports_executable():
1675
 
                    executable = None
 
2052
                    executable = False
1676
2053
                else:
1677
2054
                    executable = statval.st_mode & S_IEXEC
1678
2055
            else:
1679
2056
                size = None
1680
2057
                executable = None
1681
2058
            if kind == 'symlink':
1682
 
                link_or_sha1 = os.readlink(limbo_name)
1683
 
        if supports_executable():
1684
 
            executable = tt._new_executability.get(trans_id, executable)
 
2059
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
2060
        executable = tt._new_executability.get(trans_id, executable)
1685
2061
        return kind, size, executable, link_or_sha1
1686
2062
 
1687
2063
    def iter_changes(self, from_tree, include_unchanged=False,
1689
2065
                      require_versioned=True, want_unversioned=False):
1690
2066
        """See InterTree.iter_changes.
1691
2067
 
1692
 
        This implementation does not support include_unchanged, specific_files,
1693
 
        or want_unversioned.  extra_trees, require_versioned, and pb are
1694
 
        ignored.
 
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.
1695
2070
        """
1696
 
        if from_tree is not self._transform._tree:
1697
 
            raise ValueError('from_tree must be transform source tree.')
1698
 
        if include_unchanged:
1699
 
            raise ValueError('include_unchanged is not supported')
1700
 
        if specific_files is not None:
1701
 
            raise ValueError('specific_files is not supported')
 
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)
1702
2080
        if want_unversioned:
1703
2081
            raise ValueError('want_unversioned is not supported')
1704
2082
        return self._transform.iter_changes()
1711
2089
        name = self._transform._limbo_name(trans_id)
1712
2090
        return open(name, 'rb')
1713
2091
 
1714
 
    def get_file_text(self, file_id):
1715
 
        text_file = self.get_file(file_id)
1716
 
        try:
1717
 
            return text_file.read()
1718
 
        finally:
1719
 
            text_file.close()
 
2092
    def get_file_with_stat(self, file_id, path=None):
 
2093
        return self.get_file(file_id, path), None
1720
2094
 
1721
2095
    def annotate_iter(self, file_id,
1722
2096
                      default_revision=_mod_revision.CURRENT_REVISION):
1723
 
        changes = self._changes(file_id)
 
2097
        changes = self._iter_changes_cache.get(file_id)
1724
2098
        if changes is None:
1725
2099
            get_old = True
1726
2100
        else:
1738
2112
            return old_annotation
1739
2113
        if not changed_content:
1740
2114
            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.
1741
2122
        return annotate.reannotate([old_annotation],
1742
2123
                                   self.get_file(file_id).readlines(),
1743
2124
                                   default_revision)
1748
2129
            return self._transform._tree.get_symlink_target(file_id)
1749
2130
        trans_id = self._transform.trans_id_file_id(file_id)
1750
2131
        name = self._transform._limbo_name(trans_id)
1751
 
        return os.readlink(name)
 
2132
        return osutils.readlink(name)
1752
2133
 
1753
2134
    def walkdirs(self, prefix=''):
1754
2135
        pending = [self._transform.root]
1809
2190
        self.transform = transform
1810
2191
 
1811
2192
    def _determine_path(self, trans_id):
1812
 
        if trans_id == self.transform.root:
 
2193
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
1813
2194
            return ""
1814
2195
        name = self.transform.final_name(trans_id)
1815
2196
        parent_id = self.transform.final_parent(trans_id)
1839
2220
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
1840
2221
               delta_from_tree=False):
1841
2222
    """Create working tree for a branch, using a TreeTransform.
1842
 
    
 
2223
 
1843
2224
    This function should be used on empty trees, having a tree root at most.
1844
2225
    (see merge and revert functionality for working with existing trees)
1845
2226
 
1846
2227
    Existing files are handled like so:
1847
 
    
 
2228
 
1848
2229
    - Existing bzrdirs take precedence over creating new items.  They are
1849
2230
      created as '%s.diverted' % name.
1850
2231
    - Otherwise, if the content on disk matches the content we are building,
1952
2333
                    executable = tree.is_executable(file_id, tree_path)
1953
2334
                    if executable:
1954
2335
                        tt.set_executability(executable, trans_id)
1955
 
                    deferred_contents.append((file_id, trans_id))
 
2336
                    trans_data = (trans_id, tree_path)
 
2337
                    deferred_contents.append((file_id, trans_data))
1956
2338
                else:
1957
2339
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1958
2340
                                                          tree)
1989
2371
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1990
2372
                  hardlink):
1991
2373
    total = len(desired_files) + offset
 
2374
    wt = tt._tree
1992
2375
    if accelerator_tree is None:
1993
2376
        new_desired_files = desired_files
1994
2377
    else:
1995
2378
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1996
 
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1997
 
                         in iter if not (c or e[0] != e[1]))
 
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)
1998
2385
        new_desired_files = []
1999
2386
        count = 0
2000
 
        for file_id, trans_id in desired_files:
 
2387
        for file_id, (trans_id, tree_path) in desired_files:
2001
2388
            accelerator_path = unchanged.get(file_id)
2002
2389
            if accelerator_path is None:
2003
 
                new_desired_files.append((file_id, trans_id))
 
2390
                new_desired_files.append((file_id, (trans_id, tree_path)))
2004
2391
                continue
2005
2392
            pb.update('Adding file contents', count + offset, total)
2006
2393
            if hardlink:
2008
2395
                                   trans_id)
2009
2396
            else:
2010
2397
                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))
2011
2402
                try:
2012
2403
                    tt.create_file(contents, trans_id)
2013
2404
                finally:
2014
 
                    contents.close()
 
2405
                    try:
 
2406
                        contents.close()
 
2407
                    except AttributeError:
 
2408
                        # after filtering, contents may no longer be file-like
 
2409
                        pass
2015
2410
            count += 1
2016
2411
        offset += count
2017
 
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
2018
 
                                                 new_desired_files)):
 
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))
2019
2418
        tt.create_file(contents, trans_id)
2020
2419
        pb.update('Adding file contents', count + offset, total)
2021
2420
 
2081
2480
    if kind == 'file':
2082
2481
        contents = tree.get_file(entry.file_id).readlines()
2083
2482
        executable = tree.is_executable(entry.file_id)
2084
 
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
2483
        return tt.new_file(name, parent_id, contents, entry.file_id,
2085
2484
                           executable)
2086
2485
    elif kind in ('directory', 'tree-reference'):
2087
2486
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2088
2487
        if kind == 'tree-reference':
2089
2488
            tt.set_tree_reference(entry.reference_revision, trans_id)
2090
 
        return trans_id 
 
2489
        return trans_id
2091
2490
    elif kind == 'symlink':
2092
2491
        target = tree.get_symlink_target(entry.file_id)
2093
2492
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2095
2494
        raise errors.BadFileKindError(name, kind)
2096
2495
 
2097
2496
 
 
2497
@deprecated_function(deprecated_in((1, 9, 0)))
2098
2498
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2099
 
    """Create new file contents according to an inventory entry."""
 
2499
    """Create new file contents according to an inventory entry.
 
2500
 
 
2501
    DEPRECATED.  Use create_from_tree instead.
 
2502
    """
2100
2503
    if entry.kind == "file":
2101
2504
        if lines is None:
2102
2505
            lines = tree.get_file(entry.file_id).readlines()
2107
2510
        tt.create_directory(trans_id)
2108
2511
 
2109
2512
 
 
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
 
2110
2543
def create_entry_executability(tt, entry, trans_id):
2111
2544
    """Set the executability of a trans_id according to an inventory entry"""
2112
2545
    if entry.kind == "file":
2149
2582
        if entry.kind != working_kind:
2150
2583
            contents_mod, meta_mod = True, False
2151
2584
        else:
2152
 
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2585
            cur_entry._read_tree_state(working_tree.id2path(file_id),
2153
2586
                                       working_tree)
2154
2587
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2155
2588
            cur_entry._forget_tree_state()
2157
2590
 
2158
2591
 
2159
2592
def revert(working_tree, target_tree, filenames, backups=False,
2160
 
           pb=DummyProgress(), change_reporter=None):
 
2593
           pb=None, change_reporter=None):
2161
2594
    """Revert a working tree's contents to those of a target tree."""
2162
2595
    target_tree.lock_read()
 
2596
    pb = ui.ui_factory.nested_progress_bar()
2163
2597
    tt = TreeTransform(working_tree, pb)
2164
2598
    try:
2165
2599
        pp = ProgressPhase("Revert phase", 3, pb)
2184
2618
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2185
2619
                              backups, pp, basis_tree=None,
2186
2620
                              merge_modified=None):
2187
 
    pp.next_phase()
2188
2621
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2189
2622
    try:
2190
2623
        if merge_modified is None:
2194
2627
                                      merge_modified, basis_tree)
2195
2628
    finally:
2196
2629
        child_pb.finished()
2197
 
    pp.next_phase()
2198
2630
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2199
2631
    try:
2200
2632
        raw_conflicts = resolve_conflicts(tt, child_pb,
2293
2725
                    parent_trans = ROOT_PARENT
2294
2726
                else:
2295
2727
                    parent_trans = tt.trans_id_file_id(parent[1])
2296
 
                tt.adjust_path(name[1], parent_trans, trans_id)
 
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
2732
            if executable[0] != executable[1] and kind[1] == "file":
2298
2733
                tt.set_executability(executable[1], trans_id)
2299
 
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2300
 
            deferred_files):
2301
 
            tt.create_file(bytes, trans_id, mode_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()
2302
2751
    finally:
2303
2752
        if basis_tree is not None:
2304
2753
            basis_tree.unlock()
2305
2754
    return merge_modified
2306
2755
 
2307
2756
 
2308
 
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
2757
def resolve_conflicts(tt, pb=None, pass_func=None):
2309
2758
    """Make many conflict-resolution attempts, but die if they fail"""
2310
2759
    if pass_func is None:
2311
2760
        pass_func = conflict_pass
2312
2761
    new_conflicts = set()
 
2762
    pb = ui.ui_factory.nested_progress_bar()
2313
2763
    try:
2314
2764
        for n in range(10):
2315
2765
            pb.update('Resolution pass', n+1, 10)
2319
2769
            new_conflicts.update(pass_func(tt, conflicts))
2320
2770
        raise MalformedTransform(conflicts=conflicts)
2321
2771
    finally:
2322
 
        pb.clear()
 
2772
        pb.finished()
2323
2773
 
2324
2774
 
2325
2775
def conflict_pass(tt, conflicts, path_tree=None):
2344
2794
                existing_file, new_file = conflict[1], conflict[2]
2345
2795
            new_name = tt.final_name(existing_file)+'.moved'
2346
2796
            tt.adjust_path(new_name, final_parent, existing_file)
2347
 
            new_conflicts.add((c_type, 'Moved existing file to', 
 
2797
            new_conflicts.add((c_type, 'Moved existing file to',
2348
2798
                               existing_file, new_file))
2349
2799
        elif c_type == 'parent loop':
2350
2800
            # break the loop by undoing one of the ops that caused the loop
2354
2804
            new_conflicts.add((c_type, 'Cancelled move', cur,
2355
2805
                               tt.final_parent(cur),))
2356
2806
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2357
 
            
 
2807
 
2358
2808
        elif c_type == 'missing parent':
2359
2809
            trans_id = conflict[1]
2360
2810
            try:
2361
2811
                tt.cancel_deletion(trans_id)
2362
 
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2812
                new_conflicts.add(('deleting parent', 'Not deleting',
2363
2813
                                   trans_id))
2364
2814
            except KeyError:
2365
2815
                create = True
2430
2880
        if len(conflict) == 3:
2431
2881
            yield Conflict.factory(c_type, action=action, path=modified_path,
2432
2882
                                     file_id=modified_id)
2433
 
             
 
2883
 
2434
2884
        else:
2435
2885
            conflicting_path = fp.get_path(conflict[3])
2436
2886
            conflicting_id = tt.final_file_id(conflict[3])
2437
2887
            yield Conflict.factory(c_type, action=action, path=modified_path,
2438
 
                                   file_id=modified_id, 
 
2888
                                   file_id=modified_id,
2439
2889
                                   conflict_path=conflicting_path,
2440
2890
                                   conflict_file_id=conflicting_id)
2441
2891