← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Aaron Bentley
  • Date: 2007-03-09 21:46:40 UTC
  • mto: (2323.6.9 0.15-integration)
  • mto: This revision was merged to the branch mainline in revision 2330.
  • Revision ID: abentley@panoramicfeedback.com-20070309214640-nnxk7g37bygoz50c
Add (set|get)_public_branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import errno
19
 
from stat import S_ISREG, S_IEXEC
 
19
from stat import S_ISREG
20
20
 
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
23
23
from bzrlib import (
24
 
    annotate,
25
 
    bencode,
26
24
    bzrdir,
27
25
    delta,
28
26
    errors,
29
 
    inventory,
30
 
    multiparent,
31
 
    osutils,
32
 
    revision as _mod_revision,
 
27
    inventory
33
28
    )
34
29
""")
35
30
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
36
31
                           ReusingTransform, NotVersionedError, CantMoveRoot,
37
 
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
38
 
                           UnableCreateSymlink)
39
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
 
32
                           ExistingLimbo, ImmortalLimbo, NoFinalPath)
40
33
from bzrlib.inventory import InventoryEntry
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
 
)
 
34
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
 
35
                            delete_any)
51
36
from bzrlib.progress import DummyProgress, ProgressPhase
52
 
from bzrlib.symbol_versioning import (
53
 
        deprecated_function,
54
 
        deprecated_in,
55
 
        )
 
37
from bzrlib.symbol_versioning import deprecated_function, zero_fifteen
56
38
from bzrlib.trace import mutter, warning
57
39
from bzrlib import tree
58
40
import bzrlib.ui
69
51
 
70
52
 
71
53
class _TransformResults(object):
72
 
    def __init__(self, modified_paths, rename_count):
 
54
    def __init__(self, modified_paths):
73
55
        object.__init__(self)
74
56
        self.modified_paths = modified_paths
75
 
        self.rename_count = rename_count
76
 
 
77
 
 
78
 
class TreeTransformBase(object):
79
 
    """The base class for TreeTransform and its kin."""
80
 
 
81
 
    def __init__(self, tree, pb=DummyProgress(),
82
 
                 case_sensitive=True):
83
 
        """Constructor.
84
 
 
85
 
        :param tree: The tree that will be transformed, but not necessarily
86
 
            the output tree.
87
 
        :param pb: A ProgressTask indicating how much progress is being made
88
 
        :param case_sensitive: If True, the target of the transform is
89
 
            case sensitive, not just case preserving.
 
57
 
 
58
 
 
59
class TreeTransform(object):
 
60
    """Represent a tree transformation.
 
61
    
 
62
    This object is designed to support incremental generation of the transform,
 
63
    in any order.  
 
64
    
 
65
    It is easy to produce malformed transforms, but they are generally
 
66
    harmless.  Attempting to apply a malformed transform will cause an
 
67
    exception to be raised before any modifications are made to the tree.  
 
68
 
 
69
    Many kinds of malformed transforms can be corrected with the 
 
70
    resolve_conflicts function.  The remaining ones indicate programming error,
 
71
    such as trying to create a file with no path.
 
72
 
 
73
    Two sets of file creation methods are supplied.  Convenience methods are:
 
74
     * new_file
 
75
     * new_directory
 
76
     * new_symlink
 
77
 
 
78
    These are composed of the low-level methods:
 
79
     * create_path
 
80
     * create_file or create_directory or create_symlink
 
81
     * version_file
 
82
     * set_executability
 
83
    """
 
84
    def __init__(self, tree, pb=DummyProgress()):
 
85
        """Note: a tree_write lock is taken on the tree.
 
86
        
 
87
        Use TreeTransform.finalize() to release the lock
90
88
        """
91
89
        object.__init__(self)
92
90
        self._tree = tree
 
91
        self._tree.lock_tree_write()
 
92
        try:
 
93
            control_files = self._tree._control_files
 
94
            self._limbodir = urlutils.local_path_from_url(
 
95
                control_files.controlfilename('limbo'))
 
96
            try:
 
97
                os.mkdir(self._limbodir)
 
98
            except OSError, e:
 
99
                if e.errno == errno.EEXIST:
 
100
                    raise ExistingLimbo(self._limbodir)
 
101
        except: 
 
102
            self._tree.unlock()
 
103
            raise
 
104
 
93
105
        self._id_number = 0
94
 
        # mapping of trans_id -> new basename
95
106
        self._new_name = {}
96
 
        # mapping of trans_id -> new parent trans_id
97
107
        self._new_parent = {}
98
 
        # mapping of trans_id with new contents -> new file_kind
99
108
        self._new_contents = {}
100
 
        # Set of trans_ids whose contents will be removed
101
109
        self._removed_contents = set()
102
 
        # Mapping of trans_id -> new execute-bit value
103
110
        self._new_executability = {}
104
 
        # Mapping of trans_id -> new tree-reference value
105
111
        self._new_reference_revision = {}
106
 
        # Mapping of trans_id -> new file_id
107
112
        self._new_id = {}
108
 
        # Mapping of old file-id -> trans_id
109
113
        self._non_present_ids = {}
110
 
        # Mapping of new file_id -> trans_id
111
114
        self._r_new_id = {}
112
 
        # Set of trans_ids that will be removed
113
115
        self._removed_id = set()
114
 
        # Mapping of path in old tree -> trans_id
115
116
        self._tree_path_ids = {}
116
 
        # Mapping trans_id -> path in old tree
117
117
        self._tree_id_paths = {}
118
 
        # The trans_id that will be used as the tree root
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
 
        # Indictor of whether the transform has been applied
125
 
        self._done = False
126
 
        # A progress bar
 
118
        self._realpaths = {}
 
119
        # Cache of realpath results, to speed up canonical_path
 
120
        self._relpaths = {}
 
121
        # Cache of relpath results, to speed up canonical_path
 
122
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
123
        self.__done = False
127
124
        self._pb = pb
128
 
        # Whether the target is case sensitive
129
 
        self._case_sensitive_target = case_sensitive
130
 
        # A counter of how many files have been renamed
131
 
        self.rename_count = 0
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
125
 
144
126
    def __get_root(self):
145
127
        return self._new_root
146
128
 
147
129
    root = property(__get_root)
148
130
 
 
131
    def finalize(self):
 
132
        """Release the working tree lock, if held, clean up limbo dir."""
 
133
        if self._tree is None:
 
134
            return
 
135
        try:
 
136
            for trans_id, kind in self._new_contents.iteritems():
 
137
                path = self._limbo_name(trans_id)
 
138
                if kind == "directory":
 
139
                    os.rmdir(path)
 
140
                else:
 
141
                    os.unlink(path)
 
142
            try:
 
143
                os.rmdir(self._limbodir)
 
144
            except OSError:
 
145
                # We don't especially care *why* the dir is immortal.
 
146
                raise ImmortalLimbo(self._limbodir)
 
147
        finally:
 
148
            self._tree.unlock()
 
149
            self._tree = None
 
150
 
149
151
    def _assign_id(self):
150
152
        """Produce a new tranform id"""
151
153
        new_id = "new-%s" % self._id_number
165
167
            raise CantMoveRoot
166
168
        self._new_name[trans_id] = name
167
169
        self._new_parent[trans_id] = parent
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
172
170
 
173
171
    def adjust_root_path(self, name, parent):
174
172
        """Emulate moving the root by moving all children, instead.
175
 
 
 
173
        
176
174
        We do this by undoing the association of root's transaction id with the
177
175
        current tree.  This allows us to create a new directory with that
178
 
        transaction id.  We unversion the root directory and version the
 
176
        transaction id.  We unversion the root directory and version the 
179
177
        physically new directory, and hope someone versions the tree root
180
178
        later.
181
179
        """
184
182
        # force moving all children of root
185
183
        for child_id in self.iter_tree_children(old_root):
186
184
            if child_id != parent:
