/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: Aaron Bentley
  • Date: 2008-10-26 20:40:39 UTC
  • mto: (0.14.31 prepare-shelf)
  • mto: This revision was merged to the branch mainline in revision 3820.
  • Revision ID: aaron@aaronbentley.com-20081026204039-jkf9igehc9dkr6c7
More unicodeness for Shelf tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import errno
19
19
from stat import S_ISREG, S_IEXEC
20
 
import time
21
20
 
22
21
from bzrlib.lazy_import import lazy_import
23
22
lazy_import(globals(), """
24
23
from bzrlib import (
25
24
    annotate,
26
 
    bencode,
27
25
    bzrdir,
28
26
    delta,
29
27
    errors,
31
29
    multiparent,
32
30
    osutils,
33
31
    revision as _mod_revision,
34
 
    ui,
35
32
    )
 
33
from bzrlib.util import bencode
36
34
""")
37
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
38
 
                           ReusingTransform, CantMoveRoot,
 
36
                           ReusingTransform, NotVersionedError, CantMoveRoot,
39
37
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
40
38
                           UnableCreateSymlink)
41
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
42
39
from bzrlib.inventory import InventoryEntry
43
40
from bzrlib.osutils import (
44
41
    delete_any,
50
47
    splitpath,
51
48
    supports_executable,
52
49
)
53
 
from bzrlib.progress import ProgressPhase
 
