~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Robert Collins
  • Date: 2010-01-28 18:05:44 UTC
  • mto: (4797.2.5 2.1)
  • mto: This revision was merged to the branch mainline in revision 4989.
  • Revision ID: robertc@robertcollins.net-20100128180544-6l8x7o7obaq7b51x
Tweak ConfigurableFileMerger to use class variables rather than requiring __init__ wrapping as future proofing for helper functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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,
30
32
    osutils,
31
33
    revision as _mod_revision,
32
34
    )
33
 
from bzrlib.util import bencode
34
35
""")
35
36
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
36
37
                           ReusingTransform, NotVersionedError, CantMoveRoot,
37
38
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
38
39
                           UnableCreateSymlink)
 
40
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
39
41
from bzrlib.inventory import InventoryEntry
40
42
from bzrlib.osutils import (
41
43
    delete_any,
75
77
 
76
78
 
77
79
class TreeTransformBase(object):
78
 
    """The base class for TreeTransform and TreeTransformBase"""
 
80
    """The base class for TreeTransform and its kin."""
79
81
 
80
 
    def __init__(self, tree, limbodir, pb=DummyProgress(),
 
82
    def __init__(self, tree, pb=DummyProgress(),
81
83
                 case_sensitive=True):
82
84
        """Constructor.
83
85
 
84
86
        :param tree: The tree that will be transformed, but not necessarily
85
87
            the output tree.
86
 
        :param limbodir: A directory where new files can be stored until
87
 
            they are installed in their proper places
88
 
        :param pb: A ProgressBar indicating how much progress is being made
 
88
        :param pb: A ProgressTask indicating how much progress is being made
89
89
        :param case_sensitive: If True, the target of the transform is
90
90
            case sensitive, not just case preserving.
91
91
        """
92
92
        object.__init__(self)
93
93
        self._tree = tree
94
 
        self._limbodir = limbodir
95
 
        self._deletiondir = None
96
94
        self._id_number = 0
97
95
        # mapping of trans_id -> new basename
98
96
        self._new_name = {}
100
98
        self._new_parent = {}
101
99
        # mapping of trans_id with new contents -> new file_kind
102
100
        self._new_contents = {}
103
 
        # A mapping of transform ids to their limbo filename
104
 
        self._limbo_files = {}
105
 
        # A mapping of transform ids to a set of the transform ids of children
106
 
        # that their limbo directory has
107
 
        self._limbo_children = {}
108
 
        # Map transform ids to maps of child filename to child transform id
109
 
        self._limbo_children_names = {}
110
 
        # List of transform ids that need to be renamed from limbo into place
111
 
        self._needs_rename = set()
112
101
        # Set of trans_ids whose contents will be removed
113
102
        self._removed_contents = set()
114
103
        # Mapping of trans_id -> new execute-bit value
127
116
        self._tree_path_ids = {}
128
117
        # Mapping trans_id -> path in old tree
129
118
        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 = {}
134
119
        # The trans_id that will be used as the tree root
135
120
        root_id = tree.get_root_id()
136
121
        if root_id is not None:
146
131
        # A counter of how many files have been renamed
147
132
        self.rename_count = 0
148
133
 
 
134
    def finalize(self):
 
135
        """Release the working tree lock, if held.
 
136
 
 
137
        This is required if apply has not been invoked, but can be invoked
 
138
        even after apply.
 
139
        """
 
140
        if self._tree is None:
 
141
            return
 
142
        self._tree.unlock()
 
143
        self._tree = None
 
144
 
149
145
    def __get_root(self):
150
146
        return self._new_root
151
147
 
152
148
    root = property(__get_root)
153
149
 
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
 
 
185
150
    def _assign_id(self):
186
151
        """Produce a new tranform id"""
187
152
        new_id = "new-%s" % self._id_number
197
162
 
198
163
    def adjust_path(self, name, parent, trans_id):
199
164
        """Change the path that is assigned to a transaction id."""
 
165
        if parent is None:
 
166
            raise ValueError("Parent trans-id may not be None")
200
167
        if trans_id == self._new_root:
201
168
            raise CantMoveRoot
202
 
        previous_parent = self._new_parent.get(trans_id)
203
 
        previous_name = self._new_name.get(trans_id)
204
169
        self._new_name[trans_id] = name
205
170
        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)
233
171
 
234
172
    def adjust_root_path(self, name, parent):
235
173
        """Emulate moving the root by moving all children, instead.
236
 
        
 
174
 
237
175
        We do this by undoing the association of root's transaction id with the
238
176
        current tree.  This allows us to create a new directory with that
239
 
        transaction id.  We unversion the root directory and version the 
 
177
        transaction id.  We unversion the root directory and version the
240
178
        physically new directory, and hope someone versions the tree root
241
179
        later.
242
180
        """
245
183
        # force moving all children of root
246
184
        for child_id in self.iter_tree_children(old_root):
247
185
            if child_id != parent:
248
 
                self.adjust_path(self.final_name(child_id), 
 
186
                self.adjust_path(self.final_name(child_id),
249
187
                                 self.final_parent(child_id), child_id)
250
188
            file_id = self.final_file_id(child_id)
251
189
            if file_id is not None:
252
190
                self.unversion_file(child_id)
253
191
            self.version_file(file_id, child_id)
254
 
        
 
192
 
255
193
        # the physical root needs a new transaction id
256
194
        self._tree_path_ids.pop("")
257
195
        self._tree_id_paths.pop(old_root)
263
201
        self.version_file(old_root_file_id, old_root)
264
202
        self.unversion_file(self._new_root)
265
203
 
 
204
    def fixup_new_roots(self):
 
205
        """Reinterpret requests to change the root directory
 
206
 
 
207
        Instead of creating a root directory, or moving an existing directory,
 
208
        all the attributes and children of the new root are applied to the
 
209
        existing root directory.
 
210
 
 
211
        This means that the old root trans-id becomes obsolete, so it is
 
212
        recommended only to invoke this after the root trans-id has become
 
213
        irrelevant.
 