187
 
                self.adjust_path(self.final_name(child_id),
 
185
                self.adjust_path(self.final_name(child_id), 
188
186
                                 self.final_parent(child_id), child_id)
189
187
            file_id = self.final_file_id(child_id)
190
188
            if file_id is not None:
191
189
                self.unversion_file(child_id)
192
190
            self.version_file(file_id, child_id)
193
 
 
 
191
        
194
192
        # the physical root needs a new transaction id
195
193
        self._tree_path_ids.pop("")
196
194
        self._tree_id_paths.pop(old_root)
204
202
 
205
203
    def trans_id_tree_file_id(self, inventory_id):
206
204
        """Determine the transaction id of a working tree file.
207
 
 
 
205
        
208
206
        This reflects only files that already exist, not ones that will be
209
207
        added by transactions.
210
208
        """
211
 
        if inventory_id is None:
212
 
            raise ValueError('None is not a valid file id')
213
 
        path = self._tree.id2path(inventory_id)
 
209
        path = self._tree.inventory.id2path(inventory_id)
214
210
        return self.trans_id_tree_path(path)
215
211
 
216
212
    def trans_id_file_id(self, file_id):
219
215
        a transaction has been unversioned, it is deliberately still returned.
220
216
        (this will likely lead to an unversioned parent conflict.)
221
217
        """
222
 
        if file_id is None:
223
 
            raise ValueError('None is not a valid file id')
224
218
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
225
219
            return self._r_new_id[file_id]
226
 
        else:
227
 
            try:
228
 
                self._tree.iter_entries_by_dir([file_id]).next()
229
 
            except StopIteration:
230
 
                if file_id in self._non_present_ids:
231
 
                    return self._non_present_ids[file_id]
232
 
                else:
233
 
                    trans_id = self._assign_id()
234
 
                    self._non_present_ids[file_id] = trans_id
235
 
                    return trans_id
236
 
            else:
237
 
                return self.trans_id_tree_file_id(file_id)
 
220
        elif file_id in self._tree.inventory:
 
221
            return self.trans_id_tree_file_id(file_id)
 
222
        elif file_id in self._non_present_ids:
 
223
            return self._non_present_ids[file_id]
 
224
        else:
 
225
            trans_id = self._assign_id()
 
226
            self._non_present_ids[file_id] = trans_id
 
227
            return trans_id
 
228
 
 
229
    def canonical_path(self, path):
 
230
        """Get the canonical tree-relative path"""
 
231
        # don't follow final symlinks
 
232
        abs = self._tree.abspath(path)
 
233
        if abs in self._relpaths:
 
234
            return self._relpaths[abs]
 
235
        dirname, basename = os.path.split(abs)
 
236
        if dirname not in self._realpaths:
 
237
            self._realpaths[dirname] = os.path.realpath(dirname)
 
238
        dirname = self._realpaths[dirname]
 
239
        abs = pathjoin(dirname, basename)
 
240
        if dirname in self._relpaths:
 
241
            relpath = pathjoin(self._relpaths[dirname], basename)
 
242
            relpath = relpath.rstrip('/\\')
 
243
        else:
 
244
            relpath = self._tree.relpath(abs)
 
245
        self._relpaths[abs] = relpath
 
246
        return relpath
238
247
 
239
248
    def trans_id_tree_path(self, path):
240
249
        """Determine (and maybe set) the transaction ID for a tree path."""
251
260
            return ROOT_PARENT
252
261
        return self.trans_id_tree_path(os.path.dirname(path))
253
262
 
 
263
    def create_file(self, contents, trans_id, mode_id=None):
 
264
        """Schedule creation of a new file.
 
265
 
 
266
        See also new_file.
 
267
        
 
268
        Contents is an iterator of strings, all of which will be written
 
269
        to the target destination.
 
270
 
 
271
        New file takes the permissions of any existing file with that id,
 
272
        unless mode_id is specified.
 
273
        """
 
274
        name = self._limbo_name(trans_id)
 
275
        f = open(name, 'wb')
 
276
        try:
 
277
            try:
 
278
                unique_add(self._new_contents, trans_id, 'file')
 
279
            except:
 
280
                # Clean up the file, it never got registered so
 
281
                # TreeTransform.finalize() won't clean it up.
 
282
                f.close()
 
283
                os.unlink(name)
 
284
                raise
 
285
 
 
286
            f.writelines(contents)
 
287
        finally:
 
288
            f.close()
 
289
        self._set_mode(trans_id, mode_id, S_ISREG)
 
290
 
 
291
    def _set_mode(self, trans_id, mode_id, typefunc):
 
292
        """Set the mode of new file contents.
 
293
        The mode_id is the existing file to get the mode from (often the same
 
294
        as trans_id).  The operation is only performed if there's a mode match
 
295
        according to typefunc.
 
296
        """
 
297
        if mode_id is None:
 
298
            mode_id = trans_id
 
299
        try:
 
300
            old_path = self._tree_id_paths[mode_id]
 
301
        except KeyError:
 
302
            return
 
303
        try:
 
304
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
305
        except OSError, e:
 
306
            if e.errno == errno.ENOENT:
 
307
                return
 
308
            else:
 
309
                raise
 
310
        if typefunc(mode):
 
311
            os.chmod(self._limbo_name(trans_id), mode)
 
312
 
 
313
    def create_directory(self, trans_id):
 
314
        """Schedule creation of a new directory.
 
315
        
 
316
        See also new_directory.
 
317
        """
 
318
        os.mkdir(self._limbo_name(trans_id))
 
319
        unique_add(self._new_contents, trans_id, 'directory')
 
320
 
 
321
    def create_symlink(self, target, trans_id):
 
322
        """Schedule creation of a new symbolic link.
 
323
 
 
324
        target is a bytestring.
 
325
        See also new_symlink.
 
326
        """
 
327
        os.symlink(target, self._limbo_name(trans_id))
 
328
        unique_add(self._new_contents, trans_id, 'symlink')
 
329
 
 
330
    def cancel_creation(self, trans_id):
 
331
        """Cancel the creation of new file contents."""
 
332
        del self._new_contents[trans_id]
 
333
        delete_any(self._limbo_name(trans_id))
 
334
 
254
335
    def delete_contents(self, trans_id):
255
336
        """Schedule the contents of a path entry for deletion"""
256
337
        self.tree_kind(trans_id)
284
365
 
285
366
    def version_file(self, file_id, trans_id):
286
367
        """Schedule a file to become versioned."""
287
 
        if file_id is None:
288
 
            raise ValueError()
 
368
        assert file_id is not None
289
369
        unique_add(self._new_id, trans_id, file_id)
290
370
        unique_add(self._r_new_id, file_id, trans_id)
291
371
 
295
375
        del self._new_id[trans_id]
296
376
        del self._r_new_id[file_id]
297
377
 
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.
 
378
    def new_paths(self):
 
379
        """Determine the paths of all new and changed files"""
 
380
        new_ids = set()
 
381
        fp = FinalPaths(self)
 
382
        for id_set in (self._new_name, self._new_parent, self._new_contents,
 
383
                       self._new_id, self._new_executability):
 
384
            new_ids.update(id_set)
 
385
        new_paths = [(fp.get_path(t), t) for t in new_ids]
 
386
        new_paths.sort()
 
387
        return new_paths
 
388
 
 
389
    def tree_kind(self, trans_id):
 
390
        """Determine the file kind in the working tree.
 
391
 
 
392
        Raises NoSuchFile if the file does not exist
303
393
        """
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))
 
394
        path = self._tree_id_paths.get(trans_id)
 
395
        if path is None:
 
396
            raise NoSuchFile(None)
 
397
        try:
 
398
            return file_kind(self._tree.abspath(path))
 
399
        except OSError, e:
 
400
            if e.errno != errno.ENOENT:
 
401
                raise
 
402
            else:
 
403
                raise NoSuchFile(path)
332
404
 
333
405
    def final_kind(self, trans_id):
334
406
        """Determine the final file kind, after any changes applied.
335
 
 
 
407
        
336
408
        Raises NoSuchFile if the file does not exist/has no contents.
337
409
        (It is conceivable that a path would be created without the
338
410
        corresponding contents insertion command)
353
425
            return None
354
426
        # the file is old; the old id is still valid
355
427
        if self._new_root == trans_id:
356
 
            return self._tree.get_root_id()
357
 
        return self._tree.path2id(path)
 
428
            return self._tree.inventory.root.file_id
 
429
        return self._tree.inventory.path2id(path)
358
430
 
359
431
    def final_file_id(self, trans_id):
360
432
        """Determine the file id after any changes are applied, or None.
361
 
 
 
433
        
362
434
        None indicates that the file will not be versioned after changes are
363
435
        applied.
364
436
        """
365
437
        try:
 
438
            # there is a new id for this file
 
439
            assert self._new_id[trans_id] is not None
366
440
            return self._new_id[trans_id]
367
441
        except KeyError:
368
442
            if trans_id in self._removed_id:
403
477
 
404
478
    def by_parent(self):
405
479
        """Return a map of parent: children for known parents.
406
 
 
 
480
        
407
481
        Only new paths and parents of tree files with assigned ids are used.
408
482
        """
409
483
        by_parent = {}
410
484
        items = list(self._new_parent.iteritems())
411
 
        items.extend((t, self.final_parent(t)) for t in
 
485
        items.extend((t, self.final_parent(t)) for t in 
412
486
                      self._tree_id_paths.keys())
413
487
        for trans_id, parent_id in items:
414
488
            if parent_id not in by_parent:
425
499
 
426
500
    def find_conflicts(self):
427
501
        """Find any violations of inventory or filesystem invariants"""
428
 
        if self._done is True:
 
502
        if self.__done is True:
429
503
            raise ReusingTransform()
430
504
        conflicts = []
431
505
        # ensure all children of all existent parents are known
442
516
        conflicts.extend(self._overwrite_conflicts())
443
517
        return conflicts
444
518
 
445
 
    def _check_malformed(self):
446
 
        conflicts = self.find_conflicts()
447
 
        if len(conflicts) != 0:
448
 
            raise MalformedTransform(conflicts=conflicts)
449
 
 
450
519
    def _add_tree_children(self):
451
520
        """Add all the children of all active parents to the known paths.
452
521
 
454
523
        removed.  This is a necessary first step in detecting conflicts.
455
524
        """
456
525
        parents = self.by_parent().keys()
457
 
        parents.extend([t for t in self._removed_contents if
 
526
        parents.extend([t for t in self._removed_contents if 
458
527
                        self.tree_kind(t) == 'directory'])
459
528
        for trans_id in self._removed_id:
460
529
            file_id = self.tree_file_id(trans_id)
461
 
            if file_id is not None:
462
 
                if self._tree.inventory[file_id].kind == 'directory':
463
 
                    parents.append(trans_id)
464
 
            elif self.tree_kind(trans_id) == 'directory':
 
530
            if self._tree.inventory[file_id].kind == 'directory':
465
531
                parents.append(trans_id)
466
532
 
467
533
        for parent_id in parents:
468
534
            # ensure that all children are registered with the transaction
469
535
            list(self.iter_tree_children(parent_id))
470
536
 
 
537
    def iter_tree_children(self, parent_id):
 
538
        """Iterate through the entry's tree children, if any"""
 
539
        try:
 
540
            path = self._tree_id_paths[parent_id]
 
541
        except KeyError:
 
542
            return
 
543
        try:
 
544
            children = os.listdir(self._tree.abspath(path))
 
545
        except OSError, e:
 
546
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
 
547
                raise
 
548
            return
 
549
            
 
550
        for child in children:
 
551
            childpath = joinpath(path, child)
 
552
            if self._tree.is_control_filename(childpath):
 
553
                continue
 
554
            yield self.trans_id_tree_path(childpath)
 
555
 
471
556
    def has_named_child(self, by_parent, parent_id, name):
472
557
        try:
473
558
            children = by_parent[parent_id]
527
612
 
528
613
    def _improper_versioning(self):
529
614
        """Cannot version a file with no contents, or a bad type.
530
 
 
 
615
        
531
616
        However, existing entries with no contents are okay.
532
617
        """
533
618
        conflicts = []
543
628
 
544
629
    def _executability_conflicts(self):
545
630
        """Check for bad executability changes.
546
 
 
 
631
        
547
632
        Only versioned files may have their executability set, because
548
633
        1. only versioned entries can have executability under windows
549
634
        2. only files can be executable.  (The execute bit on a directory
578
663
    def _duplicate_entries(self, by_parent):
579
664
        """No directory may have two entries with the same name."""
580
665
        conflicts = []
581
 
        if (self._new_name, self._new_parent) == ({}, {}):
582
 
            return conflicts
583
666
        for children in by_parent.itervalues():
584
667
            name_ids = [(self.final_name(t), t) for t in children]
585
 
            if not self._case_sensitive_target:
586
 
                name_ids = [(n.lower(), t) for n, t in name_ids]
587
668
            name_ids.sort()
588
669
            last_name = None
589
670
            last_trans_id = None
607
688
        conflicts = []
608
689
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
609
690
                                self._removed_id))
610
 
        all_ids = self._tree.all_file_ids()
611
 
        active_tree_ids = all_ids.difference(removed_tree_ids)
 
691
        active_tree_ids = set((f for f in self._tree.inventory if
 
692
                               f not in removed_tree_ids))
612
693
        for trans_id, file_id in self._new_id.iteritems():
613
694
            if file_id in active_tree_ids:
614
695
                old_trans_id = self.trans_id_tree_file_id(file_id)
647
728
                continue
648
729
            return True
649
730
        return False
650
 
 
651
 
    def _set_executability(self, path, trans_id):
 
731
            
 
732
    def apply(self):
 
733
        """Apply all changes to the inventory and filesystem.
 
734
        
 
735
        If filesystem or inventory conflicts are present, MalformedTransform
 
736
        will be thrown.
 
737
        """
 
738
        conflicts = self.find_conflicts()
 
739
        if len(conflicts) != 0:
 
740
            raise MalformedTransform(conflicts=conflicts)
 
741
        limbo_inv = {}
 
742
        inv = self._tree.inventory
 
743
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
744
        try:
 
745
            child_pb.update('Apply phase', 0, 2)
 
746
            self._apply_removals(inv, limbo_inv)
 
747
            child_pb.update('Apply phase', 1, 2)
 
748
            modified_paths = self._apply_insertions(inv, limbo_inv)
 
749
        finally:
 
750
            child_pb.finished()
 
751
        self._tree._write_inventory(inv)
 
752
        self.__done = True
 
753
        self.finalize()
 
754
        return _TransformResults(modified_paths)
 
755
 
 
756
    def _limbo_name(self, trans_id):
 
757
        """Generate the limbo name of a file"""
 
758
        return pathjoin(self._limbodir, trans_id)
 
759
 
 
760
    def _apply_removals(self, inv, limbo_inv):
 
761
        """Perform tree operations that remove directory/inventory names.
 
762
        
 
763
        That is, delete files that are to be deleted, and put any files that
 
764
        need renaming into limbo.  This must be done in strict child-to-parent
 
765
        order.
 
766
        """
 
767
        tree_paths = list(self._tree_path_ids.iteritems())
 
768
        tree_paths.sort(reverse=True)
 
769
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
770
        try:
 
771
            for num, data in enumerate(tree_paths):
 
772
                path, trans_id = data
 
773
                child_pb.update('removing file', num, len(tree_paths))
 
774
                full_path = self._tree.abspath(path)
 
775
                if trans_id in self._removed_contents:
 
776
                    delete_any(full_path)
 
777
                elif trans_id in self._new_name or trans_id in \
 
778
                    self._new_parent:
 
779
                    try:
 
780
                        os.rename(full_path, self._limbo_name(trans_id))
 
781
                    except OSError, e:
 
782
                        if e.errno != errno.ENOENT:
 
783
                            raise
 
784
                if trans_id in self._removed_id:
 
785
                    if trans_id == self._new_root:
 
786
                        file_id = self._tree.inventory.root.file_id
 
787
                    else:
 
788
                        file_id = self.tree_file_id(trans_id)
 
789
                    del inv[file_id]
 
790
                elif trans_id in self._new_name or trans_id in self._new_parent:
 
791
                    file_id = self.tree_file_id(trans_id)
 
792
                    if file_id is not None:
 
793
                        limbo_inv[trans_id] = inv[file_id]
 
794
                        inv.remove_recursive_id(file_id)
 
795
        finally:
 
796
            child_pb.finished()
 
797
 
 
798
    def _apply_insertions(self, inv, limbo_inv):
 
799
        """Perform tree operations that insert directory/inventory names.
 
800
        
 
801
        That is, create any files that need to be created, and restore from
 
802
        limbo any files that needed renaming.  This must be done in strict
 
803
        parent-to-child order.
 
804
        """
 
805
        new_paths = self.new_paths()
 
806
        modified_paths = []
 
807
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
808
        try:
 
809
            for num, (path, trans_id) in enumerate(new_paths):
 
810
                child_pb.update('adding file', num, len(new_paths))
 
811
                try:
 
812
                    kind = self._new_contents[trans_id]
 
813
                except KeyError:
 
814
                    kind = contents = None
 
815
                if trans_id in self._new_contents or \
 
816
                    self.path_changed(trans_id):
 
817
                    full_path = self._tree.abspath(path)
 
818
                    try:
 
819
                        os.rename(self._limbo_name(trans_id), full_path)
 
820
                    except OSError, e:
 
821
                        # We may be renaming a dangling inventory id
 
822
                        if e.errno != errno.ENOENT:
 
823
                            raise
 
824
                    if trans_id in self._new_contents:
 
825
                        modified_paths.append(full_path)
 
826
                        del self._new_contents[trans_id]
 
827
 
 
828
                if trans_id in self._new_id:
 
829
                    if kind is None:
 
830
                        kind = file_kind(self._tree.abspath(path))
 
831
                    if trans_id in self._new_reference_revision:
 
832
                        entry = inventory.TreeReference(self._new_id[trans_id], 
 
833
                            self._new_name[trans_id], 
 
834
                            self.final_file_id(self._new_parent[trans_id]),
 
835
                            None, self._new_reference_revision[trans_id])
 
836
                        inv.add(entry)
 
837
                    else:
 
838
                        inv.add_path(path, kind, self._new_id[trans_id])
 
839
                elif trans_id in self._new_name or trans_id in\
 
840
                    self._new_parent:
 
841
                    entry = limbo_inv.get(trans_id)
 
842
                    if entry is not None:
 
843
                        entry.name = self.final_name(trans_id)
 
844
                        parent_path = os.path.dirname(path)
 
845
                        entry.parent_id = \
 
846
                            self._tree.inventory.path2id(parent_path)
 
847
                        inv.add(entry)
 
848
 
 
849
                # requires files and inventory entries to be in place
 
850
                if trans_id in self._new_executability:
 
851
                    self._set_executability(path, inv, trans_id)
 
852
        finally:
 
853
            child_pb.finished()
 
854
        return modified_paths
 
855
 
 
856
    def _set_executability(self, path, inv, trans_id):
652
857
        """Set the executability of versioned files """
 
858
        file_id = inv.path2id(path)
 
859
        new_executability = self._new_executability[trans_id]
 
860
        inv[file_id].executable = new_executability
653
861
        if supports_executable():
654
 
            new_executability = self._new_executability[trans_id]
655
862
            abspath = self._tree.abspath(path)
656
863
            current_mode = os.stat(abspath).st_mode
657
864
            if new_executability:
674
881
            self.version_file(file_id, trans_id)
675
882
        return trans_id
676
883
 
677
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
884
    def new_file(self, name, parent_id, contents, file_id=None, 
678
885
                 executable=None):
679
886
        """Convenience method to create files.
680
 
 
 
887
        
681
888
        name is the name of the file to create.
682
889
        parent_id is the transaction id of the parent directory of the file.
683
890
        contents is an iterator of bytestrings, which will be used to produce
703
910
        """
704
911
        trans_id = self._new_entry(name, parent_id, file_id)
705
912
        self.create_directory(trans_id)
706
 
        return trans_id
 
913
        return trans_id 
707
914
 
708
915
    def new_symlink(self, name, parent_id, target, file_id=None):
709
916
        """Convenience method to create symbolic link.
710
 
 
 
917
        
711
918
        name is the name of the symlink to create.
712
919
        parent_id is the transaction id of the parent directory of the symlink.
713
920
        target is a bytestring of the target of the symlink.
752
959
        from_path = self._tree_id_paths.get(from_trans_id)
753
960
        if from_versioned:
754
961
            # get data from working tree if versioned
755
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
962
            from_entry = self._tree.inventory[file_id]
756
963
            from_name = from_entry.name
757
964
            from_parent = from_entry.parent_id
758
965
        else:
794
1001
            to_executable = False
795
1002
        return to_name, to_parent, to_kind, to_executable
796
1003
 
797
 
    def iter_changes(self):
798
 
        """Produce output in the same format as Tree.iter_changes.
 
1004
    def _iter_changes(self):
 
1005
        """Produce output in the same format as Tree._iter_changes.
799
1006
 
800
1007
        Will produce nonsensical results if invoked while inventory/filesystem
801
1008
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
840
1047
                to_path = final_paths.get_path(to_trans_id)
841
1048
            if from_kind != to_kind:
842
1049
                modified = True
843
 
            elif to_kind in ('file', 'symlink') and (
 
1050
            elif to_kind in ('file' or 'symlink') and (
844
1051
                to_trans_id != from_trans_id or
845
1052
                to_trans_id in self._new_contents):
846
1053
                modified = True
856
1063
                   (from_executable, to_executable)))
857
1064
        return iter(sorted(results, key=lambda x:x[1]))
858
1065
 
859
 
    def get_preview_tree(self):
860
 
        """Return a tree representing the result of the transform.
861
 
 
862
 
        This tree only supports the subset of Tree functionality required
863
 
        by show_diff_trees.  It must only be compared to tt._tree.
864
 
        """
865
 
        return _PreviewTree(self)
866
 
 
867
 
    def commit(self, branch, message, merge_parents=None, strict=False):
868
 
        """Commit the result of this TreeTransform to a branch.
869
 
 
870
 
        :param branch: The branch to commit to.
871
 
        :param message: The message to attach to the commit.
872
 
        :param merge_parents: Additional parents specified by pending merges.
873
 
        :return: The revision_id of the revision committed.
874
 
        """
875
 
        self._check_malformed()
876
 
        if strict:
877
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
878
 
            for trans_id in unversioned:
879
 
                if self.final_file_id(trans_id) is None:
880
 
                    raise errors.StrictCommitFailed()
881
 
 
882
 
        revno, last_rev_id = branch.last_revision_info()
883
 
        if last_rev_id == _mod_revision.NULL_REVISION:
884
 
            if merge_parents is not None:
885
 
                raise ValueError('Cannot supply merge parents for first'
886
 
                                 ' commit.')
887
 
            parent_ids = []
888
 
        else:
889
 
            parent_ids = [last_rev_id]
890
 
            if merge_parents is not None:
891
 
                parent_ids.extend(merge_parents)
892
 
        if self._tree.get_revision_id() != last_rev_id:
893
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
894
 
                             self._tree.get_revision_id())
895
 
        builder = branch.get_commit_builder(parent_ids)
896
 
        preview = self.get_preview_tree()
897
 
        list(builder.record_iter_changes(preview, last_rev_id,
898
 
                                         self.iter_changes()))
899
 
        builder.finish_inventory()
900
 
        revision_id = builder.commit(message)
901
 
        branch.set_last_revision_info(revno + 1, revision_id)
902
 
        return revision_id
903
 
 
904
 
    def _text_parent(self, trans_id):
905
 
        file_id = self.tree_file_id(trans_id)
906
 
        try:
907
 
            if file_id is None or self._tree.kind(file_id) != 'file':
908
 
                return None
909
 
        except errors.NoSuchFile:
910
 
            return None
911
 
        return file_id
912
 
 
913
 
    def _get_parents_texts(self, trans_id):
914
 
        """Get texts for compression parents of this file."""
915
 
        file_id = self._text_parent(trans_id)
916
 
        if file_id is None:
917
 
            return ()
918
 
        return (self._tree.get_file_text(file_id),)
919
 
 
920
 
    def _get_parents_lines(self, trans_id):
921
 
        """Get lines for compression parents of this file."""
922
 
        file_id = self._text_parent(trans_id)
923
 
        if file_id is None:
924
 
            return ()
925
 
        return (self._tree.get_file_lines(file_id),)
926
 
 
927
 
    def serialize(self, serializer):
928
 
        """Serialize this TreeTransform.
929
 
 
930
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
931
 
        """
932
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
933
 
                        self._new_name.items())
934
 
        new_executability = dict((k, int(v)) for k, v in
935
 
                                 self._new_executability.items())
936
 
        tree_path_ids = dict((k.encode('utf-8'), v)
937
 
                             for k, v in self._tree_path_ids.items())
938
 
        attribs = {
939
 
            '_id_number': self._id_number,
940
 
            '_new_name': new_name,
941
 
            '_new_parent': self._new_parent,
942
 
            '_new_executability': new_executability,
943
 
            '_new_id': self._new_id,
944
 
            '_tree_path_ids': tree_path_ids,
945
 
            '_removed_id': list(self._removed_id),
946
 
            '_removed_contents': list(self._removed_contents),
947
 
            '_non_present_ids': self._non_present_ids,
948
 
            }
949
 
        yield serializer.bytes_record(bencode.bencode(attribs),
950
 
                                      (('attribs',),))
951
 
        for trans_id, kind in self._new_contents.items():
952
 
            if kind == 'file':
953
 
                lines = osutils.chunks_to_lines(
954
 
                    self._read_file_chunks(trans_id))
955
 
                parents = self._get_parents_lines(trans_id)
956
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
957
 
                content = ''.join(mpdiff.to_patch())
958
 
            if kind == 'directory':
959
 
                content = ''
960
 
            if kind == 'symlink':
961
 
                content = self._read_symlink_target(trans_id)
962
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
963
 
 
964
 
    def deserialize(self, records):
965
 
        """Deserialize a stored TreeTransform.
966
 
 
967
 
        :param records: An iterable of (names, content) tuples, as per
968
 
            pack.ContainerPushParser.
969
 
        """
970
 
        names, content = records.next()
971
 
        attribs = bencode.bdecode(content)
972
 
        self._id_number = attribs['_id_number']
973
 
        self._new_name = dict((k, v.decode('utf-8'))
974
 
                            for k, v in attribs['_new_name'].items())
975
 
        self._new_parent = attribs['_new_parent']
976
 
        self._new_executability = dict((k, bool(v)) for k, v in
977
 
            attribs['_new_executability'].items())
978
 
        self._new_id = attribs['_new_id']
979
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
980
 
        self._tree_path_ids = {}
981
 
        self._tree_id_paths = {}
982
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
983
 
            path = bytepath.decode('utf-8')
984
 
            self._tree_path_ids[path] = trans_id
985
 
            self._tree_id_paths[trans_id] = path
986
 
        self._removed_id = set(attribs['_removed_id'])
987
 
        self._removed_contents = set(attribs['_removed_contents'])
988
 
        self._non_present_ids = attribs['_non_present_ids']
989
 
        for ((trans_id, kind),), content in records:
990
 
            if kind == 'file':
991
 
                mpdiff = multiparent.MultiParent.from_patch(content)
992
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
993
 
                self.create_file(lines, trans_id)
994
 
            if kind == 'directory':
995
 
                self.create_directory(trans_id)
996
 
            if kind == 'symlink':
997
 
                self.create_symlink(content.decode('utf-8'), trans_id)
998
 
 
999
 
 
1000
 
class DiskTreeTransform(TreeTransformBase):
1001
 
    """Tree transform storing its contents on disk."""
1002
 
 
1003
 
    def __init__(self, tree, limbodir, pb=DummyProgress(),
1004
 
                 case_sensitive=True):
1005
 
        """Constructor.
1006
 
        :param tree: The tree that will be transformed, but not necessarily
1007
 
            the output tree.
1008
 
        :param limbodir: A directory where new files can be stored until
1009
 
            they are installed in their proper places
1010
 
        :param pb: A ProgressBar indicating how much progress is being made
1011
 
        :param case_sensitive: If True, the target of the transform is
1012
 
            case sensitive, not just case preserving.
1013
 
        """
1014
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1015
 
        self._limbodir = limbodir
1016
 
        self._deletiondir = None
1017
 
        # A mapping of transform ids to their limbo filename
1018
 
        self._limbo_files = {}
1019
 
        # A mapping of transform ids to a set of the transform ids of children
1020
 
        # that their limbo directory has
1021
 
        self._limbo_children = {}
1022
 
        # Map transform ids to maps of child filename to child transform id
1023
 
        self._limbo_children_names = {}
1024
 
        # List of transform ids that need to be renamed from limbo into place
1025
 
        self._needs_rename = set()
1026
 
 
1027
 
    def finalize(self):
1028
 
        """Release the working tree lock, if held, clean up limbo dir.
1029
 
 
1030
 
        This is required if apply has not been invoked, but can be invoked
1031
 
        even after apply.
1032
 
        """
1033
 
        if self._tree is None:
1034
 
            return
1035
 
        try:
1036
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1037
 
                       self._new_contents.iteritems()]