50
from bzrlib.progress import DummyProgress, ProgressPhase
54
51
from bzrlib.symbol_versioning import (
55
52
        deprecated_function,
56
53
        deprecated_in,
78
75
 
79
76
 
80
77
class TreeTransformBase(object):
81
 
    """The base class for TreeTransform and its kin."""
 
78
    """The base class for TreeTransform and TreeTransformBase"""
82
79
 
83
 
    def __init__(self, tree, pb=None,
 
80
    def __init__(self, tree, limbodir, pb=DummyProgress(),
84
81
                 case_sensitive=True):
85
82
        """Constructor.
86
83
 
87
84
        :param tree: The tree that will be transformed, but not necessarily
88
85
            the output tree.
89
 
        :param pb: ignored
 
86
        :param limbodir: A directory where new files can be stored until
 
87
            they are installed in their proper places
 
88
        :param pb: A ProgressBar indicating how much progress is being made
90
89
        :param case_sensitive: If True, the target of the transform is
91
90
            case sensitive, not just case preserving.
92
91
        """
93
92
        object.__init__(self)
94
93
        self._tree = tree
 
94
        self._limbodir = limbodir
 
95
        self._deletiondir = None
95
96
        self._id_number = 0
96
97
        # mapping of trans_id -> new basename
97
98
        self._new_name = {}
99
100
        self._new_parent = {}
100
101
        # mapping of trans_id with new contents -> new file_kind
101
102
        self._new_contents = {}
 
103
        # A mapping of transform ids to their limbo filename
 
104
        self._limbo_files = {}
 
105
        # A mapping of transform ids to a set of the transform ids of children
 
106
        # that their limbo directory has
 
107
        self._limbo_children = {}
 
108
        # Map transform ids to maps of child filename to child transform id
 
109
        self._limbo_children_names = {}
 
110
        # List of transform ids that need to be renamed from limbo into place
 
111
        self._needs_rename = set()
102
112
        # Set of trans_ids whose contents will be removed
103
113
        self._removed_contents = set()
104
114
        # Mapping of trans_id -> new execute-bit value
111
121
        self._non_present_ids = {}
112
122
        # Mapping of new file_id -> trans_id
113
123
        self._r_new_id = {}
114
 
        # Set of trans_ids that will be removed
 
124
        # Set of file_ids that will be removed
115
125
        self._removed_id = set()
116
126
        # Mapping of path in old tree -> trans_id
117
127
        self._tree_path_ids = {}
118
128
        # Mapping trans_id -> path in old tree
119
129
        self._tree_id_paths = {}
 
130
        # Cache of realpath results, to speed up canonical_path
 
131
        self._realpaths = {}
 
132
        # Cache of relpath results, to speed up canonical_path
 
133
        self._relpaths = {}
120
134
        # The trans_id that will be used as the tree root
121
135
        root_id = tree.get_root_id()
122
136
        if root_id is not None:
132
146
        # A counter of how many files have been renamed
133
147
        self.rename_count = 0
134
148
 
135
 
    def finalize(self):
136
 
        """Release the working tree lock, if held.
137
 
 
138
 
        This is required if apply has not been invoked, but can be invoked
139
 
        even after apply.
140
 
        """
141
 
        if self._tree is None:
142
 
            return
143
 
        self._tree.unlock()
144
 
        self._tree = None
145
 
 
146
149
    def __get_root(self):
147
150
        return self._new_root
148
151
 
149
152
    root = property(__get_root)
150
153
 
 
154
    def finalize(self):
 
155
        """Release the working tree lock, if held, clean up limbo dir.
 
156
 
 
157
        This is required if apply has not been invoked, but can be invoked
 
158
        even after apply.
 
159
        """
 
160
        if self._tree is None:
 
161
            return
 
162
        try:
 
163
            entries = [(self._limbo_name(t), t, k) for t, k in
 
164
                       self._new_contents.iteritems()]
 
165
            entries.sort(reverse=True)
 
166
            for path, trans_id, kind in entries:
 
167
                if kind == "directory":
 
168
                    os.rmdir(path)
 
169
                else:
 
170
                    os.unlink(path)
 
171
            try:
 
172
                os.rmdir(self._limbodir)
 
173
            except OSError:
 
174
                # We don't especially care *why* the dir is immortal.
 
175
                raise ImmortalLimbo(self._limbodir)
 
176
            try:
 
177
                if self._deletiondir is not None:
 
178
                    os.rmdir(self._deletiondir)
 
179
            except OSError:
 
180
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
181
        finally:
 
182
            self._tree.unlock()
 
183
            self._tree = None
 
184
 
151
185
    def _assign_id(self):
152
186
        """Produce a new tranform id"""
153
187
        new_id = "new-%s" % self._id_number
163
197
 
164
198
    def adjust_path(self, name, parent, trans_id):
165
199
        """Change the path that is assigned to a transaction id."""
166
 
        if parent is None:
167
 
            raise ValueError("Parent trans-id may not be None")
168
200
        if trans_id == self._new_root:
169
201
            raise CantMoveRoot
 
202
        previous_parent = self._new_parent.get(trans_id)
 
203
        previous_name = self._new_name.get(trans_id)
170
204
        self._new_name[trans_id] = name
171
205
        self._new_parent[trans_id] = parent
 
206
        if parent == ROOT_PARENT:
 
207
            if self._new_root is not None:
 
208
                raise ValueError("Cannot have multiple roots.")
 
209
            self._new_root = trans_id
 
210
        if (trans_id in self._limbo_files and
 
211
            trans_id not in self._needs_rename):
 
212
            self._rename_in_limbo([trans_id])
 
213
            self._limbo_children[previous_parent].remove(trans_id)
 
214
            del self._limbo_children_names[previous_parent][previous_name]
 
215
 
 
216
    def _rename_in_limbo(self, trans_ids):
 
217
        """Fix limbo names so that the right final path is produced.
 
218
 
 
219
        This means we outsmarted ourselves-- we tried to avoid renaming
 
220
        these files later by creating them with their final names in their
 
221
        final parents.  But now the previous name or parent is no longer
 
222
        suitable, so we have to rename them.
 
223
 
 
224
        Even for trans_ids that have no new contents, we must remove their
 
225
        entries from _limbo_files, because they are now stale.
 
226
        """
 
227
        for trans_id in trans_ids:
 
228
            old_path = self._limbo_files.pop(trans_id)
 
229
            if trans_id not in self._new_contents:
 
230
                continue
 
231
            new_path = self._limbo_name(trans_id)
 
232
            os.rename(old_path, new_path)
172
233
 
173
234
    def adjust_root_path(self, name, parent):
174
235
        """Emulate moving the root by moving all children, instead.
175
 
 
 
236
        
176
237
        We do this by undoing the association of root's transaction id with the
177
238
        current tree.  This allows us to create a new directory with that
178
 
        transaction id.  We unversion the root directory and version the
 
239
        transaction id.  We unversion the root directory and version the 
179
240
        physically new directory, and hope someone versions the tree root
180
241
        later.
181
242
        """
184
245
        # force moving all children of root
185
246
        for child_id in self.iter_tree_children(old_root):
186
247
            if child_id != parent:
187
 
                self.adjust_path(self.final_name(child_id),
 
248
                self.adjust_path(self.final_name(child_id), 
188
249
                                 self.final_parent(child_id), child_id)
189
250
            file_id = self.final_file_id(child_id)
190
251
            if file_id is not None:
191
252
                self.unversion_file(child_id)
192
253
            self.version_file(file_id, child_id)
193
 
 
 
254
        
194
255
        # the physical root needs a new transaction id
195
256
        self._tree_path_ids.pop("")
196
257
        self._tree_id_paths.pop(old_root)
202
263
        self.version_file(old_root_file_id, old_root)
203
264
        self.unversion_file(self._new_root)
204
265
 
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
 
300
319
    def trans_id_tree_path(self, path):
301
320
        """Determine (and maybe set) the transaction ID for a tree path."""
302
321
        path = self.canonical_path(path)
312
331
            return ROOT_PARENT
313
332
        return self.trans_id_tree_path(os.path.dirname(path))
314
333
 
 
334
    def create_file(self, contents, trans_id, mode_id=None):
 
335
        """Schedule creation of a new file.
 
336
 
 
337
        See also new_file.
 
338
        
 
339
        Contents is an iterator of strings, all of which will be written
 
340
        to the target destination.
 
341
 
 
342
        New file takes the permissions of any existing file with that id,
 
343
        unless mode_id is specified.
 
344
        """
 
345
        name = self._limbo_name(trans_id)
 
346
        f = open(name, 'wb')
 
347
        try:
 
348
            try:
 
349
                unique_add(self._new_contents, trans_id, 'file')
 
350
            except:
 
351
                # Clean up the file, it never got registered so
 
352
                # TreeTransform.finalize() won't clean it up.
 
353
                f.close()
 
354
                os.unlink(name)
 
355
                raise
 
356
 
 
357
            f.writelines(contents)
 
358
        finally:
 
359
            f.close()
 
360
        self._set_mode(trans_id, mode_id, S_ISREG)
 
361
 
 
362
    def _set_mode(self, trans_id, mode_id, typefunc):
 
363
        """Set the mode of new file contents.
 
364
        The mode_id is the existing file to get the mode from (often the same
 
365
        as trans_id).  The operation is only performed if there's a mode match
 
366
        according to typefunc.
 
367
        """
 
368
        if mode_id is None:
 
369
            mode_id = trans_id
 
370
        try:
 
371
            old_path = self._tree_id_paths[mode_id]
 
372
        except KeyError:
 
373
            return
 
374
        try:
 
375
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
376
        except OSError, e:
 
377
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
378
                # Either old_path doesn't exist, or the parent of the
 
379
                # target is not a directory (but will be one eventually)
 
380
                # Either way, we know it doesn't exist *right now*
 
381
                # See also bug #248448
 
382
                return
 
383
            else:
 
384
                raise
 
385
        if typefunc(mode):
 
386
            os.chmod(self._limbo_name(trans_id), mode)
 
387
 
 
388
    def create_hardlink(self, path, trans_id):
 
389
        """Schedule creation of a hard link"""
 
390
        name = self._limbo_name(trans_id)
 
391
        try:
 
392
            os.link(path, name)
 
393
        except OSError, e:
 
394
            if e.errno != errno.EPERM:
 
395
                raise
 
396
            raise errors.HardLinkNotSupported(path)
 
397
        try:
 
398
            unique_add(self._new_contents, trans_id, 'file')
 
399
        except:
 
400
            # Clean up the file, it never got registered so
 
401
            # TreeTransform.finalize() won't clean it up.
 
402
            os.unlink(name)
 
403
            raise
 
404
 
 
405
    def create_directory(self, trans_id):
 
406
        """Schedule creation of a new directory.
 
407
        
 
408
        See also new_directory.
 
409
        """
 
410
        os.mkdir(self._limbo_name(trans_id))
 
411
        unique_add(self._new_contents, trans_id, 'directory')
 
412
 
 
413
    def create_symlink(self, target, trans_id):
 
414
        """Schedule creation of a new symbolic link.
 
415
 
 
416
        target is a bytestring.
 
417
        See also new_symlink.
 
418
        """
 
419
        if has_symlinks():
 
420
            os.symlink(target, self._limbo_name(trans_id))
 
421
            unique_add(self._new_contents, trans_id, 'symlink')
 
422
        else:
 
423
            try:
 
424
                path = FinalPaths(self).get_path(trans_id)
 
425
            except KeyError:
 
426
                path = None
 
427
            raise UnableCreateSymlink(path=path)
 
428
 
 
429
    def cancel_creation(self, trans_id):
 
430
        """Cancel the creation of new file contents."""
 
431
        del self._new_contents[trans_id]
 
432
        children = self._limbo_children.get(trans_id)
 
433
        # if this is a limbo directory with children, move them before removing
 
434
        # the directory
 
435
        if children is not None:
 
436
            self._rename_in_limbo(children)
 
437
            del self._limbo_children[trans_id]
 
438
            del self._limbo_children_names[trans_id]
 
439
        delete_any(self._limbo_name(trans_id))
 
440
 
315
441
    def delete_contents(self, trans_id):
316
442
        """Schedule the contents of a path entry for deletion"""
317
 
        # Ensure that the object exists in the WorkingTree, this will raise an
318
 
        # exception if there is a problem
319
443
        self.tree_kind(trans_id)
320
444
        self._removed_contents.add(trans_id)
321
445
 
393
517
        new_ids.update(changed_kind)
394
518
        return sorted(FinalPaths(self).get_paths(new_ids))
395
519
 
 
520
    def tree_kind(self, trans_id):
 
521
        """Determine the file kind in the working tree.
 
522
 
 
523
        Raises NoSuchFile if the file does not exist
 
524
        """
 
525
        path = self._tree_id_paths.get(trans_id)
 
526
        if path is None:
 
527
            raise NoSuchFile(None)
 
528
        try:
 
529
            return file_kind(self._tree.abspath(path))
 
530
        except OSError, e:
 
531
            if e.errno != errno.ENOENT:
 
532
                raise
 
533
            else:
 
534
                raise NoSuchFile(path)
 
535
 
396
536
    def final_kind(self, trans_id):
397
537
        """Determine the final file kind, after any changes applied.
398
 
 
 
538
        
399
539
        Raises NoSuchFile if the file does not exist/has no contents.
400
540
        (It is conceivable that a path would be created without the
401
541
        corresponding contents insertion command)
421
561
 
422
562
    def final_file_id(self, trans_id):
423
563
        """Determine the file id after any changes are applied, or None.
424
 
 
 
564
        
425
565
        None indicates that the file will not be versioned after changes are
426
566
        applied.
427
567
        """
466
606
 
467
607
    def by_parent(self):
468
608
        """Return a map of parent: children for known parents.
469
 
 
 
609
        
470
610
        Only new paths and parents of tree files with assigned ids are used.
471
611
        """
472
612
        by_parent = {}
473
613
        items = list(self._new_parent.iteritems())
474
 
        items.extend((t, self.final_parent(t)) for t in
 
614
        items.extend((t, self.final_parent(t)) for t in 
475
615
                      self._tree_id_paths.keys())
476
616
        for trans_id, parent_id in items:
477
617
            if parent_id not in by_parent:
505
645
        conflicts.extend(self._overwrite_conflicts())
506
646
        return conflicts
507
647
 
508
 
    def _check_malformed(self):
509
 
        conflicts = self.find_conflicts()
510
 
        if len(conflicts) != 0:
511
 
            raise MalformedTransform(conflicts=conflicts)
512
 
 
513
648
    def _add_tree_children(self):
514
649
        """Add all the children of all active parents to the known paths.
515
650
 
517
652
        removed.  This is a necessary first step in detecting conflicts.
518
653
        """
519
654
        parents = self.by_parent().keys()
520
 
        parents.extend([t for t in self._removed_contents if
 
655
        parents.extend([t for t in self._removed_contents if 
521
656
                        self.tree_kind(t) == 'directory'])
522
657
        for trans_id in self._removed_id:
523
658
            file_id = self.tree_file_id(trans_id)
531
666
            # ensure that all children are registered with the transaction
532
667
            list(self.iter_tree_children(parent_id))
533
668
 
 
669
    def iter_tree_children(self, parent_id):
 
670
        """Iterate through the entry's tree children, if any"""
 
671
        try:
 
672
            path = self._tree_id_paths[parent_id]
 
673
        except KeyError:
 
674
            return
 
675
        try:
 
676
            children = os.listdir(self._tree.abspath(path))
 
677
        except OSError, e:
 
678
            if not (osutils._is_error_enotdir(e)
 
679
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
680
                raise
 
681
            return
 
682
 
 
683
        for child in children:
 
684
            childpath = joinpath(path, child)
 
685
            if self._tree.is_control_filename(childpath):
 
686
                continue
 
687
            yield self.trans_id_tree_path(childpath)
 
688
 
534
689
    def has_named_child(self, by_parent, parent_id, name):
535
690
        try:
536
691
            children = by_parent[parent_id]
590
745
 
591
746
    def _improper_versioning(self):
592
747
        """Cannot version a file with no contents, or a bad type.
593
 
 
 
748
        
594
749
        However, existing entries with no contents are okay.
595
750
        """
596
751
        conflicts = []
606
761
 
607
762
    def _executability_conflicts(self):
608
763
        """Check for bad executability changes.
609
 
 
 
764
        
610
765
        Only versioned files may have their executability set, because
611
766
        1. only versioned entries can have executability under windows
612
767
        2. only files can be executable.  (The execute bit on a directory
711
866
            return True
712
867
        return False
713
868
 
 
869
    def _limbo_name(self, trans_id):
 
870
        """Generate the limbo name of a file"""
 
871
        limbo_name = self._limbo_files.get(trans_id)
 
872
        if limbo_name is not None:
 
873
            return limbo_name
 
874
        parent = self._new_parent.get(trans_id)
 
875
        # if the parent directory is already in limbo (e.g. when building a
 
876
        # tree), choose a limbo name inside the parent, to reduce further
 
877
        # renames.
 
878
        use_direct_path = False
 
879
        if self._new_contents.get(parent) == 'directory':
 
880
            filename = self._new_name.get(trans_id)
 
881
            if filename is not None:
 
882
                if parent not in self._limbo_children:
 
883
                    self._limbo_children[parent] = set()
 
884
                    self._limbo_children_names[parent] = {}
 
885
                    use_direct_path = True
 
886
                # the direct path can only be used if no other file has
 
887
                # already taken this pathname, i.e. if the name is unused, or
 
888
                # if it is already associated with this trans_id.
 
889
                elif self._case_sensitive_target:
 
890
                    if (self._limbo_children_names[parent].get(filename)
 
891
                        in (trans_id, None)):
 
892
                        use_direct_path = True
 
893
                else:
 
894
                    for l_filename, l_trans_id in\
 
895
                        self._limbo_children_names[parent].iteritems():
 
896
                        if l_trans_id == trans_id:
 
897
                            continue
 
898
                        if l_filename.lower() == filename.lower():
 
899
                            break
 
900
                    else:
 
901
                        use_direct_path = True
 
902
 
 
903
        if use_direct_path:
 
904
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
905
            self._limbo_children[parent].add(trans_id)
 
906
            self._limbo_children_names[parent][filename] = trans_id
 
907
        else:
 
908
            limbo_name = pathjoin(self._limbodir, trans_id)
 
909
            self._needs_rename.add(trans_id)
 
910
        self._limbo_files[trans_id] = limbo_name
 
911
        return limbo_name
 
912
 
714
913
    def _set_executability(self, path, trans_id):
715
914
        """Set the executability of versioned files """
716
915
        if supports_executable():
737
936
            self.version_file(file_id, trans_id)
738
937
        return trans_id
739
938
 
740
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
939
    def new_file(self, name, parent_id, contents, file_id=None, 
741
940
                 executable=None):
742
941
        """Convenience method to create files.
743
 
 
 
942
        
744
943
        name is the name of the file to create.
745
944
        parent_id is the transaction id of the parent directory of the file.
746
945
        contents is an iterator of bytestrings, which will be used to produce
766
965
        """
767
966
        trans_id = self._new_entry(name, parent_id, file_id)
768
967
        self.create_directory(trans_id)
769
 
        return trans_id
 
968
        return trans_id 
770
969
 
771
970
    def new_symlink(self, name, parent_id, target, file_id=None):
772
971
        """Convenience method to create symbolic link.
773
 
 
 
972
        
774
973
        name is the name of the symlink to create.
775
974
        parent_id is the transaction id of the parent directory of the symlink.
776
975
        target is a bytestring of the target of the symlink.
922
1121
    def get_preview_tree(self):
923
1122
        """Return a tree representing the result of the transform.
924
1123
 
925
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
926
 
        it.
 
1124
        This tree only supports the subset of Tree functionality required
 
1125
        by show_diff_trees.  It must only be compared to tt._tree.
927
1126
        """
928
1127
        return _PreviewTree(self)
929
1128
 
930
 
    def commit(self, branch, message, merge_parents=None, strict=False):
931
 
        """Commit the result of this TreeTransform to a branch.
932
 
 
933
 
        :param branch: The branch to commit to.
934
 
        :param message: The message to attach to the commit.
935
 
        :param merge_parents: Additional parents specified by pending merges.
936
 
        :return: The revision_id of the revision committed.
937
 
        """
938
 
        self._check_malformed()
939
 
        if strict:
940
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
941
 
            for trans_id in unversioned:
942
 
                if self.final_file_id(trans_id) is None:
943
 
                    raise errors.StrictCommitFailed()
944
 
 
945
 
        revno, last_rev_id = branch.last_revision_info()
946
 
        if last_rev_id == _mod_revision.NULL_REVISION:
947
 
            if merge_parents is not None:
948
 
                raise ValueError('Cannot supply merge parents for first'
949
 
                                 ' commit.')
950
 
            parent_ids = []
951
 
        else:
952
 
            parent_ids = [last_rev_id]
953
 
            if merge_parents is not None:
954
 
                parent_ids.extend(merge_parents)
955
 
        if self._tree.get_revision_id() != last_rev_id:
956
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
957
 
                             self._tree.get_revision_id())
958
 
        builder = branch.get_commit_builder(parent_ids)
959
 
        preview = self.get_preview_tree()
960
 
        list(builder.record_iter_changes(preview, last_rev_id,
961
 
                                         self.iter_changes()))
962
 
        builder.finish_inventory()
963
 
        revision_id = builder.commit(message)
964
 
        branch.set_last_revision_info(revno + 1, revision_id)
965
 
        return revision_id
966
 
 
967
 
    def _text_parent(self, trans_id):
 
1129
    def _get_parents_texts(self, trans_id):
 
1130
        """Get texts for compression parents of this file."""
968
1131
        file_id = self.tree_file_id(trans_id)
969
1132
        try:
970
1133
            if file_id is None or self._tree.kind(file_id) != 'file':
971
 
                return None
 
1134
                return ()
972
1135
        except errors.NoSuchFile:
973
 
            return None
974
 
        return file_id
975
 
 
976
 
    def _get_parents_texts(self, trans_id):
977
 
        """Get texts for compression parents of this file."""
978
 
        file_id = self._text_parent(trans_id)
979
 
        if file_id is None:
980
1136
            return ()
981
1137
        return (self._tree.get_file_text(file_id),)
982
1138
 
983
1139
    def _get_parents_lines(self, trans_id):
984
1140
        """Get lines for compression parents of this file."""
985
 
        file_id = self._text_parent(trans_id)
986
 
        if file_id is None:
987
 
            return ()
988
 
        return (self._tree.get_file_lines(file_id),)
 
1141
        return tuple(osutils.split_lines(p) for p
 
1142
                     in self._get_parents_texts(trans_id))
989
1143
 
990
1144
    def serialize(self, serializer):
991
1145
        """Serialize this TreeTransform.
1013
1167
                                      (('attribs',),))
1014
1168
        for trans_id, kind in self._new_contents.items():
1015
1169
            if kind == 'file':
1016
 
                lines = osutils.chunks_to_lines(
1017
 
                    self._read_file_chunks(trans_id))
 
1170
                cur_file = open(self._limbo_name(trans_id), 'rb')
 
1171
                try:
 
1172
                    lines = osutils.split_lines(cur_file.read())
 
1173
                finally:
 
1174
                    cur_file.close()
1018
1175
                parents = self._get_parents_lines(trans_id)
1019
1176
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1020
1177
                content = ''.join(mpdiff.to_patch())
1021
1178
            if kind == 'directory':
1022
1179
                content = ''
1023
1180
            if kind == 'symlink':
1024
 
                content = self._read_symlink_target(trans_id)
 
1181
                content = os.readlink(self._limbo_name(trans_id))
1025
1182
            yield serializer.bytes_record(content, ((trans_id, kind),))
1026
1183
 
 
1184
 
1027
1185
    def deserialize(self, records):
1028
1186
        """Deserialize a stored TreeTransform.
1029
1187
 
1060
1218
                self.create_symlink(content.decode('utf-8'), trans_id)
1061
1219
 
1062
1220
 
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):
 
1221
class TreeTransform(TreeTransformBase):
1279
1222
    """Represent a tree transformation.
1280
1223
 
1281
1224
    This object is designed to support incremental generation of the transform,
1340
1283
    FileMover does not delete files until it is sure that a rollback will not
1341
1284
    happen.
1342
1285
    """
1343
 
    def __init__(self, tree, pb=None):
 
1286
    def __init__(self, tree, pb=DummyProgress()):
1344
1287
        """Note: a tree_write lock is taken on the tree.
1345
1288
 
1346
1289
        Use TreeTransform.finalize() to release the lock (can be omitted if
1367
1310
            tree.unlock()
1368
1311
            raise
1369
1312
 
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,
 
1313
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1375
1314
                                   tree.case_sensitive)
1376
1315
        self._deletiondir = deletiondir
1377
1316
 
1378
 
    def canonical_path(self, path):
1379
 
        """Get the canonical tree-relative path"""
1380
 
        # don't follow final symlinks
1381
 
        abs = self._tree.abspath(path)
1382
 
        if abs in self._relpaths:
1383
 
            return self._relpaths[abs]
1384
 
        dirname, basename = os.path.split(abs)
1385
 
        if dirname not in self._realpaths:
1386
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1387
 
        dirname = self._realpaths[dirname]
1388
 
        abs = pathjoin(dirname, basename)
1389
 
        if dirname in self._relpaths:
1390
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1391
 
            relpath = relpath.rstrip('/\\')
1392
 
        else:
1393
 
            relpath = self._tree.relpath(abs)
1394
 
        self._relpaths[abs] = relpath
1395
 
        return relpath
1396
 
 
1397
 
    def tree_kind(self, trans_id):
1398
 
        """Determine the file kind in the working tree.
1399
 
 
1400
 
        Raises NoSuchFile if the file does not exist
1401
 
        """
1402
 
        path = self._tree_id_paths.get(trans_id)
1403
 
        if path is None:
1404
 
            raise NoSuchFile(None)
1405
 
        try:
1406
 
            return file_kind(self._tree.abspath(path))
1407
 
        except OSError, e:
1408
 
            if e.errno != errno.ENOENT:
1409
 
                raise
1410
 
            else:
1411
 
                raise NoSuchFile(path)
1412
 
 
1413
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1414
 
        """Set the mode of new file contents.
1415
 
        The mode_id is the existing file to get the mode from (often the same
1416
 
        as trans_id).  The operation is only performed if there's a mode match
1417
 
        according to typefunc.
1418
 
        """
1419
 
        if mode_id is None:
1420
 
            mode_id = trans_id
1421
 
        try:
1422
 
            old_path = self._tree_id_paths[mode_id]
1423
 
        except KeyError:
1424
 
            return
1425
 
        try:
1426
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1427
 
        except OSError, e:
1428
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1429
 
                # Either old_path doesn't exist, or the parent of the
1430
 
                # target is not a directory (but will be one eventually)
1431
 
                # Either way, we know it doesn't exist *right now*
1432
 
                # See also bug #248448
1433
 
                return
1434
 
            else:
1435
 
                raise
1436
 
        if typefunc(mode):
1437
 
            os.chmod(self._limbo_name(trans_id), mode)
1438
 
 
1439
 
    def iter_tree_children(self, parent_id):
1440
 
        """Iterate through the entry's tree children, if any"""
1441
 
        try:
1442
 
            path = self._tree_id_paths[parent_id]
1443
 
        except KeyError:
1444
 
            return
1445
 
        try:
1446
 
            children = os.listdir(self._tree.abspath(path))
1447
 
        except OSError, e:
1448
 
            if not (osutils._is_error_enotdir(e)
1449
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1450
 
                raise
1451
 
            return
1452
 
 
1453
 
        for child in children:
1454
 
            childpath = joinpath(path, child)
1455
 
            if self._tree.is_control_filename(childpath):
1456
 
                continue
1457
 
            yield self.trans_id_tree_path(childpath)
1458
 
 
1459
 
    def _generate_limbo_path(self, trans_id):
1460
 
        """Generate a limbo path using the final path if possible.
1461
 
 
1462
 
        This optimizes the performance of applying the tree transform by
1463
 
        avoiding renames.  These renames can be avoided only when the parent
1464
 
        directory is already scheduled for creation.
1465
 
 
1466
 
        If the final path cannot be used, falls back to using the trans_id as
1467
 
        the relpath.
1468
 
        """
1469
 
        parent = self._new_parent.get(trans_id)
1470
 
        # if the parent directory is already in limbo (e.g. when building a
1471
 
        # tree), choose a limbo name inside the parent, to reduce further
1472
 
        # renames.
1473
 
        use_direct_path = False
1474
 
        if self._new_contents.get(parent) == 'directory':
1475
 
            filename = self._new_name.get(trans_id)
1476
 
            if filename is not None:
1477
 
                if parent not in self._limbo_children:
1478
 
                    self._limbo_children[parent] = set()
1479
 
                    self._limbo_children_names[parent] = {}
1480
 
                    use_direct_path = True
1481
 
                # the direct path can only be used if no other file has
1482
 
                # already taken this pathname, i.e. if the name is unused, or
1483
 
                # if it is already associated with this trans_id.
1484
 
                elif self._case_sensitive_target:
1485
 
                    if (self._limbo_children_names[parent].get(filename)
1486
 
                        in (trans_id, None)):
1487
 
                        use_direct_path = True
1488
 
                else:
1489
 
                    for l_filename, l_trans_id in\
1490
 
                        self._limbo_children_names[parent].iteritems():
1491
 
                        if l_trans_id == trans_id:
1492
 
                            continue
1493
 
                        if l_filename.lower() == filename.lower():
1494
 
                            break
1495
 
                    else:
1496
 
                        use_direct_path = True
1497
 
 
1498
 
        if not use_direct_path:
1499
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1500
 
 
1501
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1502
 
        self._limbo_children[parent].add(trans_id)
1503
 
        self._limbo_children_names[parent][filename] = trans_id
1504
 
        return limbo_name
1505
 
 
1506
 
 
1507
1317
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1508
1318
        """Apply all changes to the inventory and filesystem.
1509
1319
 
1519
1329
        :param _mover: Supply an alternate FileMover, for testing
1520
1330
        """
1521
1331
        if not no_conflicts:
1522
 
            self._check_malformed()
 
1332
            conflicts = self.find_conflicts()
 
1333
            if len(conflicts) != 0:
 
1334
                raise MalformedTransform(conflicts=conflicts)
1523
1335
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
1336
        try:
1525
1337
            if precomputed_delta is None:
1629
1441
                child_pb.update('removing file', num, len(tree_paths))
1630
1442
                full_path = self._tree.abspath(path)
1631
1443
                if trans_id in self._removed_contents:
1632
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1633
 
                    mover.pre_delete(full_path, delete_path)
1634
 
                elif (trans_id in self._new_name
1635
 
                      or trans_id in self._new_parent):
 
1444
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1445
                                     trans_id))
 
1446
                elif trans_id in self._new_name or trans_id in \
 
1447
                    self._new_parent:
1636
1448
                    try:
1637
1449
                        mover.rename(full_path, self._limbo_name(trans_id))
1638
1450
                    except OSError, e:
1684
1496
        return modified_paths
1685
1497
 
1686
1498
 
1687
 
class TransformPreview(DiskTreeTransform):
 
1499
class TransformPreview(TreeTransformBase):
1688
1500
    """A TreeTransform for generating preview trees.
1689
1501
 
1690
1502
    Unlike TreeTransform, this version works when the input tree is a
1692
1504
    unversioned files in the input tree.
1693
1505
    """
1694
1506
 
1695
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1507
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1696
1508
        tree.lock_read()
1697
1509
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1698
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1510
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1699
1511
 
1700
1512
    def canonical_path(self, path):
1701
1513
        return path
1743
1555
        self._all_children_cache = {}
1744
1556
        self._path2trans_id_cache = {}
1745
1557
        self._final_name_cache = {}
1746
 
        self._iter_changes_cache = dict((c[0], c) for c in
1747
 
                                        self._transform.iter_changes())
 
1558
 
 
1559
    def _changes(self, file_id):
 
1560
        for changes in self._transform.iter_changes():
 
1561
            if changes[0] == file_id:
 
1562
                return changes
1748
1563
 
1749
1564
    def _content_change(self, file_id):
1750
1565
        """Return True if the content of this file changed"""
1751
 
        changes = self._iter_changes_cache.get(file_id)
 
1566
        changes = self._changes(file_id)
1752
1567
        # changes[2] is true if the file content changed.  See
1753
1568
        # InterTree.iter_changes.
1754
1569
        return (changes is not None and changes[2])
1798
1613
            executable = self.is_executable(file_id, path)
1799
1614
        return kind, executable, None
1800
1615
 
1801
 
    def is_locked(self):
1802
 
        return False
1803
 
 
1804
1616
    def lock_read(self):
1805
1617
        # Perhaps in theory, this should lock the TreeTransform?
1806
 
        return self
 
1618
        pass
1807
1619
 
1808
1620
    def unlock(self):
1809
1621
        pass
1826
1638
    def __iter__(self):
1827
1639
        return iter(self.all_file_ids())
1828
1640
 
1829
 
    def _has_id(self, file_id, fallback_check):
 
1641
    def has_id(self, file_id):
1830
1642
        if file_id in self._transform._r_new_id:
1831
1643
            return True
1832
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1833
 
            trans_id in self._transform._removed_id]):
 
