← 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: 2009-03-17 07:05:37 UTC
  • mfrom: (4152.1.2 branch.stacked.streams)
  • Revision ID: pqm@pqm.ubuntu.com-20090317070537-zaud24vjs2szna87
(robertc) Add client-side streaming from stacked branches (over
        bzr:// protocols) when the sort order is compatible with doing
        that. (Robert Collins, Andrew Bennetts)

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
21
20
 
22
21
from bzrlib.lazy_import import lazy_import
23
22
lazy_import(globals(), """
24
23
from bzrlib import (
25
24
    annotate,
26
 
    bencode,
27
25
    bzrdir,
28
 
    commit,
29
26
    delta,
30
27
    errors,
31
28
    inventory,
32
29
    multiparent,
33
30
    osutils,
34
31
    revision as _mod_revision,
35
 
    ui,
36
32
    )
 
33
from bzrlib.util import bencode
37
34
""")
38
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
39
 
                           ReusingTransform, CantMoveRoot,
 
36
                           ReusingTransform, NotVersionedError, CantMoveRoot,
40
37
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
41
38
                           UnableCreateSymlink)
42
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
43
39
from bzrlib.inventory import InventoryEntry
44
40
from bzrlib.osutils import (
45
41
    delete_any,
51
47
    splitpath,
52
48
    supports_executable,
53
49
)
54
 
from bzrlib.progress import ProgressPhase
 
