~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Vincent Ladeuil
  • Date: 2009-06-22 12:52:39 UTC
  • mto: (4471.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4472.
  • Revision ID: v.ladeuil+lp@free.fr-20090622125239-kabo9smxt9c3vnir
Use a consistent scheme for naming pyrex source files.

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
import os
18
18
import errno
19
 
from stat import S_ISREG
20
 
import tempfile
 
19
from stat import S_ISREG, S_IEXEC
21
20
 
22
21
from bzrlib.lazy_import import lazy_import
23
22
lazy_import(globals(), """
24
23
from bzrlib import (
 
24
    annotate,
 
25
    bencode,
25
26
    bzrdir,
26
27
    delta,
27
28
    errors,
28
29
    inventory,
 
30
    multiparent,
 
31
    osutils,
29
32
    revision as _mod_revision,
30
33
    )
31
34
""")
33
36
                           ReusingTransform, NotVersionedError, CantMoveRoot,
34
37
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
35
38
                           UnableCreateSymlink)
 
39
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
36
40
from bzrlib.inventory import InventoryEntry
37
 
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
38
 
                            delete_any, has_symlinks)
 
41
from bzrlib.osutils import (
 
42
    delete_any,
 
43
    file_kind,
 
44
    has_symlinks,
 
45
    lexists,
 
46
    pathjoin,
 
47
    sha_file,
 
48
    splitpath,
 
49
    supports_executable,
 
50
)
39
51
from bzrlib.progress import DummyProgress, ProgressPhase
40
52
from bzrlib.symbol_versioning import (
41
53
        deprecated_function,
 
54
        deprecated_in,
42
55
        )
43
56
from bzrlib.trace import mutter, warning
44
57
from bzrlib import tree
63
76
 
64
77
 
65
78
class TreeTransformBase(object):
66
 
    """The base class for TreeTransform and TreeTransformBase"""
 
79
    """The base class for TreeTransform and its kin."""
67
80
 