1644
        elif file_id in self._transform._removed_id:
1834
1645
            return False
1835
1646
        else:
1836
 
            return fallback_check(file_id)
1837
 
 
1838
 
    def has_id(self, 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)
 
1647
            return self._transform._tree.has_id(file_id)
1843
1648
 
1844
1649
    def _path2trans_id(self, path):
1845
1650
        # We must not use None here, because that is a valid value to store.
1898
1703
            if self._transform.final_file_id(trans_id) is None:
1899
1704
                yield self._final_paths._determine_path(trans_id)
1900
1705
 
1901
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1902
 
        yield_parents=False):
 
1706
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
1903
1707
        for trans_id, parent_file_id in ordered_entries:
1904
1708
            file_id = self._transform.final_file_id(trans_id)
1905
1709
            if file_id is None:
1931
1735
                ordered_ids.append((trans_id, parent_file_id))
1932
1736
        return ordered_ids
1933
1737
 
1934
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
1738
    def iter_entries_by_dir(self, specific_file_ids=None):
1935
1739
        # This may not be a maximally efficient implementation, but it is
1936
1740
        # reasonably straightforward.  An implementation that grafts the
1937
1741
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1939
1743
        # position.
1940
1744
        ordered_ids = self._list_files_by_dir()
1941
1745
        for entry, trans_id in self._make_inv_entries(ordered_ids,
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."""
 
1746
                                                      specific_file_ids):
 
1747
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1748
 
 
1749
    def list_files(self, include_root=False):
 
1750
        """See Tree.list_files."""
1957
1751
        # XXX This should behave like WorkingTree.list_files, but is really
1958
1752
        # more like RevisionTree.list_files.
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
 
1753
        for path, entry in self.iter_entries_by_dir():
 
1754
            if entry.name == '' and not include_root:
 
1755
                continue
 
1756
            yield path, 'V', entry.kind, entry.file_id, entry
1980
1757
 
1981
1758
    def kind(self, file_id):
1982
1759
        trans_id = self._transform.trans_id_file_id(file_id)
1992
1769
    def get_file_mtime(self, file_id, path=None):
1993
1770
        """See Tree.get_file_mtime"""
1994
1771
        if not self._content_change(file_id):
1995
 
            return self._transform._tree.get_file_mtime(file_id)
 
1772
            return self._transform._tree.get_file_mtime(file_id, path)
1996
1773
        return self._stat_limbo_file(file_id).st_mtime
1997
1774
 
1998
1775
    def _file_size(self, entry, stat_value):
2052
1829
                statval = os.lstat(limbo_name)
2053
1830
                size = statval.st_size
2054
1831
                if not supports_executable():
2055
 
                    executable = False
 
1832
                    executable = None
2056
1833
                else:
2057
1834
                    executable = statval.st_mode & S_IEXEC
2058
1835
            else:
2059
1836
                size = None
2060
1837
                executable = None
2061
1838
            if kind == 'symlink':
2062
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2063
 
        executable = tt._new_executability.get(trans_id, executable)
 
1839
                link_or_sha1 = os.readlink(limbo_name)
 
1840
        if supports_executable():
 
1841
            executable = tt._new_executability.get(trans_id, executable)
2064
1842
        return kind, size, executable, link_or_sha1
2065
1843
 
2066
1844
    def iter_changes(self, from_tree, include_unchanged=False,
2092
1870
        name = self._transform._limbo_name(trans_id)
2093
1871
        return open(name, 'rb')
2094
1872
 
2095
 
    def get_file_with_stat(self, file_id, path=None):
2096
 
        return self.get_file(file_id, path), None
 
1873
    def get_file_text(self, file_id):
 
1874
        text_file = self.get_file(file_id)
 
1875
        try:
 
1876
            return text_file.read()
 
1877
        finally:
 
1878
            text_file.close()
2097
1879
 
2098
1880
    def annotate_iter(self, file_id,
2099
1881
                      default_revision=_mod_revision.CURRENT_REVISION):
2100
 
        changes = self._iter_changes_cache.get(file_id)
 
1882
        changes = self._changes(file_id)
2101
1883
        if changes is None:
2102
1884
            get_old = True
2103
1885
        else:
2115
1897
            return old_annotation
2116
1898
        if not changed_content:
2117
1899
            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.
2125
1900
        return annotate.reannotate([old_annotation],
2126
1901
                                   self.get_file(file_id).readlines(),
2127
1902
                                   default_revision)
2132
1907
            return self._transform._tree.get_symlink_target(file_id)
2133
1908
        trans_id = self._transform.trans_id_file_id(file_id)
2134
1909
        name = self._transform._limbo_name(trans_id)
2135
 
        return osutils.readlink(name)
 
1910
        return os.readlink(name)
2136
1911
 
2137
1912
    def walkdirs(self, prefix=''):
2138
1913
        pending = [self._transform.root]
2193
1968
        self.transform = transform
2194
1969
 
2195
1970
    def _determine_path(self, trans_id):
2196
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1971
        if trans_id == self.transform.root:
2197
1972
            return ""
2198
1973
        name = self.transform.final_name(trans_id)
2199
1974
        parent_id = self.transform.final_parent(trans_id)
2223
1998
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2224
1999
               delta_from_tree=False):
2225
2000
    """Create working tree for a branch, using a TreeTransform.
2226
 
 
 
2001
    
2227
2002
    This function should be used on empty trees, having a tree root at most.
2228
2003
    (see merge and revert functionality for working with existing trees)
2229
2004
 
2230
2005
    Existing files are handled like so:
2231
 
 
 
2006
    
2232
2007
    - Existing bzrdirs take precedence over creating new items.  They are
2233
2008
      created as '%s.diverted' % name.
2234
2009
    - Otherwise, if the content on disk matches the content we are building,
2336
2111
                    executable = tree.is_executable(file_id, tree_path)
2337
2112
                    if executable:
2338
2113
                        tt.set_executability(executable, trans_id)
2339
 
                    trans_data = (trans_id, tree_path)
2340
 
                    deferred_contents.append((file_id, trans_data))
 
2114
                    deferred_contents.append((file_id, trans_id))
2341
2115
                else:
2342
2116
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2343
2117
                                                          tree)
