/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-10-16 00:10:26 UTC
  • mfrom: (4711.2.2 mbp-deprecation)
  • Revision ID: pqm@pqm.ubuntu.com-20091016001026-ynt6ehpic8bzlrkz
(mbp) Remove deprecated CLIUIFactory

Show diffs side-by-side

added added

removed removed

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