68
 
    def __init__(self, tree, limbodir, pb=DummyProgress(),
 
81
    def __init__(self, tree, pb=DummyProgress(),
69
82
                 case_sensitive=True):
70
83
        """Constructor.
71
84
 
72
85
        :param tree: The tree that will be transformed, but not necessarily
73
86
            the output tree.
74
 
        :param limbodir: A directory where new files can be stored until
75
 
            they are installed in their proper places
76
87
        :param pb: A ProgressBar indicating how much progress is being made
77
88
        :param case_sensitive: If True, the target of the transform is
78
89
            case sensitive, not just case preserving.
79
90
        """
80
91
        object.__init__(self)
81
92
        self._tree = tree
82
 
        self._limbodir = limbodir
83
 
        self._deletiondir = None
84
93
        self._id_number = 0
85
94
        # mapping of trans_id -> new basename
86
95
        self._new_name = {}
88
97
        self._new_parent = {}
89
98
        # mapping of trans_id with new contents -> new file_kind
90
99
        self._new_contents = {}
91
 
        # A mapping of transform ids to their limbo filename
92
 
        self._limbo_files = {}
93
 
        # A mapping of transform ids to a set of the transform ids of children
94
 
        # that their limbo directory has
95
 
        self._limbo_children = {}
96
 
        # Map transform ids to maps of child filename to child transform id
97
 
        self._limbo_children_names = {}
98
 
        # List of transform ids that need to be renamed from limbo into place
99
 
        self._needs_rename = set()
100
100
        # Set of trans_ids whose contents will be removed
101
101
        self._removed_contents = set()
102
102
        # Mapping of trans_id -> new execute-bit value
109
109
        self._non_present_ids = {}
110
110
        # Mapping of new file_id -> trans_id
111
111
        self._r_new_id = {}
112
 
        # Set of file_ids that will be removed
 
112
        # Set of trans_ids that will be removed
113
113
        self._removed_id = set()
114
114
        # Mapping of path in old tree -> trans_id
115
115
        self._tree_path_ids = {}
116
116
        # Mapping trans_id -> path in old tree
117
117
        self._tree_id_paths = {}
118
 
        # Cache of realpath results, to speed up canonical_path
119
 
        self._realpaths = {}
120
 
        # Cache of relpath results, to speed up canonical_path
121
 
        self._relpaths = {}
122
118
        # The trans_id that will be used as the tree root
123
 
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
119
        root_id = tree.get_root_id()
 
120
        if root_id is not None:
 
121
            self._new_root = self.trans_id_tree_file_id(root_id)
 
122
        else:
 
123
            self._new_root = None
124
124
        # Indictor of whether the transform has been applied
125
125
        self._done = False
126
126
        # A progress bar
130
130
        # A counter of how many files have been renamed
131
131
        self.rename_count = 0
132
132
 
 
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
 
133
144
    def __get_root(self):
134
145
        return self._new_root
135
146
 
136
147
    root = property(__get_root)
137
148
 
138
 
    def finalize(self):
139
 
        """Release the working tree lock, if held, clean up limbo dir.
140
 
 
141
 
        This is required if apply has not been invoked, but can be invoked
142
 
        even after apply.
143
 
        """
144
 
        if self._tree is None:
145
 
            return
146
 
        try:
147
 
            entries = [(self._limbo_name(t), t, k) for t, k in
148
 
                       self._new_contents.iteritems()]
149
 
            entries.sort(reverse=True)
150
 
            for path, trans_id, kind in entries:
151
 
                if kind == "directory":
152
 
                    os.rmdir(path)
153
 
                else:
154
 
                    os.unlink(path)
155
 
            try:
156
 
                os.rmdir(self._limbodir)
157
 
            except OSError:
158
 
                # We don't especially care *why* the dir is immortal.
159
 
                raise ImmortalLimbo(self._limbodir)
160
 
            try:
161
 
                if self._deletiondir is not None:
162
 
                    os.rmdir(self._deletiondir)
163
 
            except OSError:
164
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
165
 
        finally:
166
 
            self._tree.unlock()
167
 
            self._tree = None
168
 
 
169
149
    def _assign_id(self):
170
150
        """Produce a new tranform id"""
171
151
        new_id = "new-%s" % self._id_number
183
163
        """Change the path that is assigned to a transaction id."""
184
164
        if trans_id == self._new_root:
185
165
            raise CantMoveRoot
186
 
        previous_parent = self._new_parent.get(trans_id)
187
 
        previous_name = self._new_name.get(trans_id)
188
166
        self._new_name[trans_id] = name
189
167
        self._new_parent[trans_id] = parent
190
 
        if (trans_id in self._limbo_files and
191
 
            trans_id not in self._needs_rename):
192
 
            self._rename_in_limbo([trans_id])
193
 
            self._limbo_children[previous_parent].remove(trans_id)
194
 
            del self._limbo_children_names[previous_parent][previous_name]
195
 
 
196
 
    def _rename_in_limbo(self, trans_ids):
197
 
        """Fix limbo names so that the right final path is produced.
198
 
 
199
 
        This means we outsmarted ourselves-- we tried to avoid renaming
200
 
        these files later by creating them with their final names in their
201
 
        final parents.  But now the previous name or parent is no longer
202
 
        suitable, so we have to rename them.
203
 
 
204
 
        Even for trans_ids that have no new contents, we must remove their
205
 
        entries from _limbo_files, because they are now stale.
206
 
        """
207
 
        for trans_id in trans_ids:
208
 
            old_path = self._limbo_files.pop(trans_id)
209
 
            if trans_id not in self._new_contents:
210
 
                continue
211
 
            new_path = self._limbo_name(trans_id)
212
 
            os.rename(old_path, new_path)
 
168
        if parent == ROOT_PARENT:
 
169
            if self._new_root is not None:
 
170
                raise ValueError("Cannot have multiple roots.")
 
171
            self._new_root = trans_id
213
172
 
214
173
    def adjust_root_path(self, name, parent):
215
174
        """Emulate moving the root by moving all children, instead.
216
 
        
 
175
 
217
176
        We do this by undoing the association of root's transaction id with the
218
177
        current tree.  This allows us to create a new directory with that
219
 
        transaction id.  We unversion the root directory and version the 
 
178
        transaction id.  We unversion the root directory and version the
220
179
        physically new directory, and hope someone versions the tree root
221
180
        later.
222
181
        """
225
184
        # force moving all children of root
226
185
        for child_id in self.iter_tree_children(old_root):
227
186
            if child_id != parent:
228
 
                self.adjust_path(self.final_name(child_id), 
 
187
                self.adjust_path(self.final_name(child_id),
229
188
                                 self.final_parent(child_id), child_id)
230
189
            file_id = self.final_file_id(child_id)
231
190
            if file_id is not None:
232
191
                self.unversion_file(child_id)
233
192
            self.version_file(file_id, child_id)
234
 
        
 
193
 
235
194
        # the physical root needs a new transaction id
236
195
        self._tree_path_ids.pop("")
237
196
        self._tree_id_paths.pop(old_root)
245
204
 
246
205
    def trans_id_tree_file_id(self, inventory_id):
247
206
        """Determine the transaction id of a working tree file.
248
 
        
 
207
 
249
208
        This reflects only files that already exist, not ones that will be
250
209
        added by transactions.
251
210
        """
 
211
        if inventory_id is None:
 
212
            raise ValueError('None is not a valid file id')
252
213
        path = self._tree.id2path(inventory_id)
253
214
        return self.trans_id_tree_path(path)
254
215
 
258
219
        a transaction has been unversioned, it is deliberately still returned.
259
220
        (this will likely lead to an unversioned parent conflict.)
260
221
        """
 
222
        if file_id is None:
 
223
            raise ValueError('None is not a valid file id')
261
224
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
262
225
            return self._r_new_id[file_id]
263
 
        elif file_id in self._tree.inventory:
264
 
            return self.trans_id_tree_file_id(file_id)
265
 
        elif file_id in self._non_present_ids:
266
 
            return self._non_present_ids[file_id]
267
 
        else:
268
 
            trans_id = self._assign_id()
269
 
            self._non_present_ids[file_id] = trans_id
270
 
            return trans_id
271
 
 
272
 
    def canonical_path(self, path):
273
 
        """Get the canonical tree-relative path"""
274
 
        # don't follow final symlinks
275
 
        abs = self._tree.abspath(path)
276
 
        if abs in self._relpaths:
277
 
            return self._relpaths[abs]
278
 
        dirname, basename = os.path.split(abs)
279
 
        if dirname not in self._realpaths:
280
 
            self._realpaths[dirname] = os.path.realpath(dirname)
281
 
        dirname = self._realpaths[dirname]
282
 
        abs = pathjoin(dirname, basename)
283
 
        if dirname in self._relpaths:
284
 
            relpath = pathjoin(self._relpaths[dirname], basename)
285
 
            relpath = relpath.rstrip('/\\')
286
 
        else:
287
 
            relpath = self._tree.relpath(abs)
288
 
        self._relpaths[abs] = relpath
289
 
        return relpath
 
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)
290
238
 
291
239
    def trans_id_tree_path(self, path):
292
240
        """Determine (and maybe set) the transaction ID for a tree path."""
303
251
            return ROOT_PARENT
304
252
        return self.trans_id_tree_path(os.path.dirname(path))
305
253
 
306
 
    def create_file(self, contents, trans_id, mode_id=None):
307
 
        """Schedule creation of a new file.
308
 
 
309
 
        See also new_file.
310
 
        
311
 
        Contents is an iterator of strings, all of which will be written
312
 
        to the target destination.
313
 
 
314
 
        New file takes the permissions of any existing file with that id,
315
 
        unless mode_id is specified.
316
 
        """
317
 
        name = self._limbo_name(trans_id)
318
 
        f = open(name, 'wb')
319
 
        try:
320
 
            try:
321
 
                unique_add(self._new_contents, trans_id, 'file')
322
 
            except:
323
 
                # Clean up the file, it never got registered so
324
 
                # TreeTransform.finalize() won't clean it up.
325
 
                f.close()
326
 
                os.unlink(name)
327
 
                raise
328
 
 
329
 
            f.writelines(contents)
330
 
        finally:
331
 
            f.close()
332
 
        self._set_mode(trans_id, mode_id, S_ISREG)
333
 
 
334
 
    def _set_mode(self, trans_id, mode_id, typefunc):
335
 
        """Set the mode of new file contents.
336
 
        The mode_id is the existing file to get the mode from (often the same
337
 
        as trans_id).  The operation is only performed if there's a mode match
338
 
        according to typefunc.
339
 
        """
340
 
        if mode_id is None:
341
 
            mode_id = trans_id
342
 
        try:
343
 
            old_path = self._tree_id_paths[mode_id]
344
 
        except KeyError:
345
 
            return
346
 
        try:
347
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
348
 
        except OSError, e:
349
 
            if e.errno == errno.ENOENT:
350
 
                return
351
 
            else:
352
 
                raise
353
 
        if typefunc(mode):
354
 
            os.chmod(self._limbo_name(trans_id), mode)
355
 
 
356
 
    def create_hardlink(self, path, trans_id):
357
 
        """Schedule creation of a hard link"""
358
 
        name = self._limbo_name(trans_id)
359
 
        try:
360
 
            os.link(path, name)
361
 
        except OSError, e:
362
 
            if e.errno != errno.EPERM:
363
 
                raise
364
 
            raise errors.HardLinkNotSupported(path)
365
 
        try:
366
 
            unique_add(self._new_contents, trans_id, 'file')
367
 
        except:
368
 
            # Clean up the file, it never got registered so
369
 
            # TreeTransform.finalize() won't clean it up.
370
 
            os.unlink(name)
371
 
            raise
372
 
 
373
 
    def create_directory(self, trans_id):
374
 
        """Schedule creation of a new directory.
375
 
        
376
 
        See also new_directory.
377
 
        """
378
 
        os.mkdir(self._limbo_name(trans_id))
379
 
        unique_add(self._new_contents, trans_id, 'directory')
380
 
 
381
 
    def create_symlink(self, target, trans_id):
382
 
        """Schedule creation of a new symbolic link.
383
 
 
384
 
        target is a bytestring.
385
 
        See also new_symlink.
386
 
        """
387
 
        if has_symlinks():
388
 
            os.symlink(target, self._limbo_name(trans_id))
389
 
            unique_add(self._new_contents, trans_id, 'symlink')
390
 
        else:
391
 
            try:
392
 
                path = FinalPaths(self).get_path(trans_id)
393
 
            except KeyError:
394
 
                path = None
395
 
            raise UnableCreateSymlink(path=path)
396
 
 
397
 
    def cancel_creation(self, trans_id):
398
 
        """Cancel the creation of new file contents."""
399
 
        del self._new_contents[trans_id]
400
 
        children = self._limbo_children.get(trans_id)
401
 
        # if this is a limbo directory with children, move them before removing
402
 
        # the directory
403
 
        if children is not None:
404
 
            self._rename_in_limbo(children)
405
 
            del self._limbo_children[trans_id]
406
 
            del self._limbo_children_names[trans_id]
407
 
        delete_any(self._limbo_name(trans_id))
408
 
 
409
254
    def delete_contents(self, trans_id):
410
255
        """Schedule the contents of a path entry for deletion"""
411
256
        self.tree_kind(trans_id)
450
295
        del self._new_id[trans_id]
451
296
        del self._r_new_id[file_id]
452
297
 
453
 
    def new_paths(self):
454
 
        """Determine the paths of all new and changed files"""
455
 
        new_ids = set()
456
 
        fp = FinalPaths(self)
457
 
        for id_set in (self._new_name, self._new_parent, self._new_contents,
458
 
                       self._new_id, self._new_executability):
459
 
            new_ids.update(id_set)
460
 
        new_paths = [(fp.get_path(t), t) for t in new_ids]
461
 
        new_paths.sort()
462
 
        return new_paths
463
 
 
464
 
    def tree_kind(self, trans_id):
465
 
        """Determine the file kind in the working tree.
466
 
 
467
 
        Raises NoSuchFile if the file does not exist
 
298
    def new_paths(self, filesystem_only=False):
 
299
        """Determine the paths of all new and changed files.
 
300
 
 
301
        :param filesystem_only: if True, only calculate values for files
 
302
            that require renames or execute bit changes.
468
303
        """
469
 
        path = self._tree_id_paths.get(trans_id)
470
 
        if path is None:
471
 
            raise NoSuchFile(None)
472
 
        try:
473
 
            return file_kind(self._tree.abspath(path))
474
 
        except OSError, e:
475
 
            if e.errno != errno.ENOENT:
476
 
                raise
477
 
            else:
478
 
                raise NoSuchFile(path)
 
304
        new_ids = set()
 
305
        if filesystem_only:
 
306
            stale_ids = self._needs_rename.difference(self._new_name)
 
307
            stale_ids.difference_update(self._new_parent)
 
308
            stale_ids.difference_update(self._new_contents)
 
309
            stale_ids.difference_update(self._new_id)
 
310
            needs_rename = self._needs_rename.difference(stale_ids)
 
311
            id_sets = (needs_rename, self._new_executability)
 
312
        else:
 
313
            id_sets = (self._new_name, self._new_parent, self._new_contents,
 
314
                       self._new_id, self._new_executability)
 
315
        for id_set in id_sets:
 
316
            new_ids.update(id_set)
 
317
        return sorted(FinalPaths(self).get_paths(new_ids))
 
318
 
 
319
    def _inventory_altered(self):
 
320
        """Get the trans_ids and paths of files needing new inv entries."""
 
321
        new_ids = set()
 
322
        for id_set in [self._new_name, self._new_parent, self._new_id,
 
323
                       self._new_executability]:
 
324
            new_ids.update(id_set)
 
325
        changed_kind = set(self._removed_contents)
 
326
        changed_kind.intersection_update(self._new_contents)
 
327
        changed_kind.difference_update(new_ids)
 
328
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
329
                        self.final_kind(t))
 
330
        new_ids.update(changed_kind)
 
331
        return sorted(FinalPaths(self).get_paths(new_ids))
479
332
 
480
333
    def final_kind(self, trans_id):
481
334
        """Determine the final file kind, after any changes applied.
482
 
        
 
335
 
483
336
        Raises NoSuchFile if the file does not exist/has no contents.
484
337
        (It is conceivable that a path would be created without the
485
338
        corresponding contents insertion command)
501
354
        # the file is old; the old id is still valid
502
355
        if self._new_root == trans_id:
503
356
            return self._tree.get_root_id()
504
 
        return self._tree.inventory.path2id(path)
 
357
        return self._tree.path2id(path)
505
358
 
506
359
    def final_file_id(self, trans_id):
507
360
        """Determine the file id after any changes are applied, or None.
508
 
        
 
361
 
509
362
        None indicates that the file will not be versioned after changes are
510
363
        applied.
511
364
        """
550
403
 
551
404
    def by_parent(self):
552
405
        """Return a map of parent: children for known parents.
553
 
        
 
406
 
554
407
        Only new paths and parents of tree files with assigned ids are used.
555
408
        """
556
409
        by_parent = {}
557
410
        items = list(self._new_parent.iteritems())
558
 
        items.extend((t, self.final_parent(t)) for t in 
 
411
        items.extend((t, self.final_parent(t)) for t in
559
412
                      self._tree_id_paths.keys())
560
413
        for trans_id, parent_id in items:
561
414
            if parent_id not in by_parent:
596
449
        removed.  This is a necessary first step in detecting conflicts.
597
450
        """
598
451
        parents = self.by_parent().keys()
599
 
        parents.extend([t for t in self._removed_contents if 
 
452
        parents.extend([t for t in self._removed_contents if
600
453
                        self.tree_kind(t) == 'directory'])
601
454
        for trans_id in self._removed_id:
602
455
            file_id = self.tree_file_id(trans_id)
610
463
            # ensure that all children are registered with the transaction
611
464
            list(self.iter_tree_children(parent_id))
612
465
 
613
 
    def iter_tree_children(self, parent_id):
614
 
        """Iterate through the entry's tree children, if any"""
615
 
        try:
616
 
            path = self._tree_id_paths[parent_id]
617
 
        except KeyError:
618
 
            return
619
 
        try:
620
 
            children = os.listdir(self._tree.abspath(path))
621
 
        except OSError, e:
622
 
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
623
 
                raise
624
 
            return
625
 
            
626
 
        for child in children:
627
 
            childpath = joinpath(path, child)
628
 
            if self._tree.is_control_filename(childpath):
629
 
                continue
630
 
            yield self.trans_id_tree_path(childpath)
631
 
 
632
466
    def has_named_child(self, by_parent, parent_id, name):
633
467
        try:
634
468
            children = by_parent[parent_id]
688
522
 
689
523
    def _improper_versioning(self):
690
524
        """Cannot version a file with no contents, or a bad type.
691
 
        
 
525
 
692
526
        However, existing entries with no contents are okay.
693
527
        """
694
528
        conflicts = []
704
538
 
705
539
    def _executability_conflicts(self):
706
540
        """Check for bad executability changes.
707
 
        
 
541
 
708
542
        Only versioned files may have their executability set, because
709
543
        1. only versioned entries can have executability under windows
710
544
        2. only files can be executable.  (The execute bit on a directory
809
643
            return True
810
644
        return False
811
645
 
812
 
    def _limbo_name(self, trans_id):
813
 
        """Generate the limbo name of a file"""
814
 
        limbo_name = self._limbo_files.get(trans_id)
815
 
        if limbo_name is not None:
816
 
            return limbo_name
817
 
        parent = self._new_parent.get(trans_id)
818
 
        # if the parent directory is already in limbo (e.g. when building a
819
 
        # tree), choose a limbo name inside the parent, to reduce further
820
 
        # renames.
821
 
        use_direct_path = False
822
 
        if self._new_contents.get(parent) == 'directory':
823
 
            filename = self._new_name.get(trans_id)
824
 
            if filename is not None:
825
 
                if parent not in self._limbo_children:
826
 
                    self._limbo_children[parent] = set()
827
 
                    self._limbo_children_names[parent] = {}
828
 
                    use_direct_path = True
829
 
                # the direct path can only be used if no other file has
830
 
                # already taken this pathname, i.e. if the name is unused, or
831
 
                # if it is already associated with this trans_id.
832
 
                elif self._case_sensitive_target:
833
 
                    if (self._limbo_children_names[parent].get(filename)
834
 
                        in (trans_id, None)):
835
 
                        use_direct_path = True
836
 
                else:
837
 
                    for l_filename, l_trans_id in\
838
 
                        self._limbo_children_names[parent].iteritems():
839
 
                        if l_trans_id == trans_id:
840
 
                            continue
841
 
                        if l_filename.lower() == filename.lower():
842
 
                            break
843
 
                    else:
844
 
                        use_direct_path = True
845
 
 
846
 
        if use_direct_path:
847
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
848
 
            self._limbo_children[parent].add(trans_id)
849
 
            self._limbo_children_names[parent][filename] = trans_id
850
 
        else:
851
 
            limbo_name = pathjoin(self._limbodir, trans_id)
852
 
            self._needs_rename.add(trans_id)
853
 
        self._limbo_files[trans_id] = limbo_name
854
 
        return limbo_name
855
 
 
856
 
    def _set_executability(self, path, entry, trans_id):
 
646
    def _set_executability(self, path, trans_id):
857
647
        """Set the executability of versioned files """
858
 
        new_executability = self._new_executability[trans_id]
859
 
        entry.executable = new_executability
860
648
        if supports_executable():
 
649
            new_executability = self._new_executability[trans_id]
861
650
            abspath = self._tree.abspath(path)
862
651
            current_mode = os.stat(abspath).st_mode
863
652
            if new_executability:
880
669
            self.version_file(file_id, trans_id)
881
670
        return trans_id
882
671
 
883
 
    def new_file(self, name, parent_id, contents, file_id=None, 
 
672
    def new_file(self, name, parent_id, contents, file_id=None,
884
673
                 executable=None):
885
674
        """Convenience method to create files.
886
 
        
 
675
 
887
676
        name is the name of the file to create.
888
677
        parent_id is the transaction id of the parent directory of the file.
889
678
        contents is an iterator of bytestrings, which will be used to produce
909
698
        """
910
699
        trans_id = self._new_entry(name, parent_id, file_id)
911
700
        self.create_directory(trans_id)
912
 
        return trans_id 
 
701
        return trans_id
913
702
 
914
703
    def new_symlink(self, name, parent_id, target, file_id=None):
915
704
        """Convenience method to create symbolic link.
916
 
        
 
705
 
917
706
        name is the name of the symlink to create.
918
707
        parent_id is the transaction id of the parent directory of the symlink.
919
708
        target is a bytestring of the target of the symlink.
958
747
        from_path = self._tree_id_paths.get(from_trans_id)
959
748
        if from_versioned:
960
749
            # get data from working tree if versioned
961
 
            from_entry = self._tree.inventory[file_id]
 
750
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
962
751
            from_name = from_entry.name
963
752
            from_parent = from_entry.parent_id
964
753
        else:
1070
859
        """
1071
860
        return _PreviewTree(self)
1072
861
 
1073
 
 
1074
 
class TreeTransform(TreeTransformBase):
 
862
    def _text_parent(self, trans_id):
 
863
        file_id = self.tree_file_id(trans_id)
 
864
        try:
 
865
            if file_id is None or self._tree.kind(file_id) != 'file':
 
866
                return None
 
867
        except errors.NoSuchFile:
 
868
            return None
 
869
        return file_id
 
870
 
 
871
    def _get_parents_texts(self, trans_id):
 
872
        """Get texts for compression parents of this file."""
 
873
        file_id = self._text_parent(trans_id)
 
874
        if file_id is None:
 
875
            return ()
 
876
        return (self._tree.get_file_text(file_id),)
 
877
 
 
878
    def _get_parents_lines(self, trans_id):
 
879
        """Get lines for compression parents of this file."""
 
880
        file_id = self._text_parent(trans_id)
 
881
        if file_id is None:
 
882
            return ()
 
883
        return (self._tree.get_file_lines(file_id),)
 
884
 
 
885
    def serialize(self, serializer):
 
886
        """Serialize this TreeTransform.
 
887
 
 
888
        :param serializer: A Serialiser like pack.ContainerSerializer.
 
889
        """
 
890
        new_name = dict((k, v.encode('utf-8')) for k, v in
 
891
                        self._new_name.items())
 
892
        new_executability = dict((k, int(v)) for k, v in
 
893
                                 self._new_executability.items())
 
894
        tree_path_ids = dict((k.encode('utf-8'), v)
 
895
                             for k, v in self._tree_path_ids.items())
 
896
        attribs = {
 
897
            '_id_number': self._id_number,
 
898
            '_new_name': new_name,
 
899
            '_new_parent': self._new_parent,
 
900
            '_new_executability': new_executability,
 
901
            '_new_id': self._new_id,
 
902
            '_tree_path_ids': tree_path_ids,
 
903
            '_removed_id': list(self._removed_id),
 
904
            '_removed_contents': list(self._removed_contents),
 
905
            '_non_present_ids': self._non_present_ids,
 
906
            }
 
907
        yield serializer.bytes_record(bencode.bencode(attribs),
 
908
                                      (('attribs',),))
 
909
        for trans_id, kind in self._new_contents.items():
 
910
            if kind == 'file':
 
911
                lines = osutils.chunks_to_lines(
 
912
                    self._read_file_chunks(trans_id))
 
913
                parents = self._get_parents_lines(trans_id)
 
914
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
 
915
                content = ''.join(mpdiff.to_patch())
 
916
            if kind == 'directory':
 
917
                content = ''
 
918
            if kind == 'symlink':
 
919
                content = self._read_symlink_target(trans_id)
 
920
            yield serializer.bytes_record(content, ((trans_id, kind),))
 
921
 
 
922
    def deserialize(self, records):
 
923
        """Deserialize a stored TreeTransform.
 
924
 
 
925
        :param records: An iterable of (names, content) tuples, as per
 
926
            pack.ContainerPushParser.
 
927
        """
 
928
        names, content = records.next()
 
929
        attribs = bencode.bdecode(content)
 
930
        self._id_number = attribs['_id_number']
 
931
        self._new_name = dict((k, v.decode('utf-8'))
 
932
                            for k, v in attribs['_new_name'].items())
 
933
        self._new_parent = attribs['_new_parent']
 
934
        self._new_executability = dict((k, bool(v)) for k, v in
 
935
            attribs['_new_executability'].items())
 
936
        self._new_id = attribs['_new_id']
 
937
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
 
938
        self._tree_path_ids = {}
 
939
        self._tree_id_paths = {}
 
940
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
 
941
            path = bytepath.decode('utf-8')
 
942
            self._tree_path_ids[path] = trans_id
 
943
            self._tree_id_paths[trans_id] = path
 
944
        self._removed_id = set(attribs['_removed_id'])
 
945
        self._removed_contents = set(attribs['_removed_contents'])
 
946
        self._non_present_ids = attribs['_non_present_ids']
 
947
        for ((trans_id, kind),), content in records:
 
948
            if kind == 'file':
 
949
                mpdiff = multiparent.MultiParent.from_patch(content)
 
950
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
 
951
                self.create_file(lines, trans_id)
 
952
            if kind == 'directory':
 
953
                self.create_directory(trans_id)
 
954
            if kind == 'symlink':
 
955
                self.create_symlink(content.decode('utf-8'), trans_id)
 
956
 
 
957
 
 
958
class DiskTreeTransform(TreeTransformBase):
 
959
    """Tree transform storing its contents on disk."""
 
960
 
 
961
    def __init__(self, tree, limbodir, pb=DummyProgress(),
 
962
                 case_sensitive=True):
 
963
        """Constructor.
 
964
        :param tree: The tree that will be transformed, but not necessarily
 
965
            the output tree.
 
966
        :param limbodir: A directory where new files can be stored until
 
967
            they are installed in their proper places
 
968
        :param pb: A ProgressBar indicating how much progress is being made
 
969
        :param case_sensitive: If True, the target of the transform is
 
970
            case sensitive, not just case preserving.
 
971
        """
 
972
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
 
973
        self._limbodir = limbodir
 
974
        self._deletiondir = None
 
975
        # A mapping of transform ids to their limbo filename
 
976
        self._limbo_files = {}
 
977
        # A mapping of transform ids to a set of the transform ids of children
 
978
        # that their limbo directory has
 
979
        self._limbo_children = {}
 
980
        # Map transform ids to maps of child filename to child transform id
 
981
        self._limbo_children_names = {}
 
982
        # List of transform ids that need to be renamed from limbo into place
 
983
        self._needs_rename = set()
 
984
 
 
985
    def finalize(self):
 
986
        """Release the working tree lock, if held, clean up limbo dir.
 
987
 
 
988
        This is required if apply has not been invoked, but can be invoked
 
989
        even after apply.
 
990
        """
 
991
        if self._tree is None:
 
992
            return
 
993
        try:
 
994
            entries = [(self._limbo_name(t), t, k) for t, k in
 
995
                       self._new_contents.iteritems()]
 
996
            entries.sort(reverse=True)
 
997
            for path, trans_id, kind in entries:
 
998
                if kind == "directory":
 
999
                    os.rmdir(path)
 
1000
                else:
 
1001
                    os.unlink(path)
 
1002
            try:
 
1003
                os.rmdir(self._limbodir)
 
1004
            except OSError:
 
1005
                # We don't especially care *why* the dir is immortal.
 
1006
                raise ImmortalLimbo(self._limbodir)
 
1007
            try:
 
1008
                if self._deletiondir is not None:
 
1009
                    os.rmdir(self._deletiondir)
 
1010
            except OSError:
 
1011
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
1012
        finally:
 
1013
            TreeTransformBase.finalize(self)
 
1014
 
 
1015
    def _limbo_name(self, trans_id):
 
1016
        """Generate the limbo name of a file"""
 
1017
        limbo_name = self._limbo_files.get(trans_id)
 
1018
        if limbo_name is not None:
 
1019
            return limbo_name
 
1020
        parent = self._new_parent.get(trans_id)
 
1021
        # if the parent directory is already in limbo (e.g. when building a
 
1022
        # tree), choose a limbo name inside the parent, to reduce further
 
1023
        # renames.
 
1024
        use_direct_path = False
 
1025
        if self._new_contents.get(parent) == 'directory':
 
1026
            filename = self._new_name.get(trans_id)
 
1027
            if filename is not None:
 
1028
                if parent not in self._limbo_children:
 
1029
                    self._limbo_children[parent] = set()
 
1030
                    self._limbo_children_names[parent] = {}
 
1031
                    use_direct_path = True
 
1032
                # the direct path can only be used if no other file has
 
1033
                # already taken this pathname, i.e. if the name is unused, or
 
1034
                # if it is already associated with this trans_id.
 
1035
                elif self._case_sensitive_target:
 
1036
                    if (self._limbo_children_names[parent].get(filename)
 
1037
                        in (trans_id, None)):
 
1038
                        use_direct_path = True
 
1039
                else:
 
1040
                    for l_filename, l_trans_id in\
 
1041
                        self._limbo_children_names[parent].iteritems():
 
1042
                        if l_trans_id == trans_id:
 
1043
                            continue
 
1044
                        if l_filename.lower() == filename.lower():
 
1045
                            break
 
1046
                    else:
 
1047
                        use_direct_path = True
 
1048
 
 
1049
        if use_direct_path:
 
1050
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
1051
            self._limbo_children[parent].add(trans_id)
 
1052
            self._limbo_children_names[parent][filename] = trans_id
 
1053
        else:
 
1054
            limbo_name = pathjoin(self._limbodir, trans_id)
 
1055
            self._needs_rename.add(trans_id)
 
1056
        self._limbo_files[trans_id] = limbo_name
 
1057
        return limbo_name
 
1058
 
 
1059
    def adjust_path(self, name, parent, trans_id):
 
1060
        previous_parent = self._new_parent.get(trans_id)
 
1061
        previous_name = self._new_name.get(trans_id)
 
1062
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
 
1063
        if (trans_id in self._limbo_files and
 
1064
            trans_id not in self._needs_rename):
 
1065
            self._rename_in_limbo([trans_id])
 
1066
            self._limbo_children[previous_parent].remove(trans_id)
 
1067
            del self._limbo_children_names[previous_parent][previous_name]
 
1068
 
 
1069
    def _rename_in_limbo(self, trans_ids):
 
1070
        """Fix limbo names so that the right final path is produced.
 
1071
 
 
1072
        This means we outsmarted ourselves-- we tried to avoid renaming
 
1073
        these files later by creating them with their final names in their
 
1074
        final parents.  But now the previous name or parent is no longer
 
1075
        suitable, so we have to rename them.
 
1076
 
 
1077
        Even for trans_ids that have no new contents, we must remove their
 
1078
        entries from _limbo_files, because they are now stale.
 
1079
        """
 
1080
        for trans_id in trans_ids:
 
1081
            old_path = self._limbo_files.pop(trans_id)
 
1082
            if trans_id not in self._new_contents:
 
1083
                continue
 
1084
            new_path = self._limbo_name(trans_id)
 
1085
            os.rename(old_path, new_path)
 
1086
 
 
1087
    def create_file(self, contents, trans_id, mode_id=None):
 
1088
        """Schedule creation of a new file.
 
1089
 
 
1090
        See also new_file.
 
1091
 
 
1092
        Contents is an iterator of strings, all of which will be written
 
1093
        to the target destination.
 
1094
 
 
1095
        New file takes the permissions of any existing file with that id,
 
1096
        unless mode_id is specified.
 
1097
        """
 
1098
        name = self._limbo_name(trans_id)
 
1099
        f = open(name, 'wb')
 
1100
        try:
 
1101
            try:
 
1102
                unique_add(self._new_contents, trans_id, 'file')
 
1103
            except:
 
1104
                # Clean up the file, it never got registered so
 
1105
                # TreeTransform.finalize() won't clean it up.
 
1106
                f.close()
 
1107
                os.unlink(name)
 
1108
                raise
 
1109
 
 
1110
            f.writelines(contents)
 
1111
        finally:
 
1112
            f.close()
 
1113
        self._set_mode(trans_id, mode_id, S_ISREG)
 
1114
 
 
1115
    def _read_file_chunks(self, trans_id):
 
1116
        cur_file = open(self._limbo_name(trans_id), 'rb')
 
1117
        try:
 
1118
            return cur_file.readlines()
 
1119
        finally:
 
1120
            cur_file.close()
 
1121
 
 
1122
    def _read_symlink_target(self, trans_id):
 
1123
        return os.readlink(self._limbo_name(trans_id))
 
1124
 
 
1125
    def create_hardlink(self, path, trans_id):
 
1126
        """Schedule creation of a hard link"""
 
1127
        name = self._limbo_name(trans_id)
 
1128
        try:
 
1129
            os.link(path, name)
 
1130
        except OSError, e:
 
1131
            if e.errno != errno.EPERM:
 
1132
                raise
 
1133
            raise errors.HardLinkNotSupported(path)
 
1134
        try:
 
1135
            unique_add(self._new_contents, trans_id, 'file')
 
1136
        except:
 
1137
            # Clean up the file, it never got registered so
 
1138
            # TreeTransform.finalize() won't clean it up.
 
1139
            os.unlink(name)
 
1140
            raise
 
1141
 
 
1142
    def create_directory(self, trans_id):
 
1143
        """Schedule creation of a new directory.
 
1144
 
 
1145
        See also new_directory.
 
1146
        """
 
1147
        os.mkdir(self._limbo_name(trans_id))
 
1148
        unique_add(self._new_contents, trans_id, 'directory')
 
1149
 
 
1150
    def create_symlink(self, target, trans_id):
 
1151
        """Schedule creation of a new symbolic link.
 
1152
 
 
1153
        target is a bytestring.
 
1154
        See also new_symlink.
 
1155
        """
 
1156
        if has_symlinks():
 
1157
            os.symlink(target, self._limbo_name(trans_id))
 
1158
            unique_add(self._new_contents, trans_id, 'symlink')
 
1159
        else:
 
1160
            try:
 
1161
                path = FinalPaths(self).get_path(trans_id)
 
1162
            except KeyError:
 
1163
                path = None
 
1164
            raise UnableCreateSymlink(path=path)
 
1165
 
 
1166
    def cancel_creation(self, trans_id):
 
1167
        """Cancel the creation of new file contents."""
 
1168
        del self._new_contents[trans_id]
 
1169
        children = self._limbo_children.get(trans_id)
 
1170
        # if this is a limbo directory with children, move them before removing
 
1171
        # the directory
 
1172
        if children is not None:
 
1173
            self._rename_in_limbo(children)
 
1174
            del self._limbo_children[trans_id]
 
1175
            del self._limbo_children_names[trans_id]
 
1176
        delete_any(self._limbo_name(trans_id))
 
1177
 
 
1178
 
 
1179
class TreeTransform(DiskTreeTransform):
1075
1180
    """Represent a tree transformation.
1076
1181
 
1077
1182
    This object is designed to support incremental generation of the transform,
1145
1250
        tree.lock_tree_write()
1146
1251
 
1147
1252
        try:
1148
 
            control_files = tree._control_files
1149
1253
            limbodir = urlutils.local_path_from_url(
1150
 
                control_files.controlfilename('limbo'))
 
1254
                tree._transport.abspath('limbo'))
1151
1255
            try:
1152
1256
                os.mkdir(limbodir)
1153
1257
            except OSError, e:
1154
1258
                if e.errno == errno.EEXIST:
1155
1259
                    raise ExistingLimbo(limbodir)
1156
1260
            deletiondir = urlutils.local_path_from_url(
1157
 
                control_files.controlfilename('pending-deletion'))
 
1261
                tree._transport.abspath('pending-deletion'))
1158
1262
            try:
1159
1263
                os.mkdir(deletiondir)
1160
1264
            except OSError, e:
1164
1268
            tree.unlock()
1165
1269
            raise
1166
1270
 
1167
 
        TreeTransformBase.__init__(self, tree, limbodir, pb,
 
1271
        # Cache of realpath results, to speed up canonical_path
 
1272
        self._realpaths = {}
 
1273
        # Cache of relpath results, to speed up canonical_path
 
1274
        self._relpaths = {}
 
1275
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
1168
1276
                                   tree.case_sensitive)
1169
1277
        self._deletiondir = deletiondir
1170
1278
 
1171
 
    def apply(self, no_conflicts=False, _mover=None):
 
1279
    def canonical_path(self, path):
 
1280
        """Get the canonical tree-relative path"""
 
1281
        # don't follow final symlinks
 
1282
        abs = self._tree.abspath(path)
 
1283
        if abs in self._relpaths:
 
1284
            return self._relpaths[abs]
 
1285
        dirname, basename = os.path.split(abs)
 
1286
        if dirname not in self._realpaths:
 
1287
            self._realpaths[dirname] = os.path.realpath(dirname)
 
1288
        dirname = self._realpaths[dirname]
 
1289
        abs = pathjoin(dirname, basename)
 
1290
        if dirname in self._relpaths:
 
1291
            relpath = pathjoin(self._relpaths[dirname], basename)
 
1292
            relpath = relpath.rstrip('/\\')
 
1293
        else:
 
1294
            relpath = self._tree.relpath(abs)
 
1295
        self._relpaths[abs] = relpath
 
1296
        return relpath
 
1297
 
 
1298
    def tree_kind(self, trans_id):
 
1299
        """Determine the file kind in the working tree.
 
1300
 
 
1301
        Raises NoSuchFile if the file does not exist
 
1302
        """
 
1303
        path = self._tree_id_paths.get(trans_id)
 
1304
        if path is None:
 
1305
            raise NoSuchFile(None)
 
1306
        try:
 
1307
            return file_kind(self._tree.abspath(path))
 
1308
        except OSError, e:
 
1309
            if e.errno != errno.ENOENT:
 
1310
                raise
 
1311
            else:
 
1312
                raise NoSuchFile(path)
 
1313
 
 
1314
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1315
        """Set the mode of new file contents.
 
1316
        The mode_id is the existing file to get the mode from (often the same
 
1317
        as trans_id).  The operation is only performed if there's a mode match
 
1318
        according to typefunc.
 
1319
        """
 
1320
        if mode_id is None:
 
1321
            mode_id = trans_id
 
1322
        try:
 
1323
            old_path = self._tree_id_paths[mode_id]
 
1324
        except KeyError:
 
1325
            return
 
1326
        try:
 
1327
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
1328
        except OSError, e:
 
1329
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
1330
                # Either old_path doesn't exist, or the parent of the
 
1331
                # target is not a directory (but will be one eventually)
 
1332
                # Either way, we know it doesn't exist *right now*
 
1333
                # See also bug #248448
 
1334
                return
 
1335
            else:
 
1336
                raise
 
1337
        if typefunc(mode):
 
1338
            os.chmod(self._limbo_name(trans_id), mode)
 
1339
 
 
1340
    def iter_tree_children(self, parent_id):
 
1341
        """Iterate through the entry's tree children, if any"""
 
1342
        try:
 
1343
            path = self._tree_id_paths[parent_id]
 
1344
        except KeyError:
 
1345
            return
 
1346
        try:
 
1347
            children = os.listdir(self._tree.abspath(path))
 
1348
        except OSError, e:
 
1349
            if not (osutils._is_error_enotdir(e)
 
1350
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
1351
                raise
 
1352
            return
 
1353
 
 
1354
        for child in children:
 
1355
            childpath = joinpath(path, child)
 
1356
            if self._tree.is_control_filename(childpath):
 
1357
                continue
 
1358
            yield self.trans_id_tree_path(childpath)
 
1359
 
 
1360
 
 
1361
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1172
1362
        """Apply all changes to the inventory and filesystem.
1173
1363
 
1174
1364
        If filesystem or inventory conflicts are present, MalformedTransform
1178
1368
 
1179
1369
        :param no_conflicts: if True, the caller guarantees there are no
1180
1370
            conflicts, so no check is made.
 
1371
        :param precomputed_delta: An inventory delta to use instead of
 
1372
            calculating one.
1181
1373
        :param _mover: Supply an alternate FileMover, for testing
1182
1374
        """
1183
1375
        if not no_conflicts:
1184
1376
            conflicts = self.find_conflicts()
1185
1377
            if len(conflicts) != 0:
1186
1378
                raise MalformedTransform(conflicts=conflicts)
1187
 
        inventory_delta = []
1188
1379
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1189
1380
        try:
 
1381
            if precomputed_delta is None:
 
1382
                child_pb.update('Apply phase', 0, 2)
 
1383
                inventory_delta = self._generate_inventory_delta()
 
1384
                offset = 1
 
1385
            else:
 
1386
                inventory_delta = precomputed_delta
 
1387
                offset = 0
1190
1388
            if _mover is None:
1191
1389
                mover = _FileMover()
1192
1390
            else:
1193
1391
                mover = _mover
1194
1392
            try:
1195
 
                child_pb.update('Apply phase', 0, 2)
1196
 
                self._apply_removals(inventory_delta, mover)
1197
 
                child_pb.update('Apply phase', 1, 2)
1198
 
                modified_paths = self._apply_insertions(inventory_delta, mover)
 
1393
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
 
1394
                self._apply_removals(mover)
 
1395
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
 
1396
                modified_paths = self._apply_insertions(mover)
1199
1397
            except:
1200
1398
                mover.rollback()
1201
1399
                raise
1208
1406
        self.finalize()
1209
1407
        return _TransformResults(modified_paths, self.rename_count)
1210
1408
 
1211
 
    def _apply_removals(self, inventory_delta, mover):
 
1409
    def _generate_inventory_delta(self):
 
1410
        """Generate an inventory delta for the current transform."""
 
1411
        inventory_delta = []
 
1412
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1413
        new_paths = self._inventory_altered()
 
1414
        total_entries = len(new_paths) + len(self._removed_id)
 
1415
        try:
 
1416
            for num, trans_id in enumerate(self._removed_id):
 
1417
                if (num % 10) == 0:
 
1418
                    child_pb.update('removing file', num, total_entries)
 
1419
                if trans_id == self._new_root:
 
1420
                    file_id = self._tree.get_root_id()
 
1421
                else:
 
1422
                    file_id = self.tree_file_id(trans_id)
 
1423
                # File-id isn't really being deleted, just moved
 
1424
                if file_id in self._r_new_id:
 
1425
                    continue
 
1426
                path = self._tree_id_paths[trans_id]
 
1427
                inventory_delta.append((path, None, file_id, None))
 
1428
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1429
                                     new_paths)
 
1430
            entries = self._tree.iter_entries_by_dir(
 
1431
                new_path_file_ids.values())
 
1432
            old_paths = dict((e.file_id, p) for p, e in entries)
 
1433
            final_kinds = {}
 
1434
            for num, (path, trans_id) in enumerate(new_paths):
 
1435
                if (num % 10) == 0:
 
1436
                    child_pb.update('adding file',
 
1437
                                    num + len(self._removed_id), total_entries)
 
1438
                file_id = new_path_file_ids[trans_id]
 
1439
                if file_id is None:
 
1440
                    continue
 
1441
                needs_entry = False
 
1442
                try:
 
1443
                    kind = self.final_kind(trans_id)
 
1444
                except NoSuchFile:
 
1445
                    kind = self._tree.stored_kind(file_id)
 
1446
                parent_trans_id = self.final_parent(trans_id)
 
1447
                parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1448
                if parent_file_id is None:
 
1449
                    parent_file_id = self.final_file_id(parent_trans_id)
 
1450
                if trans_id in self._new_reference_revision:
 
1451
                    new_entry = inventory.TreeReference(
 
1452
                        file_id,
 
1453
                        self._new_name[trans_id],
 
1454
                        self.final_file_id(self._new_parent[trans_id]),
 
1455
                        None, self._new_reference_revision[trans_id])
 
1456
                else:
 
1457
                    new_entry = inventory.make_entry(kind,
 
1458
                        self.final_name(trans_id),
 
1459
                        parent_file_id, file_id)
 
1460
                old_path = old_paths.get(new_entry.file_id)
 
1461
                new_executability = self._new_executability.get(trans_id)
 
1462
                if new_executability is not None:
 
1463
                    new_entry.executable = new_executability
 
1464
                inventory_delta.append(
 
1465
                    (old_path, path, new_entry.file_id, new_entry))
 
1466
        finally:
 
1467
            child_pb.finished()
 
1468
        return inventory_delta
 
1469
 
 
1470
    def _apply_removals(self, mover):
1212
1471
        """Perform tree operations that remove directory/inventory names.
1213
1472
 
1214
1473
        That is, delete files that are to be deleted, and put any files that
1215
1474
        need renaming into limbo.  This must be done in strict child-to-parent
1216
1475
        order.
 
1476
 
 
1477
        If inventory_delta is None, no inventory delta generation is performed.
1217
1478
        """
1218
1479
        tree_paths = list(self._tree_path_ids.iteritems())
1219
1480
        tree_paths.sort(reverse=True)
1235
1496
                            raise
1236
1497
                    else:
1237
1498
                        self.rename_count += 1
1238
 
                if trans_id in self._removed_id:
1239
 
                    if trans_id == self._new_root:
1240
 
                        file_id = self._tree.get_root_id()
1241
 
                    else:
1242
 
                        file_id = self.tree_file_id(trans_id)
1243
 
                    # File-id isn't really being deleted, just moved
1244
 
                    if file_id in self._r_new_id:
1245
 
                        continue
1246
 
                    inventory_delta.append((path, None, file_id, None))
1247
1499
        finally:
1248
1500
            child_pb.finished()
1249
1501
 
1250
 
    def _apply_insertions(self, inventory_delta, mover):
 
1502
    def _apply_insertions(self, mover):
1251
1503
        """Perform tree operations that insert directory/inventory names.
1252
1504
 
1253
1505
        That is, create any files that need to be created, and restore from
1254
1506
        limbo any files that needed renaming.  This must be done in strict
1255
1507
        parent-to-child order.
 
1508
 
 
1509
        If inventory_delta is None, no inventory delta is calculated, and
 
1510
        no list of modified paths is returned.
1256
1511
        """
1257
 
        new_paths = self.new_paths()
 
1512
        new_paths = self.new_paths(filesystem_only=True)
1258
1513
        modified_paths = []
 
1514
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1515
                                 new_paths)
