← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-09 15:09:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3699.
  • Revision ID: john@arbash-meinel.com-20080909150912-wyttm8he1zsls2ck
Use the right timing function on win32

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006, 2007, 2008, 2009 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
22
22
lazy_import(globals(), """
23
23
from bzrlib import (
24
24
    annotate,
25
 
    bencode,
26
25
    bzrdir,
27
26
    delta,
28
27
    errors,
29
28
    inventory,
30
 
    multiparent,
31
29
    osutils,
32
30
    revision as _mod_revision,
33
31
    )
36
34
                           ReusingTransform, NotVersionedError, CantMoveRoot,
37
35
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
38
36
                           UnableCreateSymlink)
39
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
40
37
from bzrlib.inventory import InventoryEntry
41
38
from bzrlib.osutils import (
42
39
    delete_any,
44
41
    has_symlinks,
45
42
    lexists,
46
43
    pathjoin,
47
 
    sha_file,
48
44
    splitpath,
49
45
    supports_executable,
50
46
)
51
47
from bzrlib.progress import DummyProgress, ProgressPhase
52
48
from bzrlib.symbol_versioning import (
53
49
        deprecated_function,
54
 
        deprecated_in,
55
50
        )
56
51
from bzrlib.trace import mutter, warning
57
52
from bzrlib import tree
76
71
 
77
72
 
78
73
class TreeTransformBase(object):
79
 
    """The base class for TreeTransform and its kin."""
 
74
    """The base class for TreeTransform and TreeTransformBase"""
80
75
 
81
 
    def __init__(self, tree, pb=DummyProgress(),
 
76
    def __init__(self, tree, limbodir, pb=DummyProgress(),
82
77
                 case_sensitive=True):
83
78
        """Constructor.
84
79
 
85
80
        :param tree: The tree that will be transformed, but not necessarily
86
81
            the output tree.
87
 
        :param pb: A ProgressTask indicating how much progress is being made
 
82
        :param limbodir: A directory where new files can be stored until
 
83
            they are installed in their proper places
 
84
        :param pb: A ProgressBar indicating how much progress is being made
88
85
        :param case_sensitive: If True, the target of the transform is
89
86
            case sensitive, not just case preserving.
90
87
        """
91
88
        object.__init__(self)
92
89
        self._tree = tree
 
90
        self._limbodir = limbodir
 
91
        self._deletiondir = None
93
92
        self._id_number = 0
94
93
        # mapping of trans_id -> new basename
95
94
        self._new_name = {}
97
96
        self._new_parent = {}
98
97
        # mapping of trans_id with new contents -> new file_kind
99
98
        self._new_contents = {}
 
99
        # A mapping of transform ids to their limbo filename
 
100
        self._limbo_files = {}
 
101
        # A mapping of transform ids to a set of the transform ids of children
 
102
        # that their limbo directory has
 
103
        self._limbo_children = {}
 
104
        # Map transform ids to maps of child filename to child transform id
 
105
        self._limbo_children_names = {}
 
106
        # List of transform ids that need to be renamed from limbo into place
 
107
        self._needs_rename = set()
100
108
        # Set of trans_ids whose contents will be removed
101
109
        self._removed_contents = set()
102
110
        # Mapping of trans_id -> new execute-bit value
109
117
        self._non_present_ids = {}
110
118
        # Mapping of new file_id -> trans_id
111
119
        self._r_new_id = {}
112
 
        # Set of trans_ids that will be removed
 
120
        # Set of file_ids that will be removed
113
121
        self._removed_id = set()
114
122
        # Mapping of path in old tree -> trans_id
115
123
        self._tree_path_ids = {}
116
124
        # Mapping trans_id -> path in old tree
117
125
        self._tree_id_paths = {}
 
126
        # Cache of realpath results, to speed up canonical_path
 
127
        self._realpaths = {}
 
128
        # Cache of relpath results, to speed up canonical_path
 
129
        self._relpaths = {}
118
130
        # The trans_id that will be used as the tree root
119
131
        root_id = tree.get_root_id()
120
132
        if root_id is not None:
130
142
        # A counter of how many files have been renamed
131
143
        self.rename_count = 0
132
144
 
133
 
    def finalize(self):
134
 
        """Release the working tree lock, if held.
135
 
 
136
 
        This is required if apply has not been invoked, but can be invoked
137
 
        even after apply.
138
 
        """
139
 
        if self._tree is None:
140
 
            return
141
 
        self._tree.unlock()
142
 
        self._tree = None
143
 
 
144
145
    def __get_root(self):
145
146
        return self._new_root
146
147
 
147
148
    root = property(__get_root)
148
149
 
 
150
    def finalize(self):
 
151
        """Release the working tree lock, if held, clean up limbo dir.
 
152
 
 
153
        This is required if apply has not been invoked, but can be invoked
 
154
        even after apply.
 
155
        """
 
156
        if self._tree is None:
 
157
            return
 
158
        try:
 
159
            entries = [(self._limbo_name(t), t, k) for t, k in
 
160
                       self._new_contents.iteritems()]
 
161
            entries.sort(reverse=True)
 
162
            for path, trans_id, kind in entries:
 
163
                if kind == "directory":
 
164
                    os.rmdir(path)
 
165
                else:
 
166
                    os.unlink(path)
 
167
            try:
 
168
                os.rmdir(self._limbodir)
 
169
            except OSError:
 
170
                # We don't especially care *why* the dir is immortal.
 
171
                raise ImmortalLimbo(self._limbodir)
 
172
            try:
 
173
                if self._deletiondir is not None:
 
174
                    os.rmdir(self._deletiondir)
 
175
            except OSError:
 
176
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
177
        finally:
 
178
            self._tree.unlock()
 
179
            self._tree = None
 
180
 
149
181
    def _assign_id(self):
150
182
        """Produce a new tranform id"""
151
183
        new_id = "new-%s" % self._id_number
163
195
        """Change the path that is assigned to a transaction id."""
164
196
        if trans_id == self._new_root:
165
197
            raise CantMoveRoot
 
198
        previous_parent = self._new_parent.get(trans_id)
 
199
        previous_name = self._new_name.get(trans_id)
166
200
        self._new_name[trans_id] = name
167
201
        self._new_parent[trans_id] = parent
168
202
        if parent == ROOT_PARENT:
169
203
            if self._new_root is not None:
170
204
                raise ValueError("Cannot have multiple roots.")
171
205
            self._new_root = trans_id
 
206
        if (trans_id in self._limbo_files and
 
207
            trans_id not in self._needs_rename):
 
208
            self._rename_in_limbo([trans_id])
 
209
            self._limbo_children[previous_parent].remove(trans_id)
 
210
            del self._limbo_children_names[previous_parent][previous_name]
 
211
 
 
212
    def _rename_in_limbo(self, trans_ids):
 
213
        """Fix limbo names so that the right final path is produced.
 
214
 
 
215
        This means we outsmarted ourselves-- we tried to avoid renaming
 
216
        these files later by creating them with their final names in their
 
217
        final parents.  But now the previous name or parent is no longer
 
218
        suitable, so we have to rename them.
 
219
 
 
220
        Even for trans_ids that have no new contents, we must remove their
 
221
        entries from _limbo_files, because they are now stale.
 
222
        """
 
223
        for trans_id in trans_ids:
 
224
            old_path = self._limbo_files.pop(trans_id)
 
225
            if trans_id not in self._new_contents:
 
226
                continue
 
227
            new_path = self._limbo_name(trans_id)
 
228
            os.rename(old_path, new_path)
172
229
 
173
230
    def adjust_root_path(self, name, parent):
174
231
        """Emulate moving the root by moving all children, instead.
175
 
 
 
232
        
176
233
        We do this by undoing the association of root's transaction id with the
177
234
        current tree.  This allows us to create a new directory with that
178
 
        transaction id.  We unversion the root directory and version the
 
235
        transaction id.  We unversion the root directory and version the 
179
236
        physically new directory, and hope someone versions the tree root
180
237
        later.
181
238
        """
184
241
        # force moving all children of root
185
242
        for child_id in self.iter_tree_children(old_root):
186
243
            if child_id != parent:
187
 
                self.adjust_path(self.final_name(child_id),
 
244
                self.adjust_path(self.final_name(child_id), 
188
245
                                 self.final_parent(child_id), child_id)
189
246
            file_id = self.final_file_id(child_id)
190
247
            if file_id is not None:
191
248
                self.unversion_file(child_id)
192
249
            self.version_file(file_id, child_id)
193
 
 
 
250
        
194
251
        # the physical root needs a new transaction id
195
252
        self._tree_path_ids.pop("")
196
253
        self._tree_id_paths.pop(old_root)
204
261
 
205
262
    def trans_id_tree_file_id(self, inventory_id):
206
263
        """Determine the transaction id of a working tree file.
207
 
 
 
264
        
208
265
        This reflects only files that already exist, not ones that will be
209
266
        added by transactions.
210
267
        """
223
280
            raise ValueError('None is not a valid file id')
224
281
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
225
282
            return self._r_new_id[file_id]
226
 
        else:
227
 
            try:
228
 
                self._tree.iter_entries_by_dir([file_id]).next()
229
 
            except StopIteration:
230
 
                if file_id in self._non_present_ids:
231
 
                    return self._non_present_ids[file_id]
232
 
                else:
233
 
                    trans_id = self._assign_id()
234
 
                    self._non_present_ids[file_id] = trans_id
235
 
                    return trans_id
236
 
            else:
237
 
                return self.trans_id_tree_file_id(file_id)
 
283
        elif file_id in self._tree.inventory:
 
284
            return self.trans_id_tree_file_id(file_id)
 
285
        elif file_id in self._non_present_ids:
 
286
            return self._non_present_ids[file_id]
 
287
        else:
 
288
            trans_id = self._assign_id()
 
289
            self._non_present_ids[file_id] = trans_id
 
290
            return trans_id
 
291
 
 
292
    def canonical_path(self, path):
 
293
        """Get the canonical tree-relative path"""
 
294
        # don't follow final symlinks
 
295
        abs = self._tree.abspath(path)
 
296
        if abs in self._relpaths:
 
297
            return self._relpaths[abs]
 
298
        dirname, basename = os.path.split(abs)
 
299
        if dirname not in self._realpaths:
 
300
            self._realpaths[dirname] = os.path.realpath(dirname)
 
301
        dirname = self._realpaths[dirname]
 
302
        abs = pathjoin(dirname, basename)
 
303
        if dirname in self._relpaths:
 
304
            relpath = pathjoin(self._relpaths[dirname], basename)
 
305
            relpath = relpath.rstrip('/\\')
 
306
        else:
 
307
            relpath = self._tree.relpath(abs)
 
308
        self._relpaths[abs] = relpath
 
309
        return relpath
238
310
 
239
311
    def trans_id_tree_path(self, path):
240
312
        """Determine (and maybe set) the transaction ID for a tree path."""
251
323
            return ROOT_PARENT
252
324
        return self.trans_id_tree_path(os.path.dirname(path))
253
325
 
 
326
    def create_file(self, contents, trans_id, mode_id=None):
 
327
        """Schedule creation of a new file.
 
328
 
 
329
        See also new_file.
 
330
        
 
331
        Contents is an iterator of strings, all of which will be written
 
332
        to the target destination.
 
333
 
 
334
        New file takes the permissions of any existing file with that id,
 
335
        unless mode_id is specified.
 
336
        """
 
337
        name = self._limbo_name(trans_id)
 
338
        f = open(name, 'wb')
 
339
        try:
 
340
            try:
 
341
                unique_add(self._new_contents, trans_id, 'file')
 
342
            except:
 
343
                # Clean up the file, it never got registered so
 
344
                # TreeTransform.finalize() won't clean it up.
 
345
                f.close()
 
346
                os.unlink(name)
 
347
                raise
 
348
 
 
349
            f.writelines(contents)
 
350
        finally:
 
351
            f.close()
 
352
        self._set_mode(trans_id, mode_id, S_ISREG)
 
353
 
 
354
    def _set_mode(self, trans_id, mode_id, typefunc):
 
355
        """Set the mode of new file contents.
 
356
        The mode_id is the existing file to get the mode from (often the same
 
357
        as trans_id).  The operation is only performed if there's a mode match
 
358
        according to typefunc.
 
359
        """
 
360
        if mode_id is None:
 
361
            mode_id = trans_id
 
362
        try:
 
363
            old_path = self._tree_id_paths[mode_id]
 
364
        except KeyError:
 
365
            return
 
366
        try:
 
367
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
368
        except OSError, e:
 
369
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
370
                # Either old_path doesn't exist, or the parent of the
 
371
                # target is not a directory (but will be one eventually)
 
372
                # Either way, we know it doesn't exist *right now*
 
373
                # See also bug #248448
 
374
                return
 
375
            else:
 
376
                raise
 
377
        if typefunc(mode):
 
378
            os.chmod(self._limbo_name(trans_id), mode)
 
379
 
 
380
    def create_hardlink(self, path, trans_id):
 
381
        """Schedule creation of a hard link"""
 
382
        name = self._limbo_name(trans_id)
 
383
        try:
 
384
            os.link(path, name)
 
385
        except OSError, e:
 
386
            if e.errno != errno.EPERM:
 
387
                raise
 
388
            raise errors.HardLinkNotSupported(path)
 
389
        try:
 
390
            unique_add(self._new_contents, trans_id, 'file')
 
391
        except:
 
392
            # Clean up the file, it never got registered so
 
393
            # TreeTransform.finalize() won't clean it up.
 
394
            os.unlink(name)
 
395
            raise
 
396
 
 
397
    def create_directory(self, trans_id):
 
398
        """Schedule creation of a new directory.
 
399
        
 
400
        See also new_directory.
 
401
        """
 
402
        os.mkdir(self._limbo_name(trans_id))
 
403
        unique_add(self._new_contents, trans_id, 'directory')
 
404
 
 
405
    def create_symlink(self, target, trans_id):
 
406
        """Schedule creation of a new symbolic link.
 
407
 
 
408
        target is a bytestring.
 
409
        See also new_symlink.
 
410
        """
 
411
        if has_symlinks():
 
412
            os.symlink(target, self._limbo_name(trans_id))
 
413
            unique_add(self._new_contents, trans_id, 'symlink')
 
414
        else:
 
415
            try:
 
416
                path = FinalPaths(self).get_path(trans_id)
 
417
            except KeyError:
 
418
                path = None
 
419
            raise UnableCreateSymlink(path=path)
 
420
 
 
421
    def cancel_creation(self, trans_id):
 
422
        """Cancel the creation of new file contents."""
 
423
        del self._new_contents[trans_id]
 
424
        children = self._limbo_children.get(trans_id)
 
425
        # if this is a limbo directory with children, move them before removing
 
426
        # the directory
 
427
        if children is not None:
 
428
            self._rename_in_limbo(children)
 
429
            del self._limbo_children[trans_id]
 
430
            del self._limbo_children_names[trans_id]
 
431
        delete_any(self._limbo_name(trans_id))
 
432
 
254
433
    def delete_contents(self, trans_id):
255
434
        """Schedule the contents of a path entry for deletion"""
256
435
        self.tree_kind(trans_id)
330
509
        new_ids.update(changed_kind)
331
510
        return sorted(FinalPaths(self).get_paths(new_ids))
332
511
 
 
512
    def tree_kind(self, trans_id):
 
513
        """Determine the file kind in the working tree.
 
514
 
 
515
        Raises NoSuchFile if the file does not exist
 
516
        """
 
517
        path = self._tree_id_paths.get(trans_id)
 
518
        if path is None:
 
519
            raise NoSuchFile(None)
 
520
        try:
 
521
            return file_kind(self._tree.abspath(path))
 
522
        except OSError, e:
 
523
            if e.errno != errno.ENOENT:
 
524
                raise
 
525
            else:
 
526
                raise NoSuchFile(path)
 
527
 
333
528
    def final_kind(self, trans_id):
334
529
        """Determine the final file kind, after any changes applied.
335
 
 
 
530
        
336
531
        Raises NoSuchFile if the file does not exist/has no contents.
337
532
        (It is conceivable that a path would be created without the
338
533
        corresponding contents insertion command)
354
549
        # the file is old; the old id is still valid
355
550
        if self._new_root == trans_id:
356
551
            return self._tree.get_root_id()
357
 
        return self._tree.path2id(path)
 
552
        return self._tree.inventory.path2id(path)
358
553
 
359
554
    def final_file_id(self, trans_id):
360
555
        """Determine the file id after any changes are applied, or None.
361
 
 
 
556
        
362
557
        None indicates that the file will not be versioned after changes are
363
558
        applied.
364
559
        """
403
598
 
404
599
    def by_parent(self):
405
600
        """Return a map of parent: children for known parents.
406
 
 
 
601
        
407
602
        Only new paths and parents of tree files with assigned ids are used.
408
603
        """
409
604
        by_parent = {}
410
605
        items = list(self._new_parent.iteritems())
411
 
        items.extend((t, self.final_parent(t)) for t in
 
606
        items.extend((t, self.final_parent(t)) for t in 
412
607
                      self._tree_id_paths.keys())
413
608
        for trans_id, parent_id in items:
414
609
            if parent_id not in by_parent:
442
637
        conflicts.extend(self._overwrite_conflicts())
443
638
        return conflicts
444
639
 
445
 
    def _check_malformed(self):
446
 
        conflicts = self.find_conflicts()
447
 
        if len(conflicts) != 0:
448
 
            raise MalformedTransform(conflicts=conflicts)
449
 
 
450
640
    def _add_tree_children(self):
451
641
        """Add all the children of all active parents to the known paths.
452
642
 
454
644
        removed.  This is a necessary first step in detecting conflicts.
455
645
        """
456
646
        parents = self.by_parent().keys()
457
 
        parents.extend([t for t in self._removed_contents if
 
647
        parents.extend([t for t in self._removed_contents if 
458
648
                        self.tree_kind(t) == 'directory'])
459
649
        for trans_id in self._removed_id:
460
650
            file_id = self.tree_file_id(trans_id)
468
658
            # ensure that all children are registered with the transaction
469
659
            list(self.iter_tree_children(parent_id))
470
660
 
 
661
    def iter_tree_children(self, parent_id):
 
662
        """Iterate through the entry's tree children, if any"""
 
663
        try:
 
664
            path = self._tree_id_paths[parent_id]
 
665
        except KeyError:
 
666
            return
 
667
        try:
 
668
            children = os.listdir(self._tree.abspath(path))
 
669
        except OSError, e:
 
670
            if not (osutils._is_error_enotdir(e)
 
671
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
672
                raise
 
673
            return
 
674
 
 
675
        for child in children:
 
676
            childpath = joinpath(path, child)
 
677
            if self._tree.is_control_filename(childpath):
 
678
                continue
 
679
            yield self.trans_id_tree_path(childpath)
 
680
 
471
681
    def has_named_child(self, by_parent, parent_id, name):
472
682
        try:
473
683
            children = by_parent[parent_id]
527
737
 
528
738
    def _improper_versioning(self):
529
739
        """Cannot version a file with no contents, or a bad type.
530
 
 
 
740
        
531
741
        However, existing entries with no contents are okay.
532
742
        """
533
743
        conflicts = []
543
753
 
544
754
    def _executability_conflicts(self):
545
755
        """Check for bad executability changes.
546
 
 
 
756
        
547
757
        Only versioned files may have their executability set, because
548
758
        1. only versioned entries can have executability under windows
549
759
        2. only files can be executable.  (The execute bit on a directory
648
858
            return True
649
859
        return False
650
860
 
 
861
    def _limbo_name(self, trans_id):
 
862
        """Generate the limbo name of a file"""
 
863
        limbo_name = self._limbo_files.get(trans_id)
 
864
        if limbo_name is not None:
 
865
            return limbo_name
 
866
        parent = self._new_parent.get(trans_id)
 
867
        # if the parent directory is already in limbo (e.g. when building a
 
868
        # tree), choose a limbo name inside the parent, to reduce further
 
869
        # renames.
 
870
        use_direct_path = False
 
871
        if self._new_contents.get(parent) == 'directory':
 
872
            filename = self._new_name.get(trans_id)
 
873
            if filename is not None:
 
874
                if parent not in self._limbo_children:
 
875
                    self._limbo_children[parent] = set()
 
876
                    self._limbo_children_names[parent] = {}
 
877
                    use_direct_path = True
 
878
                # the direct path can only be used if no other file has
 
879
                # already taken this pathname, i.e. if the name is unused, or
 
880
                # if it is already associated with this trans_id.
 
881
                elif self._case_sensitive_target:
 
882
                    if (self._limbo_children_names[parent].get(filename)
 
883
                        in (trans_id, None)):
 
884
                        use_direct_path = True
 
885
                else:
 
886
                    for l_filename, l_trans_id in\
 
887
                        self._limbo_children_names[parent].iteritems():
 
888
                        if l_trans_id == trans_id:
 
889
                            continue
 
890
                        if l_filename.lower() == filename.lower():
 
891
                            break
 
892
                    else:
 
893
                        use_direct_path = True
 
894
 
 
895
        if use_direct_path:
 
896
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
897
            self._limbo_children[parent].add(trans_id)
 
898
            self._limbo_children_names[parent][filename] = trans_id
 
899
        else:
 
900
            limbo_name = pathjoin(self._limbodir, trans_id)
 
901
            self._needs_rename.add(trans_id)
 
902
        self._limbo_files[trans_id] = limbo_name
 
903
        return limbo_name
 
904
 
651
905
    def _set_executability(self, path, trans_id):
652
906
        """Set the executability of versioned files """
653
907
        if supports_executable():
674
928
            self.version_file(file_id, trans_id)
675
929
        return trans_id
676
930
 
677
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
931
    def new_file(self, name, parent_id, contents, file_id=None, 
678
932
                 executable=None):
679
933
        """Convenience method to create files.
680
 
 
 
934
        
681
935
        name is the name of the file to create.
682
936
        parent_id is the transaction id of the parent directory of the file.
683
937
        contents is an iterator of bytestrings, which will be used to produce
703
957
        """
704
958
        trans_id = self._new_entry(name, parent_id, file_id)
705
959
        self.create_directory(trans_id)
706
 
        return trans_id
 
960
        return trans_id 
707
961
 
708
962
    def new_symlink(self, name, parent_id, target, file_id=None):
709
963
        """Convenience method to create symbolic link.
710
 
 
 
964
        
711
965
        name is the name of the symlink to create.
712
966
        parent_id is the transaction id of the parent directory of the symlink.
713
967
        target is a bytestring of the target of the symlink.
752
1006
        from_path = self._tree_id_paths.get(from_trans_id)
753
1007
        if from_versioned:
754
1008
            # get data from working tree if versioned
755
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1009
            from_entry = self._tree.inventory[file_id]
756
1010
            from_name = from_entry.name
757
1011
            from_parent = from_entry.parent_id
758
1012
        else:
864
1118
        """
865
1119
        return _PreviewTree(self)
866
1120
 
867
 
    def commit(self, branch, message, merge_parents=None, strict=False):
868
 
        """Commit the result of this TreeTransform to a branch.
869
 
 
870
 
        :param branch: The branch to commit to.
871
 
        :param message: The message to attach to the commit.
872
 
        :param merge_parents: Additional parents specified by pending merges.
873
 
        :return: The revision_id of the revision committed.
874
 
        """
875
 
        self._check_malformed()
876
 
        if strict:
877
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
878
 
            for trans_id in unversioned:
879
 
                if self.final_file_id(trans_id) is None:
880
 
                    raise errors.StrictCommitFailed()
881
 
 
882
 
        revno, last_rev_id = branch.last_revision_info()
883
 
        if last_rev_id == _mod_revision.NULL_REVISION:
884
 
            if merge_parents is not None:
885
 
                raise ValueError('Cannot supply merge parents for first'
886
 
                                 ' commit.')
887
 
            parent_ids = []
888
 
        else:
889
 
            parent_ids = [last_rev_id]
890
 
            if merge_parents is not None:
891
 
                parent_ids.extend(merge_parents)
892
 
        if self._tree.get_revision_id() != last_rev_id:
893
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
894
 
                             self._tree.get_revision_id())
895
 
        builder = branch.get_commit_builder(parent_ids)
896
 
        preview = self.get_preview_tree()
897
 
        list(builder.record_iter_changes(preview, last_rev_id,
898
 
                                         self.iter_changes()))
899
 
        builder.finish_inventory()
900
 
        revision_id = builder.commit(message)
901
 
        branch.set_last_revision_info(revno + 1, revision_id)
902
 
        return revision_id
903
 
 
904
 
    def _text_parent(self, trans_id):
905
 
        file_id = self.tree_file_id(trans_id)
906
 
        try:
907
 
            if file_id is None or self._tree.kind(file_id) != 'file':
908
 
                return None
909
 
        except errors.NoSuchFile:
910
 
            return None
911
 
        return file_id
912
 
 
913
 
    def _get_parents_texts(self, trans_id):
914
 
        """Get texts for compression parents of this file."""
915
 
        file_id = self._text_parent(trans_id)
916
 
        if file_id is None:
917
 
            return ()
918
 
        return (self._tree.get_file_text(file_id),)
919
 
 
920
 
    def _get_parents_lines(self, trans_id):
921
 
        """Get lines for compression parents of this file."""
922
 
        file_id = self._text_parent(trans_id)
923
 
        if file_id is None:
924
 
            return ()
925
 
        return (self._tree.get_file_lines(file_id),)
926
 
 
927
 
    def serialize(self, serializer):
928
 
        """Serialize this TreeTransform.
929
 
 
930
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
931
 
        """
932
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
933
 
                        self._new_name.items())
934
 
        new_executability = dict((k, int(v)) for k, v in
935
 
                                 self._new_executability.items())
936
 
        tree_path_ids = dict((k.encode('utf-8'), v)
937
 
                             for k, v in self._tree_path_ids.items())
938
 
        attribs = {
939
 
            '_id_number': self._id_number,
940
 
            '_new_name': new_name,
941
 
            '_new_parent': self._new_parent,
942
 
            '_new_executability': new_executability,
943
 
            '_new_id': self._new_id,
944
 
            '_tree_path_ids': tree_path_ids,
945
 
            '_removed_id': list(self._removed_id),
946
 
            '_removed_contents': list(self._removed_contents),
947
 
            '_non_present_ids': self._non_present_ids,
948
 
            }
949
 
        yield serializer.bytes_record(bencode.bencode(attribs),
950
 
                                      (('attribs',),))
951
 
        for trans_id, kind in self._new_contents.items():
952
 
            if kind == 'file':
953
 
                lines = osutils.chunks_to_lines(
954
 
                    self._read_file_chunks(trans_id))
955
 
                parents = self._get_parents_lines(trans_id)
956
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
957
 
                content = ''.join(mpdiff.to_patch())
958
 
            if kind == 'directory':
959
 
                content = ''
960
 
            if kind == 'symlink':
961
 
                content = self._read_symlink_target(trans_id)
962
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
963
 
 
964
 
    def deserialize(self, records):
965
 
        """Deserialize a stored TreeTransform.
966
 
 
967
 
        :param records: An iterable of (names, content) tuples, as per
968
 
            pack.ContainerPushParser.
969
 
        """
970
 
        names, content = records.next()
971
 
        attribs = bencode.bdecode(content)
972
 
        self._id_number = attribs['_id_number']
973
 
        self._new_name = dict((k, v.decode('utf-8'))
974
 
                            for k, v in attribs['_new_name'].items())
975
 
        self._new_parent = attribs['_new_parent']
976
 
        self._new_executability = dict((k, bool(v)) for k, v in
977
 
            attribs['_new_executability'].items())
978
 
        self._new_id = attribs['_new_id']
979
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
980
 
        self._tree_path_ids = {}
981
 
        self._tree_id_paths = {}
982
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
983
 
            path = bytepath.decode('utf-8')
984
 
            self._tree_path_ids[path] = trans_id
985
 
            self._tree_id_paths[trans_id] = path
986
 
        self._removed_id = set(attribs['_removed_id'])
987
 
        self._removed_contents = set(attribs['_removed_contents'])
988
 
        self._non_present_ids = attribs['_non_present_ids']
989
 
        for ((trans_id, kind),), content in records:
990
 
            if kind == 'file':
991
 
                mpdiff = multiparent.MultiParent.from_patch(content)
992
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
993
 
                self.create_file(lines, trans_id)
994
 
            if kind == 'directory':
995
 
                self.create_directory(trans_id)
996
 
            if kind == 'symlink':
997
 
                self.create_symlink(content.decode('utf-8'), trans_id)
998
 
 
999
 
 
1000
 
class DiskTreeTransform(TreeTransformBase):
1001
 
    """Tree transform storing its contents on disk."""
1002
 
 
1003
 
    def __init__(self, tree, limbodir, pb=DummyProgress(),
1004
 
                 case_sensitive=True):
1005
 
        """Constructor.
1006
 
        :param tree: The tree that will be transformed, but not necessarily
1007
 
            the output tree.
1008
 
        :param limbodir: A directory where new files can be stored until
1009
 
            they are installed in their proper places
1010
 
        :param pb: A ProgressBar indicating how much progress is being made
1011
 
        :param case_sensitive: If True, the target of the transform is
1012
 
            case sensitive, not just case preserving.
1013
 
        """
1014
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1015
 
        self._limbodir = limbodir
1016
 
        self._deletiondir = None
1017
 
        # A mapping of transform ids to their limbo filename
1018
 
        self._limbo_files = {}
1019
 
        # A mapping of transform ids to a set of the transform ids of children
1020
 
        # that their limbo directory has
1021
 
        self._limbo_children = {}
1022
 
        # Map transform ids to maps of child filename to child transform id
1023
 
        self._limbo_children_names = {}
1024
 
        # List of transform ids that need to be renamed from limbo into place
1025
 
        self._needs_rename = set()
1026
 
 
1027
 
    def finalize(self):
1028
 
        """Release the working tree lock, if held, clean up limbo dir.
1029
 
 
1030
 
        This is required if apply has not been invoked, but can be invoked
1031
 
        even after apply.
1032
 
        """
1033
 
        if self._tree is None:
1034
 
            return
1035
 
        try:
1036
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1037
 
                       self._new_contents.iteritems()]
1038
 
            entries.sort(reverse=True)
1039
 
            for path, trans_id, kind in entries:
1040
 
                delete_any(path)
1041
 
            try:
1042
 
                delete_any(self._limbodir)
1043
 
            except OSError:
1044
 
                # We don't especially care *why* the dir is immortal.
1045
 
                raise ImmortalLimbo(self._limbodir)
1046
 
            try:
1047
 
                if self._deletiondir is not None:
1048
 
                    delete_any(self._deletiondir)
1049
 
            except OSError:
1050
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1051
 
        finally:
1052
 
            TreeTransformBase.finalize(self)
1053
 
 
1054
 
    def _limbo_name(self, trans_id):
1055
 
        """Generate the limbo name of a file"""
1056
 
        limbo_name = self._limbo_files.get(trans_id)
1057
 
        if limbo_name is not None:
1058
 
            return limbo_name
1059
 
        parent = self._new_parent.get(trans_id)
1060
 
        # if the parent directory is already in limbo (e.g. when building a
1061
 
        # tree), choose a limbo name inside the parent, to reduce further
1062
 
        # renames.
1063
 
        use_direct_path = False
1064
 
        if self._new_contents.get(parent) == 'directory':
1065
 
            filename = self._new_name.get(trans_id)
1066
 
            if filename is not None:
1067
 
                if parent not in self._limbo_children:
1068
 
                    self._limbo_children[parent] = set()
1069
 
                    self._limbo_children_names[parent] = {}
1070
 
                    use_direct_path = True
1071
 
                # the direct path can only be used if no other file has
1072
 
                # already taken this pathname, i.e. if the name is unused, or
1073
 
                # if it is already associated with this trans_id.
1074
 
                elif self._case_sensitive_target:
1075
 
                    if (self._limbo_children_names[parent].get(filename)
1076
 
                        in (trans_id, None)):
1077
 
                        use_direct_path = True
1078
 
                else:
1079
 
                    for l_filename, l_trans_id in\
1080
 
                        self._limbo_children_names[parent].iteritems():
1081
 
                        if l_trans_id == trans_id:
1082
 
                            continue
1083
 
                        if l_filename.lower() == filename.lower():
1084
 
                            break
1085
 
                    else:
1086
 
                        use_direct_path = True
1087
 
 
1088
 
        if use_direct_path:
1089
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
1090
 
            self._limbo_children[parent].add(trans_id)
1091
 
            self._limbo_children_names[parent][filename] = trans_id
1092
 
        else:
1093
 
            limbo_name = pathjoin(self._limbodir, trans_id)
1094
 
            self._needs_rename.add(trans_id)
1095
 
        self._limbo_files[trans_id] = limbo_name
1096
 
        return limbo_name
1097
 
 
1098
 
    def adjust_path(self, name, parent, trans_id):
1099
 
        previous_parent = self._new_parent.get(trans_id)
1100
 
        previous_name = self._new_name.get(trans_id)
1101
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1102
 
        if (trans_id in self._limbo_files and
1103
 
            trans_id not in self._needs_rename):
1104
 
            self._rename_in_limbo([trans_id])
1105
 
            self._limbo_children[previous_parent].remove(trans_id)
1106
 
            del self._limbo_children_names[previous_parent][previous_name]
1107
 
 
1108
 
    def _rename_in_limbo(self, trans_ids):
1109
 
        """Fix limbo names so that the right final path is produced.
1110
 
 
1111
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1112
 
        these files later by creating them with their final names in their
1113
 
        final parents.  But now the previous name or parent is no longer
1114
 
        suitable, so we have to rename them.
1115
 
 
1116
 
        Even for trans_ids that have no new contents, we must remove their
1117
 
        entries from _limbo_files, because they are now stale.
1118
 
        """
1119
 
        for trans_id in trans_ids:
1120
 
            old_path = self._limbo_files.pop(trans_id)
1121
 
            if trans_id not in self._new_contents:
1122
 
                continue
1123
 
            new_path = self._limbo_name(trans_id)
1124
 
            os.rename(old_path, new_path)
1125
 
 
1126
 
    def create_file(self, contents, trans_id, mode_id=None):
1127
 
        """Schedule creation of a new file.
1128
 
 
1129
 
        See also new_file.
1130
 
 
1131
 
        Contents is an iterator of strings, all of which will be written
1132
 
        to the target destination.
1133
 
 
1134
 
        New file takes the permissions of any existing file with that id,
1135
 
        unless mode_id is specified.
1136
 
        """
1137
 
        name = self._limbo_name(trans_id)
1138
 
        f = open(name, 'wb')
1139
 
        try:
1140
 
            try:
1141
 
                unique_add(self._new_contents, trans_id, 'file')
1142
 
            except:
1143
 
                # Clean up the file, it never got registered so
1144
 
                # TreeTransform.finalize() won't clean it up.
1145
 
                f.close()
1146
 
                os.unlink(name)
1147
 
                raise
1148
 
 
1149
 
            f.writelines(contents)
1150
 
        finally:
1151
 
            f.close()
1152
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1153
 
 
1154
 
    def _read_file_chunks(self, trans_id):
1155
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1156
 
        try:
1157
 
            return cur_file.readlines()
1158
 
        finally:
1159
 
            cur_file.close()
1160
 
 
1161
 
    def _read_symlink_target(self, trans_id):
1162
 
        return os.readlink(self._limbo_name(trans_id))
1163
 
 
1164
 
    def create_hardlink(self, path, trans_id):
1165
 
        """Schedule creation of a hard link"""
1166
 
        name = self._limbo_name(trans_id)
1167
 
        try:
1168
 
            os.link(path, name)
1169
 
        except OSError, e:
1170
 
            if e.errno != errno.EPERM:
1171
 
                raise
1172
 
            raise errors.HardLinkNotSupported(path)
1173
 
        try:
1174
 
            unique_add(self._new_contents, trans_id, 'file')
1175
 
        except:
1176
 
            # Clean up the file, it never got registered so
1177
 
            # TreeTransform.finalize() won't clean it up.
1178
 
            os.unlink(name)
1179
 
            raise
1180
 
 
1181
 
    def create_directory(self, trans_id):
1182
 
        """Schedule creation of a new directory.
1183
 
 
1184
 
        See also new_directory.
1185
 
        """
1186
 
        os.mkdir(self._limbo_name(trans_id))
1187
 
        unique_add(self._new_contents, trans_id, 'directory')
1188
 
 
1189
 
    def create_symlink(self, target, trans_id):
1190
 
        """Schedule creation of a new symbolic link.
1191
 
 
1192
 
        target is a bytestring.
1193
 
        See also new_symlink.
1194
 
        """
1195
 
        if has_symlinks():
1196
 
            os.symlink(target, self._limbo_name(trans_id))
1197
 
            unique_add(self._new_contents, trans_id, 'symlink')
1198
 
        else:
1199
 
            try:
1200
 
                path = FinalPaths(self).get_path(trans_id)
1201
 
            except KeyError:
1202
 
                path = None
1203
 
            raise UnableCreateSymlink(path=path)
1204
 
 
1205
 
    def cancel_creation(self, trans_id):
1206
 
        """Cancel the creation of new file contents."""
1207
 
        del self._new_contents[trans_id]
1208
 
        children = self._limbo_children.get(trans_id)
1209
 
        # if this is a limbo directory with children, move them before removing
1210
 
        # the directory
1211
 
        if children is not None:
1212
 
            self._rename_in_limbo(children)
1213
 
            del self._limbo_children[trans_id]
1214
 
            del self._limbo_children_names[trans_id]
1215
 
        delete_any(self._limbo_name(trans_id))
1216
 
 
1217
 
 
1218
 
class TreeTransform(DiskTreeTransform):
 
1121
 
 
1122
class TreeTransform(TreeTransformBase):
1219
1123
    """Represent a tree transformation.
1220
1124
 
1221
1125
    This object is designed to support incremental generation of the transform,
1307
1211
            tree.unlock()
1308
1212
            raise
1309
1213
 
1310
 
        # Cache of realpath results, to speed up canonical_path
1311
 
        self._realpaths = {}
1312
 
        # Cache of relpath results, to speed up canonical_path
1313
 
        self._relpaths = {}
1314
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1214
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1315
1215
                                   tree.case_sensitive)
1316
1216
        self._deletiondir = deletiondir
1317
1217
 
1318
 
    def canonical_path(self, path):
1319
 
        """Get the canonical tree-relative path"""
1320
 
        # don't follow final symlinks
1321
 
        abs = self._tree.abspath(path)
1322
 
        if abs in self._relpaths:
1323
 
            return self._relpaths[abs]
1324
 
        dirname, basename = os.path.split(abs)
1325
 
        if dirname not in self._realpaths:
1326
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1327
 
        dirname = self._realpaths[dirname]
1328
 
        abs = pathjoin(dirname, basename)
1329
 
        if dirname in self._relpaths:
1330
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1331
 
            relpath = relpath.rstrip('/\\')
1332
 
        else:
1333
 
            relpath = self._tree.relpath(abs)
1334
 
        self._relpaths[abs] = relpath
1335
 
        return relpath
1336
 
 
1337
 
    def tree_kind(self, trans_id):
1338
 
        """Determine the file kind in the working tree.
1339
 
 
1340
 
        Raises NoSuchFile if the file does not exist
1341
 
        """
1342
 
        path = self._tree_id_paths.get(trans_id)
1343
 
        if path is None:
1344
 
            raise NoSuchFile(None)
1345
 
        try:
1346
 
            return file_kind(self._tree.abspath(path))
1347
 
        except OSError, e:
1348
 
            if e.errno != errno.ENOENT:
1349
 
                raise
1350
 
            else:
1351
 
                raise NoSuchFile(path)
1352
 
 
1353
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1354
 
        """Set the mode of new file contents.
1355
 
        The mode_id is the existing file to get the mode from (often the same
1356
 
        as trans_id).  The operation is only performed if there's a mode match
1357
 
        according to typefunc.
1358
 
        """
1359
 
        if mode_id is None:
1360
 
            mode_id = trans_id
1361
 
        try:
1362
 
            old_path = self._tree_id_paths[mode_id]
1363
 
        except KeyError:
1364
 
            return
1365
 
        try:
1366
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1367
 
        except OSError, e:
1368
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1369
 
                # Either old_path doesn't exist, or the parent of the
1370
 
                # target is not a directory (but will be one eventually)
1371
 
                # Either way, we know it doesn't exist *right now*
1372
 
                # See also bug #248448
1373
 
                return
1374
 
            else:
1375
 
                raise
1376
 
        if typefunc(mode):
1377
 
            os.chmod(self._limbo_name(trans_id), mode)
1378
 
 
1379
 
    def iter_tree_children(self, parent_id):
1380
 
        """Iterate through the entry's tree children, if any"""
1381
 
        try:
1382
 
            path = self._tree_id_paths[parent_id]
1383
 
        except KeyError:
1384
 
            return
1385
 
        try:
1386
 
            children = os.listdir(self._tree.abspath(path))
1387
 
        except OSError, e:
1388
 
            if not (osutils._is_error_enotdir(e)
1389
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1390
 
                raise
1391
 
            return
1392
 
 
1393
 
        for child in children:
1394
 
            childpath = joinpath(path, child)
1395
 
            if self._tree.is_control_filename(childpath):
1396
 
                continue
1397
 
            yield self.trans_id_tree_path(childpath)
1398
 
 
1399
1218
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1400
1219
        """Apply all changes to the inventory and filesystem.
1401
1220
 
1411
1230
        :param _mover: Supply an alternate FileMover, for testing
1412
1231
        """
1413
1232
        if not no_conflicts:
1414
 
            self._check_malformed()
 
1233
            conflicts = self.find_conflicts()
 
1234
            if len(conflicts) != 0:
 
1235
                raise MalformedTransform(conflicts=conflicts)
1415
1236
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1416
1237
        try:
1417
1238
            if precomputed_delta is None:
1576
1397
        return modified_paths
1577
1398
 
1578
1399
 
1579
 
class TransformPreview(DiskTreeTransform):
 
1400
class TransformPreview(TreeTransformBase):
1580
1401
    """A TreeTransform for generating preview trees.
1581
1402
 
1582
1403
    Unlike TreeTransform, this version works when the input tree is a
1587
1408
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1588
1409
        tree.lock_read()
1589
1410
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1590
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1411
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1591
1412
 
1592
1413
    def canonical_path(self, path):
1593
1414
        return path
1617
1438
        file_id = self.tree_file_id(parent_id)
1618
1439
        if file_id is None:
1619
1440
            return
1620
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1621
 
        children = getattr(entry, 'children', {})
 
1441
        children = getattr(self._tree.inventory[file_id], 'children', {})
1622
1442
        for child in children:
1623
1443
            childpath = joinpath(path, child)
1624
1444
            yield self.trans_id_tree_path(childpath)
1632
1452
        self._final_paths = FinalPaths(transform)
1633
1453
        self.__by_parent = None
1634
1454
        self._parent_ids = []
1635
 
        self._all_children_cache = {}
1636
 
        self._path2trans_id_cache = {}
1637
 
        self._final_name_cache = {}
1638
1455
 
1639
1456
    def _changes(self, file_id):
1640
1457
        for changes in self._transform.iter_changes():
1683
1500
            self.__by_parent = self._transform.by_parent()
1684
1501
        return self.__by_parent
1685
1502
 
1686
 
    def _comparison_data(self, entry, path):
1687
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1688
 
        if kind == 'missing':
1689
 
            kind = None
1690
 
            executable = False
1691
 
        else:
1692
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
1693
 
            executable = self.is_executable(file_id, path)
1694
 
        return kind, executable, None
1695
 
 
1696
1503
    def lock_read(self):
1697
1504
        # Perhaps in theory, this should lock the TreeTransform?
1698
1505
        pass
1718
1525
    def __iter__(self):
1719
1526
        return iter(self.all_file_ids())
1720
1527
 
1721
 
    def _has_id(self, file_id, fallback_check):
1722
 
        if file_id in self._transform._r_new_id:
1723
 
            return True
1724
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1725
 
            trans_id in self._transform._removed_id]):
1726
 
            return False
1727
 
        else:
1728
 
            return fallback_check(file_id)
1729
 
 
1730
 
    def has_id(self, file_id):
1731
 
        return self._has_id(file_id, self._transform._tree.has_id)
1732
 
 
1733
 
    def has_or_had_id(self, file_id):
1734
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
1528
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1529
        """See Tree.paths2ids"""
 
1530
        to_find = set(specific_files)
 
1531
        result = set()
 
1532
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1533
             executable) in self._transform.iter_changes():
 
1534
            if paths[1] in to_find:
 
1535
                result.add(file_id)
 
1536
                to_find.remove(paths[1])
 
1537
        result.update(self._transform._tree.paths2ids(to_find,
 
1538
                      trees=[], require_versioned=require_versioned))
 
1539
        return result
1735
1540
 
1736
1541
    def _path2trans_id(self, path):
1737
 
        # We must not use None here, because that is a valid value to store.
1738
 
        trans_id = self._path2trans_id_cache.get(path, object)
1739
 
        if trans_id is not object:
1740
 
            return trans_id
1741
1542
        segments = splitpath(path)
1742
1543
        cur_parent = self._transform.root
1743
1544
        for cur_segment in segments:
1744
1545
            for child in self._all_children(cur_parent):
1745
 
                final_name = self._final_name_cache.get(child)
1746
 
                if final_name is None:
1747
 
                    final_name = self._transform.final_name(child)
1748
 
                    self._final_name_cache[child] = final_name
1749
 
                if final_name == cur_segment:
 
1546
                if self._transform.final_name(child) == cur_segment:
1750
1547
                    cur_parent = child
1751
1548
                    break
1752
1549
            else:
1753
 
                self._path2trans_id_cache[path] = None
1754
1550
                return None
1755
 
        self._path2trans_id_cache[path] = cur_parent
1756
1551
        return cur_parent
1757
1552
 
1758
1553
    def path2id(self, path):
1766
1561
            raise errors.NoSuchId(self, file_id)
1767
1562
 
1768
1563
    def _all_children(self, trans_id):
1769
 
        children = self._all_children_cache.get(trans_id)
1770
 
        if children is not None:
1771
 
            return children
1772
1564
        children = set(self._transform.iter_tree_children(trans_id))
1773
1565
        # children in the _new_parent set are provided by _by_parent.
1774
1566
        children.difference_update(self._transform._new_parent.keys())
1775
1567
        children.update(self._by_parent.get(trans_id, []))
1776
 
        self._all_children_cache[trans_id] = children
1777
1568
        return children
1778
1569
 
1779
 
    def iter_children(self, file_id):
1780
 
        trans_id = self._transform.trans_id_file_id(file_id)
1781
 
        for child_trans_id in self._all_children(trans_id):
1782
 
            yield self._transform.final_file_id(child_trans_id)
1783
 
 
1784
 
    def extras(self):
1785
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
1786
 
                              in self._transform._tree.extras())
1787
 
        possible_extras.update(self._transform._new_contents)
1788
 
        possible_extras.update(self._transform._removed_id)
1789
 
        for trans_id in possible_extras:
1790
 
            if self._transform.final_file_id(trans_id) is None:
1791
 
                yield self._final_paths._determine_path(trans_id)
1792
 
 
1793
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None):
 
1570
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
1794
1571
        for trans_id, parent_file_id in ordered_entries:
1795
1572
            file_id = self._transform.final_file_id(trans_id)
1796
1573
            if file_id is None:
1833
1610
                                                      specific_file_ids):
1834
1611
            yield unicode(self._final_paths.get_path(trans_id)), entry
1835
1612
 
1836
 
    def _iter_entries_for_dir(self, dir_path):
1837
 
        """Return path, entry for items in a directory without recursing down."""
1838
 
        dir_file_id = self.path2id(dir_path)
1839
 
        ordered_ids = []
1840
 
        for file_id in self.iter_children(dir_file_id):
1841
 
            trans_id = self._transform.trans_id_file_id(file_id)
1842
 
            ordered_ids.append((trans_id, file_id))
1843
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1844
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1845
 
 
1846
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1847
 
        """See WorkingTree.list_files."""
 
1613
    def list_files(self, include_root=False):
 
1614
        """See Tree.list_files."""
1848
1615
        # XXX This should behave like WorkingTree.list_files, but is really
1849
1616
        # more like RevisionTree.list_files.
1850
 
        if recursive:
1851
 
            prefix = None
1852
 
            if from_dir:
1853
 
                prefix = from_dir + '/'
1854
 
            entries = self.iter_entries_by_dir()
1855
 
            for path, entry in entries:
1856
 
                if entry.name == '' and not include_root:
1857
 
                    continue
1858
 
                if prefix:
1859
 
                    if not path.startswith(prefix):
1860
 
                        continue
1861
 
                    path = path[len(prefix):]
1862
 
                yield path, 'V', entry.kind, entry.file_id, entry
1863
 
        else:
1864
 
            if from_dir is None and include_root is True:
1865
 
                root_entry = inventory.make_entry('directory', '',
1866
 
                    ROOT_PARENT, self.get_root_id())
1867
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1868
 
            entries = self._iter_entries_for_dir(from_dir or '')
1869
 
            for path, entry in entries:
1870
 
                yield path, 'V', entry.kind, entry.file_id, entry
 
1617
        for path, entry in self.iter_entries_by_dir():
 
1618
            if entry.name == '' and not include_root:
 
1619
                continue
 
1620
            yield path, 'V', entry.kind, entry.file_id, entry
1871
1621
 
1872
1622
    def kind(self, file_id):
1873
1623
        trans_id = self._transform.trans_id_file_id(file_id)
1886
1636
            return self._transform._tree.get_file_mtime(file_id, path)
1887
1637
        return self._stat_limbo_file(file_id).st_mtime
1888
1638
 
1889
 
    def _file_size(self, entry, stat_value):
1890
 
        return self.get_file_size(entry.file_id)
1891
 
 
1892
1639
    def get_file_size(self, file_id):
1893
1640
        """See Tree.get_file_size"""
1894
1641
        if self.kind(file_id) == 'file':
1897
1644
            return None
1898
1645
 
1899
1646
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1900
 
        trans_id = self._transform.trans_id_file_id(file_id)
1901
 
        kind = self._transform._new_contents.get(trans_id)
1902
 
        if kind is None:
1903
 
            return self._transform._tree.get_file_sha1(file_id)
1904
 
        if kind == 'file':
1905
 
            fileobj = self.get_file(file_id)
1906
 
            try:
1907
 
                return sha_file(fileobj)
1908
 
            finally:
1909
 
                fileobj.close()
 
1647
        return self._transform._tree.get_file_sha1(file_id)
1910
1648
 
1911
1649
    def is_executable(self, file_id, path=None):
1912
 
        if file_id is None:
1913
 
            return False
1914
1650
        trans_id = self._transform.trans_id_file_id(file_id)
1915
1651
        try:
1916
1652
            return self._transform._new_executability[trans_id]
1917
1653
        except KeyError:
1918
 
            try:
1919
 
                return self._transform._tree.is_executable(file_id, path)
1920
 
            except OSError, e:
1921
 
                if e.errno == errno.ENOENT:
1922
 
                    return False
1923
 
                raise
1924
 
            except errors.NoSuchId:
1925
 
                return False
 
1654
            return self._transform._tree.is_executable(file_id, path)
1926
1655
 
1927
1656
    def path_content_summary(self, path):
1928
1657
        trans_id = self._path2trans_id(path)
1950
1679
                size = None
1951
1680
                executable = None
1952
1681
            if kind == 'symlink':
1953
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
1682
                link_or_sha1 = os.readlink(limbo_name)
1954
1683
        if supports_executable():
1955
1684
            executable = tt._new_executability.get(trans_id, executable)
1956
1685
        return kind, size, executable, link_or_sha1
1960
1689
                      require_versioned=True, want_unversioned=False):
1961
1690
        """See InterTree.iter_changes.
1962
1691
 
1963
 
        This has a fast path that is only used when the from_tree matches
1964
 
        the transform tree, and no fancy options are supplied.
 
1692
        This implementation does not support include_unchanged, specific_files,
 
1693
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1694
        ignored.
1965
1695
        """
1966
 
        if (from_tree is not self._transform._tree or include_unchanged or
1967
 
            specific_files or want_unversioned):
1968
 
            return tree.InterTree(from_tree, self).iter_changes(
1969
 
                include_unchanged=include_unchanged,
1970
 
                specific_files=specific_files,
1971
 
                pb=pb,
1972
 
                extra_trees=extra_trees,
1973
 
                require_versioned=require_versioned,
1974
 
                want_unversioned=want_unversioned)
 
1696
        if from_tree is not self._transform._tree:
 
1697
            raise ValueError('from_tree must be transform source tree.')
 
1698
        if include_unchanged:
 
1699
            raise ValueError('include_unchanged is not supported')
 
1700
        if specific_files is not None:
 
1701
            raise ValueError('specific_files is not supported')
1975
1702
        if want_unversioned:
1976
1703
            raise ValueError('want_unversioned is not supported')
1977
1704
        return self._transform.iter_changes()
1984
1711
        name = self._transform._limbo_name(trans_id)
1985
1712
        return open(name, 'rb')
1986
1713
 
1987
 
    def get_file_with_stat(self, file_id, path=None):
1988
 
        return self.get_file(file_id, path), None
 
1714
    def get_file_text(self, file_id):
 
1715
        text_file = self.get_file(file_id)
 
1716
        try:
 
1717
            return text_file.read()
 
1718
        finally:
 
1719
            text_file.close()
1989
1720
 
1990
1721
    def annotate_iter(self, file_id,
1991
1722
                      default_revision=_mod_revision.CURRENT_REVISION):
2007
1738
            return old_annotation
2008
1739
        if not changed_content:
2009
1740
            return old_annotation
2010
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2011
 
        #       doing, however it fails slightly because it doesn't know what
2012
 
        #       the *other* revision_id is, so it doesn't know how to give the
2013
 
        #       other as the origin for some lines, they all get
2014
 
        #       'default_revision'
2015
 
        #       It would be nice to be able to use the new Annotator based
2016
 
        #       approach, as well.
2017
1741
        return annotate.reannotate([old_annotation],
2018
1742
                                   self.get_file(file_id).readlines(),
2019
1743
                                   default_revision)
2024
1748
            return self._transform._tree.get_symlink_target(file_id)
2025
1749
        trans_id = self._transform.trans_id_file_id(file_id)
2026
1750
        name = self._transform._limbo_name(trans_id)
2027
 
        return osutils.readlink(name)
 
1751
        return os.readlink(name)
2028
1752
 
2029
1753
    def walkdirs(self, prefix=''):
2030
1754
        pending = [self._transform.root]
2085
1809
        self.transform = transform
2086
1810
 
2087
1811
    def _determine_path(self, trans_id):
2088
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1812
        if trans_id == self.transform.root:
2089
1813
            return ""
2090
1814
        name = self.transform.final_name(trans_id)
2091
1815
        parent_id = self.transform.final_parent(trans_id)
2115
1839
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2116
1840
               delta_from_tree=False):
2117
1841
    """Create working tree for a branch, using a TreeTransform.
2118
 
 
 
1842
    
2119
1843
    This function should be used on empty trees, having a tree root at most.
2120
1844
    (see merge and revert functionality for working with existing trees)
2121
1845
 
2122
1846
    Existing files are handled like so:
2123
 
 
 
1847
    
2124
1848
    - Existing bzrdirs take precedence over creating new items.  They are
2125
1849
      created as '%s.diverted' % name.
2126
1850
    - Otherwise, if the content on disk matches the content we are building,
2228
1952
                    executable = tree.is_executable(file_id, tree_path)
2229
1953
                    if executable:
2230
1954
                        tt.set_executability(executable, trans_id)
2231
 
                    trans_data = (trans_id, tree_path)
2232
 
                    deferred_contents.append((file_id, trans_data))
 
1955
                    deferred_contents.append((file_id, trans_id))
2233
1956
                else:
2234
1957
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2235
1958
                                                          tree)
2266
1989
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2267
1990
                  hardlink):
2268
1991
    total = len(desired_files) + offset
2269
 
    wt = tt._tree
2270
1992
    if accelerator_tree is None:
2271
1993
        new_desired_files = desired_files
2272
1994
    else:
2275
1997
                         in iter if not (c or e[0] != e[1]))
2276
1998
        new_desired_files = []
2277
1999
        count = 0
2278
 
        for file_id, (trans_id, tree_path) in desired_files:
 
2000
        for file_id, trans_id in desired_files:
2279
2001
            accelerator_path = unchanged.get(file_id)
2280
2002
            if accelerator_path is None:
2281
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
2003
                new_desired_files.append((file_id, trans_id))
2282
2004
                continue
2283
2005
            pb.update('Adding file contents', count + offset, total)
2284
2006
            if hardlink:
2286
2008
                                   trans_id)
2287
2009
            else:
2288
2010
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2289
 
                if wt.supports_content_filtering():
2290
 
                    filters = wt._content_filter_stack(tree_path)
2291
 
                    contents = filtered_output_bytes(contents, filters,
2292
 
                        ContentFilterContext(tree_path, tree))
2293
2011
                try:
2294
2012
                    tt.create_file(contents, trans_id)
2295
2013
                finally:
2296
 
                    try:
2297
 
                        contents.close()
2298
 
                    except AttributeError:
2299
 
                        # after filtering, contents may no longer be file-like
2300
 
                        pass
 
2014
                    contents.close()
2301
2015
            count += 1
2302
2016
        offset += count
2303
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2304
 
            tree.iter_files_bytes(new_desired_files)):
