/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Neil Martinsen-Burrell
  • Date: 2009-12-11 00:00:04 UTC
  • mto: (4892.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4893.
  • Revision ID: nmb@wartburg.edu-20091211000004-zwb6gatjrsig4q1g
Fixes from Vicent and Martins reviews

Show diffs side-by-side

added added

removed removed

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