214
        """
 
215
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
 
216
                     ROOT_PARENT]
 
217
        if len(new_roots) < 1:
 
218
            return
 
219
        if len(new_roots) != 1:
 
220
            raise ValueError('A tree cannot have two roots!')
 
221
        if self._new_root is None:
 
222
            self._new_root = new_roots[0]
 
223
            return
 
224
        old_new_root = new_roots[0]
 
225
        # TODO: What to do if a old_new_root is present, but self._new_root is
 
226
        #       not listed as being removed? This code explicitly unversions
 
227
        #       the old root and versions it with the new file_id. Though that
 
228
        #       seems like an incomplete delta
 
229
 
 
230
        # unversion the new root's directory.
 
231
        file_id = self.final_file_id(old_new_root)
 
232
        if old_new_root in self._new_id:
 
233
            self.cancel_versioning(old_new_root)
 
234
        else:
 
235
            self.unversion_file(old_new_root)
 
236
        # if, at this stage, root still has an old file_id, zap it so we can
 
237
        # stick a new one in.
 
238
        if (self.tree_file_id(self._new_root) is not None and
 
239
            self._new_root not in self._removed_id):
 
240
            self.unversion_file(self._new_root)
 
241
        self.version_file(file_id, self._new_root)
 
242
 
 
243
        # Now move children of new root into old root directory.
 
244
        # Ensure all children are registered with the transaction, but don't
 
245
        # use directly-- some tree children have new parents
 
246
        list(self.iter_tree_children(old_new_root))
 
247
        # Move all children of new root into old root directory.
 
248
        for child in self.by_parent().get(old_new_root, []):
 
249
            self.adjust_path(self.final_name(child), self._new_root, child)
 
250
 
 
251
        # Ensure old_new_root has no directory.
 
252
        if old_new_root in self._new_contents:
 
253
            self.cancel_creation(old_new_root)
 
254
        else:
 
255
            self.delete_contents(old_new_root)
 
256
 
 
257
        # prevent deletion of root directory.
 
258
        if self._new_root in self._removed_contents:
 
259
            self.cancel_deletion(self._new_root)
 
260
 
 
261
        # destroy path info for old_new_root.
 
262
        del self._new_parent[old_new_root]
 
263
        del self._new_name[old_new_root]
 
264
 
266
265
    def trans_id_tree_file_id(self, inventory_id):
267
266
        """Determine the transaction id of a working tree file.
268
 
        
 
267
 
269
268
        This reflects only files that already exist, not ones that will be
270
269
        added by transactions.
271
270
        """
297
296
            else:
298
297
                return self.trans_id_tree_file_id(file_id)
299
298
 
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
 
 
319
299
    def trans_id_tree_path(self, path):
320
300
        """Determine (and maybe set) the transaction ID for a tree path."""
321
301
        path = self.canonical_path(path)
331
311
            return ROOT_PARENT
332
312
        return self.trans_id_tree_path(os.path.dirname(path))
333
313
 
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
 
 
441
314
    def delete_contents(self, trans_id):
442
315
        """Schedule the contents of a path entry for deletion"""
 
316
        # Ensure that the object exists in the WorkingTree, this will raise an
 
317
        # exception if there is a problem
443
318
        self.tree_kind(trans_id)
444
319
        self._removed_contents.add(trans_id)
445
320
 
517
392
        new_ids.update(changed_kind)
518
393
        return sorted(FinalPaths(self).get_paths(new_ids))
519
394
 
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
 
 
536
395
    def final_kind(self, trans_id):
537
396
        """Determine the final file kind, after any changes applied.
538
 
        
 
397
 
539
398
        Raises NoSuchFile if the file does not exist/has no contents.
540
399
        (It is conceivable that a path would be created without the
541
400
        corresponding contents insertion command)
561
420
 
562
421
    def final_file_id(self, trans_id):
563
422
        """Determine the file id after any changes are applied, or None.
564
 
        
 
423
 
565
424
        None indicates that the file will not be versioned after changes are
566
425
        applied.
567
426
        """
606
465
 
607
466
    def by_parent(self):
608
467
        """Return a map of parent: children for known parents.
609
 
        
 
468
 
610
469
        Only new paths and parents of tree files with assigned ids are used.
611
470
        """
612
471
        by_parent = {}
613
472
        items = list(self._new_parent.iteritems())