50
from bzrlib.progress import DummyProgress, ProgressPhase
55
51
from bzrlib.symbol_versioning import (
56
52
        deprecated_function,
57
53
        deprecated_in,
79
75
 
80
76
 
81
77
class TreeTransformBase(object):
82
 
    """The base class for TreeTransform and its kin."""
 
78
    """The base class for TreeTransform and TreeTransformBase"""
83
79
 
84
 
    def __init__(self, tree, pb=None,
 
80
    def __init__(self, tree, limbodir, pb=DummyProgress(),
85
81
                 case_sensitive=True):
86
82
        """Constructor.
87
83
 
88
84
        :param tree: The tree that will be transformed, but not necessarily
89
85
            the output tree.
90
 
        :param pb: ignored
 
86
        :param limbodir: A directory where new files can be stored until
 
87
            they are installed in their proper places
 
88
        :param pb: A ProgressBar indicating how much progress is being made
91
89
        :param case_sensitive: If True, the target of the transform is
92
90
            case sensitive, not just case preserving.
93
91
        """
94
92
        object.__init__(self)
95
93
        self._tree = tree
 
94
        self._limbodir = limbodir
 
95
        self._deletiondir = None
96
96
        self._id_number = 0
97
97
        # mapping of trans_id -> new basename
98
98
        self._new_name = {}
100
100
        self._new_parent = {}
101
101
        # mapping of trans_id with new contents -> new file_kind
102
102
        self._new_contents = {}
 
103
        # A mapping of transform ids to their limbo filename
 
104
        self._limbo_files = {}
 
105
        # A mapping of transform ids to a set of the transform ids of children
 
106
        # that their limbo directory has
 
107
        self._limbo_children = {}
 
108
        # Map transform ids to maps of child filename to child transform id
 
109
        self._limbo_children_names = {}
 
110
        # List of transform ids that need to be renamed from limbo into place
 
111
        self._needs_rename = set()
103
112
        # Set of trans_ids whose contents will be removed
104
113
        self._removed_contents = set()
105
114
        # Mapping of trans_id -> new execute-bit value
118
127
        self._tree_path_ids = {}
119
128
        # Mapping trans_id -> path in old tree
120
129
        self._tree_id_paths = {}
 
130
        # Cache of realpath results, to speed up canonical_path
 
131
        self._realpaths = {}
 
132
        # Cache of relpath results, to speed up canonical_path
 
133
        self._relpaths = {}
121
134
        # The trans_id that will be used as the tree root
122
135
        root_id = tree.get_root_id()
123
136
        if root_id is not None:
133
146
        # A counter of how many files have been renamed
134
147
        self.rename_count = 0
135
148
 
136
 
    def finalize(self):
137
 
        """Release the working tree lock, if held.
138
 
 
139
 
        This is required if apply has not been invoked, but can be invoked
140
 
        even after apply.
141
 
        """
142
 
        if self._tree is None:
143
 
            return
144
 
        self._tree.unlock()
145
 
        self._tree = None
146
 
 
147
149
    def __get_root(self):
148
150
        return self._new_root
149
151
 
150
152
    root = property(__get_root)
151
153
 
 
154
    def finalize(self):
 
155
        """Release the working tree lock, if held, clean up limbo dir.
 
156
 
 
157
        This is required if apply has not been invoked, but can be invoked
 
158
        even after apply.
 
159
        """
 
160
        if self._tree is None:
 
161
            return
 
162
        try:
 
163
            entries = [(self._limbo_name(t), t, k) for t, k in
 
164
                       self._new_contents.iteritems()]
 
165
            entries.sort(reverse=True)
 
166
            for path, trans_id, kind in entries:
 
167
                if kind == "directory":
 
168
                    os.rmdir(path)
 
169
                else:
 
170
                    os.unlink(path)
 
171
            try:
 
172
                os.rmdir(self._limbodir)
 
173
            except OSError:
 
174
                # We don't especially care *why* the dir is immortal.
 
175
                raise ImmortalLimbo(self._limbodir)
 
176
            try:
 
177
                if self._deletiondir is not None:
 
178
                    os.rmdir(self._deletiondir)
 
179
            except OSError:
 
180
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
181
        finally:
 
182
            self._tree.unlock()
 
183
            self._tree = None
 
184
 
152
185
    def _assign_id(self):
153
186
        """Produce a new tranform id"""
154
187
        new_id = "new-%s" % self._id_number
164
197
 
165
198
    def adjust_path(self, name, parent, trans_id):
166
199
        """Change the path that is assigned to a transaction id."""
167
 
        if parent is None:
168
 
            raise ValueError("Parent trans-id may not be None")
169
200
        if trans_id == self._new_root:
170
201
            raise CantMoveRoot
 
202
        previous_parent = self._new_parent.get(trans_id)
 
203
        previous_name = self._new_name.get(trans_id)
171
204
        self._new_name[trans_id] = name
172
205
        self._new_parent[trans_id] = parent
 
206
        if parent == ROOT_PARENT:
 
207
            if self._new_root is not None:
 
208
                raise ValueError("Cannot have multiple roots.")
 
209
            self._new_root = trans_id
 
210
        if (trans_id in self._limbo_files and
 
211
            trans_id not in self._needs_rename):
 
212
            self._rename_in_limbo([trans_id])
 
213
            self._limbo_children[previous_parent].remove(trans_id)
 
214
            del self._limbo_children_names[previous_parent][previous_name]
 
215
 
 
216
    def _rename_in_limbo(self, trans_ids):
 
217
        """Fix limbo names so that the right final path is produced.
 
218
 
 
219
        This means we outsmarted ourselves-- we tried to avoid renaming
 
220
        these files later by creating them with their final names in their
 
221
        final parents.  But now the previous name or parent is no longer
 
222
        suitable, so we have to rename them.
 
223
 
 
224
        Even for trans_ids that have no new contents, we must remove their
 
225
        entries from _limbo_files, because they are now stale.
 
226
        """
 
227
        for trans_id in trans_ids:
 
228
            old_path = self._limbo_files.pop(trans_id)
 
229
            if trans_id not in self._new_contents:
 
230
                continue
 
231
            new_path = self._limbo_name(trans_id)
 
232
            os.rename(old_path, new_path)
173
233
 
174
234
    def adjust_root_path(self, name, parent):
175
235
        """Emulate moving the root by moving all children, instead.
203
263
        self.version_file(old_root_file_id, old_root)
204
264
        self.unversion_file(self._new_root)
205
265
 
206
 
    def fixup_new_roots(self):
207
 
        """Reinterpret requests to change the root directory
208
 
 
209
 
        Instead of creating a root directory, or moving an existing directory,
210
 
        all the attributes and children of the new root are applied to the
211
 
        existing root directory.
212
 
 
213
 
        This means that the old root trans-id becomes obsolete, so it is
214
 
        recommended only to invoke this after the root trans-id has become
215
 
        irrelevant.
216
 
        """
217
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
218
 
                     ROOT_PARENT]
219
 
        if len(new_roots) < 1:
220
 
            return
221
 
        if len(new_roots) != 1:
222
 
            raise ValueError('A tree cannot have two roots!')
223
 
        if self._new_root is None:
224
 
            self._new_root = new_roots[0]
225
 
            return
226
 
        old_new_root = new_roots[0]
227
 
        # TODO: What to do if a old_new_root is present, but self._new_root is
228
 
        #       not listed as being removed? This code explicitly unversions
229
 
        #       the old root and versions it with the new file_id. Though that
230
 
        #       seems like an incomplete delta
231
 
 
232
 
        # unversion the new root's directory.
233
 
        file_id = self.final_file_id(old_new_root)
234
 
        if old_new_root in self._new_id:
235
 
            self.cancel_versioning(old_new_root)
236
 
        else:
237
 
            self.unversion_file(old_new_root)
238
 
        # if, at this stage, root still has an old file_id, zap it so we can
239
 
        # stick a new one in.
240
 
        if (self.tree_file_id(self._new_root) is not None and
241
 
            self._new_root not in self._removed_id):
242
 
            self.unversion_file(self._new_root)
243
 
        self.version_file(file_id, self._new_root)
244
 
 
245
 
        # Now move children of new root into old root directory.
246
 
        # Ensure all children are registered with the transaction, but don't
247
 
        # use directly-- some tree children have new parents
248
 
        list(self.iter_tree_children(old_new_root))
249
 
        # Move all children of new root into old root directory.
250
 
        for child in self.by_parent().get(old_new_root, []):
251
 
            self.adjust_path(self.final_name(child), self._new_root, child)
252
 
 
253
 
        # Ensure old_new_root has no directory.
254
 
        if old_new_root in self._new_contents:
255
 
            self.cancel_creation(old_new_root)
256
 
        else:
257
 
            self.delete_contents(old_new_root)
258
 
 
259
 
        # prevent deletion of root directory.
260
 
        if self._new_root in self._removed_contents:
261
 
            self.cancel_deletion(self._new_root)
262
 
 
263
 
        # destroy path info for old_new_root.
264
 
        del self._new_parent[old_new_root]
265
 
        del self._new_name[old_new_root]
266
 
 
267
266
    def trans_id_tree_file_id(self, inventory_id):
268
267
        """Determine the transaction id of a working tree file.
269
268
 
298
297
            else:
299
298
                return self.trans_id_tree_file_id(file_id)
300
299
 
 
300
    def canonical_path(self, path):
 
301
        """Get the canonical tree-relative path"""
 
302
        # don't follow final symlinks
 
303
        abs = self._tree.abspath(path)
 
304
        if abs in self._relpaths:
 
305
            return self._relpaths[abs]
 
306
        dirname, basename = os.path.split(abs)
 
307
        if dirname not in self._realpaths:
 
308
            self._realpaths[dirname] = os.path.realpath(dirname)
 
309
        dirname = self._realpaths[dirname]
 
310
        abs = pathjoin(dirname, basename)
 
311
        if dirname in self._relpaths:
 
312
            relpath = pathjoin(self._relpaths[dirname], basename)
 
313
            relpath = relpath.rstrip('/\\')
 
314
        else:
 
315
            relpath = self._tree.relpath(abs)
 
316
        self._relpaths[abs] = relpath
 
317
        return relpath
 
318
 
301
319
    def trans_id_tree_path(self, path):
302
320
        """Determine (and maybe set) the transaction ID for a tree path."""
303
321
        path = self.canonical_path(path)
313
331
            return ROOT_PARENT
314
332
        return self.trans_id_tree_path(os.path.dirname(path))
315
333
 
 
334
    def create_file(self, contents, trans_id, mode_id=None):
 
335
        """Schedule creation of a new file.
 
336
 
 
337
        See also new_file.
 
338
 
 
339
        Contents is an iterator of strings, all of which will be written
 
340
        to the target destination.
 
341
 
 
342
        New file takes the permissions of any existing file with that id,
 
343
        unless mode_id is specified.
 
344
        """
 
345
        name = self._limbo_name(trans_id)
 
346
        f = open(name, 'wb')
 
347
        try:
 
348
            try:
 
349
                unique_add(self._new_contents, trans_id, 'file')
 
350
            except:
 
351
                # Clean up the file, it never got registered so
 
352
                # TreeTransform.finalize() won't clean it up.
 
353
                f.close()
 
354
                os.unlink(name)
 
355
                raise
 
356
 
 
357
            f.writelines(contents)
 
358
        finally:
 
359
            f.close()
 
360
        self._set_mode(trans_id, mode_id, S_ISREG)
 
361
 
 
362
    def _set_mode(self, trans_id, mode_id, typefunc):
 
363
        """Set the mode of new file contents.
 
364
        The mode_id is the existing file to get the mode from (often the same
 
365
        as trans_id).  The operation is only performed if there's a mode match
 
366
        according to typefunc.
 
367
        """
 
368
        if mode_id is None:
 
369
            mode_id = trans_id
 
370
        try:
 
371
            old_path = self._tree_id_paths[mode_id]
 
372
        except KeyError:
 
373
            return
 
374
        try:
 
375
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
376
        except OSError, e:
 
377
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
378
                # Either old_path doesn't exist, or the parent of the
 
379
                # target is not a directory (but will be one eventually)
 
380
                # Either way, we know it doesn't exist *right now*
 
381
                # See also bug #248448
 
382
                return
 
383
            else:
 
384
                raise
 
385
        if typefunc(mode):
 
386
            os.chmod(self._limbo_name(trans_id), mode)
 
387
 
 
388
    def create_hardlink(self, path, trans_id):
 
389
        """Schedule creation of a hard link"""
 
390
        name = self._limbo_name(trans_id)
 
391
        try:
 
392
            os.link(path, name)
 
393
        except OSError, e:
 
394
            if e.errno != errno.EPERM:
 
395
                raise
 
396
            raise errors.HardLinkNotSupported(path)
 
397
        try:
 
398
            unique_add(self._new_contents, trans_id, 'file')
 
399
        except:
 
400
            # Clean up the file, it never got registered so
 
401
            # TreeTransform.finalize() won't clean it up.
 
402
            os.unlink(name)
 
403
            raise
 
404
 
 
405
    def create_directory(self, trans_id):
 
406
        """Schedule creation of a new directory.
 
407
 
 
408
        See also new_directory.
 
409
        """
 
410
        os.mkdir(self._limbo_name(trans_id))
 
411
        unique_add(self._new_contents, trans_id, 'directory')
 
412
 
 
413
    def create_symlink(self, target, trans_id):
 
414
        """Schedule creation of a new symbolic link.
 
415
 
 
416
        target is a bytestring.
 
417
        See also new_symlink.
 
418
        """
 
419
        if has_symlinks():
 
420
            os.symlink(target, self._limbo_name(trans_id))
 
421
            unique_add(self._new_contents, trans_id, 'symlink')
 
422
        else:
 
423
            try:
 
424
                path = FinalPaths(self).get_path(trans_id)
 
425
            except KeyError:
 
426
                path = None
 
427
            raise UnableCreateSymlink(path=path)
 
428
 
 
429
    def cancel_creation(self, trans_id):
 
430
        """Cancel the creation of new file contents."""
 
431
        del self._new_contents[trans_id]
 
432
        children = self._limbo_children.get(trans_id)
 
433
        # if this is a limbo directory with children, move them before removing
 
434
        # the directory
 
435
        if children is not None:
 
436
            self._rename_in_limbo(children)
 
437
            del self._limbo_children[trans_id]
 
438
            del self._limbo_children_names[trans_id]
 
439
        delete_any(self._limbo_name(trans_id))
 
440
 
316
441
    def delete_contents(self, trans_id):
317
442
        """Schedule the contents of a path entry for deletion"""
318
 
        # Ensure that the object exists in the WorkingTree, this will raise an
319
 
        # exception if there is a problem
320
443
        self.tree_kind(trans_id)
321
444
        self._removed_contents.add(trans_id)
322
445
 
394
517
        new_ids.update(changed_kind)
395
518
        return sorted(FinalPaths(self).get_paths(new_ids))
396
519
 
 
520
    def tree_kind(self, trans_id):
 
521
        """Determine the file kind in the working tree.
 
522
 
 
523
        Raises NoSuchFile if the file does not exist
 
524
        """
 
525
        path = self._tree_id_paths.get(trans_id)
 
526
        if path is None:
 
527
            raise NoSuchFile(None)
 
528
        try:
 
529
            return file_kind(self._tree.abspath(path))
 
530
        except OSError, e:
 
531
            if e.errno != errno.ENOENT:
 
532
                raise
 
533
            else:
 
534
                raise NoSuchFile(path)
 
535
 
397
536
    def final_kind(self, trans_id):
398
537
        """Determine the final file kind, after any changes applied.
399
538
 
506
645
        conflicts.extend(self._overwrite_conflicts())
507
646
        return conflicts
508
647
 
509
 
    def _check_malformed(self):
510
 
        conflicts = self.find_conflicts()
511
 
        if len(conflicts) != 0:
512
 
            raise MalformedTransform(conflicts=conflicts)
513
 
 
514
648
    def _add_tree_children(self):
515
649
        """Add all the children of all active parents to the known paths.
516
650
 
532
666
            # ensure that all children are registered with the transaction
533
667
            list(self.iter_tree_children(parent_id))
534
668
 
 
669
    def iter_tree_children(self, parent_id):
 
670
        """Iterate through the entry's tree children, if any"""
 
671
        try:
 
672
            path = self._tree_id_paths[parent_id]
 
673
        except KeyError:
 
674
            return
 
675
        try:
 
676
            children = os.listdir(self._tree.abspath(path))
 
677
        except OSError, e:
 
678
            if not (osutils._is_error_enotdir(e)
 
679
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
680
                raise
 
681
            return
 
682
 
 
683
        for child in children:
 
684
            childpath = joinpath(path, child)
 
685
            if self._tree.is_control_filename(childpath):
 
686
                continue
 
687
            yield self.trans_id_tree_path(childpath)
 
688
 
535
689
    def has_named_child(self, by_parent, parent_id, name):
536
690
        try:
537
691
            children = by_parent[parent_id]
712
866
            return True
713
867
        return False
714
868
 
 
869
    def _limbo_name(self, trans_id):
 
870
        """Generate the limbo name of a file"""
 
871
        limbo_name = self._limbo_files.get(trans_id)
 
872
        if limbo_name is not None:
 
873
            return limbo_name
 
874
        parent = self._new_parent.get(trans_id)
 
875
        # if the parent directory is already in limbo (e.g. when building a
 
876
        # tree), choose a limbo name inside the parent, to reduce further
 
877
        # renames.
 
878
        use_direct_path = False
 
879
        if self._new_contents.get(parent) == 'directory':
 
880
            filename = self._new_name.get(trans_id)
 
881
            if filename is not None:
 
882
                if parent not in self._limbo_children:
 
883
                    self._limbo_children[parent] = set()
 
884
                    self._limbo_children_names[parent] = {}
 
885
                    use_direct_path = True
 
886
                # the direct path can only be used if no other file has
 
887
                # already taken this pathname, i.e. if the name is unused, or
 
888
                # if it is already associated with this trans_id.
 
889
                elif self._case_sensitive_target:
 
890
                    if (self._limbo_children_names[parent].get(filename)
 
891
                        in (trans_id, None)):
 
892
                        use_direct_path = True
 
893
                else:
 
894
                    for l_filename, l_trans_id in\
 
895
                        self._limbo_children_names[parent].iteritems():
 
896
                        if l_trans_id == trans_id:
 
897
                            continue
 
898
                        if l_filename.lower() == filename.lower():
 
899
                            break
 
900
                    else:
 
901
                        use_direct_path = True
 
902
 
 
903
        if use_direct_path:
 
904
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
905
            self._limbo_children[parent].add(trans_id)
 
906
            self._limbo_children_names[parent][filename] = trans_id
 
907
        else:
 
908
            limbo_name = pathjoin(self._limbodir, trans_id)
 
909
            self._needs_rename.add(trans_id)
 
910
        self._limbo_files[trans_id] = limbo_name
 
911
        return limbo_name
 
912
 
715
913
    def _set_executability(self, path, trans_id):
716
914
        """Set the executability of versioned files """
717
915
        if supports_executable():
923
1121
    def get_preview_tree(self):
924
1122
        """Return a tree representing the result of the transform.
925
1123
 
926
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
927
 
        it.
 
1124
        This tree only supports the subset of Tree functionality required
 
1125
        by show_diff_trees.  It must only be compared to tt._tree.
928
1126
        """
929
1127
        return _PreviewTree(self)
930
1128
 
931
 
    def commit(self, branch, message, merge_parents=None, strict=False,
932
 
               timestamp=None, timezone=None, committer=None, authors=None,
933
 
               revprops=None, revision_id=None):
934
 
        """Commit the result of this TreeTransform to a branch.
935
 
 
936
 
        :param branch: The branch to commit to.
937
 
        :param message: The message to attach to the commit.
938
 
        :param merge_parents: Additional parent revision-ids specified by
939
 
            pending merges.
940
 
        :param strict: If True, abort the commit if there are unversioned
941
 
            files.
942
 
        :param timestamp: if not None, seconds-since-epoch for the time and
943
 
            date.  (May be a float.)
944
 
        :param timezone: Optional timezone for timestamp, as an offset in
945
 
            seconds.
946
 
        :param committer: Optional committer in email-id format.
947
 
            (e.g. "J Random Hacker <jrandom@example.com>")
948
 
        :param authors: Optional list of authors in email-id format.
949
 
        :param revprops: Optional dictionary of revision properties.
950
 
        :param revision_id: Optional revision id.  (Specifying a revision-id
951
 
            may reduce performance for some non-native formats.)
952
 
        :return: The revision_id of the revision committed.
953
 
        """
954
 
        self._check_malformed()
955
 
        if strict:
956
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
957
 
            for trans_id in unversioned:
958
 
                if self.final_file_id(trans_id) is None:
959
 
                    raise errors.StrictCommitFailed()
960
 
 
961
 
        revno, last_rev_id = branch.last_revision_info()
962
 
        if last_rev_id == _mod_revision.NULL_REVISION:
963
 
            if merge_parents is not None:
964
 
                raise ValueError('Cannot supply merge parents for first'
965
 
                                 ' commit.')
966
 
            parent_ids = []
967
 
        else:
968
 
            parent_ids = [last_rev_id]
969
 
            if merge_parents is not None:
970
 
                parent_ids.extend(merge_parents)
971
 
        if self._tree.get_revision_id() != last_rev_id:
972
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
973
 
                             self._tree.get_revision_id())
974
 
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
975
 
        builder = branch.get_commit_builder(parent_ids,
976
 
                                            timestamp=timestamp,
977
 
                                            timezone=timezone,
978
 
                                            committer=committer,
979
 
                                            revprops=revprops,
980
 
                                            revision_id=revision_id)
981
 
        preview = self.get_preview_tree()
982
 
        list(builder.record_iter_changes(preview, last_rev_id,
983
 
                                         self.iter_changes()))
984
 
        builder.finish_inventory()
985
 
        revision_id = builder.commit(message)
986
 
        branch.set_last_revision_info(revno + 1, revision_id)
987
 
        return revision_id
988
 
 
989
1129
    def _text_parent(self, trans_id):
990
1130
        file_id = self.tree_file_id(trans_id)
991
1131
        try:
1035
1175
                                      (('attribs',),))
1036
1176
        for trans_id, kind in self._new_contents.items():
1037
1177
            if kind == 'file':
1038
 
                lines = osutils.chunks_to_lines(
1039
 
                    self._read_file_chunks(trans_id))
 
1178
                cur_file = open(self._limbo_name(trans_id), 'rb')
 
1179
                try:
 
1180
                    lines = osutils.chunks_to_lines(cur_file.readlines())
 
1181
                finally:
 
1182
                    cur_file.close()
1040
1183
                parents = self._get_parents_lines(trans_id)
1041
1184
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1042
1185
                content = ''.join(mpdiff.to_patch())
1043
1186
            if kind == 'directory':
1044
1187
                content = ''
1045
1188
            if kind == 'symlink':
1046
 
                content = self._read_symlink_target(trans_id)
 
1189
                content = os.readlink(self._limbo_name(trans_id))
1047
1190
            yield serializer.bytes_record(content, ((trans_id, kind),))
1048
1191
 
 
1192
 
1049
1193
    def deserialize(self, records):
1050
1194
        """Deserialize a stored TreeTransform.
1051
1195
 
1082
1226
                self.create_symlink(content.decode('utf-8'), trans_id)
1083
1227
 
1084
1228
 
1085
 
class DiskTreeTransform(TreeTransformBase):
1086
 
    """Tree transform storing its contents on disk."""
1087
 
 
1088
 
    def __init__(self, tree, limbodir, pb=None,
1089
 
                 case_sensitive=True):
1090
 
        """Constructor.
1091
 
        :param tree: The tree that will be transformed, but not necessarily
1092
 
            the output tree.
1093
 
        :param limbodir: A directory where new files can be stored until
1094
 
            they are installed in their proper places
1095
 
        :param pb: ignored
1096
 
        :param case_sensitive: If True, the target of the transform is
1097
 
            case sensitive, not just case preserving.
1098
 
        """
1099
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1100
 
        self._limbodir = limbodir
1101
 
        self._deletiondir = None
1102
 
        # A mapping of transform ids to their limbo filename
1103
 
        self._limbo_files = {}
1104
 
        # A mapping of transform ids to a set of the transform ids of children
1105
 
        # that their limbo directory has
1106
 
        self._limbo_children = {}
1107
 
        # Map transform ids to maps of child filename to child transform id
1108
 
        self._limbo_children_names = {}
1109
 
        # List of transform ids that need to be renamed from limbo into place
1110
 
        self._needs_rename = set()
1111
 
        self._creation_mtime = None
1112
 
 
1113
 
    def finalize(self):
1114
 
        """Release the working tree lock, if held, clean up limbo dir.
1115
 
 
1116
 
        This is required if apply has not been invoked, but can be invoked
1117
 
        even after apply.
1118
 
        """
1119
 
        if self._tree is None:
1120
 
            return
1121
 
        try:
1122
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1123
 
                       self._new_contents.iteritems()]
1124
 
            entries.sort(reverse=True)
1125
 
            for path, trans_id, kind in entries:
1126
 
                delete_any(path)
1127
 
            try:
1128
 
                delete_any(self._limbodir)
1129
 
            except OSError:
1130
 
                # We don't especially care *why* the dir is immortal.
1131
 
                raise ImmortalLimbo(self._limbodir)
1132
 
            try:
1133
 
                if self._deletiondir is not None:
1134
 
                    delete_any(self._deletiondir)
1135
 
            except OSError:
1136
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1137
 
        finally:
1138
 
            TreeTransformBase.finalize(self)
1139
 
 
1140
 
    def _limbo_name(self, trans_id):
1141
 
        """Generate the limbo name of a file"""
1142
 
        limbo_name = self._limbo_files.get(trans_id)
1143
 
        if limbo_name is None:
1144
 
            limbo_name = self._generate_limbo_path(trans_id)
1145
 
            self._limbo_files[trans_id] = limbo_name
1146
 
        return limbo_name
1147
 
 
1148
 
    def _generate_limbo_path(self, trans_id):
1149
 
        """Generate a limbo path using the trans_id as the relative path.
1150
 
 
1151
 
        This is suitable as a fallback, and when the transform should not be
1152
 
        sensitive to the path encoding of the limbo directory.
1153
 
        """
1154
 
        self._needs_rename.add(trans_id)
1155
 
        return pathjoin(self._limbodir, trans_id)
1156
 
 
1157
 
    def adjust_path(self, name, parent, trans_id):
1158
 
        previous_parent = self._new_parent.get(trans_id)
1159
 
        previous_name = self._new_name.get(trans_id)
1160
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1161
 
        if (trans_id in self._limbo_files and
1162
 
            trans_id not in self._needs_rename):
1163
 
            self._rename_in_limbo([trans_id])
1164
 
            if previous_parent != parent:
1165
 
                self._limbo_children[previous_parent].remove(trans_id)
1166
 
            if previous_parent != parent or previous_name != name:
1167
 
                del self._limbo_children_names[previous_parent][previous_name]
1168
 
 
1169
 
    def _rename_in_limbo(self, trans_ids):
1170
 
        """Fix limbo names so that the right final path is produced.
1171
 
 
1172
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1173
 
        these files later by creating them with their final names in their
1174
 
        final parents.  But now the previous name or parent is no longer
1175
 
        suitable, so we have to rename them.
1176
 
 
1177
 
        Even for trans_ids that have no new contents, we must remove their
1178
 
        entries from _limbo_files, because they are now stale.
1179
 
        """
1180
 
        for trans_id in trans_ids:
1181
 
            old_path = self._limbo_files.pop(trans_id)
1182
 
            if trans_id not in self._new_contents:
1183
 
                continue
1184
 
            new_path = self._limbo_name(trans_id)
1185
 
            os.rename(old_path, new_path)
1186
 
            for descendant in self._limbo_descendants(trans_id):
1187
 
                desc_path = self._limbo_files[descendant]
1188
 
                desc_path = new_path + desc_path[len(old_path):]
1189
 
                self._limbo_files[descendant] = desc_path
1190
 
 
1191
 
    def _limbo_descendants(self, trans_id):
1192
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1193
 
        descendants = set(self._limbo_children.get(trans_id, []))
1194
 
        for descendant in list(descendants):
1195
 
            descendants.update(self._limbo_descendants(descendant))
1196
 
        return descendants
1197
 
 
1198
 
    def create_file(self, contents, trans_id, mode_id=None):
1199
 
        """Schedule creation of a new file.
1200
 
 
1201
 
        See also new_file.
1202
 
 
1203
 
        Contents is an iterator of strings, all of which will be written
1204
 
        to the target destination.
1205
 
 
1206
 
        New file takes the permissions of any existing file with that id,
1207
 
        unless mode_id is specified.
1208
 
        """
1209
 
        name = self._limbo_name(trans_id)
1210
 
        f = open(name, 'wb')
1211
 
        try:
1212
 
            try:
1213
 
                unique_add(self._new_contents, trans_id, 'file')
1214
 
            except:
1215
 
                # Clean up the file, it never got registered so
1216
 
                # TreeTransform.finalize() won't clean it up.
1217
 
                f.close()
1218
 
                os.unlink(name)
1219
 
                raise
1220
 
 
1221
 
            f.writelines(contents)
1222
 
        finally:
1223
 
            f.close()
1224
 
        self._set_mtime(name)
1225
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1226
 
 
1227
 
    def _read_file_chunks(self, trans_id):
1228
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1229
 
        try:
1230
 
            return cur_file.readlines()
1231
 
        finally:
1232
 
            cur_file.close()
1233
 
 
1234
 
    def _read_symlink_target(self, trans_id):
1235
 
        return os.readlink(self._limbo_name(trans_id))
1236
 
 
1237
 
    def _set_mtime(self, path):
1238
 
        """All files that are created get the same mtime.
1239
 
 
1240
 
        This time is set by the first object to be created.
1241
 
        """
1242
 
        if self._creation_mtime is None:
1243
 
            self._creation_mtime = time.time()
1244
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1245
 
 
1246
 
    def create_hardlink(self, path, trans_id):
1247
 
        """Schedule creation of a hard link"""
1248
 
        name = self._limbo_name(trans_id)
1249
 
        try:
1250
 
            os.link(path, name)
1251
 
        except OSError, e:
1252
 
            if e.errno != errno.EPERM:
1253
 
                raise
1254
 
            raise errors.HardLinkNotSupported(path)
1255
 
        try:
1256
 
            unique_add(self._new_contents, trans_id, 'file')
1257
 
        except:
1258
 
            # Clean up the file, it never got registered so
1259
 
            # TreeTransform.finalize() won't clean it up.
1260
 
            os.unlink(name)
1261
 
            raise
1262
 
 
1263
 
    def create_directory(self, trans_id):
1264
 
        """Schedule creation of a new directory.
1265
 
 
1266
 
        See also new_directory.
1267
 
        """
1268
 
        os.mkdir(self._limbo_name(trans_id))
1269
 
        unique_add(self._new_contents, trans_id, 'directory')
1270
 
 
1271
 
    def create_symlink(self, target, trans_id):
1272
 
        """Schedule creation of a new symbolic link.
1273
 
 
1274
 
        target is a bytestring.
1275
 
        See also new_symlink.
1276
 
        """
1277
 
        if has_symlinks():
1278
 
            os.symlink(target, self._limbo_name(trans_id))
1279
 
            unique_add(self._new_contents, trans_id, 'symlink')
1280
 
        else:
1281
 
            try:
1282
 
                path = FinalPaths(self).get_path(trans_id)
1283
 
            except KeyError:
1284
 
                path = None
1285
 
            raise UnableCreateSymlink(path=path)
1286
 
 
1287
 
    def cancel_creation(self, trans_id):
1288
 
        """Cancel the creation of new file contents."""
1289
 
        del self._new_contents[trans_id]
1290
 
        children = self._limbo_children.get(trans_id)
1291
 
        # if this is a limbo directory with children, move them before removing
1292
 
        # the directory
1293
 
        if children is not None:
1294
 
            self._rename_in_limbo(children)
1295
 
            del self._limbo_children[trans_id]
1296
 
            del self._limbo_children_names[trans_id]
1297
 
        delete_any(self._limbo_name(trans_id))
1298
 
 
1299
 
 
1300
 
class TreeTransform(DiskTreeTransform):
 
1229
class TreeTransform(TreeTransformBase):
1301
1230
    """Represent a tree transformation.
1302
1231
 
1303
1232
    This object is designed to support incremental generation of the transform,
1362
1291
    FileMover does not delete files until it is sure that a rollback will not
1363
1292
    happen.
1364
1293
    """
1365
 
    def __init__(self, tree, pb=None):
 
1294
    def __init__(self, tree, pb=DummyProgress()):
1366
1295
        """Note: a tree_write lock is taken on the tree.
1367
1296
 
1368
1297
        Use TreeTransform.finalize() to release the lock (can be omitted if
1389
1318
            tree.unlock()
1390
1319
            raise
1391
1320
 
1392
 
        # Cache of realpath results, to speed up canonical_path
1393
 
        self._realpaths = {}
1394
 
        # Cache of relpath results, to speed up canonical_path
1395
 
        self._relpaths = {}
1396
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1321
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1397
1322
                                   tree.case_sensitive)
1398
1323
        self._deletiondir = deletiondir
1399
1324
 
1400
 
    def canonical_path(self, path):
1401
 
        """Get the canonical tree-relative path"""
1402
 
        # don't follow final symlinks
1403
 
        abs = self._tree.abspath(path)
1404
 
        if abs in self._relpaths:
1405
 
            return self._relpaths[abs]
1406
 
        dirname, basename = os.path.split(abs)
1407
 
        if dirname not in self._realpaths:
1408
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1409
 
        dirname = self._realpaths[dirname]
1410
 
        abs = pathjoin(dirname, basename)
1411
 
        if dirname in self._relpaths:
1412
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1413
 
            relpath = relpath.rstrip('/\\')
1414
 
        else:
1415
 
            relpath = self._tree.relpath(abs)
1416
 
        self._relpaths[abs] = relpath
1417
 
        return relpath
1418
 
 
1419
 
    def tree_kind(self, trans_id):
1420
 
        """Determine the file kind in the working tree.
1421
 
 
1422
 
        Raises NoSuchFile if the file does not exist
1423
 
        """
1424
 
        path = self._tree_id_paths.get(trans_id)
1425
 
        if path is None:
1426
 
            raise NoSuchFile(None)
1427
 
        try:
1428
 
            return file_kind(self._tree.abspath(path))
1429
 
        except OSError, e:
1430
 
            if e.errno != errno.ENOENT:
1431
 
                raise
1432
 
            else:
1433
 
                raise NoSuchFile(path)
1434
 
 
1435
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1436
 
        """Set the mode of new file contents.
1437
 
        The mode_id is the existing file to get the mode from (often the same
1438
 
        as trans_id).  The operation is only performed if there's a mode match
1439
 
        according to typefunc.
1440
 
        """
1441
 
        if mode_id is None:
1442
 
            mode_id = trans_id
1443
 
        try:
1444
 
            old_path = self._tree_id_paths[mode_id]
1445
 
        except KeyError:
1446
 
            return
1447
 
        try:
1448
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1449
 
        except OSError, e:
1450
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1451
 
                # Either old_path doesn't exist, or the parent of the
1452
 
                # target is not a directory (but will be one eventually)
1453
 
                # Either way, we know it doesn't exist *right now*
1454
 
                # See also bug #248448
1455
 
                return
1456
 
            else:
1457
 
                raise
1458
 
        if typefunc(mode):
1459
 
            os.chmod(self._limbo_name(trans_id), mode)
1460
 
 
1461
 
    def iter_tree_children(self, parent_id):
1462
 
        """Iterate through the entry's tree children, if any"""
1463
 
        try:
1464
 
            path = self._tree_id_paths[parent_id]
1465
 
        except KeyError:
1466
 
            return
1467
 
        try:
1468
 
            children = os.listdir(self._tree.abspath(path))
1469
 
        except OSError, e:
1470
 
            if not (osutils._is_error_enotdir(e)
1471
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1472
 
                raise
1473
 
            return
1474
 
 
1475
 
        for child in children:
1476
 
            childpath = joinpath(path, child)
1477
 
            if self._tree.is_control_filename(childpath):
1478
 
                continue
1479
 
            yield self.trans_id_tree_path(childpath)
1480
 
 
1481
 
    def _generate_limbo_path(self, trans_id):
1482
 
        """Generate a limbo path using the final path if possible.
1483
 
 
1484
 
        This optimizes the performance of applying the tree transform by
1485
 
        avoiding renames.  These renames can be avoided only when the parent
1486
 
        directory is already scheduled for creation.
1487
 
 
1488
 
        If the final path cannot be used, falls back to using the trans_id as
1489
 
        the relpath.
1490
 
        """
1491
 
        parent = self._new_parent.get(trans_id)
1492
 
        # if the parent directory is already in limbo (e.g. when building a
1493
 
        # tree), choose a limbo name inside the parent, to reduce further
1494
 
        # renames.
1495
 
        use_direct_path = False
1496
 
        if self._new_contents.get(parent) == 'directory':
1497
 
            filename = self._new_name.get(trans_id)
1498
 
            if filename is not None:
1499
 
                if parent not in self._limbo_children:
1500
 
                    self._limbo_children[parent] = set()
1501
 
                    self._limbo_children_names[parent] = {}
1502
 
                    use_direct_path = True
1503
 
                # the direct path can only be used if no other file has
1504
 
                # already taken this pathname, i.e. if the name is unused, or
1505
 
                # if it is already associated with this trans_id.
1506
 
                elif self._case_sensitive_target:
1507
 
                    if (self._limbo_children_names[parent].get(filename)
1508
 
                        in (trans_id, None)):
1509
 
                        use_direct_path = True
1510
 
                else:
1511
 
                    for l_filename, l_trans_id in\
1512
 
                        self._limbo_children_names[parent].iteritems():
1513
 
                        if l_trans_id == trans_id:
1514
 
                            continue
1515
 
                        if l_filename.lower() == filename.lower():
1516
 
                            break
1517
 
                    else:
1518
 
                        use_direct_path = True
1519
 
 
1520
 
        if not use_direct_path:
1521
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1522
 
 
1523
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1524
 
        self._limbo_children[parent].add(trans_id)
1525
 
        self._limbo_children_names[parent][filename] = trans_id
1526
 
        return limbo_name
1527
 
 
1528
 
 
1529
1325
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1530
1326
        """Apply all changes to the inventory and filesystem.
1531
1327
 
1541
1337
        :param _mover: Supply an alternate FileMover, for testing
1542
1338
        """
1543
1339
        if not no_conflicts:
1544
 
            self._check_malformed()
 
1340
            conflicts = self.find_conflicts()
 
1341
            if len(conflicts) != 0:
 
1342
                raise MalformedTransform(conflicts=conflicts)
1545
1343
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1546
1344
        try:
1547
1345
            if precomputed_delta is None:
1651
1449
                child_pb.update('removing file', num, len(tree_paths))
1652
1450
                full_path = self._tree.abspath(path)
1653
1451
                if trans_id in self._removed_contents:
1654
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1655
 
                    mover.pre_delete(full_path, delete_path)
1656
 
                elif (trans_id in self._new_name
1657
 
                      or trans_id in self._new_parent):
 
1452
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1453
                                     trans_id))
 