1038
 
            entries.sort(reverse=True)
1039
 
            for path, trans_id, kind in entries:
1040
 
                delete_any(path)
1041
 
            try:
1042
 
                delete_any(self._limbodir)
1043
 
            except OSError:
1044
 
                # We don't especially care *why* the dir is immortal.
1045
 
                raise ImmortalLimbo(self._limbodir)
1046
 
            try:
1047
 
                if self._deletiondir is not None:
1048
 
                    delete_any(self._deletiondir)
1049
 
            except OSError:
1050
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1051
 
        finally:
1052
 
            TreeTransformBase.finalize(self)
1053
 
 
1054
 
    def _limbo_name(self, trans_id):
1055
 
        """Generate the limbo name of a file"""
1056
 
        limbo_name = self._limbo_files.get(trans_id)
1057
 
        if limbo_name is not None:
1058
 
            return limbo_name
1059
 
        parent = self._new_parent.get(trans_id)
1060
 
        # if the parent directory is already in limbo (e.g. when building a
1061
 
        # tree), choose a limbo name inside the parent, to reduce further
1062
 
        # renames.
1063
 
        use_direct_path = False
1064
 
        if self._new_contents.get(parent) == 'directory':
1065
 
            filename = self._new_name.get(trans_id)
1066
 
            if filename is not None:
1067
 
                if parent not in self._limbo_children:
1068
 
                    self._limbo_children[parent] = set()
1069
 
                    self._limbo_children_names[parent] = {}
1070
 
                    use_direct_path = True
1071
 
                # the direct path can only be used if no other file has
1072
 
                # already taken this pathname, i.e. if the name is unused, or
1073
 
                # if it is already associated with this trans_id.
1074
 
                elif self._case_sensitive_target:
1075
 
                    if (self._limbo_children_names[parent].get(filename)
1076
 
                        in (trans_id, None)):
1077
 
                        use_direct_path = True
1078
 
                else:
1079
 
                    for l_filename, l_trans_id in\
1080
 
                        self._limbo_children_names[parent].iteritems():
1081
 
                        if l_trans_id == trans_id:
1082
 
                            continue
1083
 
                        if l_filename.lower() == filename.lower():
1084
 
                            break
1085
 
                    else:
1086
 
                        use_direct_path = True
1087
 
 
1088
 
        if use_direct_path:
1089
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
1090
 
            self._limbo_children[parent].add(trans_id)
1091
 
            self._limbo_children_names[parent][filename] = trans_id
1092
 
        else:
1093
 
            limbo_name = pathjoin(self._limbodir, trans_id)
1094
 
            self._needs_rename.add(trans_id)
1095
 
        self._limbo_files[trans_id] = limbo_name
1096
 
        return limbo_name
1097
 
 
1098
 
    def adjust_path(self, name, parent, trans_id):
1099
 
        previous_parent = self._new_parent.get(trans_id)
1100
 
        previous_name = self._new_name.get(trans_id)
1101
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1102
 
        if (trans_id in self._limbo_files and
1103
 
            trans_id not in self._needs_rename):
1104
 
            self._rename_in_limbo([trans_id])
1105
 
            self._limbo_children[previous_parent].remove(trans_id)
1106
 
            del self._limbo_children_names[previous_parent][previous_name]
1107
 
 
1108
 
    def _rename_in_limbo(self, trans_ids):
1109
 
        """Fix limbo names so that the right final path is produced.
1110
 
 
1111
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1112
 
        these files later by creating them with their final names in their
1113
 
        final parents.  But now the previous name or parent is no longer
1114
 
        suitable, so we have to rename them.
1115
 
 
1116
 
        Even for trans_ids that have no new contents, we must remove their
1117
 
        entries from _limbo_files, because they are now stale.
1118
 
        """
1119
 
        for trans_id in trans_ids:
1120
 
            old_path = self._limbo_files.pop(trans_id)
1121
 
            if trans_id not in self._new_contents:
1122
 
                continue
1123
 
            new_path = self._limbo_name(trans_id)
1124
 
            os.rename(old_path, new_path)
1125
 
 
1126
 
    def create_file(self, contents, trans_id, mode_id=None):
1127
 
        """Schedule creation of a new file.
1128
 
 
1129
 
        See also new_file.
1130
 
 
1131
 
        Contents is an iterator of strings, all of which will be written
1132
 
        to the target destination.
1133
 
 
1134
 
        New file takes the permissions of any existing file with that id,
1135
 
        unless mode_id is specified.
1136
 
        """
1137
 
        name = self._limbo_name(trans_id)
1138
 
        f = open(name, 'wb')
1139
 
        try:
1140
 
            try:
1141
 
                unique_add(self._new_contents, trans_id, 'file')
1142
 
            except:
1143
 
                # Clean up the file, it never got registered so
1144
 
                # TreeTransform.finalize() won't clean it up.
1145
 
                f.close()
1146
 
                os.unlink(name)
1147
 
                raise
1148
 
 
1149
 
            f.writelines(contents)
1150
 
        finally:
1151
 
            f.close()
1152
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1153
 
 
1154
 
    def _read_file_chunks(self, trans_id):
1155
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1156
 
        try:
1157
 
            return cur_file.readlines()
1158
 
        finally:
1159
 
            cur_file.close()
1160
 
 
1161
 
    def _read_symlink_target(self, trans_id):
1162
 
        return os.readlink(self._limbo_name(trans_id))
1163
 
 
1164
 
    def create_hardlink(self, path, trans_id):
1165
 
        """Schedule creation of a hard link"""
1166
 
        name = self._limbo_name(trans_id)
1167
 
        try:
1168
 
            os.link(path, name)
1169
 
        except OSError, e:
1170
 
            if e.errno != errno.EPERM:
1171
 
                raise
1172
 
            raise errors.HardLinkNotSupported(path)
1173
 
        try:
1174
 
            unique_add(self._new_contents, trans_id, 'file')
1175
 
        except:
1176
 
            # Clean up the file, it never got registered so
1177
 
            # TreeTransform.finalize() won't clean it up.
1178
 
            os.unlink(name)
1179
 
            raise
1180
 
 
1181
 
    def create_directory(self, trans_id):
1182
 
        """Schedule creation of a new directory.
1183
 
 
1184
 
        See also new_directory.
1185
 
        """
1186
 
        os.mkdir(self._limbo_name(trans_id))
1187
 
        unique_add(self._new_contents, trans_id, 'directory')
1188
 
 
1189
 
    def create_symlink(self, target, trans_id):
1190
 
        """Schedule creation of a new symbolic link.
1191
 
 
1192
 
        target is a bytestring.
1193
 
        See also new_symlink.
1194
 
        """
1195
 
        if has_symlinks():
1196
 
            os.symlink(target, self._limbo_name(trans_id))
1197
 
            unique_add(self._new_contents, trans_id, 'symlink')
1198
 
        else:
1199
 
            try:
1200
 
                path = FinalPaths(self).get_path(trans_id)
1201
 
            except KeyError:
1202
 
                path = None
1203
 
            raise UnableCreateSymlink(path=path)
1204
 
 
1205
 
    def cancel_creation(self, trans_id):
1206
 
        """Cancel the creation of new file contents."""
1207
 
        del self._new_contents[trans_id]
1208
 
        children = self._limbo_children.get(trans_id)
1209
 
        # if this is a limbo directory with children, move them before removing
1210
 
        # the directory
1211
 
        if children is not None:
1212
 
            self._rename_in_limbo(children)
1213
 
            del self._limbo_children[trans_id]
1214
 
            del self._limbo_children_names[trans_id]
1215
 
        delete_any(self._limbo_name(trans_id))
1216
 
 
1217
 
 
1218
 
class TreeTransform(DiskTreeTransform):
1219
 
    """Represent a tree transformation.
1220
 
 
1221
 
    This object is designed to support incremental generation of the transform,
1222
 
    in any order.
1223
 
 
1224
 
    However, it gives optimum performance when parent directories are created
1225
 
    before their contents.  The transform is then able to put child files
1226
 
    directly in their parent directory, avoiding later renames.
1227
 
 
1228
 
    It is easy to produce malformed transforms, but they are generally
1229
 
    harmless.  Attempting to apply a malformed transform will cause an
1230
 
    exception to be raised before any modifications are made to the tree.
1231
 
 
1232
 
    Many kinds of malformed transforms can be corrected with the
1233
 
    resolve_conflicts function.  The remaining ones indicate programming error,
1234
 
    such as trying to create a file with no path.
1235
 
 
1236
 
    Two sets of file creation methods are supplied.  Convenience methods are:
1237
 
     * new_file
1238
 
     * new_directory
1239
 
     * new_symlink
1240
 
 
1241
 
    These are composed of the low-level methods:
1242
 
     * create_path
1243
 
     * create_file or create_directory or create_symlink
1244
 
     * version_file
1245
 
     * set_executability
1246
 
 
1247
 
    Transform/Transaction ids
1248
 
    -------------------------
1249
 
    trans_ids are temporary ids assigned to all files involved in a transform.
1250
 
    It's possible, even common, that not all files in the Tree have trans_ids.
1251
 
 
1252
 
    trans_ids are used because filenames and file_ids are not good enough
1253
 
    identifiers; filenames change, and not all files have file_ids.  File-ids
1254
 
    are also associated with trans-ids, so that moving a file moves its
1255
 
    file-id.
1256
 
 
1257
 
    trans_ids are only valid for the TreeTransform that generated them.
1258
 
 
1259
 
    Limbo
1260
 
    -----
1261
 
    Limbo is a temporary directory use to hold new versions of files.
1262
 
    Files are added to limbo by create_file, create_directory, create_symlink,
1263
 
    and their convenience variants (new_*).  Files may be removed from limbo
1264
 
    using cancel_creation.  Files are renamed from limbo into their final
1265
 
    location as part of TreeTransform.apply
1266
 
 
1267
 
    Limbo must be cleaned up, by either calling TreeTransform.apply or
1268
 
    calling TreeTransform.finalize.
1269
 
 
1270
 
    Files are placed into limbo inside their parent directories, where
1271
 
    possible.  This reduces subsequent renames, and makes operations involving
1272
 
    lots of files faster.  This optimization is only possible if the parent
1273
 
    directory is created *before* creating any of its children, so avoid
1274
 
    creating children before parents, where possible.
1275
 
 
1276
 
    Pending-deletion
1277
 
    ----------------
1278
 
    This temporary directory is used by _FileMover for storing files that are
1279
 
    about to be deleted.  In case of rollback, the files will be restored.
1280
 
    FileMover does not delete files until it is sure that a rollback will not
1281
 
    happen.
1282
 
    """
1283
 
    def __init__(self, tree, pb=DummyProgress()):
1284
 
        """Note: a tree_write lock is taken on the tree.
1285
 
 
1286
 
        Use TreeTransform.finalize() to release the lock (can be omitted if
1287
 
        TreeTransform.apply() called).
1288
 
        """
1289
 
        tree.lock_tree_write()
1290
 
 
1291
 
        try:
1292
 
            limbodir = urlutils.local_path_from_url(
1293
 
                tree._transport.abspath('limbo'))
1294
 
            try:
1295
 
                os.mkdir(limbodir)
1296
 
            except OSError, e:
1297
 
                if e.errno == errno.EEXIST:
1298
 
                    raise ExistingLimbo(limbodir)
1299
 
            deletiondir = urlutils.local_path_from_url(
1300
 
                tree._transport.abspath('pending-deletion'))
1301
 
            try:
1302
 
                os.mkdir(deletiondir)
1303
 
            except OSError, e:
1304
 
                if e.errno == errno.EEXIST:
1305
 
                    raise errors.ExistingPendingDeletion(deletiondir)
1306
 
        except:
1307
 
            tree.unlock()
1308
 
            raise
1309
 
 
1310
 
        # Cache of realpath results, to speed up canonical_path
1311
 
        self._realpaths = {}
1312
 
        # Cache of relpath results, to speed up canonical_path
1313
 
        self._relpaths = {}
1314
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
1315
 
                                   tree.case_sensitive)
1316
 
        self._deletiondir = deletiondir
1317
 
 
1318
 
    def canonical_path(self, path):
1319
 
        """Get the canonical tree-relative path"""
1320
 
        # don't follow final symlinks
1321
 
        abs = self._tree.abspath(path)
1322
 
        if abs in self._relpaths:
1323
 
            return self._relpaths[abs]
1324
 
        dirname, basename = os.path.split(abs)
1325
 
        if dirname not in self._realpaths:
1326
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1327
 
        dirname = self._realpaths[dirname]
1328
 
        abs = pathjoin(dirname, basename)
1329
 
        if dirname in self._relpaths:
1330
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1331
 
            relpath = relpath.rstrip('/\\')
1332
 
        else:
1333
 
            relpath = self._tree.relpath(abs)
1334
 
        self._relpaths[abs] = relpath
1335
 
        return relpath
1336
 
 
1337
 
    def tree_kind(self, trans_id):
1338
 
        """Determine the file kind in the working tree.
1339
 
 
1340
 
        Raises NoSuchFile if the file does not exist
1341
 
        """
1342
 
        path = self._tree_id_paths.get(trans_id)
1343
 
        if path is None:
1344
 
            raise NoSuchFile(None)
1345
 
        try:
1346
 
            return file_kind(self._tree.abspath(path))
1347
 
        except OSError, e:
1348
 
            if e.errno != errno.ENOENT:
1349
 
                raise
1350
 
            else:
1351
 
                raise NoSuchFile(path)
1352
 
 
1353
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1354
 
        """Set the mode of new file contents.
1355
 
        The mode_id is the existing file to get the mode from (often the same
1356
 
        as trans_id).  The operation is only performed if there's a mode match
1357
 
        according to typefunc.
1358
 
        """
1359
 
        if mode_id is None:
1360
 
            mode_id = trans_id
1361
 
        try:
1362
 
            old_path = self._tree_id_paths[mode_id]
1363
 
        except KeyError:
1364
 
            return
1365
 
        try:
1366
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1367
 
        except OSError, e:
1368
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1369
 
                # Either old_path doesn't exist, or the parent of the
1370
 
                # target is not a directory (but will be one eventually)
1371
 
                # Either way, we know it doesn't exist *right now*
1372
 
                # See also bug #248448
1373
 
                return
1374
 
            else:
1375
 
                raise
1376
 
        if typefunc(mode):
1377
 
            os.chmod(self._limbo_name(trans_id), mode)
1378
 
 
1379
 
    def iter_tree_children(self, parent_id):
1380
 
        """Iterate through the entry's tree children, if any"""
1381
 
        try:
1382
 
            path = self._tree_id_paths[parent_id]
1383
 
        except KeyError:
1384
 
            return
1385
 
        try:
1386
 
            children = os.listdir(self._tree.abspath(path))
1387
 
        except OSError, e:
1388
 
            if not (osutils._is_error_enotdir(e)
1389
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1390
 
                raise
1391
 
            return
1392
 
 
1393
 
        for child in children:
1394
 
            childpath = joinpath(path, child)
1395
 
            if self._tree.is_control_filename(childpath):
1396
 
                continue
1397
 
            yield self.trans_id_tree_path(childpath)
1398
 
 
1399
 
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1400
 
        """Apply all changes to the inventory and filesystem.
1401
 
 
1402
 
        If filesystem or inventory conflicts are present, MalformedTransform
1403
 
        will be thrown.
1404
 
 
1405
 
        If apply succeeds, finalize is not necessary.
1406
 
 
1407
 
        :param no_conflicts: if True, the caller guarantees there are no
1408
 
            conflicts, so no check is made.
1409
 
        :param precomputed_delta: An inventory delta to use instead of
1410
 
            calculating one.
1411
 
        :param _mover: Supply an alternate FileMover, for testing
1412
 
        """
1413
 
        if not no_conflicts:
1414
 
            self._check_malformed()
1415
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1416
 
        try:
1417
 
            if precomputed_delta is None:
1418
 
                child_pb.update('Apply phase', 0, 2)
1419
 
                inventory_delta = self._generate_inventory_delta()
1420
 
                offset = 1
1421
 
            else:
1422
 
                inventory_delta = precomputed_delta
1423
 
                offset = 0
1424
 
            if _mover is None:
1425
 
                mover = _FileMover()
1426
 
            else:
1427
 
                mover = _mover
1428
 
            try:
1429
 
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
1430
 
                self._apply_removals(mover)
1431
 
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
1432
 
                modified_paths = self._apply_insertions(mover)
1433
 
            except:
1434
 
                mover.rollback()
1435
 
                raise
1436
 
            else:
1437
 
                mover.apply_deletions()
1438
 
        finally:
1439
 
            child_pb.finished()
1440
 
        self._tree.apply_inventory_delta(inventory_delta)
1441
 
        self._done = True
1442
 
        self.finalize()
1443
 
        return _TransformResults(modified_paths, self.rename_count)
1444
 
 
1445
 
    def _generate_inventory_delta(self):
1446
 
        """Generate an inventory delta for the current transform."""
1447
 
        inventory_delta = []
1448
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1449
 
        new_paths = self._inventory_altered()
1450
 
        total_entries = len(new_paths) + len(self._removed_id)
1451
 
        try:
1452
 
            for num, trans_id in enumerate(self._removed_id):
1453
 
                if (num % 10) == 0:
1454
 
                    child_pb.update('removing file', num, total_entries)
1455
 
                if trans_id == self._new_root:
1456
 
                    file_id = self._tree.get_root_id()
1457
 
                else:
1458
 
                    file_id = self.tree_file_id(trans_id)
1459
 
                # File-id isn't really being deleted, just moved
1460
 
                if file_id in self._r_new_id:
1461
 
                    continue
1462
 
                path = self._tree_id_paths[trans_id]
1463
 
                inventory_delta.append((path, None, file_id, None))
1464
 
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1465
 
                                     new_paths)
1466
 
            entries = self._tree.iter_entries_by_dir(
1467
 
                new_path_file_ids.values())
1468
 
            old_paths = dict((e.file_id, p) for p, e in entries)
1469
 
            final_kinds = {}
1470
 
            for num, (path, trans_id) in enumerate(new_paths):
1471
 
                if (num % 10) == 0:
1472
 
                    child_pb.update('adding file',
1473
 
                                    num + len(self._removed_id), total_entries)
1474
 
                file_id = new_path_file_ids[trans_id]
1475
 
                if file_id is None:
1476
 
                    continue
1477
 
                needs_entry = False
1478
 
                try:
1479
 
                    kind = self.final_kind(trans_id)
1480
 
                except NoSuchFile:
1481
 
                    kind = self._tree.stored_kind(file_id)
1482
 
                parent_trans_id = self.final_parent(trans_id)
1483
 
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1484
 
                if parent_file_id is None:
1485
 
                    parent_file_id = self.final_file_id(parent_trans_id)
1486
 
                if trans_id in self._new_reference_revision:
1487
 
                    new_entry = inventory.TreeReference(
1488
 
                        file_id,
1489
 
                        self._new_name[trans_id],
1490
 
                        self.final_file_id(self._new_parent[trans_id]),
1491
 
                        None, self._new_reference_revision[trans_id])
1492
 
                else:
1493
 
                    new_entry = inventory.make_entry(kind,
1494
 
                        self.final_name(trans_id),
1495
 
                        parent_file_id, file_id)
1496
 
                old_path = old_paths.get(new_entry.file_id)
1497
 
                new_executability = self._new_executability.get(trans_id)
1498
 
                if new_executability is not None:
1499
 
                    new_entry.executable = new_executability
1500
 
                inventory_delta.append(
1501
 
                    (old_path, path, new_entry.file_id, new_entry))
1502
 
        finally:
1503
 
            child_pb.finished()
1504
 
        return inventory_delta
1505
 
 
1506
 
    def _apply_removals(self, mover):
1507
 
        """Perform tree operations that remove directory/inventory names.
1508
 
 
1509
 
        That is, delete files that are to be deleted, and put any files that
1510
 
        need renaming into limbo.  This must be done in strict child-to-parent
1511
 
        order.
1512
 
 
1513
 
        If inventory_delta is None, no inventory delta generation is performed.
1514
 
        """
1515
 
        tree_paths = list(self._tree_path_ids.iteritems())
1516
 
        tree_paths.sort(reverse=True)
1517
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1518
 
        try:
1519
 
            for num, data in enumerate(tree_paths):
1520
 
                path, trans_id = data
1521
 
                child_pb.update('removing file', num, len(tree_paths))
1522
 
                full_path = self._tree.abspath(path)
1523
 
                if trans_id in self._removed_contents:
1524
 
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
1525
 
                                     trans_id))
1526
 
                elif trans_id in self._new_name or trans_id in \
1527
 
                    self._new_parent:
1528
 
                    try:
1529
 
                        mover.rename(full_path, self._limbo_name(trans_id))
1530
 
                    except OSError, e:
1531
 
                        if e.errno != errno.ENOENT:
1532
 
                            raise
1533
 
                    else:
1534
 
                        self.rename_count += 1
1535
 
        finally:
1536
 
            child_pb.finished()
1537
 
 
1538
 
    def _apply_insertions(self, mover):
1539
 
        """Perform tree operations that insert directory/inventory names.
1540
 
 
1541
 
        That is, create any files that need to be created, and restore from
1542
 
        limbo any files that needed renaming.  This must be done in strict
1543
 
        parent-to-child order.
1544
 
 
1545
 
        If inventory_delta is None, no inventory delta is calculated, and
1546
 
        no list of modified paths is returned.
1547
 
        """
1548
 
        new_paths = self.new_paths(filesystem_only=True)
1549
 
        modified_paths = []
1550
 
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1551
 
                                 new_paths)
1552
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1553
 
        try:
1554
 
            for num, (path, trans_id) in enumerate(new_paths):
1555
 
                if (num % 10) == 0:
1556
 
                    child_pb.update('adding file', num, len(new_paths))
1557
 
                full_path = self._tree.abspath(path)
1558
 
                if trans_id in self._needs_rename:
1559
 
                    try:
1560
 
                        mover.rename(self._limbo_name(trans_id), full_path)
1561
 
                    except OSError, e:
1562
 
                        # We may be renaming a dangling inventory id
1563
 
                        if e.errno != errno.ENOENT:
1564
 
                            raise
1565
 
                    else:
1566
 
                        self.rename_count += 1
1567
 
                if (trans_id in self._new_contents or
1568
 
                    self.path_changed(trans_id)):
1569
 
                    if trans_id in self._new_contents:
1570
 
                        modified_paths.append(full_path)
1571
 
                if trans_id in self._new_executability:
1572
 
                    self._set_executability(path, trans_id)
1573
 
        finally:
1574
 
            child_pb.finished()
1575
 
        self._new_contents.clear()
1576
 
        return modified_paths
1577
 
 
1578
 
 
1579
 
class TransformPreview(DiskTreeTransform):
1580
 
    """A TreeTransform for generating preview trees.
1581
 
 
1582
 
    Unlike TreeTransform, this version works when the input tree is a
1583
 
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
1584
 
    unversioned files in the input tree.
1585
 
    """
1586
 
 
1587
 
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1588
 
        tree.lock_read()
1589
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1590
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1591
 
 
1592
 
    def canonical_path(self, path):
1593
 
        return path
1594
 
 
1595
 
    def tree_kind(self, trans_id):
1596
 
        path = self._tree_id_paths.get(trans_id)
1597
 
        if path is None:
1598
 
            raise NoSuchFile(None)
1599
 
        file_id = self._tree.path2id(path)
1600
 
        return self._tree.kind(file_id)
1601
 
 
1602
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1603
 
        """Set the mode of new file contents.
1604
 
        The mode_id is the existing file to get the mode from (often the same
1605
 
        as trans_id).  The operation is only performed if there's a mode match
1606
 
        according to typefunc.
1607
 
        """
1608
 
        # is it ok to ignore this?  probably
1609
 
        pass
1610
 
 
1611
 
    def iter_tree_children(self, parent_id):
1612
 
        """Iterate through the entry's tree children, if any"""
1613
 
        try:
1614
 
            path = self._tree_id_paths[parent_id]
1615
 
        except KeyError:
1616
 
            return
1617
 
        file_id = self.tree_file_id(parent_id)
1618
 
        if file_id is None:
1619
 
            return
1620
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1621
 
        children = getattr(entry, 'children', {})
1622
 
        for child in children:
1623
 
            childpath = joinpath(path, child)
1624
 
            yield self.trans_id_tree_path(childpath)
1625
 
 
1626
 
 
1627
 
class _PreviewTree(tree.Tree):
1628
 
    """Partial implementation of Tree to support show_diff_trees"""
1629
 
 
1630
 
    def __init__(self, transform):
1631
 
        self._transform = transform
1632
 
        self._final_paths = FinalPaths(transform)
1633
 
        self.__by_parent = None
1634
 
        self._parent_ids = []
1635
 
        self._all_children_cache = {}
1636
 
        self._path2trans_id_cache = {}
1637
 
        self._final_name_cache = {}
1638
 
 
1639
 
    def _changes(self, file_id):
1640
 
        for changes in self._transform.iter_changes():
1641
 
            if changes[0] == file_id:
1642
 
                return changes
1643
 
 
1644
 
    def _content_change(self, file_id):
1645
 
        """Return True if the content of this file changed"""
1646
 
        changes = self._changes(file_id)
1647
 
        # changes[2] is true if the file content changed.  See
1648
 
        # InterTree.iter_changes.
1649
 
        return (changes is not None and changes[2])
1650
 
 
1651
 
    def _get_repository(self):
1652
 
        repo = getattr(self._transform._tree, '_repository', None)
1653
 
        if repo is None:
1654
 
            repo = self._transform._tree.branch.repository
1655
 
        return repo
1656
 
 
1657
 
    def _iter_parent_trees(self):
1658
 
        for revision_id in self.get_parent_ids():
1659
 
            try:
1660
 
                yield self.revision_tree(revision_id)
1661
 
            except errors.NoSuchRevisionInTree:
1662
 
                yield self._get_repository().revision_tree(revision_id)
1663
 
 
1664
 
    def _get_file_revision(self, file_id, vf, tree_revision):
1665
 
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1666
 
                       self._iter_parent_trees()]
1667
 
        vf.add_lines((file_id, tree_revision), parent_keys,
1668
 
                     self.get_file(file_id).readlines())
1669
 
        repo = self._get_repository()
1670
 
        base_vf = repo.texts
1671
 
        if base_vf not in vf.fallback_versionedfiles:
1672
 
            vf.fallback_versionedfiles.append(base_vf)
1673
 
        return tree_revision
1674
 
 
1675
 
    def _stat_limbo_file(self, file_id):
1676
 
        trans_id = self._transform.trans_id_file_id(file_id)
1677
 
        name = self._transform._limbo_name(trans_id)
1678
 
        return os.lstat(name)
1679
 
 
1680
 
    @property
1681
 
    def _by_parent(self):
1682
 
        if self.__by_parent is None:
1683
 
            self.__by_parent = self._transform.by_parent()
1684
 
        return self.__by_parent
1685
 
 
1686
 
    def _comparison_data(self, entry, path):
1687
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1688
 
        if kind == 'missing':
1689
 
            kind = None
1690
 
            executable = False
1691
 
        else:
1692
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
1693
 
            executable = self.is_executable(file_id, path)
1694
 
        return kind, executable, None
1695
 
 
1696
 
    def lock_read(self):
1697
 
        # Perhaps in theory, this should lock the TreeTransform?
1698
 
        pass
1699
 
 
1700
 
    def unlock(self):
1701
 
        pass
1702
 
 
1703
 
    @property
1704
 
    def inventory(self):
1705
 
        """This Tree does not use inventory as its backing data."""
1706
 
        raise NotImplementedError(_PreviewTree.inventory)
1707
 
 
1708
 
    def get_root_id(self):
1709
 
        return self._transform.final_file_id(self._transform.root)
1710
 
 
1711
 
    def all_file_ids(self):
1712
 
        tree_ids = set(self._transform._tree.all_file_ids())
1713
 
        tree_ids.difference_update(self._transform.tree_file_id(t)
1714
 
                                   for t in self._transform._removed_id)
1715
 
        tree_ids.update(self._transform._new_id.values())
1716
 
        return tree_ids
1717
 
 
1718
 
    def __iter__(self):
1719
 
        return iter(self.all_file_ids())
1720
 
 
1721
 
    def _has_id(self, file_id, fallback_check):
1722
 
        if file_id in self._transform._r_new_id:
1723
 
            return True
1724
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1725
 
            trans_id in self._transform._removed_id]):
1726
 
            return False
1727
 
        else:
1728
 
            return fallback_check(file_id)
1729
 
 
1730
 
    def has_id(self, file_id):
1731
 
        return self._has_id(file_id, self._transform._tree.has_id)
1732
 
 
1733
 
    def has_or_had_id(self, file_id):
1734
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
1735
 
 
1736
 
    def _path2trans_id(self, path):
1737
 
        # We must not use None here, because that is a valid value to store.
1738
 
        trans_id = self._path2trans_id_cache.get(path, object)
1739
 
        if trans_id is not object:
1740
 
            return trans_id
1741
 
        segments = splitpath(path)
1742
 
        cur_parent = self._transform.root
1743
 
        for cur_segment in segments:
1744
 
            for child in self._all_children(cur_parent):
1745
 
                final_name = self._final_name_cache.get(child)
1746
 
                if final_name is None:
1747
 
                    final_name = self._transform.final_name(child)
1748
 
                    self._final_name_cache[child] = final_name
1749
 
                if final_name == cur_segment:
1750
 
                    cur_parent = child
1751
 
                    break
1752
 
            else:
1753
 
                self._path2trans_id_cache[path] = None
1754
 
                return None
1755
 
        self._path2trans_id_cache[path] = cur_parent
1756
 
        return cur_parent
1757
 
 
1758
 
    def path2id(self, path):
1759
 
        return self._transform.final_file_id(self._path2trans_id(path))
1760
 
 
1761
 
    def id2path(self, file_id):
1762
 
        trans_id = self._transform.trans_id_file_id(file_id)
1763
 
        try:
1764
 
            return self._final_paths._determine_path(trans_id)
1765
 
        except NoFinalPath:
1766
 
            raise errors.NoSuchId(self, file_id)
1767
 
 
1768
 
    def _all_children(self, trans_id):
1769
 
        children = self._all_children_cache.get(trans_id)
1770
 
        if children is not None:
1771
 
            return children
1772
 
        children = set(self._transform.iter_tree_children(trans_id))
1773
 
        # children in the _new_parent set are provided by _by_parent.
1774
 
        children.difference_update(self._transform._new_parent.keys())
1775
 
        children.update(self._by_parent.get(trans_id, []))
1776
 
        self._all_children_cache[trans_id] = children
1777
 
        return children
1778
 
 
1779
 
    def iter_children(self, file_id):
1780
 
        trans_id = self._transform.trans_id_file_id(file_id)
1781
 
        for child_trans_id in self._all_children(trans_id):
1782
 
            yield self._transform.final_file_id(child_trans_id)
1783
 
 
1784
 
    def extras(self):
1785
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
1786
 
                              in self._transform._tree.extras())
1787
 
        possible_extras.update(self._transform._new_contents)
1788
 
        possible_extras.update(self._transform._removed_id)
1789
 
        for trans_id in possible_extras:
1790
 
            if self._transform.final_file_id(trans_id) is None:
1791
 
                yield self._final_paths._determine_path(trans_id)
1792
 
 
1793
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None):
1794
 
        for trans_id, parent_file_id in ordered_entries:
1795
 
            file_id = self._transform.final_file_id(trans_id)
1796
 
            if file_id is None:
1797
 
                continue
1798
 
            if (specific_file_ids is not None
1799
 
                and file_id not in specific_file_ids):
1800
 
                continue
1801
 
            try:
1802
 
                kind = self._transform.final_kind(trans_id)
1803
 
            except NoSuchFile:
1804
 
                kind = self._transform._tree.stored_kind(file_id)
1805
 
            new_entry = inventory.make_entry(
1806
 
                kind,
1807
 
                self._transform.final_name(trans_id),
1808
 
                parent_file_id, file_id)
1809
 
            yield new_entry, trans_id
1810
 
 
1811
 
    def _list_files_by_dir(self):
1812
 
        todo = [ROOT_PARENT]
1813
 
        ordered_ids = []
1814
 
        while len(todo) > 0:
1815
 
            parent = todo.pop()
1816
 
            parent_file_id = self._transform.final_file_id(parent)
1817
 
            children = list(self._all_children(parent))
1818
 
            paths = dict(zip(children, self._final_paths.get_paths(children)))
1819
 
            children.sort(key=paths.get)
1820
 
            todo.extend(reversed(children))
1821
 
            for trans_id in children:
1822
 
                ordered_ids.append((trans_id, parent_file_id))