2374
2148
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2375
2149
                  hardlink):
2376
2150
    total = len(desired_files) + offset
2377
 
    wt = tt._tree
2378
2151
    if accelerator_tree is None:
2379
2152
        new_desired_files = desired_files
2380
2153
    else:
2381
2154
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
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)
 
2155
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
2156
                         in iter if not (c or e[0] != e[1]))
2388
2157
        new_desired_files = []
2389
2158
        count = 0
2390
 
        for file_id, (trans_id, tree_path) in desired_files:
 
2159
        for file_id, trans_id in desired_files:
2391
2160
            accelerator_path = unchanged.get(file_id)
2392
2161
            if accelerator_path is None:
2393
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
2162
                new_desired_files.append((file_id, trans_id))
2394
2163
                continue
2395
2164
            pb.update('Adding file contents', count + offset, total)
2396
2165
            if hardlink:
2398
2167
                                   trans_id)
2399
2168
            else:
2400
2169
                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))
2405
2170
                try:
2406
2171
                    tt.create_file(contents, trans_id)
2407
2172
                finally:
2408
 
                    try:
2409
 
                        contents.close()
2410
 
                    except AttributeError:
2411
 
                        # after filtering, contents may no longer be file-like
2412
 
                        pass
 
2173
                    contents.close()