1259
1516
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1260
 
        completed_new = []
1261
1517
        try:
1262
1518
            for num, (path, trans_id) in enumerate(new_paths):
1263
 
                new_entry = None
1264
 
                child_pb.update('adding file', num, len(new_paths))
1265
 
                if trans_id in self._new_contents or \
1266
 
                    self.path_changed(trans_id):
1267
 
                    full_path = self._tree.abspath(path)
1268
 
                    if trans_id in self._needs_rename:
1269
 
                        try:
1270
 
                            mover.rename(self._limbo_name(trans_id), full_path)
1271
 
                        except OSError, e:
1272
 
                            # We may be renaming a dangling inventory id
1273
 
                            if e.errno != errno.ENOENT:
1274
 
                                raise
1275
 
                        else:
1276
 
                            self.rename_count += 1
 
1519
                if (num % 10) == 0:
 
1520
                    child_pb.update('adding file', num, len(new_paths))
 
1521
                full_path = self._tree.abspath(path)
 
1522
                if trans_id in self._needs_rename:
 
1523
                    try:
 
1524
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1525
                    except OSError, e:
 
1526
                        # We may be renaming a dangling inventory id
 
1527
                        if e.errno != errno.ENOENT:
 
1528
                            raise
 
1529
                    else:
 
1530
                        self.rename_count += 1
 