1454
                elif trans_id in self._new_name or trans_id in \
 
1455
                    self._new_parent:
1658
1456
                    try:
1659
1457
                        mover.rename(full_path, self._limbo_name(trans_id))
1660
 
                    except errors.TransformRenameFailed, e:
 
1458
                    except OSError, e:
1661
1459
                        if e.errno != errno.ENOENT:
1662
1460
                            raise
1663
1461
                    else:
1688
1486
                if trans_id in self._needs_rename:
1689
1487
                    try:
1690
1488
                        mover.rename(self._limbo_name(trans_id), full_path)
1691
 
                    except errors.TransformRenameFailed, e:
 
1489
                    except OSError, e:
1692
1490
                        # We may be renaming a dangling inventory id
1693
1491
                        if e.errno != errno.ENOENT:
1694
1492
                            raise
1706
1504
        return modified_paths
1707
1505
 
1708
1506
 
1709
 
class TransformPreview(DiskTreeTransform):
 
1507
class TransformPreview(TreeTransformBase):
1710
1508
    """A TreeTransform for generating preview trees.
1711
1509
 
1712
1510
    Unlike TreeTransform, this version works when the input tree is a
1714
1512
    unversioned files in the input tree.
1715
1513
    """
1716
1514
 
1717
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1515
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1718
1516
        tree.lock_read()