2413
2174
            count += 1
2414
2175
        offset += count
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))
 
2176
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
2177
                                                 new_desired_files)):
2421
2178
        tt.create_file(contents, trans_id)
2422
2179
        pb.update('Adding file contents', count + offset, total)
2423
2180
 
2483
2240
    if kind == 'file':
2484
2241
        contents = tree.get_file(entry.file_id).readlines()
2485
2242
        executable = tree.is_executable(entry.file_id)
2486
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
2243
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2487
2244
                           executable)
2488
2245
    elif kind in ('directory', 'tree-reference'):
2489
2246
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2490
2247
        if kind == 'tree-reference':
2491
2248
            tt.set_tree_reference(entry.reference_revision, trans_id)
2492
 
        return trans_id
 
2249
        return trans_id 
2493
2250
    elif kind == 'symlink':
2494
2251
        target = tree.get_symlink_target(entry.file_id)
2495
2252
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2513
2270
        tt.create_directory(trans_id)
2514
2271
 
2515
2272
 
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
 
    """
 
2273
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
 
2274
    """Create new file contents according to tree contents."""
2524
2275
    kind = tree.kind(file_id)
2525
2276
    if kind == 'directory':
2526
2277
        tt.create_directory(trans_id)
2531
2282
                bytes = tree_file.readlines()
2532
2283
            finally:
2533
2284
                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))
2539
2285
        tt.create_file(bytes, trans_id)
2540
2286
    elif kind == "symlink":
2541
2287
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2585
2331
        if entry.kind != working_kind:
2586
2332
            contents_mod, meta_mod = True, False
2587
2333
        else:
2588
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
2334
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2589
2335
                                       working_tree)
2590
2336
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2591
2337
            cur_entry._forget_tree_state()
2593
2339
 
2594
2340
 
2595
2341
def revert(working_tree, target_tree, filenames, backups=False,
2596
 
           pb=None, change_reporter=None):
 
2342
           pb=DummyProgress(), change_reporter=None):
2597
2343
    """Revert a working tree's contents to those of a target tree."""