1531
                if (trans_id in self._new_contents or
 
1532
                    self.path_changed(trans_id)):
1277
1533
                    if trans_id in self._new_contents:
1278
1534
                        modified_paths.append(full_path)
1279
 
                        completed_new.append(trans_id)
1280
 
                file_id = self.final_file_id(trans_id)
1281
 
                if file_id is not None and (trans_id in self._new_id or
1282
 
                    trans_id in self._new_name or trans_id in self._new_parent
1283
 
                    or trans_id in self._new_executability):
1284
 
                    try:
1285
 
                        kind = self.final_kind(trans_id)
1286
 
                    except NoSuchFile:
1287
 
                        kind = self._tree.stored_kind(file_id)
1288
 
                    if trans_id in self._new_reference_revision:
1289
 
                        new_entry = inventory.TreeReference(
1290
 
                            self.final_file_id(trans_id),
1291
 
                            self._new_name[trans_id],
1292
 
                            self.final_file_id(self._new_parent[trans_id]),
1293
 
                            None, self._new_reference_revision[trans_id])
1294
 
                    else:
1295
 
                        new_entry = inventory.make_entry(kind,
1296
 
                            self.final_name(trans_id),
1297
 
                            self.final_file_id(self.final_parent(trans_id)),
1298
 
                            self.final_file_id(trans_id))