1823
 
        return ordered_ids
1824
 
 
1825
 
    def iter_entries_by_dir(self, specific_file_ids=None):
1826
 
        # This may not be a maximally efficient implementation, but it is
1827
 
        # reasonably straightforward.  An implementation that grafts the
1828
 
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1829
 
        # might be more efficient, but requires tricky inferences about stack
1830
 
        # position.
1831
 
        ordered_ids = self._list_files_by_dir()
1832
 
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1833
 
                                                      specific_file_ids):
1834
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1835
 
 
1836
 
    def _iter_entries_for_dir(self, dir_path):
1837
 
        """Return path, entry for items in a directory without recursing down."""
1838
 
        dir_file_id = self.path2id(dir_path)
1839
 
        ordered_ids = []
1840
 
        for file_id in self.iter_children(dir_file_id):
1841
 
            trans_id = self._transform.trans_id_file_id(file_id)
1842
 
            ordered_ids.append((trans_id, file_id))
1843
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1844
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1845
 
 
1846
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1847
 
        """See WorkingTree.list_files."""
1848
 
        # XXX This should behave like WorkingTree.list_files, but is really
1849
 
        # more like RevisionTree.list_files.
1850
 
        if recursive:
1851
 
            prefix = None
1852
 
            if from_dir:
1853
 
                prefix = from_dir + '/'
1854
 
            entries = self.iter_entries_by_dir()
1855
 
            for path, entry in entries:
1856
 
                if entry.name == '' and not include_root:
1857
 
                    continue
1858
 
                if prefix:
1859
 
                    if not path.startswith(prefix):
1860
 
                        continue
1861
 
                    path = path[len(prefix):]
1862
 
                yield path, 'V', entry.kind, entry.file_id, entry
1863
 
        else:
1864
 
            if from_dir is None and include_root is True:
1865
 
                root_entry = inventory.make_entry('directory', '',
1866
 
                    ROOT_PARENT, self.get_root_id())
1867
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1868
 
            entries = self._iter_entries_for_dir(from_dir or '')
1869
 
            for path, entry in entries:
1870
 
                yield path, 'V', entry.kind, entry.file_id, entry
1871
 
 
1872
 
    def kind(self, file_id):
1873
 
        trans_id = self._transform.trans_id_file_id(file_id)
1874
 
        return self._transform.final_kind(trans_id)
1875
 
 
1876
 
    def stored_kind(self, file_id):
1877
 
        trans_id = self._transform.trans_id_file_id(file_id)
1878
 
        try:
1879
 
            return self._transform._new_contents[trans_id]
1880
 
        except KeyError:
1881
 
            return self._transform._tree.stored_kind(file_id)
1882
 
 
1883
 
    def get_file_mtime(self, file_id, path=None):
1884
 
        """See Tree.get_file_mtime"""
1885
 
        if not self._content_change(file_id):
1886
 
            return self._transform._tree.get_file_mtime(file_id, path)
1887
 
        return self._stat_limbo_file(file_id).st_mtime
1888
 
 
1889
 
    def _file_size(self, entry, stat_value):
1890
 
        return self.get_file_size(entry.file_id)
1891
 
 
1892
 
    def get_file_size(self, file_id):
1893
 
        """See Tree.get_file_size"""
1894
 
        if self.kind(file_id) == 'file':
1895
 
            return self._transform._tree.get_file_size(file_id)
1896
 
        else:
1897
 
            return None
1898
 
 
1899
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1900
 
        trans_id = self._transform.trans_id_file_id(file_id)
1901
 
        kind = self._transform._new_contents.get(trans_id)
1902
 
        if kind is None:
1903
 
            return self._transform._tree.get_file_sha1(file_id)
1904
 
        if kind == 'file':
1905
 
            fileobj = self.get_file(file_id)
1906
 
            try:
1907
 
                return sha_file(fileobj)
1908
 
            finally:
1909
 
                fileobj.close()
1910
 
 
1911
 
    def is_executable(self, file_id, path=None):
1912
 
        if file_id is None:
1913
 
            return False
1914
 
        trans_id = self._transform.trans_id_file_id(file_id)
1915
 
        try:
1916
 
            return self._transform._new_executability[trans_id]
1917
 
        except KeyError:
1918
 
            try:
1919
 
                return self._transform._tree.is_executable(file_id, path)
1920
 
            except OSError, e:
1921
 
                if e.errno == errno.ENOENT:
1922
 
                    return False
1923
 
                raise
1924
 
            except errors.NoSuchId:
1925
 
                return False
1926
 
 
1927
 
    def path_content_summary(self, path):
1928
 
        trans_id = self._path2trans_id(path)
1929
 
        tt = self._transform
1930
 
        tree_path = tt._tree_id_paths.get(trans_id)
1931
 
        kind = tt._new_contents.get(trans_id)
1932
 
        if kind is None:
1933
 
            if tree_path is None or trans_id in tt._removed_contents:
1934
 
                return 'missing', None, None, None
1935
 
            summary = tt._tree.path_content_summary(tree_path)
1936
 
            kind, size, executable, link_or_sha1 = summary
1937
 
        else:
1938
 
            link_or_sha1 = None
1939
 
            limbo_name = tt._limbo_name(trans_id)
1940
 
            if trans_id in tt._new_reference_revision:
1941
 
                kind = 'tree-reference'
1942
 
            if kind == 'file':
1943
 
                statval = os.lstat(limbo_name)
1944
 
                size = statval.st_size
1945
 
                if not supports_executable():
1946
 
                    executable = None
1947
 
                else:
1948
 
                    executable = statval.st_mode & S_IEXEC
1949
 
            else:
1950
 
                size = None
1951
 
                executable = None
1952
 
            if kind == 'symlink':
1953
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1954
 
        if supports_executable():
1955
 
            executable = tt._new_executability.get(trans_id, executable)
1956
 
        return kind, size, executable, link_or_sha1
1957
 
 
1958
 
    def iter_changes(self, from_tree, include_unchanged=False,
1959
 
                      specific_files=None, pb=None, extra_trees=None,
1960
 
                      require_versioned=True, want_unversioned=False):
1961
 
        """See InterTree.iter_changes.
1962
 
 
1963
 
        This has a fast path that is only used when the from_tree matches
1964
 
        the transform tree, and no fancy options are supplied.
1965
 
        """
1966
 
        if (from_tree is not self._transform._tree or include_unchanged or
1967
 
            specific_files or want_unversioned):
1968
 
            return tree.InterTree(from_tree, self).iter_changes(
1969
 
                include_unchanged=include_unchanged,
1970
 
                specific_files=specific_files,
1971
 
                pb=pb,
1972
 
                extra_trees=extra_trees,
1973
 
                require_versioned=require_versioned,
1974
 
                want_unversioned=want_unversioned)
1975
 
        if want_unversioned:
1976
 
            raise ValueError('want_unversioned is not supported')
1977
 
        return self._transform.iter_changes()
1978
 
 
1979
 
    def get_file(self, file_id, path=None):
1980
 
        """See Tree.get_file"""
1981
 
        if not self._content_change(file_id):
1982
 
            return self._transform._tree.get_file(file_id, path)
1983
 
        trans_id = self._transform.trans_id_file_id(file_id)
1984
 
        name = self._transform._limbo_name(trans_id)
1985
 
        return open(name, 'rb')
1986
 
 
1987
 
    def get_file_with_stat(self, file_id, path=None):
1988
 
        return self.get_file(file_id, path), None
1989
 
 
1990
 
    def annotate_iter(self, file_id,
1991
 
                      default_revision=_mod_revision.CURRENT_REVISION):
1992
 
        changes = self._changes(file_id)
1993
 
        if changes is None:
1994
 
            get_old = True
1995
 
        else:
1996
 
            changed_content, versioned, kind = (changes[2], changes[3],
1997
 
                                                changes[6])
1998
 
            if kind[1] is None:
1999
 
                return None
2000
 
            get_old = (kind[0] == 'file' and versioned[0])
2001
 
        if get_old:
2002
 
            old_annotation = self._transform._tree.annotate_iter(file_id,
2003
 
                default_revision=default_revision)
2004
 
        else:
2005
 
            old_annotation = []
2006
 
        if changes is None:
2007
 
            return old_annotation
2008
 
        if not changed_content:
2009
 
            return old_annotation
2010
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2011
 
        #       doing, however it fails slightly because it doesn't know what
2012
 
        #       the *other* revision_id is, so it doesn't know how to give the
2013
 
        #       other as the origin for some lines, they all get
2014
 
        #       'default_revision'
2015
 
        #       It would be nice to be able to use the new Annotator based
2016
 
        #       approach, as well.
2017
 
        return annotate.reannotate([old_annotation],
2018
 
                                   self.get_file(file_id).readlines(),
2019
 
                                   default_revision)
2020
 
 
2021
 
    def get_symlink_target(self, file_id):
2022
 
        """See Tree.get_symlink_target"""
2023
 
        if not self._content_change(file_id):
2024
 
            return self._transform._tree.get_symlink_target(file_id)
2025
 
        trans_id = self._transform.trans_id_file_id(file_id)
2026
 
        name = self._transform._limbo_name(trans_id)
2027
 
        return osutils.readlink(name)
2028
 
 
2029
 
    def walkdirs(self, prefix=''):
2030
 
        pending = [self._transform.root]
2031
 
        while len(pending) > 0:
2032
 
            parent_id = pending.pop()
2033
 
            children = []
2034
 
            subdirs = []
2035
 
            prefix = prefix.rstrip('/')
2036
 
            parent_path = self._final_paths.get_path(parent_id)
2037
 
            parent_file_id = self._transform.final_file_id(parent_id)
2038
 
            for child_id in self._all_children(parent_id):
2039
 
                path_from_root = self._final_paths.get_path(child_id)
2040
 
                basename = self._transform.final_name(child_id)
2041
 
                file_id = self._transform.final_file_id(child_id)
2042
 
                try:
2043
 
                    kind = self._transform.final_kind(child_id)
2044
 
                    versioned_kind = kind
2045
 
                except NoSuchFile:
2046
 
                    kind = 'unknown'
2047
 
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2048
 
                if versioned_kind == 'directory':
2049
 
                    subdirs.append(child_id)
2050
 
                children.append((path_from_root, basename, kind, None,
2051
 
                                 file_id, versioned_kind))
2052
 
            children.sort()
2053
 
            if parent_path.startswith(prefix):
2054
 
                yield (parent_path, parent_file_id), children
2055
 
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2056
 
                                  reverse=True))
2057
 
 
2058
 
    def get_parent_ids(self):
2059
 
        return self._parent_ids
2060
 
 
2061
 
    def set_parent_ids(self, parent_ids):
2062
 
        self._parent_ids = parent_ids
2063
 
 
2064
 
    def get_revision_tree(self, revision_id):
2065
 
        return self._transform._tree.get_revision_tree(revision_id)
2066
 
 
2067
1066
 
2068
1067
def joinpath(parent, child):
2069
1068
    """Join tree-relative paths, handling the tree root specially"""
2085
1084
        self.transform = transform
2086
1085
 
2087
1086
    def _determine_path(self, trans_id):
2088
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1087
        if trans_id == self.transform.root:
2089
1088
            return ""
2090
1089
        name = self.transform.final_name(trans_id)
2091
1090
        parent_id = self.transform.final_parent(trans_id)
2100
1099
            self._known_paths[trans_id] = self._determine_path(trans_id)
2101
1100
        return self._known_paths[trans_id]
2102
1101
 
2103
 
    def get_paths(self, trans_ids):
2104
 
        return [(self.get_path(t), t) for t in trans_ids]
2105
 
 
2106
 
 
2107
 
 
2108
1102
def topology_sorted_ids(tree):
2109
1103
    """Determine the topological order of the ids in a tree"""
2110
1104
    file_ids = list(tree)
2112
1106
    return file_ids
2113
1107
 
2114
1108
 
2115
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2116
 
               delta_from_tree=False):
 
1109
def build_tree(tree, wt):
2117
1110
    """Create working tree for a branch, using a TreeTransform.
2118
 
 
 
1111
    
2119
1112
    This function should be used on empty trees, having a tree root at most.
2120
1113
    (see merge and revert functionality for working with existing trees)
2121
1114
 
2122
1115
    Existing files are handled like so:
2123
 
 
 
1116
    
2124
1117
    - Existing bzrdirs take precedence over creating new items.  They are
2125
1118
      created as '%s.diverted' % name.
2126
1119
    - Otherwise, if the content on disk matches the content we are building,
2127
1120
      it is silently replaced.
2128
1121
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2129
 
 
2130
 
    :param tree: The tree to convert wt into a copy of
2131
 
    :param wt: The working tree that files will be placed into
2132
 
    :param accelerator_tree: A tree which can be used for retrieving file
2133
 
        contents more quickly than tree itself, i.e. a workingtree.  tree
2134
 
        will be used for cases where accelerator_tree's content is different.
2135
 
    :param hardlink: If true, hard-link files to accelerator_tree, where
2136
 
        possible.  accelerator_tree must implement abspath, i.e. be a
2137
 
        working tree.
2138
 
    :param delta_from_tree: If true, build_tree may use the input Tree to
2139
 
        generate the inventory delta.
2140
1122
    """
2141
1123
    wt.lock_tree_write()
2142
1124
    try:
2143
1125
        tree.lock_read()
2144
1126
        try:
2145
 
            if accelerator_tree is not None:
2146
 
                accelerator_tree.lock_read()
2147
 
            try:
2148
 
                return _build_tree(tree, wt, accelerator_tree, hardlink,
2149
 
                                   delta_from_tree)
2150
 
            finally:
2151
 
                if accelerator_tree is not None:
2152
 
                    accelerator_tree.unlock()
 
1127
            return _build_tree(tree, wt)
2153
1128
        finally:
2154
1129
            tree.unlock()
2155
1130
    finally:
2156
1131
        wt.unlock()
2157
1132
 
2158
 
 
2159
 
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1133
def _build_tree(tree, wt):
2160
1134
    """See build_tree."""
