/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

(andrew) Fix tracebacks when receiving error responses to
        BzrDirFormat.initialize* RPCs.

Show diffs side-by-side

added added

removed removed

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