1299
 
                    try:
1300
 
                        old_path = self._tree.id2path(new_entry.file_id)
1301
 
                    except errors.NoSuchId:
1302
 
                        old_path = None
1303
 
                    inventory_delta.append((old_path, path, new_entry.file_id,
1304
 
                                            new_entry))
1305
 
 
1306
1535
                if trans_id in self._new_executability:
1307
 
                    self._set_executability(path, new_entry, trans_id)
 
1536
                    self._set_executability(path, trans_id)
1308
1537
        finally:
1309
1538
            child_pb.finished()
1310
 
        for trans_id in completed_new:
1311
 
            del self._new_contents[trans_id]
 
1539
        self._new_contents.clear()
1312
1540
        return modified_paths
1313
1541
 
1314
1542
 
1315
 
class TransformPreview(TreeTransformBase):
 
1543
class TransformPreview(DiskTreeTransform):
1316
1544
    """A TreeTransform for generating preview trees.
1317
1545
 
1318
1546
    Unlike TreeTransform, this version works when the input tree is a
1322
1550
 
1323
1551
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1324
1552
        tree.lock_read()
1325
 
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1326
 
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1553
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
 
1554
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1327
1555
 
1328
1556
    def canonical_path(self, path):
1329
1557
        return path
1351
1579
        except KeyError:
1352
1580
            return
1353
1581
        file_id = self.tree_file_id(parent_id)
1354
 
        for child in self._tree.inventory[file_id].children.iterkeys():
 
1582
        if file_id is None:
 
1583
            return
 
1584
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1585
        children = getattr(entry, 'children', {})
 
1586
        for child in children:
1355
1587
            childpath = joinpath(path, child)
1356
1588
            yield self.trans_id_tree_path(childpath)
1357
1589
 
1362
1594
    def __init__(self, transform):
1363
1595
        self._transform = transform
1364
1596
        self._final_paths = FinalPaths(transform)
 
1597
        self.__by_parent = None
 
1598
        self._parent_ids = []
 
1599
        self._all_children_cache = {}
 
1600
        self._path2trans_id_cache = {}
 
1601
        self._final_name_cache = {}
1365
1602
 
1366
1603
    def _changes(self, file_id):
1367
1604
        for changes in self._transform.iter_changes():
1375
1612
        # InterTree.iter_changes.
1376
1613
        return (changes is not None and changes[2])
1377
1614
 
 
1615
    def _get_repository(self):
 
1616
        repo = getattr(self._transform._tree, '_repository', None)
 
1617
        if repo is None:
 
1618
            repo = self._transform._tree.branch.repository
 
1619
        return repo
 
1620
 
 
1621
    def _iter_parent_trees(self):
 
1622
        for revision_id in self.get_parent_ids():
 
1623
            try:
 
1624
                yield self.revision_tree(revision_id)
 
1625
            except errors.NoSuchRevisionInTree:
 
1626
                yield self._get_repository().revision_tree(revision_id)
 
1627
 
1378
1628
    def _get_file_revision(self, file_id, vf, tree_revision):
1379
 
        return self._transform._tree._get_file_revision(file_id, vf,
1380
 
                                                        tree_revision)
 
1629
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
1630
                       self._iter_parent_trees()]
 
1631
        vf.add_lines((file_id, tree_revision), parent_keys,
 
1632
                     self.get_file(file_id).readlines())
 
1633
        repo = self._get_repository()
 
1634
        base_vf = repo.texts
 
1635
        if base_vf not in vf.fallback_versionedfiles:
 
1636
            vf.fallback_versionedfiles.append(base_vf)
 
1637
        return tree_revision
1381
1638
 
1382
1639
    def _stat_limbo_file(self, file_id):
1383
1640
        trans_id = self._transform.trans_id_file_id(file_id)
1384
1641
        name = self._transform._limbo_name(trans_id)
1385
1642
        return os.lstat(name)
1386
1643
 
 
1644
    @property
 
1645
    def _by_parent(self):
 
1646
        if self.__by_parent is None:
 
1647
            self.__by_parent = self._transform.by_parent()
 
1648
        return self.__by_parent
 
1649
 
 
1650
    def _comparison_data(self, entry, path):
 
1651
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
 
1652
        if kind == 'missing':
 
1653
            kind = None
 
1654
            executable = False
 
1655
        else:
 
1656
            file_id = self._transform.final_file_id(self._path2trans_id(path))
 
1657
            executable = self.is_executable(file_id, path)
 
1658
        return kind, executable, None
 
1659
 
1387
1660
    def lock_read(self):
1388
1661
        # Perhaps in theory, this should lock the TreeTransform?
1389
1662
        pass
1400
1673
        return self._transform.final_file_id(self._transform.root)
1401
1674
 
1402
1675
    def all_file_ids(self):
1403
 
        return self._transform._tree.all_file_ids()
 
1676
        tree_ids = set(self._transform._tree.all_file_ids())
 
1677
        tree_ids.difference_update(self._transform.tree_file_id(t)
 
1678
                                   for t in self._transform._removed_id)
 
1679
        tree_ids.update(self._transform._new_id.values())
 
1680
        return tree_ids
1404
1681
 
1405
1682
    def __iter__(self):
1406
1683
        return iter(self.all_file_ids())
1407
1684
 
1408
 
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
1409
 
        """See Tree.paths2ids"""
1410
 
        to_find = set(specific_files)
1411
 
        result = set()
1412
 
        for (file_id, paths, changed, versioned, parent, name, kind,
1413
 
             executable) in self._transform.iter_changes():
1414
 
            if paths[1] in to_find:
1415
 
                result.append(file_id)
1416
 
                to_find.remove(paths[1])
1417
 
        result.update(self._transform._tree.paths2ids(to_find,
1418
 
                      trees=[], require_versioned=require_versioned))
1419
 
        return result
 
1685
    def has_id(self, file_id):
 
1686
        if file_id in self._transform._r_new_id:
 
1687
            return True
 
1688
        elif file_id in set([self._transform.tree_file_id(trans_id) for
 
1689
            trans_id in self._transform._removed_id]):
 
1690
            return False
 
1691
        else:
 
1692
            return self._transform._tree.has_id(file_id)
 
1693
 
 
1694
    def _path2trans_id(self, path):
 
1695
        # We must not use None here, because that is a valid value to store.
 
1696
        trans_id = self._path2trans_id_cache.get(path, object)
 
1697
        if trans_id is not object:
 
1698
            return trans_id
 
1699
        segments = splitpath(path)
 
1700
        cur_parent = self._transform.root
 
1701
        for cur_segment in segments:
 
1702
            for child in self._all_children(cur_parent):
 
1703
                final_name = self._final_name_cache.get(child)
 
1704
                if final_name is None:
 
1705
                    final_name = self._transform.final_name(child)
 
1706
                    self._final_name_cache[child] = final_name
 
1707
                if final_name == cur_segment:
 
1708
                    cur_parent = child
 
1709
                    break
 
1710
            else:
 
1711
                self._path2trans_id_cache[path] = None
 
1712
                return None
 
1713
        self._path2trans_id_cache[path] = cur_parent
 
1714
        return cur_parent
1420
1715
 
1421
1716
    def path2id(self, path):
1422
 
        return self._transform._tree.path2id(path)
 
1717
        return self._transform.final_file_id(self._path2trans_id(path))
1423
1718
 
1424
1719
    def id2path(self, file_id):
1425
1720
        trans_id = self._transform.trans_id_file_id(file_id)
1428
1723
        except NoFinalPath:
1429
1724
            raise errors.NoSuchId(self, file_id)
1430
1725
 
 
1726
    def _all_children(self, trans_id):
 
1727
        children = self._all_children_cache.get(trans_id)
 
1728
        if children is not None:
 
1729
            return children
 
1730
        children = set(self._transform.iter_tree_children(trans_id))
 
1731
        # children in the _new_parent set are provided by _by_parent.
 
1732
        children.difference_update(self._transform._new_parent.keys())
 
1733
        children.update(self._by_parent.get(trans_id, []))
 
1734
        self._all_children_cache[trans_id] = children
 
1735
        return children
 
1736
 
 
1737
    def iter_children(self, file_id):
 
1738
        trans_id = self._transform.trans_id_file_id(file_id)
 
1739
        for child_trans_id in self._all_children(trans_id):
 
1740
            yield self._transform.final_file_id(child_trans_id)
 
1741
 
 
1742
    def extras(self):
 
1743
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
 
1744
                              in self._transform._tree.extras())
 
1745
        possible_extras.update(self._transform._new_contents)
 
1746
        possible_extras.update(self._transform._removed_id)
 
1747
        for trans_id in possible_extras:
 
1748
            if self._transform.final_file_id(trans_id) is None:
 
1749
                yield self._final_paths._determine_path(trans_id)
 
1750
 
 
1751
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None):
 
1752
        for trans_id, parent_file_id in ordered_entries:
 
1753
            file_id = self._transform.final_file_id(trans_id)
 
1754
            if file_id is None:
 
1755
                continue
 
1756
            if (specific_file_ids is not None
 
1757
                and file_id not in specific_file_ids):
 
1758
                continue
 
1759
            try:
 
1760
                kind = self._transform.final_kind(trans_id)
 
1761
            except NoSuchFile:
 
1762
                kind = self._transform._tree.stored_kind(file_id)
 
1763
            new_entry = inventory.make_entry(
 
1764
                kind,
 
1765
                self._transform.final_name(trans_id),
 
1766
                parent_file_id, file_id)
 
1767
            yield new_entry, trans_id
 
1768
 
 
1769
    def _list_files_by_dir(self):
 
1770
        todo = [ROOT_PARENT]
 
1771
        ordered_ids = []
 
1772
        while len(todo) > 0:
 
1773
            parent = todo.pop()
 
1774
            parent_file_id = self._transform.final_file_id(parent)
 
1775
            children = list(self._all_children(parent))
 
1776
            paths = dict(zip(children, self._final_paths.get_paths(children)))
 
1777
            children.sort(key=paths.get)
 
1778
            todo.extend(reversed(children))
 
1779
            for trans_id in children:
 
1780
                ordered_ids.append((trans_id, parent_file_id))
 
1781
        return ordered_ids
 
1782
 
1431
1783
    def iter_entries_by_dir(self, specific_file_ids=None):
1432
 
        return self._transform._tree.iter_entries_by_dir(specific_file_ids)
 
1784
        # This may not be a maximally efficient implementation, but it is
 
1785
        # reasonably straightforward.  An implementation that grafts the
 
1786
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
1787
        # might be more efficient, but requires tricky inferences about stack
 
1788
        # position.
 
1789
        ordered_ids = self._list_files_by_dir()
 
1790
        for entry, trans_id in self._make_inv_entries(ordered_ids,
 
1791
                                                      specific_file_ids):
 
1792
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1793
 
 
1794
    def _iter_entries_for_dir(self, dir_path):
 
1795
        """Return path, entry for items in a directory without recursing down."""
 
1796
        dir_file_id = self.path2id(dir_path)
 
1797
        ordered_ids = []
 
1798
        for file_id in self.iter_children(dir_file_id):
 
1799
            trans_id = self._transform.trans_id_file_id(file_id)
 
1800
            ordered_ids.append((trans_id, file_id))
 
1801
        for entry, trans_id in self._make_inv_entries(ordered_ids):
 
1802
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1803
 
 
1804
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1805
        """See WorkingTree.list_files."""
 
1806
        # XXX This should behave like WorkingTree.list_files, but is really
 
1807
        # more like RevisionTree.list_files.
 
1808
        if recursive:
 
1809
            prefix = None
 
1810
            if from_dir:
 
1811
                prefix = from_dir + '/'
 
1812
            entries = self.iter_entries_by_dir()
 
1813
            for path, entry in entries:
 
1814
                if entry.name == '' and not include_root:
 
1815
                    continue
 
1816
                if prefix:
 
1817
                    if not path.startswith(prefix):
 
1818
                        continue
 
1819
                    path = path[len(prefix):]
 
1820
                yield path, 'V', entry.kind, entry.file_id, entry
 
1821
        else:
 
1822
            if from_dir is None and include_root is True:
 
1823
                root_entry = inventory.make_entry('directory', '',
 
1824
                    ROOT_PARENT, self.get_root_id())
 
1825
                yield '', 'V', 'directory', root_entry.file_id, root_entry
 
1826
            entries = self._iter_entries_for_dir(from_dir or '')
 
1827
            for path, entry in entries:
 
1828
                yield path, 'V', entry.kind, entry.file_id, entry
1433
1829
 
1434
1830
    def kind(self, file_id):
1435
1831
        trans_id = self._transform.trans_id_file_id(file_id)
1436
1832
        return self._transform.final_kind(trans_id)
1437
1833
 
1438
1834
    def stored_kind(self, file_id):
1439
 
        return self._transform._tree.stored_kind(file_id)
 
1835
        trans_id = self._transform.trans_id_file_id(file_id)
 
1836
        try:
 
1837
            return self._transform._new_contents[trans_id]
 
1838
        except KeyError:
 
1839
            return self._transform._tree.stored_kind(file_id)
1440
1840
 
1441
1841
    def get_file_mtime(self, file_id, path=None):
1442
1842
        """See Tree.get_file_mtime"""
1444
1844
            return self._transform._tree.get_file_mtime(file_id, path)
1445
1845
        return self._stat_limbo_file(file_id).st_mtime
1446
1846
 
 
1847
    def _file_size(self, entry, stat_value):
 
1848
        return self.get_file_size(entry.file_id)
 
1849
 
1447
1850
    def get_file_size(self, file_id):
1448
1851
        """See Tree.get_file_size"""
1449
1852
        if self.kind(file_id) == 'file':
1452
1855
            return None
1453
1856
 
1454
1857
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1455
 
        return self._transform._tree.get_file_sha1(file_id)
 
1858
        trans_id = self._transform.trans_id_file_id(file_id)
 
1859
        kind = self._transform._new_contents.get(trans_id)
 
1860
        if kind is None:
 
1861
            return self._transform._tree.get_file_sha1(file_id)
 
1862
        if kind == 'file':
 
1863
            fileobj = self.get_file(file_id)
 
1864
            try:
 
1865
                return sha_file(fileobj)
 
1866
            finally:
 
1867
                fileobj.close()
1456
1868
 
1457
1869
    def is_executable(self, file_id, path=None):
1458
 
        return self._transform._tree.is_executable(file_id, path)
 
1870
        if file_id is None:
 
1871
            return False
 
1872
        trans_id = self._transform.trans_id_file_id(file_id)
 
1873
        try:
 
1874
            return self._transform._new_executability[trans_id]
 
1875
        except KeyError:
 
1876
            try:
 
1877
                return self._transform._tree.is_executable(file_id, path)
 
1878
            except OSError, e:
 
1879
                if e.errno == errno.ENOENT:
 
1880
                    return False
 
1881
                raise
 
1882
            except errors.NoSuchId:
 
1883
                return False
1459
1884
 
1460
1885
    def path_content_summary(self, path):
1461
 
        return self._transform._tree.path_content_summary(path)
 
1886
        trans_id = self._path2trans_id(path)
 
1887
        tt = self._transform
 
1888
        tree_path = tt._tree_id_paths.get(trans_id)
 
1889
        kind = tt._new_contents.get(trans_id)
 
1890
        if kind is None:
 
1891
            if tree_path is None or trans_id in tt._removed_contents:
 
1892
                return 'missing', None, None, None
 
1893
            summary = tt._tree.path_content_summary(tree_path)
 
1894
            kind, size, executable, link_or_sha1 = summary
 
1895
        else:
 
1896
            link_or_sha1 = None
 
1897
            limbo_name = tt._limbo_name(trans_id)
 
1898
            if trans_id in tt._new_reference_revision:
 
1899
                kind = 'tree-reference'
 
1900
            if kind == 'file':
 
1901
                statval = os.lstat(limbo_name)
 
1902
                size = statval.st_size
 
1903
                if not supports_executable():
 
1904
                    executable = None
 
1905
                else:
 
1906
                    executable = statval.st_mode & S_IEXEC
 
1907
            else:
 
1908
                size = None
 
1909
                executable = None
 
1910
            if kind == 'symlink':
 
1911
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
1912
        if supports_executable():
 
1913
            executable = tt._new_executability.get(trans_id, executable)
 
1914
        return kind, size, executable, link_or_sha1
1462
1915
 
1463
1916
    def iter_changes(self, from_tree, include_unchanged=False,
1464
1917
                      specific_files=None, pb=None, extra_trees=None,
1465
1918
                      require_versioned=True, want_unversioned=False):
1466
1919
        """See InterTree.iter_changes.