2161
 
    for num, _unused in enumerate(wt.all_file_ids()):
2162
 
        if num > 0:  # more than just a root
2163
 
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2164
 
    existing_files = set()
2165
 
    for dir, files in wt.walkdirs():
2166
 
        existing_files.update(f[0] for f in files)
 
1135
    if len(wt.inventory) > 1:  # more than just a root
 
1136
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2167
1137
    file_trans_id = {}
2168
1138
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2169
1139
    pp = ProgressPhase("Build phase", 2, top_pb)
2170
1140
    if tree.inventory.root is not None:
2171
 
        # This is kind of a hack: we should be altering the root
2172
 
        # as part of the regular tree shape diff logic.
2173
 
        # The conditional test here is to avoid doing an
 
1141
        # this is kindof a hack: we should be altering the root 
 
1142
        # as partof the regular tree shape diff logic.
 
1143
        # the conditional test hereis to avoid doing an
2174
1144
        # expensive operation (flush) every time the root id
2175
1145
        # is set within the tree, nor setting the root and thus
2176
1146
        # marking the tree as dirty, because we use two different
2177
1147
        # idioms here: tree interfaces and inventory interfaces.
2178
 
        if wt.get_root_id() != tree.get_root_id():
2179
 
            wt.set_root_id(tree.get_root_id())
 
1148
        if wt.path2id('') != tree.inventory.root.file_id:
 
1149
            wt.set_root_id(tree.inventory.root.file_id)
2180
1150
            wt.flush()
2181
1151
    tt = TreeTransform(wt)
2182
1152
    divert = set()
2186
1156
            tt.trans_id_tree_file_id(wt.get_root_id())
2187
1157
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2188
1158
        try:
2189
 
            deferred_contents = []
2190
 
            num = 0
2191
 
            total = len(tree.inventory)
2192
 
            if delta_from_tree:
2193
 
                precomputed_delta = []
2194
 
            else:
2195
 
                precomputed_delta = None
2196
1159
            for num, (tree_path, entry) in \
2197
1160
                enumerate(tree.inventory.iter_entries_by_dir()):
2198
 
                pb.update("Building tree", num - len(deferred_contents), total)
 
1161
                pb.update("Building tree", num, len(tree.inventory))
2199
1162
                if entry.parent_id is None:
2200
1163
                    continue
2201
1164
                reparent = False
2202
1165
                file_id = entry.file_id
2203
 
                if delta_from_tree:
2204
 
                    precomputed_delta.append((None, tree_path, file_id, entry))
2205
 
                if tree_path in existing_files:
2206
 
                    target_path = wt.abspath(tree_path)
 
1166
                target_path = wt.abspath(tree_path)
 
1167
                try:
2207
1168
                    kind = file_kind(target_path)
 
1169
                except NoSuchFile:
 
1170
                    pass
 
1171
                else:
2208
1172
                    if kind == "directory":
2209
1173
                        try:
2210
1174
                            bzrdir.BzrDir.open(target_path)
2218
1182
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2219
1183
                        if kind == 'directory':
2220
1184
                            reparent = True
 
1185
                if entry.parent_id not in file_trans_id:
 
1186
                    raise AssertionError(
 
1187
                        'entry %s parent id %r is not in file_trans_id %r'
 
1188
                        % (entry, entry.parent_id, file_trans_id))
2221
1189
                parent_id = file_trans_id[entry.parent_id]
2222
 
                if entry.kind == 'file':
2223
 
                    # We *almost* replicate new_by_entry, so that we can defer
2224
 
                    # getting the file text, and get them all at once.
2225
 
                    trans_id = tt.create_path(entry.name, parent_id)
2226
 
                    file_trans_id[file_id] = trans_id
2227
 
                    tt.version_file(file_id, trans_id)
2228
 
                    executable = tree.is_executable(file_id, tree_path)
2229
 
                    if executable:
2230
 
                        tt.set_executability(executable, trans_id)
2231
 
                    trans_data = (trans_id, tree_path)
2232
 
                    deferred_contents.append((file_id, trans_data))
2233
 
                else:
2234
 
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2235
 
                                                          tree)
 
1190
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
1191
                                                      tree)
2236
1192
                if reparent:
2237
1193
                    new_trans_id = file_trans_id[file_id]
2238
1194
                    old_parent = tt.trans_id_tree_path(tree_path)
2239
1195
                    _reparent_children(tt, old_parent, new_trans_id)
2240
 
            offset = num + 1 - len(deferred_contents)
2241
 
            _create_files(tt, tree, deferred_contents, pb, offset,
2242
 
                          accelerator_tree, hardlink)
2243
1196
        finally:
2244
1197
            pb.finished()
2245
1198
        pp.next_phase()
2246
1199
        divert_trans = set(file_trans_id[f] for f in divert)
2247
1200
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2248
1201
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2249
 
        if len(raw_conflicts) > 0:
2250
 
            precomputed_delta = None
2251
1202
        conflicts = cook_conflicts(raw_conflicts, tt)
2252
1203
        for conflict in conflicts:
2253
1204
            warning(conflict)
2255
1206
            wt.add_conflicts(conflicts)
2256
1207
        except errors.UnsupportedOperation:
2257
1208
            pass
2258
 
        result = tt.apply(no_conflicts=True,
2259
 
                          precomputed_delta=precomputed_delta)
 
1209
        tt.apply()
2260
1210
    finally:
2261
1211
        tt.finalize()
2262
1212
        top_pb.finished()
2263
 
    return result
2264
 
 
2265
 
 
2266
 
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2267
 
                  hardlink):
2268
 
    total = len(desired_files) + offset
2269
 
    wt = tt._tree
2270
 
    if accelerator_tree is None:
2271
 
        new_desired_files = desired_files
2272
 
    else:
2273
 
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2274
 
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2275
 
                         in iter if not (c or e[0] != e[1]))
2276
 
        new_desired_files = []
2277
 
        count = 0
2278
 
        for file_id, (trans_id, tree_path) in desired_files:
2279
 
            accelerator_path = unchanged.get(file_id)
2280
 
            if accelerator_path is None:
2281
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
2282
 
                continue
2283
 
            pb.update('Adding file contents', count + offset, total)
2284
 
            if hardlink:
2285
 
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2286
 
                                   trans_id)
2287
 
            else:
2288
 
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2289
 
                if wt.supports_content_filtering():
2290
 
                    filters = wt._content_filter_stack(tree_path)
2291
 
                    contents = filtered_output_bytes(contents, filters,
2292
 
                        ContentFilterContext(tree_path, tree))
2293
 
                try:
2294
 
                    tt.create_file(contents, trans_id)
2295
 
                finally:
2296
 
                    try:
2297
 
                        contents.close()
2298
 
                    except AttributeError:
2299
 
                        # after filtering, contents may no longer be file-like
2300
 
                        pass
2301
 
            count += 1
2302
 
        offset += count
2303
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2304
 
            tree.iter_files_bytes(new_desired_files)):
2305
 
        if wt.supports_content_filtering():
2306
 
            filters = wt._content_filter_stack(tree_path)
2307
 
            contents = filtered_output_bytes(contents, filters,
2308
 
                ContentFilterContext(tree_path, tree))
2309
 
        tt.create_file(contents, trans_id)
2310
 
        pb.update('Adding file contents', count + offset, total)
2311
1213
 
2312
1214
 
2313
1215
def _reparent_children(tt, old_parent, new_parent):
2314
1216
    for child in tt.iter_tree_children(old_parent):
2315
1217
        tt.adjust_path(tt.final_name(child), new_parent, child)
2316
1218
 
2317
 
def _reparent_transform_children(tt, old_parent, new_parent):
2318
 
    by_parent = tt.by_parent()
2319
 
    for child in by_parent[old_parent]:
2320
 
        tt.adjust_path(tt.final_name(child), new_parent, child)
2321
 
    return by_parent[old_parent]
2322
1219
 
2323
1220
def _content_match(tree, entry, file_id, kind, target_path):
2324
1221
    if entry.kind != kind:
2338
1235
    new_conflicts = set()
2339
1236
    for c_type, conflict in ((c[0], c) for c in conflicts):
2340
1237
        # Anything but a 'duplicate' would indicate programmer error
2341
 
        if c_type != 'duplicate':
2342
 
            raise AssertionError(c_type)
 
1238
        assert c_type == 'duplicate', c_type
2343
1239
        # Now figure out which is new and which is old
2344
1240
        if tt.new_contents(conflict[1]):
2345
1241
            new_file = conflict[1]
2371
1267
    if kind == 'file':
2372
1268
        contents = tree.get_file(entry.file_id).readlines()
2373
1269
        executable = tree.is_executable(entry.file_id)
2374
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
1270
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2375
1271
                           executable)
2376
1272
    elif kind in ('directory', 'tree-reference'):
2377
1273
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2378
1274
        if kind == 'tree-reference':
2379
1275
            tt.set_tree_reference(entry.reference_revision, trans_id)
2380
 
        return trans_id
 
1276
        return trans_id 
2381
1277
    elif kind == 'symlink':
2382
1278
        target = tree.get_symlink_target(entry.file_id)
2383
1279
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2384
1280
    else:
2385
1281
        raise errors.BadFileKindError(name, kind)
2386
1282
 
2387
 
 
2388
 
@deprecated_function(deprecated_in((1, 9, 0)))
2389
1283
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2390
 
    """Create new file contents according to an inventory entry.
2391
 
 
2392
 
    DEPRECATED.  Use create_from_tree instead.
2393
 
    """
 
1284
    """Create new file contents according to an inventory entry."""
2394
1285
    if entry.kind == "file":
2395
1286
        if lines is None:
2396
1287
            lines = tree.get_file(entry.file_id).readlines()
2400
1291
    elif entry.kind == "directory":
2401
1292
        tt.create_directory(trans_id)
2402
1293
 
2403
 
 
2404
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2405
 
    """Create new file contents according to tree contents."""
2406
 
    kind = tree.kind(file_id)
2407
 
    if kind == 'directory':
2408
 
        tt.create_directory(trans_id)
2409
 
    elif kind == "file":
2410
 
        if bytes is None:
2411
 
            tree_file = tree.get_file(file_id)
2412
 
            try:
2413
 
                bytes = tree_file.readlines()
2414
 
            finally:
2415
 
                tree_file.close()
2416
 
        tt.create_file(bytes, trans_id)
2417
 
    elif kind == "symlink":
2418
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2419
 
    else:
2420
 
        raise AssertionError('Unknown kind %r' % kind)
2421
 
 
2422
 
 
2423
1294
def create_entry_executability(tt, entry, trans_id):
2424
1295
    """Set the executability of a trans_id according to an inventory entry"""
2425
1296
    if entry.kind == "file":
2426
1297
        tt.set_executability(entry.executable, trans_id)
2427
1298
 
2428
1299
 
 
1300
@deprecated_function(zero_fifteen)
 
1301
def find_interesting(working_tree, target_tree, filenames):
 
1302
    """Find the ids corresponding to specified filenames.
 
1303
    
 
1304
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
 
1305
    """
 
1306
    working_tree.lock_read()
 
1307
    try:
 
1308
        target_tree.lock_read()
 
1309
        try:
 
1310
            return working_tree.paths2ids(filenames, [target_tree])
 
1311
        finally:
 
1312
            target_tree.unlock()
 
1313
    finally:
 
1314
        working_tree.unlock()
 
1315
 
 
1316
 
 
1317
def change_entry(tt, file_id, working_tree, target_tree, 
 
1318
                 trans_id_file_id, backups, trans_id, by_parent):
 
1319
    """Replace a file_id's contents with those from a target tree."""
 
1320
    e_trans_id = trans_id_file_id(file_id)
 
1321
    entry = target_tree.inventory[file_id]
 
1322
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
 
1323
                                                           working_tree)
 
1324
    if contents_mod:
 
1325
        mode_id = e_trans_id
 
1326
        if has_contents:
 
1327
            if not backups:
 
1328
                tt.delete_contents(e_trans_id)
 
1329
            else:
 
1330
                parent_trans_id = trans_id_file_id(entry.parent_id)
 
1331
                backup_name = get_backup_name(entry, by_parent,
 
1332
                                              parent_trans_id, tt)
 
1333
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
 
1334
                tt.unversion_file(e_trans_id)
 
1335
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
 
1336
                tt.version_file(file_id, e_trans_id)
 
1337
                trans_id[file_id] = e_trans_id
 
1338
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
 
1339
        create_entry_executability(tt, entry, e_trans_id)
 
1340
 
 
1341
    elif meta_mod:
 
1342
        tt.set_executability(entry.executable, e_trans_id)
 
1343
    if tt.final_name(e_trans_id) != entry.name:
 
1344
        adjust_path  = True
 
1345
    else:
 
1346
        parent_id = tt.final_parent(e_trans_id)
 
1347
        parent_file_id = tt.final_file_id(parent_id)
 
1348
        if parent_file_id != entry.parent_id:
 
1349
            adjust_path = True
 
1350
        else:
 
1351
            adjust_path = False
 
1352
    if adjust_path:
 
1353
        parent_trans_id = trans_id_file_id(entry.parent_id)
 
1354
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
 
1355
 
 
1356
 
2429
1357
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2430
1358
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2431
1359
 
2462
1390
        if entry.kind != working_kind:
2463
1391
            contents_mod, meta_mod = True, False
2464
1392
        else:
2465
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
1393
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2466
1394
                                       working_tree)
2467
1395
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2468
1396
            cur_entry._forget_tree_state()
2476
1404
    tt = TreeTransform(working_tree, pb)
2477
1405
    try:
2478
1406
        pp = ProgressPhase("Revert phase", 3, pb)
2479
 
        conflicts, merge_modified = _prepare_revert_transform(
2480
 
            working_tree, target_tree, tt, filenames, backups, pp)
 
1407
        pp.next_phase()
 
1408
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1409
        try:
 
1410
            _alter_files(working_tree, target_tree, tt, child_pb,
 
1411
                         filenames, backups)
 
1412
        finally:
 
1413
            child_pb.finished()
 
1414
        pp.next_phase()
 