614
 
        items.extend((t, self.final_parent(t)) for t in 
 
473
        items.extend((t, self.final_parent(t)) for t in
615
474
                      self._tree_id_paths.keys())
616
475
        for trans_id, parent_id in items:
617
476
            if parent_id not in by_parent:
645
504
        conflicts.extend(self._overwrite_conflicts())
646
505
        return conflicts
647
506
 
 
507
    def _check_malformed(self):
 
508
        conflicts = self.find_conflicts()
 
509
        if len(conflicts) != 0:
 
510
            raise MalformedTransform(conflicts=conflicts)
 
511
 
648
512
    def _add_tree_children(self):
649
513
        """Add all the children of all active parents to the known paths.
650
514
 
652
516
        removed.  This is a necessary first step in detecting conflicts.
653
517
        """
654
518
        parents = self.by_parent().keys()
655
 
        parents.extend([t for t in self._removed_contents if 
 
519
        parents.extend([t for t in self._removed_contents if
656
520
                        self.tree_kind(t) == 'directory'])
657
521
        for trans_id in self._removed_id:
658
522
            file_id = self.tree_file_id(trans_id)
666
530
            # ensure that all children are registered with the transaction
667
531
            list(self.iter_tree_children(parent_id))
668
532
 
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
 
 
689
533
    def has_named_child(self, by_parent, parent_id, name):
690
534
        try:
691
535
            children = by_parent[parent_id]
745
589
 
746
590
    def _improper_versioning(self):
747
591
        """Cannot version a file with no contents, or a bad type.
748
 
        
 
592
 
749
593
        However, existing entries with no contents are okay.
750
594
        """
751
595
        conflicts = []
761
605
 
762
606
    def _executability_conflicts(self):
763
607
        """Check for bad executability changes.
764
 
        
 
608
 
765
609
        Only versioned files may have their executability set, because
766
610
        1. only versioned entries can have executability under windows
767
611
        2. only files can be executable.  (The execute bit on a directory
866
710
            return True
867
711
        return False
868
712
 
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
 
 
913
713
    def _set_executability(self, path, trans_id):
914
714
        """Set the executability of versioned files """
915
715
        if supports_executable():
936
736
            self.version_file(file_id, trans_id)
937
737
        return trans_id
938
738
 
939
 
    def new_file(self, name, parent_id, contents, file_id=None, 
 
739
    def new_file(self, name, parent_id, contents, file_id=None,
940
740
                 executable=None):
941
741
        """Convenience method to create files.
942
 
        
 
742
 
943
743
        name is the name of the file to create.
944
744
        parent_id is the transaction id of the parent directory of the file.
945
745
        contents is an iterator of bytestrings, which will be used to produce
965
765
        """
966
766
        trans_id = self._new_entry(name, parent_id, file_id)
967
767
        self.create_directory(trans_id)
968
 
        return trans_id 
 
768
        return trans_id
969
769
 
970
770
    def new_symlink(self, name, parent_id, target, file_id=None):
971
771
        """Convenience method to create symbolic link.
972
 
        
 
772
 
973
773
        name is the name of the symlink to create.
974
774
        parent_id is the transaction id of the parent directory of the symlink.
975
775
        target is a bytestring of the target of the symlink.
1121
921
    def get_preview_tree(self):
1122
922
        """Return a tree representing the result of the transform.
1123
923
 
1124
 
        This tree only supports the subset of Tree functionality required
1125
 
        by show_diff_trees.  It must only be compared to tt._tree.
 
924
        The tree is a snapshot, and altering the TreeTransform will invalidate
 
925
        it.
1126
926
        """
1127
927
        return _PreviewTree(self)
1128
928
 
 
929
    def commit(self, branch, message, merge_parents=None, strict=False):
 
930
        """Commit the result of this TreeTransform to a branch.
 
931
 
 
932
        :param branch: The branch to commit to.
 
933
        :param message: The message to attach to the commit.
 
934
        :param merge_parents: Additional parents specified by pending merges.
 
935
        :return: The revision_id of the revision committed.
 
936
        """
 
937
        self._check_malformed()
 
938
        if strict:
 
939
            unversioned = set(self._new_contents).difference(set(self._new_id))
 
940
            for trans_id in unversioned:
 
941
                if self.final_file_id(trans_id) is None:
 
942
                    raise errors.StrictCommitFailed()
 
943
 
 
944
        revno, last_rev_id = branch.last_revision_info()
 
945
        if last_rev_id == _mod_revision.NULL_REVISION:
 
946
            if merge_parents is not None:
 
947
                raise ValueError('Cannot supply merge parents for first'
 
948
                                 ' commit.')
 
949
            parent_ids = []
 
950
        else:
 
951
            parent_ids = [last_rev_id]
 
952
            if merge_parents is not None:
 
953
                parent_ids.extend(merge_parents)
 
954
        if self._tree.get_revision_id() != last_rev_id:
 
955
            raise ValueError('TreeTransform not based on branch basis: %s' %
 
956
                             self._tree.get_revision_id())
 
957
        builder = branch.get_commit_builder(parent_ids)
 
958
        preview = self.get_preview_tree()
 
959
        list(builder.record_iter_changes(preview, last_rev_id,
 
960
                                         self.iter_changes()))
 
961
        builder.finish_inventory()
 
962
        revision_id = builder.commit(message)
 
963
        branch.set_last_revision_info(revno + 1, revision_id)
 
964
        return revision_id
 
965
 
1129
966
    def _text_parent(self, trans_id):
1130
967
        file_id = self.tree_file_id(trans_id)
1131
968
        try:
1175
1012
                                      (('attribs',),))
1176
1013
        for trans_id, kind in self._new_contents.items():
1177
1014
            if kind == 'file':
1178
 
                cur_file = open(self._limbo_name(trans_id), 'rb')
1179
 
                try:
1180
 
                    lines = osutils.chunks_to_lines(cur_file.readlines())
1181
 
                finally:
1182
 
                    cur_file.close()
 
1015
                lines = osutils.chunks_to_lines(
 
1016
                    self._read_file_chunks(trans_id))
1183
1017
                parents = self._get_parents_lines(trans_id)
1184
1018
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1185
1019
                content = ''.join(mpdiff.to_patch())
1186
1020
            if kind == 'directory':
1187
1021
                content = ''
1188
1022
            if kind == 'symlink':
1189
 
                content = os.readlink(self._limbo_name(trans_id))
 
1023
                content = self._read_symlink_target(trans_id)
1190
1024
            yield serializer.bytes_record(content, ((trans_id, kind),))
1191
1025
 
1192
 
 
1193
1026
    def deserialize(self, records):
1194
1027
        """Deserialize a stored TreeTransform.
1195
1028
 
1226
1059
                self.create_symlink(content.decode('utf-8'), trans_id)
1227
1060
 
1228
1061
 
1229
 
class TreeTransform(TreeTransformBase):
 
1062
class DiskTreeTransform(TreeTransformBase):
 
1063
    """Tree transform storing its contents on disk."""
 
1064
 
 
1065
    def __init__(self, tree, limbodir, pb=DummyProgress(),
 
1066
                 case_sensitive=True):
 
1067
        """Constructor.
 
1068
        :param tree: The tree that will be transformed, but not necessarily
 
1069
            the output tree.
 
1070
        :param limbodir: A directory where new files can be stored until
 
1071
            they are installed in their proper places
 
1072
        :param pb: A ProgressBar indicating how much progress is being made
 
1073
        :param case_sensitive: If True, the target of the transform is
 
1074
            case sensitive, not just case preserving.
 
1075
        """
 
1076
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
 
1077
        self._limbodir = limbodir
 
1078
        self._deletiondir = None
 
1079
        # A mapping of transform ids to their limbo filename
 
1080
        self._limbo_files = {}
 
1081
        # A mapping of transform ids to a set of the transform ids of children
 
1082
        # that their limbo directory has
 
1083
        self._limbo_children = {}
 
1084
        # Map transform ids to maps of child filename to child transform id
 
1085
        self._limbo_children_names = {}
 
1086
        # List of transform ids that need to be renamed from limbo into place
 
1087
        self._needs_rename = set()
 
1088
        self._creation_mtime = None
 
1089
 
 
1090
    def finalize(self):
 
1091
        """Release the working tree lock, if held, clean up limbo dir.
 
1092
 
 
1093
        This is required if apply has not been invoked, but can be invoked
 
1094
        even after apply.
 
1095
        """
 
1096
        if self._tree is None:
 
1097
            return
 
1098
        try:
 
1099
            entries = [(self._limbo_name(t), t, k) for t, k in
 
1100
                       self._new_contents.iteritems()]
 
1101
            entries.sort(reverse=True)
 
1102
            for path, trans_id, kind in entries:
 
1103
                delete_any(path)
 
1104
            try:
 
1105
                delete_any(self._limbodir)
 
1106
            except OSError:
 
1107
                # We don't especially care *why* the dir is immortal.
 
1108
                raise ImmortalLimbo(self._limbodir)
 
1109
            try:
 
1110
                if self._deletiondir is not None:
 
1111
                    delete_any(self._deletiondir)
 
1112
            except OSError:
 
1113
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
1114
        finally:
 
1115
            TreeTransformBase.finalize(self)
 
1116
 
 
1117
    def _limbo_name(self, trans_id):
 
1118
        """Generate the limbo name of a file"""
 
1119
        limbo_name = self._limbo_files.get(trans_id)
 
1120
        if limbo_name is None:
 
1121
            limbo_name = self._generate_limbo_path(trans_id)
 
1122
            self._limbo_files[trans_id] = limbo_name
 
1123
        return limbo_name
 
1124
 
 
1125
    def _generate_limbo_path(self, trans_id):
 
1126
        """Generate a limbo path using the trans_id as the relative path.
 
1127
 
 
1128
        This is suitable as a fallback, and when the transform should not be
 
1129
        sensitive to the path encoding of the limbo directory.
 
1130
        """
 
1131
        self._needs_rename.add(trans_id)
 
1132
        return pathjoin(self._limbodir, trans_id)
 
1133
 
 
1134
    def adjust_path(self, name, parent, trans_id):
 
1135
        previous_parent = self._new_parent.get(trans_id)
 
1136
        previous_name = self._new_name.get(trans_id)
 
1137
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
 
1138
        if (trans_id in self._limbo_files and
 
1139
            trans_id not in self._needs_rename):
 
1140
            self._rename_in_limbo([trans_id])
 
1141
            if previous_parent != parent:
 
1142
                self._limbo_children[previous_parent].remove(trans_id)
 
1143
            if previous_parent != parent or previous_name != name:
 
1144
                del self._limbo_children_names[previous_parent][previous_name]
 
1145
 
 
1146
    def _rename_in_limbo(self, trans_ids):
 
1147
        """Fix limbo names so that the right final path is produced.
 
1148
 
 
1149
        This means we outsmarted ourselves-- we tried to avoid renaming
 
1150
        these files later by creating them with their final names in their
 
1151
        final parents.  But now the previous name or parent is no longer
 
1152
        suitable, so we have to rename them.
 
1153
 
 
1154
        Even for trans_ids that have no new contents, we must remove their
 
1155
        entries from _limbo_files, because they are now stale.
 
1156
        """
 
1157
        for trans_id in trans_ids:
 
1158
            old_path = self._limbo_files.pop(trans_id)
 
1159
            if trans_id not in self._new_contents:
 
1160
                continue
 
1161
            new_path = self._limbo_name(trans_id)
 
1162
            os.rename(old_path, new_path)
 
1163
            for descendant in self._limbo_descendants(trans_id):
 
1164
                desc_path = self._limbo_files[descendant]
 
1165
                desc_path = new_path + desc_path[len(old_path):]
 
1166
                self._limbo_files[descendant] = desc_path
 
1167
 
 
1168
    def _limbo_descendants(self, trans_id):
 
1169
        """Return the set of trans_ids whose limbo paths descend from this."""
 
1170
        descendants = set(self._limbo_children.get(trans_id, []))
 
1171
        for descendant in list(descendants):
 
1172
            descendants.update(self._limbo_descendants(descendant))
 
1173
        return descendants
 
1174
 
 
1175
    def create_file(self, contents, trans_id, mode_id=None):
 
1176
        """Schedule creation of a new file.
 
1177
 
 
1178
        See also new_file.
 
1179
 
 
1180
        Contents is an iterator of strings, all of which will be written
 
1181
        to the target destination.
 
1182
 
 
1183
        New file takes the permissions of any existing file with that id,
 
1184
        unless mode_id is specified.
 
1185
        """
 
1186
        name = self._limbo_name(trans_id)
 
1187
        f = open(name, 'wb')
 
1188
        try:
 
1189
            try:
 
1190
                unique_add(self._new_contents, trans_id, 'file')
 
1191
            except:
 
1192
                # Clean up the file, it never got registered so
 
1193
                # TreeTransform.finalize() won't clean it up.
 
1194
                f.close()
 
1195
                os.unlink(name)
 
1196
                raise
 
1197
 
 
1198
            f.writelines(contents)
 
1199
        finally:
 
1200
            f.close()
 
1201
        self._set_mtime(name)
 
1202
        self._set_mode(trans_id, mode_id, S_ISREG)
 
1203
 
 
1204
    def _read_file_chunks(self, trans_id):
 
1205
        cur_file = open(self._limbo_name(trans_id), 'rb')
 
1206
        try:
 
1207
            return cur_file.readlines()
 
1208
        finally:
 
1209
            cur_file.close()
 
1210
 
 
1211
    def _read_symlink_target(self, trans_id):
 
1212
        return os.readlink(self._limbo_name(trans_id))
 
1213
 
 
1214
    def _set_mtime(self, path):
 
1215
        """All files that are created get the same mtime.
 
1216
 
 
1217
        This time is set by the first object to be created.
 
1218
        """
 
1219
        if self._creation_mtime is None:
 
1220
            self._creation_mtime = time.time()
 
1221
        os.utime(path, (self._creation_mtime, self._creation_mtime))
 
1222
 
 
1223
    def create_hardlink(self, path, trans_id):
 
1224
        """Schedule creation of a hard link"""
 
1225
        name = self._limbo_name(trans_id)
 
1226
        try:
 
1227
            os.link(path, name)
 
1228
        except OSError, e:
 
1229
            if e.errno != errno.EPERM:
 
1230
                raise
 
1231
            raise errors.HardLinkNotSupported(path)
 
1232
        try:
 
1233
            unique_add(self._new_contents, trans_id, 'file')
 
1234
        except:
 
1235
            # Clean up the file, it never got registered so
 
1236
            # TreeTransform.finalize() won't clean it up.
 
1237
            os.unlink(name)
 
1238
            raise
 
1239
 
 
1240
    def create_directory(self, trans_id):
 
1241
        """Schedule creation of a new directory.
 
1242
 
 
1243
        See also new_directory.
 
1244
        """
 
1245
        os.mkdir(self._limbo_name(trans_id))
 
1246
        unique_add(self._new_contents, trans_id, 'directory')
 
1247
 
 
1248
    def create_symlink(self, target, trans_id):
 
1249
        """Schedule creation of a new symbolic link.
 
1250
 
 
1251
        target is a bytestring.
 
1252
        See also new_symlink.
 
1253
        """
 
1254
        if has_symlinks():
 
1255
            os.symlink(target, self._limbo_name(trans_id))
 
1256
            unique_add(self._new_contents, trans_id, 'symlink')
 
1257
        else:
 
1258
            try:
 
1259
                path = FinalPaths(self).get_path(trans_id)
 
1260
            except KeyError:
 
1261
                path = None
 
1262
            raise UnableCreateSymlink(path=path)
 
1263
 
 
1264
    def cancel_creation(self, trans_id):
 
1265
        """Cancel the creation of new file contents."""
 
1266
        del self._new_contents[trans_id]
 
1267
        children = self._limbo_children.get(trans_id)
 
1268
        # if this is a limbo directory with children, move them before removing
 
1269
        # the directory
 
1270
        if children is not None:
 
1271
            self._rename_in_limbo(children)
 
1272
            del self._limbo_children[trans_id]
 
1273
            del self._limbo_children_names[trans_id]
 
1274
        delete_any(self._limbo_name(trans_id))
 
1275
 
 
1276
 
 
1277
class TreeTransform(DiskTreeTransform):
1230
1278
    """Represent a tree transformation.
1231
1279
 
1232
1280
    This object is designed to support incremental generation of the transform,
1318
1366
            tree.unlock()
1319
1367
            raise
1320
1368
 
1321
 
        TreeTransformBase.__init__(self, tree, limbodir, pb,
 
1369
        # Cache of realpath results, to speed up canonical_path
 
1370
        self._realpaths = {}
 
1371
        # Cache of relpath results, to speed up canonical_path
 
1372
        self._relpaths = {}
 
1373
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
1322
1374
                                   tree.case_sensitive)
1323
1375
        self._deletiondir = deletiondir
1324
1376
 
 
1377
    def canonical_path(self, path):
 
1378
        """Get the canonical tree-relative path"""
 
1379
        # don't follow final symlinks
 
1380
        abs = self._tree.abspath(path)
 
1381
        if abs in self._relpaths:
 
1382
            return self._relpaths[abs]
 
1383
        dirname, basename = os.path.split(abs)
 
1384
        if dirname not in self._realpaths:
 
1385
            self._realpaths[dirname] = os.path.realpath(dirname)
 
1386
        dirname = self._realpaths[dirname]
 
1387
        abs = pathjoin(dirname, basename)
 
1388
        if dirname in self._relpaths:
 
1389
            relpath = pathjoin(self._relpaths[dirname], basename)
 
1390
            relpath = relpath.rstrip('/\\')
 
1391
        else:
 
1392
            relpath = self._tree.relpath(abs)
 
1393
        self._relpaths[abs] = relpath
 
1394
        return relpath
 
1395
 
 
1396
    def tree_kind(self, trans_id):
 
1397
        """Determine the file kind in the working tree.
 
1398
 
 
1399
        Raises NoSuchFile if the file does not exist
 
1400
        """
 
1401
        path = self._tree_id_paths.get(trans_id)
 
1402
        if path is None:
 
1403
            raise NoSuchFile(None)
 
1404
        try:
 
1405
            return file_kind(self._tree.abspath(path))
 
1406
        except OSError, e:
 
1407
            if e.errno != errno.ENOENT:
 
1408
                raise
 
1409
            else:
 
1410
                raise NoSuchFile(path)
 
1411
 
 
1412
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1413
        """Set the mode of new file contents.
 
1414
        The mode_id is the existing file to get the mode from (often the same
 
1415
        as trans_id).  The operation is only performed if there's a mode match
 
1416
        according to typefunc.
 
1417
        """
 
1418
        if mode_id is None:
 
1419
            mode_id = trans_id
 
1420
        try:
 
1421
            old_path = self._tree_id_paths[mode_id]
 
1422
        except KeyError:
 
1423
            return
 
1424
        try:
 
1425
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
1426
        except OSError, e:
 
1427
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
1428
                # Either old_path doesn't exist, or the parent of the
 
1429
                # target is not a directory (but will be one eventually)
 
1430
                # Either way, we know it doesn't exist *right now*
 
1431
                # See also bug #248448
 
1432
                return
 
1433
            else:
 
1434
                raise
 
1435
        if typefunc(mode):
 
1436
            os.chmod(self._limbo_name(trans_id), mode)
 
1437
 
 
1438
    def iter_tree_children(self, parent_id):
 
1439
        """Iterate through the entry's tree children, if any"""
 
1440
        try:
 
1441
            path = self._tree_id_paths[parent_id]
 
1442
        except KeyError:
 
1443
            return
 
1444
        try:
 
1445
            children = os.listdir(self._tree.abspath(path))
 
1446
        except OSError, e:
 
1447
            if not (osutils._is_error_enotdir(e)
 
1448
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
1449
                raise
 
1450
            return
 
1451
 
 
1452
        for child in children:
 
1453
            childpath = joinpath(path, child)
 
1454
            if self._tree.is_control_filename(childpath):
 
1455
                continue
 
1456
            yield self.trans_id_tree_path(childpath)
 
1457
 
 
1458
    def _generate_limbo_path(self, trans_id):
 
1459
        """Generate a limbo path using the final path if possible.
 
1460
 
 
1461
        This optimizes the performance of applying the tree transform by
 
1462
        avoiding renames.  These renames can be avoided only when the parent
 
1463
        directory is already scheduled for creation.
 
1464
 
 
1465
        If the final path cannot be used, falls back to using the trans_id as
 
1466
        the relpath.
 
1467
        """
 
1468
        parent = self._new_parent.get(trans_id)
 
1469
        # if the parent directory is already in limbo (e.g. when building a
 
1470
        # tree), choose a limbo name inside the parent, to reduce further
 
1471
        # renames.
 
1472
        use_direct_path = False
 
1473
        if self._new_contents.get(parent) == 'directory':
 
1474
            filename = self._new_name.get(trans_id)
 
1475
            if filename is not None:
 
1476
                if parent not in self._limbo_children:
 
1477
                    self._limbo_children[parent] = set()
 
1478
                    self._limbo_children_names[parent] = {}
 
1479
                    use_direct_path = True
 
1480
                # the direct path can only be used if no other file has
 
1481
                # already taken this pathname, i.e. if the name is unused, or
 
1482
                # if it is already associated with this trans_id.
 
1483
                elif self._case_sensitive_target:
 
1484
                    if (self._limbo_children_names[parent].get(filename)
 
1485
                        in (trans_id, None)):
 
1486
                        use_direct_path = True
 
1487
                else:
 
1488
                    for l_filename, l_trans_id in\
 
1489
                        self._limbo_children_names[parent].iteritems():
 
1490
                        if l_trans_id == trans_id:
 
1491
                            continue
 
1492
                        if l_filename.lower() == filename.lower():
 
1493
                            break
 
1494
                    else:
 
1495
                        use_direct_path = True
 
1496
 
 
1497
        if not use_direct_path:
 
1498
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
 
1499
 
 
1500
        limbo_name = pathjoin(self._limbo_files[parent], filename)
 
1501
        self._limbo_children[parent].add(trans_id)
 
1502
        self._limbo_children_names[parent][filename] = trans_id
 
1503
        return limbo_name
 
1504
 
 
1505
 
1325
1506
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1326
1507
        """Apply all changes to the inventory and filesystem.
1327
1508
 
1337
1518
        :param _mover: Supply an alternate FileMover, for testing
1338
1519
        """
1339
1520
        if not no_conflicts:
1340
 
            conflicts = self.find_conflicts()
1341
 
            if len(conflicts) != 0:
1342
 
                raise MalformedTransform(conflicts=conflicts)
 
1521
            self._check_malformed()
1343
1522
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1344
1523
        try:
1345
1524
            if precomputed_delta is None:
1449
1628
                child_pb.update('removing file', num, len(tree_paths))
1450
1629
                full_path = self._tree.abspath(path)
1451
1630
                if trans_id in self._removed_contents:
1452
 
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
1453
 
                                     trans_id))
1454
 
                elif trans_id in self._new_name or trans_id in \
1455
 
                    self._new_parent:
 
1631
                    delete_path = os.path.join(self._deletiondir, trans_id)
 
1632
                    mover.pre_delete(full_path, delete_path)
 
1633
                elif (trans_id in self._new_name
 
1634
                      or trans_id in self._new_parent):
1456
1635
                    try:
1457
1636
                        mover.rename(full_path, self._limbo_name(trans_id))
1458
1637
                    except OSError, e:
1504
1683
        return modified_paths
1505
1684
 
1506
1685
 
1507
 
class TransformPreview(TreeTransformBase):
 
1686
class TransformPreview(DiskTreeTransform):
1508
1687
    """A TreeTransform for generating preview trees.
1509
1688
 
1510
1689
    Unlike TreeTransform, this version works when the input tree is a
1515
1694
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1516
1695
        tree.lock_read()
1517
1696
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1518
 
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1697
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1519
1698
 
1520
1699
    def canonical_path(self, path):
1521
1700
        return path
1563
1742
        self._all_children_cache = {}
1564
1743
        self._path2trans_id_cache = {}
1565
1744
        self._final_name_cache = {}
1566
 
 
1567
 
    def _changes(self, file_id):
1568
 
        for changes in self._transform.iter_changes():
1569
 
            if changes[0] == file_id:
1570
 
                return changes
 
1745
        self._iter_changes_cache = dict((c[0], c) for c in
 
1746
                                        self._transform.iter_changes())
1571
1747
 
1572
1748
    def _content_change(self, file_id):
1573
1749
        """Return True if the content of this file changed"""
1574
 
        changes = self._changes(file_id)
 
1750
        changes = self._iter_changes_cache.get(file_id)
1575
1751
        # changes[2] is true if the file content changed.  See
1576
1752
        # InterTree.iter_changes.
1577
1753
        return (changes is not None and changes[2])
1646
1822
    def __iter__(self):
1647
1823
        return iter(self.all_file_ids())
1648
1824
 
1649
 
    def has_id(self, file_id):
 
1825
    def _has_id(self, file_id, fallback_check):
1650
1826
        if file_id in self._transform._r_new_id:
1651
1827
            return True
1652
1828
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1653
1829
            trans_id in self._transform._removed_id]):
1654
1830
            return False
1655
1831
        else:
1656
 
            return self._transform._tree.has_id(file_id)
 
1832
            return fallback_check(file_id)
 
1833
 
 
1834
    def has_id(self, file_id):
 
1835
        return self._has_id(file_id, self._transform._tree.has_id)
 
1836
 
 
1837
    def has_or_had_id(self, file_id):
 
1838
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
1657
1839
 
1658
1840
    def _path2trans_id(self, path):
1659
1841
        # We must not use None here, because that is a valid value to store.
1712
1894
            if self._transform.final_file_id(trans_id) is None:
1713
1895
                yield self._final_paths._determine_path(trans_id)
1714
1896
 
1715
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
 
1897
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
 
1898
        yield_parents=False):
1716
1899
        for trans_id, parent_file_id in ordered_entries:
1717
1900
            file_id = self._transform.final_file_id(trans_id)
1718
1901
            if file_id is None:
1744
1927
                ordered_ids.append((trans_id, parent_file_id))
1745
1928
        return ordered_ids
1746
1929
 
1747
 
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1930
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1748
1931
        # This may not be a maximally efficient implementation, but it is
1749
1932
        # reasonably straightforward.  An implementation that grafts the
1750
1933
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1752
1935
        # position.
1753
1936
        ordered_ids = self._list_files_by_dir()
1754
1937
        for entry, trans_id in self._make_inv_entries(ordered_ids,
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."""
 
1938
            specific_file_ids, yield_parents=yield_parents):
 