1467
1920
 
1468
 
        This implementation does not support include_unchanged, specific_files,
1469
 
        or want_unversioned.  extra_trees, require_versioned, and pb are
1470
 
        ignored.
 
1921
        This has a fast path that is only used when the from_tree matches
 
1922
        the transform tree, and no fancy options are supplied.
1471
1923
        """
1472
 
        if from_tree is not self._transform._tree:
1473
 
            raise ValueError('from_tree must be transform source tree.')
1474
 
        if include_unchanged:
1475
 
            raise ValueError('include_unchanged is not supported')
1476
 
        if specific_files is not None:
1477
 
            raise ValueError('specific_files is not supported')
 
1924
        if (from_tree is not self._transform._tree or include_unchanged or
 
1925
            specific_files or want_unversioned):
 
1926
            return tree.InterTree(from_tree, self).iter_changes(
 
1927
                include_unchanged=include_unchanged,
 
1928
                specific_files=specific_files,
 
1929
                pb=pb,
 
1930
                extra_trees=extra_trees,
 
1931
                require_versioned=require_versioned,
 
1932
                want_unversioned=want_unversioned)
1478
1933
        if want_unversioned:
1479
1934
            raise ValueError('want_unversioned is not supported')
1480
1935
        return self._transform.iter_changes()
1487
1942
        name = self._transform._limbo_name(trans_id)
1488
1943
        return open(name, 'rb')
1489
1944
 
1490
 
    def get_file_text(self, file_id):
1491
 
        text_file = self.get_file(file_id)
1492
 
        try:
1493
 
            return text_file.read()
1494
 
        finally:
1495
 
            text_file.close()
 
1945
    def get_file_with_stat(self, file_id, path=None):
 
1946
        return self.get_file(file_id, path), None
1496
1947
 
1497
1948
    def annotate_iter(self, file_id,
1498
1949
                      default_revision=_mod_revision.CURRENT_REVISION):
1499
 
        return self._transform._tree.annotate_iter(file_id,
1500
 
            default_revision=default_revision)
 
1950
        changes = self._changes(file_id)
 
1951
        if changes is None:
 
1952
            get_old = True
 
1953
        else:
 
1954
            changed_content, versioned, kind = (changes[2], changes[3],
 
1955
                                                changes[6])
 
1956
            if kind[1] is None:
 
1957
                return None
 
1958
            get_old = (kind[0] == 'file' and versioned[0])
 
1959
        if get_old:
 
1960
            old_annotation = self._transform._tree.annotate_iter(file_id,
 
1961
                default_revision=default_revision)
 
1962
        else:
 
1963
            old_annotation = []
 
1964
        if changes is None:
 
1965
            return old_annotation
 
1966
        if not changed_content:
 
1967
            return old_annotation
 
1968
        return annotate.reannotate([old_annotation],
 
1969
                                   self.get_file(file_id).readlines(),
 
1970
                                   default_revision)
1501
1971
 
1502
1972
    def get_symlink_target(self, file_id):
1503
1973
        """See Tree.get_symlink_target"""
1505
1975
            return self._transform._tree.get_symlink_target(file_id)
1506
1976
        trans_id = self._transform.trans_id_file_id(file_id)
1507
1977
        name = self._transform._limbo_name(trans_id)
1508
 
        return os.readlink(name)
1509
 
 
1510
 
    def list_files(self, include_root=False):
1511
 
        return self._transform._tree.list_files(include_root)
1512
 
 
1513
 
    def walkdirs(self, prefix=""):
1514
 
        return self._transform._tree.walkdirs(prefix)
 
1978
        return osutils.readlink(name)
 
1979
 
 
1980
    def walkdirs(self, prefix=''):
 
1981
        pending = [self._transform.root]
 
1982
        while len(pending) > 0:
 
1983
            parent_id = pending.pop()
 
1984
            children = []
 
1985
            subdirs = []
 
1986
            prefix = prefix.rstrip('/')
 
1987
            parent_path = self._final_paths.get_path(parent_id)
 
1988
            parent_file_id = self._transform.final_file_id(parent_id)
 
1989
            for child_id in self._all_children(parent_id):
 
1990
                path_from_root = self._final_paths.get_path(child_id)
 
1991
                basename = self._transform.final_name(child_id)
 
1992
                file_id = self._transform.final_file_id(child_id)
 
1993
                try:
 
1994
                    kind = self._transform.final_kind(child_id)
 
1995
                    versioned_kind = kind
 
1996
                except NoSuchFile:
 
1997
                    kind = 'unknown'
 
1998
                    versioned_kind = self._transform._tree.stored_kind(file_id)
 
1999
                if versioned_kind == 'directory':
 
2000
                    subdirs.append(child_id)
 
2001
                children.append((path_from_root, basename, kind, None,
 
2002
                                 file_id, versioned_kind))
 
2003
            children.sort()
 
2004
            if parent_path.startswith(prefix):
 
2005
                yield (parent_path, parent_file_id), children
 
2006
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
 
2007
                                  reverse=True))
1515
2008
 
1516
2009
    def get_parent_ids(self):
1517
 
        return self._transform._tree.get_parent_ids()
 
2010
        return self._parent_ids
 
2011
 
 
2012
    def set_parent_ids(self, parent_ids):
 
2013
        self._parent_ids = parent_ids
1518
2014
 
1519
2015
    def get_revision_tree(self, revision_id):
1520
2016
        return self._transform._tree.get_revision_tree(revision_id)
1555
2051
            self._known_paths[trans_id] = self._determine_path(trans_id)
1556
2052
        return self._known_paths[trans_id]
1557
2053
 
 
2054
    def get_paths(self, trans_ids):
 
2055
        return [(self.get_path(t), t) for t in trans_ids]
 
2056
 
 
2057
 
1558
2058
 
1559
2059
def topology_sorted_ids(tree):
1560
2060
    """Determine the topological order of the ids in a tree"""
1563
2063
    return file_ids
1564
2064
 
1565
2065
 
1566
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
 
2066
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
 
2067
               delta_from_tree=False):
1567
2068
    """Create working tree for a branch, using a TreeTransform.