2305
 
        if wt.supports_content_filtering():
2306
 
            filters = wt._content_filter_stack(tree_path)
2307
 
            contents = filtered_output_bytes(contents, filters,
2308
 
                ContentFilterContext(tree_path, tree))
 
2017
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
2018
                                                 new_desired_files)):
2309
2019
        tt.create_file(contents, trans_id)
2310
2020
        pb.update('Adding file contents', count + offset, total)
2311
2021
 
2371
2081
    if kind == 'file':
2372
2082
        contents = tree.get_file(entry.file_id).readlines()
2373
2083
        executable = tree.is_executable(entry.file_id)
2374
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
2084
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2375
2085
                           executable)
2376
2086
    elif kind in ('directory', 'tree-reference'):
2377
2087
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2378
2088
        if kind == 'tree-reference':
2379
2089
            tt.set_tree_reference(entry.reference_revision, trans_id)
2380
 
        return trans_id
 
2090
        return trans_id 
2381
2091
    elif kind == 'symlink':
2382
2092
        target = tree.get_symlink_target(entry.file_id)
2383
2093
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2385
2095
        raise errors.BadFileKindError(name, kind)
2386
2096
 
2387
2097
 
2388
 
@deprecated_function(deprecated_in((1, 9, 0)))
2389
2098
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2390
 
    """Create new file contents according to an inventory entry.
2391
 
 
2392
 
    DEPRECATED.  Use create_from_tree instead.
2393
 
    """
 