2598
2344
    target_tree.lock_read()
2599
 
    pb = ui.ui_factory.nested_progress_bar()
2600
2345
    tt = TreeTransform(working_tree, pb)
2601
2346
    try:
2602
2347
        pp = ProgressPhase("Revert phase", 3, pb)
2621
2366
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2622
2367
                              backups, pp, basis_tree=None,
2623
2368
                              merge_modified=None):
 
2369
    pp.next_phase()
2624
2370
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2625
2371
    try:
2626
2372
        if merge_modified is None:
2630
2376
                                      merge_modified, basis_tree)
2631
2377
    finally:
2632
2378
        child_pb.finished()
 
2379
    pp.next_phase()
2633
2380
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2634
2381
    try:
2635
2382
        raw_conflicts = resolve_conflicts(tt, child_pb,
2728
2475
                    parent_trans = ROOT_PARENT
2729
2476
                else:
2730
2477
                    parent_trans = tt.trans_id_file_id(parent[1])
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)
 
2478
                tt.adjust_path(name[1], parent_trans, trans_id)
2735
2479
            if executable[0] != executable[1] and kind[1] == "file":
2736
2480
                tt.set_executability(executable[1], trans_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()
 
2481
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2482
            deferred_files):
 
2483
            tt.create_file(bytes, trans_id, mode_id)