1568
 
    
 
2069
 
1569
2070
    This function should be used on empty trees, having a tree root at most.
1570
2071
    (see merge and revert functionality for working with existing trees)
1571
2072
 
1572
2073
    Existing files are handled like so:
1573
 
    
 
2074
 
1574
2075
    - Existing bzrdirs take precedence over creating new items.  They are
1575
2076
      created as '%s.diverted' % name.
1576
2077
    - Otherwise, if the content on disk matches the content we are building,
1585
2086
    :param hardlink: If true, hard-link files to accelerator_tree, where
1586
2087
        possible.  accelerator_tree must implement abspath, i.e. be a
1587
2088
        working tree.
 
2089
    :param delta_from_tree: If true, build_tree may use the input Tree to
 
2090
        generate the inventory delta.
1588
2091
    """
1589
2092
    wt.lock_tree_write()
1590
2093
    try:
1593
2096
            if accelerator_tree is not None:
1594
2097
                accelerator_tree.lock_read()
1595
2098
            try:
1596
 
                return _build_tree(tree, wt, accelerator_tree, hardlink)
 
2099
                return _build_tree(tree, wt, accelerator_tree, hardlink,
 
2100
                                   delta_from_tree)
1597
2101
            finally:
1598
2102
                if accelerator_tree is not None:
1599
2103
                    accelerator_tree.unlock()
1603
2107
        wt.unlock()
1604
2108
 
1605
2109
 
1606
 
def _build_tree(tree, wt, accelerator_tree, hardlink):
 
2110
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
1607
2111
    """See build_tree."""
1608
2112
    for num, _unused in enumerate(wt.all_file_ids()):
1609
2113
        if num > 0:  # more than just a root
1610
2114
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2115
    existing_files = set()
 
2116
    for dir, files in wt.walkdirs():
 
2117
        existing_files.update(f[0] for f in files)
1611
2118
    file_trans_id = {}
1612
2119
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1613
2120
    pp = ProgressPhase("Build phase", 2, top_pb)
1632
2139
        try:
1633
2140
            deferred_contents = []
1634
2141
            num = 0
 
2142
            total = len(tree.inventory)
 
2143
            if delta_from_tree:
 
2144
                precomputed_delta = []
 
2145
            else:
 
2146
                precomputed_delta = None
1635
2147
            for num, (tree_path, entry) in \
1636
2148
                enumerate(tree.inventory.iter_entries_by_dir()):
1637
 
                pb.update("Building tree", num - len(deferred_contents),
1638
 
                          len(tree.inventory))
 
2149
                pb.update("Building tree", num - len(deferred_contents), total)
1639
2150
                if entry.parent_id is None:
1640
2151
                    continue
1641
2152
                reparent = False
1642
2153
                file_id = entry.file_id
1643
 
                target_path = wt.abspath(tree_path)
1644
 
                try:
 
2154
                if delta_from_tree:
 
2155
                    precomputed_delta.append((None, tree_path, file_id, entry))
 
2156
                if tree_path in existing_files:
 
2157
                    target_path = wt.abspath(tree_path)
1645
2158
                    kind = file_kind(target_path)
1646
 
                except NoSuchFile:
1647
 
                    pass
1648
 
                else:
1649
2159
                    if kind == "directory":
1650
2160
                        try:
1651
2161
                            bzrdir.BzrDir.open(target_path)
1659
2169
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
1660
2170
                        if kind == 'directory':
1661
2171
                            reparent = True
1662
 
                if entry.parent_id not in file_trans_id:
1663
 
                    raise AssertionError(
1664
 
                        'entry %s parent id %r is not in file_trans_id %r'
1665
 
                        % (entry, entry.parent_id, file_trans_id))
1666
2172
                parent_id = file_trans_id[entry.parent_id]
1667
2173
                if entry.kind == 'file':
1668
2174
                    # We *almost* replicate new_by_entry, so that we can defer
1669
2175
                    # getting the file text, and get them all at once.
1670
2176
                    trans_id = tt.create_path(entry.name, parent_id)
1671
2177
                    file_trans_id[file_id] = trans_id
1672
 
                    tt.version_file(entry.file_id, trans_id)
1673
 
                    executable = tree.is_executable(entry.file_id, tree_path)
1674
 
                    if executable is not None:
 
2178
                    tt.version_file(file_id, trans_id)
 
2179
                    executable = tree.is_executable(file_id, tree_path)
 
2180
                    if executable:
1675
2181
                        tt.set_executability(executable, trans_id)
1676
 
                    deferred_contents.append((entry.file_id, trans_id))
 
2182
                    trans_data = (trans_id, tree_path)
 
2183
                    deferred_contents.append((file_id, trans_data))
1677
2184
                else:
1678
2185
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1679
2186
                                                          tree)
1690
2197
        divert_trans = set(file_trans_id[f] for f in divert)
1691
2198
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1692
2199
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
2200
        if len(raw_conflicts) > 0:
 
2201
            precomputed_delta = None
1693
2202
        conflicts = cook_conflicts(raw_conflicts, tt)
1694
2203
        for conflict in conflicts:
1695
2204
            warning(conflict)
1697
2206
            wt.add_conflicts(conflicts)
1698
2207
        except errors.UnsupportedOperation:
1699
2208
            pass
1700
 
        result = tt.apply(no_conflicts=True)
 
2209
        result = tt.apply(no_conflicts=True,
 
2210
                          precomputed_delta=precomputed_delta)
1701
2211
    finally:
1702
2212
        tt.finalize()
1703
2213
        top_pb.finished()
1707
2217
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1708
2218
                  hardlink):
1709
2219
    total = len(desired_files) + offset
 
2220
    wt = tt._tree
1710
2221
    if accelerator_tree is None:
1711
2222
        new_desired_files = desired_files
1712
2223
    else:
1715
2226
                         in iter if not (c or e[0] != e[1]))
1716
2227
        new_desired_files = []
1717
2228
        count = 0
1718
 
        for file_id, trans_id in desired_files:
 
2229
        for file_id, (trans_id, tree_path) in desired_files:
1719
2230
            accelerator_path = unchanged.get(file_id)
1720
2231
            if accelerator_path is None:
1721
 
                new_desired_files.append((file_id, trans_id))
 
2232
                new_desired_files.append((file_id, (trans_id, tree_path)))
1722
2233
                continue
1723
2234
            pb.update('Adding file contents', count + offset, total)
1724
2235
            if hardlink:
1726
2237
                                   trans_id)
1727
2238
            else:
1728
2239
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
2240
                if wt.supports_content_filtering():
 
2241
                    filters = wt._content_filter_stack(tree_path)
 
2242
                    contents = filtered_output_bytes(contents, filters,
 
2243
                        ContentFilterContext(tree_path, tree))
1729
2244
                try:
1730
2245
                    tt.create_file(contents, trans_id)
1731
2246
                finally:
1732
 
                    contents.close()
 
2247
                    try:
 
2248
                        contents.close()
 
2249
                    except AttributeError:
 
2250
                        # after filtering, contents may no longer be file-like
 
2251
                        pass
1733
2252
            count += 1
1734
2253
        offset += count
1735
 
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1736
 
                                                 new_desired_files)):
 
2254
    for count, ((trans_id, tree_path), contents) in enumerate(
 
2255
            tree.iter_files_bytes(new_desired_files)):
 
2256
        if wt.supports_content_filtering():
 
2257
            filters = wt._content_filter_stack(tree_path)
 
2258
            contents = filtered_output_bytes(contents, filters,
 
2259
                ContentFilterContext(tree_path, tree))
1737
2260
        tt.create_file(contents, trans_id)
1738
2261
        pb.update('Adding file contents', count + offset, total)
1739
2262
 
1799
2322
    if kind == 'file':
1800
2323
        contents = tree.get_file(entry.file_id).readlines()
1801
2324
        executable = tree.is_executable(entry.file_id)
1802
 
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
2325
        return tt.new_file(name, parent_id, contents, entry.file_id,
1803
2326
                           executable)
1804
2327
    elif kind in ('directory', 'tree-reference'):
1805
2328
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
1806
2329
        if kind == 'tree-reference':
1807
2330
            tt.set_tree_reference(entry.reference_revision, trans_id)
1808
 
        return trans_id 
 
2331
        return trans_id
1809
2332
    elif kind == 'symlink':
1810
2333
        target = tree.get_symlink_target(entry.file_id)
1811
2334
        return tt.new_symlink(name, parent_id, target, entry.file_id)
1813
2336
        raise errors.BadFileKindError(name, kind)
1814
2337
 
1815
2338
 
 
2339
@deprecated_function(deprecated_in((1, 9, 0)))
1816
2340
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1817
 
    """Create new file contents according to an inventory entry."""
 
2341
    """Create new file contents according to an inventory entry.
 
