← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Aaron Bentley
  • Date: 2006-06-21 14:30:57 UTC
  • mfrom: (1801.1.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 1803.
  • Revision ID: abentley@panoramicfeedback.com-20060621143057-776e4b8d707e430e
Install benchmarks. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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