2754
2484
    finally:
2755
2485
        if basis_tree is not None:
2756
2486
            basis_tree.unlock()
2757
2487
    return merge_modified
2758
2488
 
2759
2489
 
2760
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2490
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2761
2491
    """Make many conflict-resolution attempts, but die if they fail"""
2762
2492
    if pass_func is None:
2763
2493
        pass_func = conflict_pass
2764
2494
    new_conflicts = set()
2765
 
    pb = ui.ui_factory.nested_progress_bar()
2766
2495
    try:
2767
2496
        for n in range(10):
2768
2497
            pb.update('Resolution pass', n+1, 10)
2772
2501
            new_conflicts.update(pass_func(tt, conflicts))
2773
2502
        raise MalformedTransform(conflicts=conflicts)
2774
2503
    finally:
2775
 
        pb.finished()
 
2504
        pb.clear()
2776
2505
 
2777
2506
 
2778
2507
def conflict_pass(tt, conflicts, path_tree=None):
2797
2526
                existing_file, new_file = conflict[1], conflict[2]
2798
2527
            new_name = tt.final_name(existing_file)+'.moved'
2799
2528
            tt.adjust_path(new_name, final_parent, existing_file)
2800
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2529
            new_conflicts.add((c_type, 'Moved existing file to', 
2801
2530
                               existing_file, new_file))