2099
    """Create new file contents according to an inventory entry."""
2394
2100
    if entry.kind == "file":
2395
2101
        if lines is None:
2396
2102
            lines = tree.get_file(entry.file_id).readlines()
2401
2107
        tt.create_directory(trans_id)
2402
2108
 
2403
2109
 
2404
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2405
 
    """Create new file contents according to tree contents."""
2406
 
    kind = tree.kind(file_id)
2407
 
    if kind == 'directory':
2408
 
        tt.create_directory(trans_id)
2409
 
    elif kind == "file":
2410
 
        if bytes is None:
2411
 
            tree_file = tree.get_file(file_id)
2412
 
            try:
2413
 
                bytes = tree_file.readlines()
2414
 
            finally:
2415
 
                tree_file.close()
2416
 
        tt.create_file(bytes, trans_id)
2417
 
    elif kind == "symlink":
2418
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2419
 
    else:
2420
 
        raise AssertionError('Unknown kind %r' % kind)
2421
 
 
2422
 
 
2423
2110
def create_entry_executability(tt, entry, trans_id):
2424
2111
    """Set the executability of a trans_id according to an inventory entry"""
2425
2112
    if entry.kind == "file":
2462
2149
        if entry.kind != working_kind:
2463
2150
            contents_mod, meta_mod = True, False