1939
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1940
 
 
1941
    def _iter_entries_for_dir(self, dir_path):
 
1942
        """Return path, entry for items in a directory without recursing down."""
 
1943
        dir_file_id = self.path2id(dir_path)
 
1944
        ordered_ids = []
 
1945
        for file_id in self.iter_children(dir_file_id):
 
1946
            trans_id = self._transform.trans_id_file_id(file_id)
 
1947
            ordered_ids.append((trans_id, file_id))
 
1948
        for entry, trans_id in self._make_inv_entries(ordered_ids):
 
1949
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1950
 
 
1951
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1952
        """See WorkingTree.list_files."""
1760
1953
        # XXX This should behave like WorkingTree.list_files, but is really
1761
1954
        # more like RevisionTree.list_files.
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
 
1955
        if recursive:
 
1956
            prefix = None
 
1957
            if from_dir:
 
1958
                prefix = from_dir + '/'
 
1959
            entries = self.iter_entries_by_dir()
 
1960
            for path, entry in entries:
 
1961
                if entry.name == '' and not include_root:
 
1962
                    continue
 
1963
                if prefix:
 
1964
                    if not path.startswith(prefix):
 
1965
                        continue
 
1966
                    path = path[len(prefix):]
 
1967
                yield path, 'V', entry.kind, entry.file_id, entry
 