1415
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1416
        try:
 
1417
            raw_conflicts = resolve_conflicts(tt, child_pb)
 
1418
        finally:
 
1419
            child_pb.finished()
 
1420
        conflicts = cook_conflicts(raw_conflicts, tt)
2481
1421
        if change_reporter:
2482
1422
            change_reporter = delta._ChangeReporter(
2483
1423
                unversioned_filter=working_tree.is_ignored)
2484
 
            delta.report_changes(tt.iter_changes(), change_reporter)
 
1424
            delta.report_changes(tt._iter_changes(), change_reporter)
2485
1425
        for conflict in conflicts:
2486
1426
            warning(conflict)
2487
1427
        pp.next_phase()
2488
1428
        tt.apply()
2489
 
        working_tree.set_merge_modified(merge_modified)
 
1429
        working_tree.set_merge_modified({})
2490
1430
    finally:
2491
1431
        target_tree.unlock()
2492
1432
        tt.finalize()
2494
1434
    return conflicts
2495
1435
 
2496
1436
 
2497
 
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2498
 
                              backups, pp, basis_tree=None,
2499
 
                              merge_modified=None):
2500
 
    pp.next_phase()
2501
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2502
 
    try:
2503
 
        if merge_modified is None:
2504
 
            merge_modified = working_tree.merge_modified()
2505
 
        merge_modified = _alter_files(working_tree, target_tree, tt,
2506
 
                                      child_pb, filenames, backups,
2507
 
                                      merge_modified, basis_tree)
2508
 
    finally:
2509
 
        child_pb.finished()
2510
 
    pp.next_phase()
2511
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2512
 
    try:
2513
 
        raw_conflicts = resolve_conflicts(tt, child_pb,
2514
 
            lambda t, c: conflict_pass(t, c, target_tree))
2515
 
    finally:
2516
 
        child_pb.finished()
2517
 
    conflicts = cook_conflicts(raw_conflicts, tt)
2518
 
    return conflicts, merge_modified
2519
 
 
2520
 
 
2521
1437
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2522
 
                 backups, merge_modified, basis_tree=None):
2523
 
    if basis_tree is not None:
2524
 
        basis_tree.lock_read()
2525
 
    change_list = target_tree.iter_changes(working_tree,
 
1438
                 backups):
 
1439
    merge_modified = working_tree.merge_modified()
 
1440
    change_list = target_tree._iter_changes(working_tree,
2526
1441
        specific_files=specific_files, pb=pb)
2527
 
    if target_tree.get_root_id() is None:
 
1442
    if target_tree.inventory.root is None:
2528
1443
        skip_root = True
2529
1444
    else:
2530
1445
        skip_root = False
 
1446
    basis_tree = None
2531
1447
    try:
2532
 
        deferred_files = []
2533
1448
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2534
1449
                kind, executable) in enumerate(change_list):
2535
1450
            if skip_root and file_id[0] is not None and parent[0] is None:
2541
1456
                if kind[0] == 'file' and (backups or kind[1] is None):
2542
1457
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2543
1458
                    if merge_modified.get(file_id) != wt_sha1:
2544
 
                        # acquire the basis tree lazily to prevent the
2545
 
                        # expense of accessing it when it's not needed ?
2546
 
                        # (Guessing, RBC, 200702)
 
1459
                        # acquire the basis tree lazyily to prevent the expense
 
1460
                        # of accessing it when its not needed ? (Guessing, RBC,
 
1461
                        # 200702)
2547
1462
                        if basis_tree is None:
2548
1463
                            basis_tree = working_tree.basis_tree()
2549
1464
                            basis_tree.lock_read()
2569
1484
                        # contents
2570
1485
                        mode_id = trans_id
2571
1486
                        trans_id = new_trans_id
2572
 
                if kind[1] in ('directory', 'tree-reference'):
 
1487
                if kind[1] == 'directory':
2573
1488
                    tt.create_directory(trans_id)
2574
 
                    if kind[1] == 'tree-reference':
2575
 
                        revision = target_tree.get_reference_revision(file_id,
2576
 
                                                                      path[1])
2577
 
                        tt.set_tree_reference(revision, trans_id)
2578
1489
                elif kind[1] == 'symlink':
2579
1490
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2580
1491
                                      trans_id)
2581
1492
                elif kind[1] == 'file':
2582
 
                    deferred_files.append((file_id, (trans_id, mode_id)))
2583
 
                    if basis_tree is None:
2584
 
                        basis_tree = working_tree.basis_tree()
2585
 
                        basis_tree.lock_read()
2586
 
                    new_sha1 = target_tree.get_file_sha1(file_id)
2587
 
                    if (file_id in basis_tree and new_sha1 ==
2588
 
                        basis_tree.get_file_sha1(file_id)):
2589
 
                        if file_id in merge_modified:
2590
 
                            del merge_modified[file_id]
2591
 
                    else:
2592
 
                        merge_modified[file_id] = new_sha1
2593
 
 
 
1493
                    tt.create_file(target_tree.get_file_lines(file_id),
 
1494
                                   trans_id, mode_id)
2594
1495
                    # preserve the execute bit when backing up
2595
1496
                    if keep_content and executable[0] == executable[1]:
2596
1497
                        tt.set_executability(executable[1], trans_id)
2597
 
                elif kind[1] is not None:
2598
 
                    raise AssertionError(kind[1])
 
1498
                else:
 
1499
                    assert kind[1] is None
2599
1500
            if versioned == (False, True):
2600
1501
                tt.version_file(file_id, trans_id)
2601
1502
            if versioned == (True, False):
2602
1503
                tt.unversion_file(trans_id)
2603
 
            if (name[1] is not None and
 
1504
            if (name[1] is not None and 
2604
1505
                (name[0] != name[1] or parent[0] != parent[1])):
2605
 
                if name[1] == '' and parent[1] is None:
2606
 
                    parent_trans = ROOT_PARENT
2607
 
                else:
2608
 
                    parent_trans = tt.trans_id_file_id(parent[1])
2609
 
                tt.adjust_path(name[1], parent_trans, trans_id)
 
1506
                tt.adjust_path(
 
1507
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
2610
1508
            if executable[0] != executable[1] and kind[1] == "file":
2611
1509
                tt.set_executability(executable[1], trans_id)
2612
 
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2613
 
            deferred_files):
2614
 
            tt.create_file(bytes, trans_id, mode_id)
2615
1510
    finally:
2616
1511
        if basis_tree is not None:
2617
1512
            basis_tree.unlock()
2618
 
    return merge_modified
2619
1513
 
2620
1514
 
2621
1515
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2635
1529
        pb.clear()
2636
1530
 
2637
1531
 
2638
 
def conflict_pass(tt, conflicts, path_tree=None):
2639
 
    """Resolve some classes of conflicts.
2640
 
 
2641
 
    :param tt: The transform to resolve conflicts in
2642
 
    :param conflicts: The conflicts to resolve
2643
 
    :param path_tree: A Tree to get supplemental paths from
2644
 
    """
 
1532
def conflict_pass(tt, conflicts):
 
1533
    """Resolve some classes of conflicts."""
2645
1534
    new_conflicts = set()
2646
1535
    for c_type, conflict in ((c[0], c) for c in conflicts):
2647
1536
        if c_type == 'duplicate id':
2650
1539
                               conflict[1], conflict[2], ))
2651
1540
        elif c_type == 'duplicate':
2652
1541
            # files that were renamed take precedence
 
1542
            new_name = tt.final_name(conflict[1])+'.moved'
2653
1543
            final_parent = tt.final_parent(conflict[1])
2654
1544
            if tt.path_changed(conflict[1]):
2655
 
                existing_file, new_file = conflict[2], conflict[1]
 
1545
                tt.adjust_path(new_name, final_parent, conflict[2])
 
1546
                new_conflicts.add((c_type, 'Moved existing file to', 
 
1547
                                   conflict[2], conflict[1]))
2656
1548
            else:
2657
 
                existing_file, new_file = conflict[1], conflict[2]
2658
 
            new_name = tt.final_name(existing_file)+'.moved'
2659
 
            tt.adjust_path(new_name, final_parent, existing_file)
2660
 
            new_conflicts.add((c_type, 'Moved existing file to',
2661
 
                               existing_file, new_file))
 
1549
                tt.adjust_path(new_name, final_parent, conflict[1])
 
1550
                new_conflicts.add((c_type, 'Moved existing file to', 
 
1551
                                  conflict[1], conflict[2]))
2662
1552
        elif c_type == 'parent loop':
2663
1553
            # break the loop by undoing one of the ops that caused the loop
2664
1554
            cur = conflict[1]
2667
1557
            new_conflicts.add((c_type, 'Cancelled move', cur,
2668
1558
                               tt.final_parent(cur),))
2669
1559
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2670
 
 
 
1560
            
2671
1561
        elif c_type == 'missing parent':
2672
1562
            trans_id = conflict[1]
2673
1563
            try:
2674
1564
                tt.cancel_deletion(trans_id)
2675
 
                new_conflicts.add(('deleting parent', 'Not deleting',
 
1565
                new_conflicts.add(('deleting parent', 'Not deleting', 
2676
1566
                                   trans_id))
2677
1567
            except KeyError:
2678
 
                create = True
2679
 
                try:
2680
 
                    tt.final_name(trans_id)
2681
 
                except NoFinalPath:
2682
 
                    if path_tree is not None:
2683
 
                        file_id = tt.final_file_id(trans_id)
2684
 
                        if file_id is None:
2685
 
                            file_id = tt.inactive_file_id(trans_id)
2686
 
                        entry = path_tree.inventory[file_id]
2687
 
                        # special-case the other tree root (move its
2688
 
                        # children to current root)
2689
 
                        if entry.parent_id is None:
2690
 
                            create=False
2691
 
                            moved = _reparent_transform_children(
2692
 
                                tt, trans_id, tt.root)
2693
 
                            for child in moved:
2694
 
                                new_conflicts.add((c_type, 'Moved to root',
2695
 
                                                   child))
2696
 
                        else:
2697
 
                            parent_trans_id = tt.trans_id_file_id(
2698
 
                                entry.parent_id)
2699
 
                            tt.adjust_path(entry.name, parent_trans_id,
2700
 
                                           trans_id)
2701
 
                if create:
2702
 
                    tt.create_directory(trans_id)
2703
 
                    new_conflicts.add((c_type, 'Created directory', trans_id))
 
1568
                tt.create_directory(trans_id)
 
1569
                new_conflicts.add((c_type, 'Created directory', trans_id))
2704
1570
        elif c_type == 'unversioned parent':
2705
 
            file_id = tt.inactive_file_id(conflict[1])
2706
 
            # special-case the other tree root (move its children instead)
2707
 
            if path_tree and file_id in path_tree:
2708
 
                if path_tree.inventory[file_id].parent_id is None:
2709
 
                    continue
2710
 
            tt.version_file(file_id, conflict[1])
 
1571
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
2711
1572
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2712
 
        elif c_type == 'non-directory parent':
2713
 
            parent_id = conflict[1]
2714
 
            parent_parent = tt.final_parent(parent_id)
2715
 
            parent_name = tt.final_name(parent_id)
2716
 
            parent_file_id = tt.final_file_id(parent_id)
2717
 
            new_parent_id = tt.new_directory(parent_name + '.new',
2718
 
                parent_parent, parent_file_id)
2719
 
            _reparent_transform_children(tt, parent_id, new_parent_id)
2720
 
            if parent_file_id is not None:
2721
 
                tt.unversion_file(parent_id)
2722
 
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
2723
 
        elif c_type == 'versioning no contents':
2724
 
            tt.cancel_versioning(conflict[1])
2725
1573
    return new_conflicts
2726
1574
 
2727
1575
 
2743
1591
        if len(conflict) == 3:
2744
1592
            yield Conflict.factory(c_type, action=action, path=modified_path,
2745
1593
                                     file_id=modified_id)
2746
 
 
 
1594
             
2747
1595
        else:
2748
1596
            conflicting_path = fp.get_path(conflict[3])
2749
1597
            conflicting_id = tt.final_file_id(conflict[3])
2750
1598
            yield Conflict.factory(c_type, action=action, path=modified_path,
2751
 
                                   file_id=modified_id,
 
1599
                                   file_id=modified_id, 
2752
1600
                                   conflict_path=conflicting_path,
2753
1601
                                   conflict_file_id=conflicting_id)
2754
 
 
2755
 
 
2756
 
class _FileMover(object):
2757
 
    """Moves and deletes files for TreeTransform, tracking operations"""
2758
 
 
2759
 
    def __init__(self):
2760
 
        self.past_renames = []
2761
 
        self.pending_deletions = []
2762
 
 
2763
 
    def rename(self, from_, to):
2764
 
        """Rename a file from one path to another.  Functions like os.rename"""
2765
 
        try:
2766
 
            os.rename(from_, to)
2767
 
        except OSError, e:
2768
 
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2769
 
                raise errors.FileExists(to, str(e))
2770
 
            raise
2771
 
        self.past_renames.append((from_, to))
2772
 
 
2773
 
    def pre_delete(self, from_, to):
2774
 
        """Rename a file out of the way and mark it for deletion.
2775
 
 
2776
 
        Unlike os.unlink, this works equally well for files and directories.
2777
 
        :param from_: The current file path
2778
 
        :param to: A temporary path for the file
2779
 
        """
2780
 
        self.rename(from_, to)
2781
 
        self.pending_deletions.append(to)
2782
 
 
2783
 
    def rollback(self):
2784
 
        """Reverse all renames that have been performed"""
2785
 
        for from_, to in reversed(self.past_renames):
2786
 
            os.rename(to, from_)
2787
 
        # after rollback, don't reuse _FileMover
2788
 
        past_renames = None
2789
 
        pending_deletions = None
2790
 
 
2791
 
    def apply_deletions(self):
2792
 
        """Apply all marked deletions"""
2793
 
        for path in self.pending_deletions:
2794
 
            delete_any(path)
2795
 
        # after apply_deletions, don't reuse _FileMover
2796
 
        past_renames = None
2797
 
        pending_deletions = None