1719
1517
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1720
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1518
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1721
1519
 
1722
1520
    def canonical_path(self, path):
1723
1521
        return path
1765
1563
        self._all_children_cache = {}
1766
1564
        self._path2trans_id_cache = {}
1767
1565
        self._final_name_cache = {}
1768
 
        self._iter_changes_cache = dict((c[0], c) for c in
1769
 
                                        self._transform.iter_changes())
 
1566
 
 
1567
    def _changes(self, file_id):
 
1568
        for changes in self._transform.iter_changes():
 
1569
            if changes[0] == file_id:
 
1570
                return changes
1770
1571
 
1771
1572
    def _content_change(self, file_id):
1772
1573
        """Return True if the content of this file changed"""
1773
 
        changes = self._iter_changes_cache.get(file_id)
 
1574
        changes = self._changes(file_id)
1774
1575
        # changes[2] is true if the file content changed.  See
1775
1576
        # InterTree.iter_changes.
1776
1577
        return (changes is not None and changes[2])
1792
1593
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1793
1594
                       self._iter_parent_trees()]
1794
1595
        vf.add_lines((file_id, tree_revision), parent_keys,
1795
 
                     self.get_file_lines(file_id))
 
1596
                     self.get_file(file_id).readlines())
1796
1597
        repo = self._get_repository()