1968
        else:
 
1969
            if from_dir is None and include_root is True:
 
1970
                root_entry = inventory.make_entry('directory', '',
 
1971
                    ROOT_PARENT, self.get_root_id())
 
1972
                yield '', 'V', 'directory', root_entry.file_id, root_entry
 
1973
            entries = self._iter_entries_for_dir(from_dir or '')
 
1974
            for path, entry in entries:
 
1975
                yield path, 'V', entry.kind, entry.file_id, entry
1766
1976
 
1767
1977
    def kind(self, file_id):
1768
1978
        trans_id = self._transform.trans_id_file_id(file_id)
1778
1988
    def get_file_mtime(self, file_id, path=None):
1779
1989
        """See Tree.get_file_mtime"""
1780
1990
        if not self._content_change(file_id):
1781
 
            return self._transform._tree.get_file_mtime(file_id, path)
 
1991
            return self._transform._tree.get_file_mtime(file_id)
1782
1992
        return self._stat_limbo_file(file_id).st_mtime
1783
1993
 
1784
1994
    def _file_size(self, entry, stat_value):
1838
2048
                statval = os.lstat(limbo_name)
1839
2049
                size = statval.st_size
1840
2050
                if not supports_executable():
1841
 
                    executable = None
 
2051
                    executable = False
