/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Robert Collins
  • Date: 2010-05-11 08:36:16 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511083616-b8fjb19zomwupid0
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.

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