1797
1598
        base_vf = repo.texts
1798
1599
        if base_vf not in vf.fallback_versionedfiles:
1820
1621
            executable = self.is_executable(file_id, path)
1821
1622
        return kind, executable, None
1822
1623
 
1823
 
    def is_locked(self):
1824
 
        return False
1825
 
 
1826
1624
    def lock_read(self):
1827
1625
        # Perhaps in theory, this should lock the TreeTransform?
1828
 
        return self
 
1626
        pass
1829
1627
 
1830
1628
    def unlock(self):
1831
1629
        pass
1848
1646
    def __iter__(self):
1849
1647
        return iter(self.all_file_ids())
1850
1648
 
1851
 
    def _has_id(self, file_id, fallback_check):
 
1649
    def has_id(self, file_id):
1852
1650
        if file_id in self._transform._r_new_id:
1853
1651
            return True
1854
1652
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1855
1653
            trans_id in self._transform._removed_id]):
1856
1654
            return False
1857
1655
        else:
1858
 
            return fallback_check(file_id)
1859
 
 
1860
 
    def has_id(self, file_id):
1861
 
        return self._has_id(file_id, self._transform._tree.has_id)
1862
 
 
1863
 
    def has_or_had_id(self, file_id):
1864
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
1656
            return self._transform._tree.has_id(file_id)