1842
2052
                else:
1843
2053
                    executable = statval.st_mode & S_IEXEC
1844
2054
            else:
1845
2055
                size = None
1846
2056
                executable = None
1847
2057
            if kind == 'symlink':
1848
 
                link_or_sha1 = os.readlink(limbo_name)
1849
 
        if supports_executable():
1850
 
            executable = tt._new_executability.get(trans_id, executable)
 
2058
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
2059
        executable = tt._new_executability.get(trans_id, executable)
1851
2060
        return kind, size, executable, link_or_sha1
1852
2061
 
1853
2062
    def iter_changes(self, from_tree, include_unchanged=False,
1879
2088
        name = self._transform._limbo_name(trans_id)
1880
2089
        return open(name, 'rb')
1881
2090
 
 
2091
    def get_file_with_stat(self, file_id, path=None):
 
2092
        return self.get_file(file_id, path), None
 
2093
 
1882
2094
    def annotate_iter(self, file_id,
1883
2095
                      default_revision=_mod_revision.CURRENT_REVISION):
1884
 
        changes = self._changes(file_id)
 
2096
        changes = self._iter_changes_cache.get(file_id)
1885
2097
        if changes is None:
1886
2098
            get_old = True
1887
2099
        else:
1899
2111
            return old_annotation
1900
2112
        if not changed_content:
1901
2113
            return old_annotation
 
2114
        # TODO: This is doing something similar to what WT.annotate_iter is
 
2115
        #       doing, however it fails slightly because it doesn't know what
 
2116
        #       the *other* revision_id is, so it doesn't know how to give the
 
2117
        #       other as the origin for some lines, they all get
 
2118
        #       'default_revision'
 
2119
        #       It would be nice to be able to use the new Annotator based
 
2120
        #       approach, as well.
1902
2121
        return annotate.reannotate([old_annotation],
1903
2122
                                   self.get_file(file_id).readlines(),
1904
2123
                                   default_revision)
1909
2128
            return self._transform._tree.get_symlink_target(file_id)
1910
2129
        trans_id = self._transform.trans_id_file_id(file_id)
1911
2130
        name = self._transform._limbo_name(trans_id)
1912
 
        return os.readlink(name)
 
2131
        return osutils.readlink(name)
1913
2132
 
1914
2133
    def walkdirs(self, prefix=''):
1915
2134
        pending = [self._transform.root]
1970
2189
        self.transform = transform
1971
2190
 
1972
2191
    def _determine_path(self, trans_id):
1973
 
        if trans_id == self.transform.root:
 
2192
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
1974
2193
            return ""
1975
2194
        name = self.transform.final_name(trans_id)
1976
2195
        parent_id = self.transform.final_parent(trans_id)
2000
2219
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2001
2220
               delta_from_tree=False):