2802
2531
        elif c_type == 'parent loop':
2803
2532
            # break the loop by undoing one of the ops that caused the loop
2807
2536
            new_conflicts.add((c_type, 'Cancelled move', cur,
2808
2537
                               tt.final_parent(cur),))
2809
2538
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2810
 
 
 
2539
            
2811
2540
        elif c_type == 'missing parent':
2812
2541
            trans_id = conflict[1]
2813
2542
            try:
2814
2543
                tt.cancel_deletion(trans_id)
2815
 
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2544
                new_conflicts.add(('deleting parent', 'Not deleting', 
2816
2545
                                   trans_id))
2817
2546
            except KeyError:
2818
2547
                create = True
2827
2556
                        # special-case the other tree root (move its
2828
2557
                        # children to current root)
2829
2558
                        if entry.parent_id is None:
2830
 
                            create = False
 
2559
                            create=False
2831
2560
                            moved = _reparent_transform_children(
2832
2561
                                tt, trans_id, tt.root)
2833
2562
                            for child in moved:
2883
2612
        if len(conflict) == 3:
2884
2613
            yield Conflict.factory(c_type, action=action, path=modified_path,
2885
2614
                                     file_id=modified_id)
2886
 
 
 
2615
             
2887
2616
        else:
2888
2617
            conflicting_path = fp.get_path(conflict[3])
2889
2618
            conflicting_id = tt.final_file_id(conflict[3])
2890
2619
            yield Conflict.factory(c_type, action=action, path=modified_path,
2891
 
                                   file_id=modified_id,
 
2620
                                   file_id=modified_id, 
2892
2621
                                   conflict_path=conflicting_path,
2893
2622
                                   conflict_file_id=conflicting_id)
2894
2623
 
2901
2630
        self.pending_deletions = []
2902
2631
 
2903
2632
    def rename(self, from_, to):
2904
 
        """Rename a file from one path to another."""
 
2633
        """Rename a file from one path to another.  Functions like os.rename"""
2905
2634
        try:
2906
 
            osutils.rename(from_, to)
 
2635
            os.rename(from_, to)
2907
2636
        except OSError, e:
2908
2637
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2909
2638
                raise errors.FileExists(to, str(e))
2923
2652
    def rollback(self):
2924
2653
        """Reverse all renames that have been performed"""
2925
2654
        for from_, to in reversed(self.past_renames):
2926
 
            osutils.rename(to, from_)
 
2655
            os.rename(to, from_)
2927
2656
        # after rollback, don't reuse _FileMover
2928
2657
        past_renames = None
2929
2658
        pending_deletions = None