1865
1657
 
1866
1658
    def _path2trans_id(self, path):
1867
1659
        # We must not use None here, because that is a valid value to store.
1920
1712
            if self._transform.final_file_id(trans_id) is None:
1921
1713
                yield self._final_paths._determine_path(trans_id)
1922
1714
 
1923
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1924
 
        yield_parents=False):
 
1715
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
1925
1716
        for trans_id, parent_file_id in ordered_entries:
1926
1717
            file_id = self._transform.final_file_id(trans_id)
1927
1718
            if file_id is None:
1953
1744
                ordered_ids.append((trans_id, parent_file_id))
1954
1745
        return ordered_ids
1955
1746
 
1956
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
1747
    def iter_entries_by_dir(self, specific_file_ids=None):
1957
1748
        # This may not be a maximally efficient implementation, but it is
1958
1749
        # reasonably straightforward.  An implementation that grafts the
1959
1750
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1961
1752
        # position.
1962
1753
        ordered_ids = self._list_files_by_dir()
1963
1754
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1964
 
            specific_file_ids, yield_parents=yield_parents):
1965
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1966
 
 
1967
 
    def _iter_entries_for_dir(self, dir_path):
1968
 
        """Return path, entry for items in a directory without recursing down."""
1969
 
        dir_file_id = self.path2id(dir_path)
1970
 
        ordered_ids = []
1971
 
        for file_id in self.iter_children(dir_file_id):
1972
 
            trans_id = self._transform.trans_id_file_id(file_id)
1973
 
            ordered_ids.append((trans_id, file_id))
1974
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1975
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1976
 
 
1977
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1978
 
        """See WorkingTree.list_files."""
 
1755
                                                      specific_file_ids):
 
1756
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1757
 
 
1758
    def list_files(self, include_root=False):
 
1759
        """See Tree.list_files."""