2002
2221
    """Create working tree for a branch, using a TreeTransform.
2003
 
    
 
2222
 
2004
2223
    This function should be used on empty trees, having a tree root at most.
2005
2224
    (see merge and revert functionality for working with existing trees)
2006
2225
 
2007
2226
    Existing files are handled like so:
2008
 
    
 
2227
 
2009
2228
    - Existing bzrdirs take precedence over creating new items.  They are
2010
2229
      created as '%s.diverted' % name.
2011
2230
    - Otherwise, if the content on disk matches the content we are building,
2113
2332
                    executable = tree.is_executable(file_id, tree_path)
2114
2333
                    if executable:
2115
2334
                        tt.set_executability(executable, trans_id)
2116
 
                    deferred_contents.append((file_id, trans_id))
 
2335
                    trans_data = (trans_id, tree_path)
 
2336
                    deferred_contents.append((file_id, trans_data))
2117
2337
                else:
2118
2338
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2119
2339
                                                          tree)
2150
2370
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2151
2371
                  hardlink):
2152
2372
    total = len(desired_files) + offset
 
2373
    wt = tt._tree
2153
2374
    if accelerator_tree is None:
2154
2375
        new_desired_files = desired_files
2155
2376
    else:
2156
2377
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
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]))
 
2378
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
 
2379
                     in iter if not (c or e[0] != e[1])]
 
2380
        if accelerator_tree.supports_content_filtering():
 
2381
            unchanged = [(f, p) for (f, p) in unchanged
 
2382
                         if not accelerator_tree.iter_search_rules([p]).next()]
 
2383
        unchanged = dict(unchanged)
2159
2384
        new_desired_files = []
2160
2385
        count = 0
2161
 
        for file_id, trans_id in desired_files:
 
2386
        for file_id, (trans_id, tree_path) in desired_files:
2162
2387
            accelerator_path = unchanged.get(file_id)
2163
2388
            if accelerator_path is None:
2164
 
                new_desired_files.append((file_id, trans_id))
 
2389
                new_desired_files.append((file_id, (trans_id, tree_path)))
2165
2390
                continue
2166
2391
            pb.update('Adding file contents', count + offset, total)
2167
2392
            if hardlink:
2169
2394
                                   trans_id)
2170
2395
            else:
2171
2396
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
2397
                if wt.supports_content_filtering():
 
2398
                    filters = wt._content_filter_stack(tree_path)
 
2399
                    contents = filtered_output_bytes(contents, filters,
 
2400
                        ContentFilterContext(tree_path, tree))
2172
2401
                try:
2173
2402
                    tt.create_file(contents, trans_id)
2174
2403
                finally:
2175
 
                    contents.close()
 
2404
                    try:
 
2405
                        contents.close()
 
2406
                    except AttributeError:
 
2407
                        # after filtering, contents may no longer be file-like
 
2408
                        pass
2176
2409
            count += 1
2177
2410
        offset += count
2178
 
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
2179
 
                                                 new_desired_files)):
 
2411
    for count, ((trans_id, tree_path), contents) in enumerate(
 
2412
            tree.iter_files_bytes(new_desired_files)):
 
2413
        if wt.supports_content_filtering():
 
2414
            filters = wt._content_filter_stack(tree_path)
 
2415
            contents = filtered_output_bytes(contents, filters,
 
2416
                ContentFilterContext(tree_path, tree))
2180
2417
        tt.create_file(contents, trans_id)
2181
2418
        pb.update('Adding file contents', count + offset, total)
2182
2419
 
2242
2479
    if kind == 'file':
2243
2480
        contents = tree.get_file(entry.file_id).readlines()
2244
2481
        executable = tree.is_executable(entry.file_id)
2245
 
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
2482
        return tt.new_file(name, parent_id, contents, entry.file_id,
2246
2483
                           executable)
2247
2484
    elif kind in ('directory', 'tree-reference'):
2248
2485
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2249
2486
        if kind == 'tree-reference':
2250
2487
            tt.set_tree_reference(entry.reference_revision, trans_id)
2251
 
        return trans_id 
 
2488
        return trans_id
2252
2489
    elif kind == 'symlink':
2253
2490
        target = tree.get_symlink_target(entry.file_id)
2254
2491
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2272
2509
        tt.create_directory(trans_id)
2273
2510
 
2274
2511
 
2275
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2276
 
    """Create new file contents according to tree contents."""
 
2512
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
 
2513
    filter_tree_path=None):
 
2514
    """Create new file contents according to tree contents.
 