2464
2151
        else:
2465
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
2152
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2466
2153
                                       working_tree)
2467
2154
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2468
2155
            cur_entry._forget_tree_state()
2657
2344
                existing_file, new_file = conflict[1], conflict[2]
2658
2345
            new_name = tt.final_name(existing_file)+'.moved'
2659
2346
            tt.adjust_path(new_name, final_parent, existing_file)
2660
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2347
            new_conflicts.add((c_type, 'Moved existing file to', 
2661
2348
                               existing_file, new_file))
2662
2349
        elif c_type == 'parent loop':
2663
2350
            # break the loop by undoing one of the ops that caused the loop
2667
2354
            new_conflicts.add((c_type, 'Cancelled move', cur,
2668
2355
                               tt.final_parent(cur),))
2669
2356
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2670
 
 
 
2357
            
2671
2358
        elif c_type == 'missing parent':
2672
2359
            trans_id = conflict[1]
2673
2360
            try:
2674
2361
                tt.cancel_deletion(trans_id)
2675
 
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2362
                new_conflicts.add(('deleting parent', 'Not deleting', 
2676
2363
                                   trans_id))
2677
2364
            except KeyError:
2678
2365
                create = True
2743
2430
        if len(conflict) == 3:
2744
2431
            yield Conflict.factory(c_type, action=action, path=modified_path,
2745
2432
                                     file_id=modified_id)
2746
 
 
 
2433
             
2747
2434
        else:
2748
2435
            conflicting_path = fp.get_path(conflict[3])
2749
2436
            conflicting_id = tt.final_file_id(conflict[3])
2750
2437
            yield Conflict.factory(c_type, action=action, path=modified_path,
2751
 
                                   file_id=modified_id,
 
2438
                                   file_id=modified_id, 
2752
2439
                                   conflict_path=conflicting_path,
2753
2440
                                   conflict_file_id=conflicting_id)
2754
2441