1979
1760
        # XXX This should behave like WorkingTree.list_files, but is really
1980
1761
        # more like RevisionTree.list_files.
1981
 
        if recursive:
1982
 
            prefix = None
1983
 
            if from_dir:
1984
 
                prefix = from_dir + '/'
1985
 
            entries = self.iter_entries_by_dir()
1986
 
            for path, entry in entries:
1987
 
                if entry.name == '' and not include_root:
1988
 
                    continue
1989
 
                if prefix:
1990
 
                    if not path.startswith(prefix):
1991
 
                        continue
1992
 
                    path = path[len(prefix):]
1993
 
                yield path, 'V', entry.kind, entry.file_id, entry
1994
 
        else:
1995
 
            if from_dir is None and include_root is True:
1996
 
                root_entry = inventory.make_entry('directory', '',
1997
 
                    ROOT_PARENT, self.get_root_id())
1998
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1999
 
            entries = self._iter_entries_for_dir(from_dir or '')
2000
 
            for path, entry in entries:
2001
 
                yield path, 'V', entry.kind, entry.file_id, entry
 
1762
        for path, entry in self.iter_entries_by_dir():
 
1763
            if entry.name == '' and not include_root:
 
1764
                continue
 
1765
            yield path, 'V', entry.kind, entry.file_id, entry
2002
1766
 
2003
1767
    def kind(self, file_id):
2004
1768
        trans_id = self._transform.trans_id_file_id(file_id)
2014
1778
    def get_file_mtime(self, file_id, path=None):
2015
1779
        """See Tree.get_file_mtime"""
2016
1780
        if not self._content_change(file_id):
2017
 
            return self._transform._tree.get_file_mtime(file_id)
 
1781
            return self._transform._tree.get_file_mtime(file_id, path)
2018
1782
        return self._stat_limbo_file(file_id).st_mtime
2019
1783
 
2020
1784
    def _file_size(self, entry, stat_value):
2074
1838
                statval = os.lstat(limbo_name)
2075
1839
                size = statval.st_size
2076
1840
                if not supports_executable():
2077
 
                    executable = False
 
1841
                    executable = None
2078
1842
                else:
2079
1843
                    executable = statval.st_mode & S_IEXEC
2080
1844
            else:
2082
1846
                executable = None
2083
1847
            if kind == 'symlink':
2084
1848
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2085
 
        executable = tt._new_executability.get(trans_id, executable)
 
1849
        if supports_executable():
 
1850
            executable = tt._new_executability.get(trans_id, executable)
2086
1851
        return kind, size, executable, link_or_sha1
2087
1852
 
2088
1853
    def iter_changes(self, from_tree, include_unchanged=False,
2114
1879
        name = self._transform._limbo_name(trans_id)
2115
1880
        return open(name, 'rb')
2116
1881
 
2117
 
    def get_file_with_stat(self, file_id, path=None):
2118
 
        return self.get_file(file_id, path), None
2119
 
 
2120
1882
    def annotate_iter(self, file_id,
2121
1883
                      default_revision=_mod_revision.CURRENT_REVISION):
2122
 
        changes = self._iter_changes_cache.get(file_id)
 
1884
        changes = self._changes(file_id)
2123
1885
        if changes is None:
2124
1886
            get_old = True
2125
1887
        else:
2137
1899
            return old_annotation
2138
1900
        if not changed_content:
2139
1901
            return old_annotation
2140
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2141
 
        #       doing, however it fails slightly because it doesn't know what
2142
 
        #       the *other* revision_id is, so it doesn't know how to give the
2143
 
        #       other as the origin for some lines, they all get
2144
 
        #       'default_revision'
2145
 
        #       It would be nice to be able to use the new Annotator based
2146
 
        #       approach, as well.
2147
1902
        return annotate.reannotate([old_annotation],
2148
1903
                                   self.get_file(file_id).readlines(),
2149
1904
                                   default_revision)
2154
1909
            return self._transform._tree.get_symlink_target(file_id)
2155
1910
        trans_id = self._transform.trans_id_file_id(file_id)
2156
1911
        name = self._transform._limbo_name(trans_id)
2157
 
        return osutils.readlink(name)
 
1912
        return os.readlink(name)
2158
1913
 
2159
1914
    def walkdirs(self, prefix=''):
2160
1915
        pending = [self._transform.root]
2215
1970
        self.transform = transform
2216
1971
 
2217
1972
    def _determine_path(self, trans_id):
2218
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1973
        if trans_id == self.transform.root:
2219
1974
            return ""
2220
1975
        name = self.transform.final_name(trans_id)
2221
1976
        parent_id = self.transform.final_parent(trans_id)
2291
2046
    for num, _unused in enumerate(wt.all_file_ids()):
2292
2047
        if num > 0:  # more than just a root
2293
2048
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2049
    existing_files = set()
 
2050
    for dir, files in wt.walkdirs():
 
2051
        existing_files.update(f[0] for f in files)
2294
2052
    file_trans_id = {}
2295
2053
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2296
2054
    pp = ProgressPhase("Build phase", 2, top_pb)
2320
2078
                precomputed_delta = []
2321
2079
            else:
2322
2080
                precomputed_delta = None
2323
 
            # Check if tree inventory has content. If so, we populate
2324
 
            # existing_files with the directory content. If there are no
2325
 
            # entries we skip populating existing_files as its not used.
2326
 
            # This improves performance and unncessary work on large
2327
 
            # directory trees. (#501307)
2328
 
            if total > 0:
2329
 
                existing_files = set()
2330
 
                for dir, files in wt.walkdirs():
2331
 
                    existing_files.update(f[0] for f in files)
2332
2081
            for num, (tree_path, entry) in \
2333
2082
                enumerate(tree.inventory.iter_entries_by_dir()):
2334
2083
                pb.update("Building tree", num - len(deferred_contents), total)
2364
2113
                    executable = tree.is_executable(file_id, tree_path)
2365
2114
                    if executable:
2366
2115
                        tt.set_executability(executable, trans_id)
2367
 
                    trans_data = (trans_id, tree_path)
2368
 
                    deferred_contents.append((file_id, trans_data))
 
2116
                    deferred_contents.append((file_id, trans_id))
2369
2117
                else:
2370
2118
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2371
2119
                                                          tree)
2402
2150
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2403
2151
                  hardlink):
2404
2152
    total = len(desired_files) + offset
2405
 
    wt = tt._tree
2406
2153
    if accelerator_tree is None:
2407
2154
        new_desired_files = desired_files
2408
2155
    else:
2409
2156
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2410
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2411
 
                     in iter if not (c or e[0] != e[1])]
2412
 
        if accelerator_tree.supports_content_filtering():
2413
 
            unchanged = [(f, p) for (f, p) in unchanged
2414
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2415
 
        unchanged = dict(unchanged)
 
2157
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
2158
                         in iter if not (c or e[0] != e[1]))
2416
2159
        new_desired_files = []
2417
2160
        count = 0
2418
 
        for file_id, (trans_id, tree_path) in desired_files:
 
2161
        for file_id, trans_id in desired_files:
2419
2162
            accelerator_path = unchanged.get(file_id)
2420
2163
            if accelerator_path is None:
2421
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
2164
                new_desired_files.append((file_id, trans_id))
2422
2165
                continue
2423
2166
            pb.update('Adding file contents', count + offset, total)
2424
2167
            if hardlink:
2426
2169
                                   trans_id)
2427
2170
            else:
2428
2171
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2429
 
                if wt.supports_content_filtering():
2430
 
                    filters = wt._content_filter_stack(tree_path)
2431
 
                    contents = filtered_output_bytes(contents, filters,
2432
 
                        ContentFilterContext(tree_path, tree))
2433
2172
                try:
2434
2173
                    tt.create_file(contents, trans_id)
2435
2174
                finally:
2436
 
                    try:
2437
 
                        contents.close()
2438
 
                    except AttributeError:
2439
 
                        # after filtering, contents may no longer be file-like
2440
 
                        pass
 
2175
                    contents.close()
2441
2176
            count += 1
2442
2177
        offset += count
2443
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2444
 
            tree.iter_files_bytes(new_desired_files)):
2445
 
        if wt.supports_content_filtering():
2446
 
            filters = wt._content_filter_stack(tree_path)
2447
 
            contents = filtered_output_bytes(contents, filters,
2448
 
                ContentFilterContext(tree_path, tree))
 
2178
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
2179
                                                 new_desired_files)):
2449
2180
        tt.create_file(contents, trans_id)
2450
2181
        pb.update('Adding file contents', count + offset, total)
2451
2182
 
2466
2197
    if entry.kind == "directory":
2467
2198
        return True
2468
2199
    if entry.kind == "file":
2469
 
        f = file(target_path, 'rb')
2470
 
        try:
2471
 
            if tree.get_file_text(file_id) == f.read():
2472
 
                return True
2473
 
        finally:
2474
 
            f.close()
 
2200
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
2201
            return True
2475
2202
    elif entry.kind == "symlink":
2476
2203
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2477
2204
            return True
2529
2256
        raise errors.BadFileKindError(name, kind)
2530
2257
 
2531
2258
 
2532
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2533
 
    filter_tree_path=None):
2534
 
    """Create new file contents according to tree contents.
2535
 
    
2536
 
    :param filter_tree_path: the tree path to use to lookup
2537
 
      content filters to apply to the bytes output in the working tree.
2538
 
      This only applies if the working tree supports content filtering.
 
2259
@deprecated_function(deprecated_in((1, 9, 0)))
 
2260
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
2261
    """Create new file contents according to an inventory entry.
 
2262
 
 
2263
    DEPRECATED.  Use create_from_tree instead.
2539
2264
    """
 
2265
    if entry.kind == "file":
 
2266
        if lines is None:
 
2267
            lines = tree.get_file(entry.file_id).readlines()
 
2268
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
2269
    elif entry.kind == "symlink":
 
2270
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
2271
    elif entry.kind == "directory":
 
2272
        tt.create_directory(trans_id)
 
2273
 
 
2274
 
 
2275
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
 
2276
    """Create new file contents according to tree contents."""
2540
2277
    kind = tree.kind(file_id)
2541
2278
    if kind == 'directory':
2542
2279
        tt.create_directory(trans_id)
2547
2284
                bytes = tree_file.readlines()
2548
2285
            finally:
2549
2286
                tree_file.close()
2550
 
        wt = tt._tree
2551
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2552
 
            filters = wt._content_filter_stack(filter_tree_path)
2553
 
            bytes = filtered_output_bytes(bytes, filters,
2554
 
                ContentFilterContext(filter_tree_path, tree))
2555
2287
        tt.create_file(bytes, trans_id)
2556
2288
    elif kind == "symlink":
2557
2289
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2609
2341
 
2610
2342
 
2611
2343
def revert(working_tree, target_tree, filenames, backups=False,
2612
 
           pb=None, change_reporter=None):
 
2344
           pb=DummyProgress(), change_reporter=None):
2613
2345
    """Revert a working tree's contents to those of a target tree."""
2614
2346
    target_tree.lock_read()
2615
 
    pb = ui.ui_factory.nested_progress_bar()
2616
2347
    tt = TreeTransform(working_tree, pb)
2617
2348
    try:
2618
2349
        pp = ProgressPhase("Revert phase", 3, pb)
2637
2368
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2638
2369
                              backups, pp, basis_tree=None,
2639
2370
                              merge_modified=None):
 
2371
    pp.next_phase()
2640
2372
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2641
2373
    try:
2642
2374
        if merge_modified is None:
2646
2378
                                      merge_modified, basis_tree)
2647
2379
    finally:
2648
2380
        child_pb.finished()
 
2381
    pp.next_phase()
2649
2382
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2650
2383
    try:
2651
2384
        raw_conflicts = resolve_conflicts(tt, child_pb,
2744
2477
                    parent_trans = ROOT_PARENT
2745
2478
                else:
2746
2479
                    parent_trans = tt.trans_id_file_id(parent[1])
2747
 
                if parent[0] is None and versioned[0]:
2748
 
                    tt.adjust_root_path(name[1], parent_trans)
2749
 
                else:
2750
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
 
2480
                tt.adjust_path(name[1], parent_trans, trans_id)
2751
2481
            if executable[0] != executable[1] and kind[1] == "file":
2752
2482
                tt.set_executability(executable[1], trans_id)
2753
 
        if working_tree.supports_content_filtering():
2754
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2755
 
                target_tree.iter_files_bytes(deferred_files)):
2756
 
                file_id = deferred_files[index][0]
2757
 
                # We're reverting a tree to the target tree so using the
2758
 
                # target tree to find the file path seems the best choice
2759
 
                # here IMO - Ian C 27/Oct/2009
2760
 
                filter_tree_path = target_tree.id2path(file_id)
2761
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2762
 
                bytes = filtered_output_bytes(bytes, filters,
2763
 
                    ContentFilterContext(filter_tree_path, working_tree))
2764
 
                tt.create_file(bytes, trans_id, mode_id)
2765
 
        else:
2766
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2767
 
                deferred_files):
2768
 
                tt.create_file(bytes, trans_id, mode_id)
2769
 
        tt.fixup_new_roots()
 
2483
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2484
            deferred_files):
 
2485
            tt.create_file(bytes, trans_id, mode_id)
2770
2486
    finally:
2771
2487
        if basis_tree is not None:
2772
2488
            basis_tree.unlock()
2773
2489
    return merge_modified
2774
2490
 
2775
2491
 
2776
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2492
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2777
2493
    """Make many conflict-resolution attempts, but die if they fail"""
2778
2494
    if pass_func is None:
2779
2495
        pass_func = conflict_pass
2780
2496
    new_conflicts = set()
2781
 
    pb = ui.ui_factory.nested_progress_bar()
2782
2497
    try:
2783
2498
        for n in range(10):
2784
2499
            pb.update('Resolution pass', n+1, 10)
2788
2503
            new_conflicts.update(pass_func(tt, conflicts))
2789
2504
        raise MalformedTransform(conflicts=conflicts)
2790
2505
    finally:
2791
 
        pb.finished()
 
2506
        pb.clear()
2792
2507
 
2793
2508
 
2794
2509
def conflict_pass(tt, conflicts, path_tree=None):
2843
2558
                        # special-case the other tree root (move its
2844
2559
                        # children to current root)
2845
2560
                        if entry.parent_id is None:
2846
 
                            create = False
 
2561
                            create=False
2847
2562
                            moved = _reparent_transform_children(
2848
2563
                                tt, trans_id, tt.root)
2849
2564
                            for child in moved:
2917
2632
        self.pending_deletions = []
2918
2633
 
2919
2634
    def rename(self, from_, to):
2920
 
        """Rename a file from one path to another."""
 
2635
        """Rename a file from one path to another.  Functions like os.rename"""
2921
2636
        try:
2922
2637
            os.rename(from_, to)
2923
2638
        except OSError, e:
2924
2639
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2925
2640
                raise errors.FileExists(to, str(e))
2926
 
            # normal OSError doesn't include filenames so it's hard to see where
2927
 
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
2928
 
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
 
2641
            raise
2929
2642
        self.past_renames.append((from_, to))
2930
2643
 
2931
2644
    def pre_delete(self, from_, to):
2941
2654
    def rollback(self):
2942
2655
        """Reverse all renames that have been performed"""
2943
2656
        for from_, to in reversed(self.past_renames):
2944
 
            try:
2945
 
                os.rename(to, from_)
2946
 
            except OSError, e:
2947
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)                
 
2657
            os.rename(to, from_)
2948
2658
        # after rollback, don't reuse _FileMover
2949
2659
        past_renames = None
2950
2660
        pending_deletions = None