2342
 
 
2343
    DEPRECATED.  Use create_from_tree instead.
 
2344
    """
1818
2345
    if entry.kind == "file":
1819
2346
        if lines is None:
1820
2347
            lines = tree.get_file(entry.file_id).readlines()
1825
2352
        tt.create_directory(trans_id)
1826
2353
 
1827
2354
 
 
2355
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
 
2356
    """Create new file contents according to tree contents."""
 
2357
    kind = tree.kind(file_id)
 
2358
    if kind == 'directory':
 
2359
        tt.create_directory(trans_id)
 
2360
    elif kind == "file":
 
2361
        if bytes is None:
 
2362
            tree_file = tree.get_file(file_id)
 
2363
            try:
 
2364
                bytes = tree_file.readlines()
 
2365
            finally:
 
2366
                tree_file.close()
 
2367
        tt.create_file(bytes, trans_id)
 
2368
    elif kind == "symlink":
 
2369
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
 
2370
    else:
 
2371
        raise AssertionError('Unknown kind %r' % kind)
 
2372
 
 
2373
 
1828
2374
def create_entry_executability(tt, entry, trans_id):
1829
2375
    """Set the executability of a trans_id according to an inventory entry"""
1830
2376
    if entry.kind == "file":
1867
2413
        if entry.kind != working_kind:
1868
2414
            contents_mod, meta_mod = True, False
1869
2415
        else:
1870
 
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2416
            cur_entry._read_tree_state(working_tree.id2path(file_id),
1871
2417
                                       working_tree)
1872
2418
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
1873
2419
            cur_entry._forget_tree_state()
1881
2427
    tt = TreeTransform(working_tree, pb)
1882
2428
    try:
1883
2429
        pp = ProgressPhase("Revert phase", 3, pb)
1884
 
        pp.next_phase()
1885
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1886
 
        try:
1887
 
            merge_modified = _alter_files(working_tree, target_tree, tt,
1888
 
                                          child_pb, filenames, backups)
1889
 
        finally:
1890
 
            child_pb.finished()
1891
 
        pp.next_phase()
1892
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1893
 
        try:
1894
 
            raw_conflicts = resolve_conflicts(tt, child_pb,
1895
 
                lambda t, c: conflict_pass(t, c, target_tree))
1896
 
        finally:
1897
 
            child_pb.finished()
1898
 
        conflicts = cook_conflicts(raw_conflicts, tt)
 
2430
        conflicts, merge_modified = _prepare_revert_transform(
 
2431
            working_tree, target_tree, tt, filenames, backups, pp)
1899
2432
        if change_reporter:
1900
2433
            change_reporter = delta._ChangeReporter(
1901
2434
                unversioned_filter=working_tree.is_ignored)
1912
2445
    return conflicts
1913
2446
 
1914
2447
 
 
2448
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
 
2449
                              backups, pp, basis_tree=None,
 
2450
                              merge_modified=None):
 
2451
    pp.next_phase()
 
2452
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2453
    try:
 
2454
        if merge_modified is None:
 
2455
            merge_modified = working_tree.merge_modified()
 
2456
        merge_modified = _alter_files(working_tree, target_tree, tt,
 
2457
                                      child_pb, filenames, backups,
 
2458
                                      merge_modified, basis_tree)
 
2459
    finally:
 
2460
        child_pb.finished()
 
2461
    pp.next_phase()
 
2462
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2463
    try:
 
2464
        raw_conflicts = resolve_conflicts(tt, child_pb,
 
2465
            lambda t, c: conflict_pass(t, c, target_tree))
 
2466
    finally:
 
2467
        child_pb.finished()
 
2468
    conflicts = cook_conflicts(raw_conflicts, tt)
 
2469
    return conflicts, merge_modified
 
2470
 
 
2471
 
1915
2472
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1916
 
                 backups):
1917
 
    merge_modified = working_tree.merge_modified()
 
2473
                 backups, merge_modified, basis_tree=None):
 
2474
    if basis_tree is not None:
 
2475
        basis_tree.lock_read()
1918
2476
    change_list = target_tree.iter_changes(working_tree,
1919
2477
        specific_files=specific_files, pb=pb)
1920
 
    if target_tree.inventory.root is None:
 
2478
    if target_tree.get_root_id() is None:
1921
2479
        skip_root = True
1922
2480
    else:
1923
2481
        skip_root = False
1924
 
    basis_tree = None
1925
2482
    try:
1926
2483
        deferred_files = []
1927
2484
        for id_num, (file_id, path, changed_content, versioned, parent, name,
1963
2520
                        # contents
1964
2521
                        mode_id = trans_id
1965
2522
                        trans_id = new_trans_id
1966
 
                if kind[1] == 'directory':
 
2523
                if kind[1] in ('directory', 'tree-reference'):
1967
2524
                    tt.create_directory(trans_id)
 
2525
                    if kind[1] == 'tree-reference':
 
2526
                        revision = target_tree.get_reference_revision(file_id,
 
2527
                                                                      path[1])
 
2528
                        tt.set_tree_reference(revision, trans_id)
1968
2529
                elif kind[1] == 'symlink':
1969
2530
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
1970
2531
                                      trans_id)
1990
2551
                tt.version_file(file_id, trans_id)
1991
2552
            if versioned == (True, False):
1992
2553
                tt.unversion_file(trans_id)
1993
 
            if (name[1] is not None and 
 
2554
            if (name[1] is not None and
1994
2555
                (name[0] != name[1] or parent[0] != parent[1])):
1995
 
                tt.adjust_path(
1996
 
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
2556
                if name[1] == '' and parent[1] is None:
 
2557
                    parent_trans = ROOT_PARENT
 
2558
                else:
 
2559
                    parent_trans = tt.trans_id_file_id(parent[1])
 
2560
                tt.adjust_path(name[1], parent_trans, trans_id)
1997
2561
            if executable[0] != executable[1] and kind[1] == "file":
1998
2562
                tt.set_executability(executable[1], trans_id)
1999
2563
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2044
2608
                existing_file, new_file = conflict[1], conflict[2]
2045
2609
            new_name = tt.final_name(existing_file)+'.moved'
2046
2610
            tt.adjust_path(new_name, final_parent, existing_file)
2047
 
            new_conflicts.add((c_type, 'Moved existing file to', 
 
2611
            new_conflicts.add((c_type, 'Moved existing file to',
2048
2612
                               existing_file, new_file))
2049
2613
        elif c_type == 'parent loop':
2050
2614
            # break the loop by undoing one of the ops that caused the loop
2054
2618
            new_conflicts.add((c_type, 'Cancelled move', cur,
2055
2619
                               tt.final_parent(cur),))
2056
2620
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2057
 
            
 
2621
 
2058
2622
        elif c_type == 'missing parent':
2059
2623
            trans_id = conflict[1]
2060
2624
            try:
2061
2625
                tt.cancel_deletion(trans_id)
2062
 
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2626
                new_conflicts.add(('deleting parent', 'Not deleting',
2063
2627
                                   trans_id))
2064
2628
            except KeyError:
2065
2629
                create = True
2107
2671
            if parent_file_id is not None:
2108
2672
                tt.unversion_file(parent_id)
2109
2673
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
 
2674
        elif c_type == 'versioning no contents':
 
2675
            tt.cancel_versioning(conflict[1])
2110
2676
    return new_conflicts
2111
2677
 
2112
2678
 
2128
2694
        if len(conflict) == 3:
2129
2695
            yield Conflict.factory(c_type, action=action, path=modified_path,
2130
2696
                                     file_id=modified_id)
2131
 
             
 
2697
 
2132
2698
        else:
2133
2699
            conflicting_path = fp.get_path(conflict[3])
2134
2700
            conflicting_id = tt.final_file_id(conflict[3])
2135
2701
            yield Conflict.factory(c_type, action=action, path=modified_path,
2136
 
                                   file_id=modified_id, 
 
2702
                                   file_id=modified_id,
2137
2703
                                   conflict_path=conflicting_path,
2138
2704
                                   conflict_file_id=conflicting_id)
2139
2705