2515
    
 
2516
    :param filter_tree_path: the tree path to use to lookup
 
2517
      content filters to apply to the bytes output in the working tree.
 
2518
      This only applies if the working tree supports content filtering.
 
2519
    """
2277
2520
    kind = tree.kind(file_id)
2278
2521
    if kind == 'directory':
2279
2522
        tt.create_directory(trans_id)
2284
2527
                bytes = tree_file.readlines()
2285
2528
            finally:
2286
2529
                tree_file.close()
 
2530
        wt = tt._tree
 
2531
        if wt.supports_content_filtering() and filter_tree_path is not None:
 
2532
            filters = wt._content_filter_stack(filter_tree_path)
 
2533
            bytes = filtered_output_bytes(bytes, filters,
 
2534
                ContentFilterContext(filter_tree_path, tree))
2287
2535
        tt.create_file(bytes, trans_id)
2288
2536
    elif kind == "symlink":
2289
2537
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2333
2581
        if entry.kind != working_kind:
2334
2582
            contents_mod, meta_mod = True, False
2335
2583
        else:
2336
 
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2584
            cur_entry._read_tree_state(working_tree.id2path(file_id),
2337
2585
                                       working_tree)
2338
2586
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2339
2587
            cur_entry._forget_tree_state()
2477
2725
                    parent_trans = ROOT_PARENT
2478
2726
                else:
2479
2727
                    parent_trans = tt.trans_id_file_id(parent[1])
2480
 
                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)
2481
2732
            if executable[0] != executable[1] and kind[1] == "file":
2482
2733
                tt.set_executability(executable[1], trans_id)
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)
 
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()
2486
2751
    finally:
2487
2752
        if basis_tree is not None:
2488
2753
            basis_tree.unlock()
2528
2793
                existing_file, new_file = conflict[1], conflict[2]
2529
2794
            new_name = tt.final_name(existing_file)+'.moved'
2530
2795
            tt.adjust_path(new_name, final_parent, existing_file)
2531
 
            new_conflicts.add((c_type, 'Moved existing file to', 
 
2796
            new_conflicts.add((c_type, 'Moved existing file to',
2532
2797
                               existing_file, new_file))
2533
2798
        elif c_type == 'parent loop':
2534
2799
            # break the loop by undoing one of the ops that caused the loop
2538
2803
            new_conflicts.add((c_type, 'Cancelled move', cur,
2539
2804
                               tt.final_parent(cur),))
2540
2805
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2541
 
            
 
2806
 
2542
2807
        elif c_type == 'missing parent':
2543
2808
            trans_id = conflict[1]
2544
2809
            try:
2545
2810
                tt.cancel_deletion(trans_id)
2546
 
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2811
                new_conflicts.add(('deleting parent', 'Not deleting',
2547
2812
                                   trans_id))
2548
2813
            except KeyError:
2549
2814
                create = True
2614
2879
        if len(conflict) == 3:
2615
2880
            yield Conflict.factory(c_type, action=action, path=modified_path,
2616
2881
                                     file_id=modified_id)
2617
 
             
 
2882
 
2618
2883
        else:
2619
2884
            conflicting_path = fp.get_path(conflict[3])
2620
2885
            conflicting_id = tt.final_file_id(conflict[3])
2621
2886
            yield Conflict.factory(c_type, action=action, path=modified_path,
2622
 
                                   file_id=modified_id, 
 
2887
                                   file_id=modified_id,
2623
2888
                                   conflict_path=conflicting_path,
2624
2889
                                   conflict_file_id=conflicting_id)
2625
2890