~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
import os
18
18
import errno
19
19
from stat import S_ISREG, S_IEXEC
20
 
import time
21
20
 
22
 
from bzrlib import (
23
 
    errors,
24
 
    lazy_import,
25
 
    registry,
26
 
    trace,
27
 
    tree,
28
 
    )
29
 
lazy_import.lazy_import(globals(), """
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
30
23
from bzrlib import (
31
24
    annotate,
32
 
    bencode,
33
25
    bzrdir,
34
 
    commit,
35
 
    conflicts,
36
26
    delta,
37
27
    errors,
38
28
    inventory,
39
29
    multiparent,
40
30
    osutils,
41
31
    revision as _mod_revision,
42
 
    ui,
43
 
    urlutils,
44
32
    )
 
33
from bzrlib.util import bencode
45
34
""")
46
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
47
 
                           ReusingTransform, CantMoveRoot,
 
36
                           ReusingTransform, NotVersionedError, CantMoveRoot,
48
37
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
49
38
                           UnableCreateSymlink)
50
39
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
 
40
from bzrlib.inventory import InventoryEntry
51
41
from bzrlib.osutils import (
52
42
    delete_any,
53
43
    file_kind,
54
44
    has_symlinks,
 
45
    lexists,
55
46
    pathjoin,
56
47
    sha_file,
57
48
    splitpath,
58
49
    supports_executable,
59
 
    )
60
 
from bzrlib.progress import ProgressPhase
 
50
)
 
51
from bzrlib.progress import DummyProgress, ProgressPhase
61
52
from bzrlib.symbol_versioning import (
62
 
    deprecated_function,
63
 
    deprecated_in,
64
 
    deprecated_method,
65
 
    )
 
53
        deprecated_function,
 
54
        deprecated_in,
 
55
        )
 
56
from bzrlib.trace import mutter, warning
 
57
from bzrlib import tree
 
58
import bzrlib.ui
 
59
import bzrlib.urlutils as urlutils
66
60
 
67
61
 
68
62
ROOT_PARENT = "root-parent"
69
63
 
 
64
 
70
65
def unique_add(map, key, value):
71
66
    if key in map:
72
67
        raise DuplicateKey(key=key)
73
68
    map[key] = value
74
69
 
75
70
 
76
 
 
77
71
class _TransformResults(object):
78
72
    def __init__(self, modified_paths, rename_count):
79
73
        object.__init__(self)
82
76
 
83
77
 
84
78
class TreeTransformBase(object):
85
 
    """The base class for TreeTransform and its kin."""
 
79
    """The base class for TreeTransform and TreeTransformBase"""
86
80
 
87
 
    def __init__(self, tree, pb=None,
 
81
    def __init__(self, tree, limbodir, pb=DummyProgress(),
88
82
                 case_sensitive=True):
89
83
        """Constructor.
90
84
 
91
85
        :param tree: The tree that will be transformed, but not necessarily
92
86
            the output tree.
93
 
        :param pb: ignored
 
87
        :param limbodir: A directory where new files can be stored until
 
88
            they are installed in their proper places
 
89
        :param pb: A ProgressBar indicating how much progress is being made
94
90
        :param case_sensitive: If True, the target of the transform is
95
91
            case sensitive, not just case preserving.
96
92
        """
97
93
        object.__init__(self)
98
94
        self._tree = tree
 
95
        self._limbodir = limbodir
 
96
        self._deletiondir = None
99
97
        self._id_number = 0
100
98
        # mapping of trans_id -> new basename
101
99
        self._new_name = {}
103
101
        self._new_parent = {}
104
102
        # mapping of trans_id with new contents -> new file_kind
105
103
        self._new_contents = {}
106
 
        # mapping of trans_id => (sha1 of content, stat_value)
107
 
        self._observed_sha1s = {}
 
104
        # A mapping of transform ids to their limbo filename
 
105
        self._limbo_files = {}
 
106
        # A mapping of transform ids to a set of the transform ids of children
 
107
        # that their limbo directory has
 
108
        self._limbo_children = {}
 
109
        # Map transform ids to maps of child filename to child transform id
 
110
        self._limbo_children_names = {}
 
111
        # List of transform ids that need to be renamed from limbo into place
 
112
        self._needs_rename = set()
108
113
        # Set of trans_ids whose contents will be removed
109
114
        self._removed_contents = set()
110
115
        # Mapping of trans_id -> new execute-bit value
123
128
        self._tree_path_ids = {}
124
129
        # Mapping trans_id -> path in old tree
125
130
        self._tree_id_paths = {}
 
131
        # Cache of realpath results, to speed up canonical_path
 
132
        self._realpaths = {}
 
133
        # Cache of relpath results, to speed up canonical_path
 
134
        self._relpaths = {}
126
135
        # The trans_id that will be used as the tree root
127
136
        root_id = tree.get_root_id()
128
137
        if root_id is not None:
129
138
            self._new_root = self.trans_id_tree_file_id(root_id)
130
139
        else:
131
140
            self._new_root = None
132
 
        # Indicator of whether the transform has been applied
 
141
        # Indictor of whether the transform has been applied
133
142
        self._done = False
134
143
        # A progress bar
135
144
        self._pb = pb
138
147
        # A counter of how many files have been renamed
139
148
        self.rename_count = 0
140
149
 
141
 
    def __enter__(self):
142
 
        """Support Context Manager API."""
143
 
        return self
144
 
 
145
 
    def __exit__(self, exc_type, exc_val, exc_tb):
146
 
        """Support Context Manager API."""
147
 
        self.finalize()
148
 
 
149
 
    def finalize(self):
150
 
        """Release the working tree lock, if held.
151
 
 
152
 
        This is required if apply has not been invoked, but can be invoked
153
 
        even after apply.
154
 
        """
155
 
        if self._tree is None:
156
 
            return
157
 
        self._tree.unlock()
158
 
        self._tree = None
159
 
 
160
150
    def __get_root(self):
161
151
        return self._new_root
162
152
 
163
153
    root = property(__get_root)
164
154
 
 
155
    def finalize(self):
 
156
        """Release the working tree lock, if held, clean up limbo dir.
 
157
 
 
158
        This is required if apply has not been invoked, but can be invoked
 
159
        even after apply.
 
160
        """
 
161
        if self._tree is None:
 
162
            return
 
163
        try:
 
164
            entries = [(self._limbo_name(t), t, k) for t, k in
 
165
                       self._new_contents.iteritems()]
 
166
            entries.sort(reverse=True)
 
167
            for path, trans_id, kind in entries:
 
168
                if kind == "directory":
 
169
                    os.rmdir(path)
 
170
                else:
 
171
                    os.unlink(path)
 
172
            try:
 
173
                os.rmdir(self._limbodir)
 
174
            except OSError:
 
175
                # We don't especially care *why* the dir is immortal.
 
176
                raise ImmortalLimbo(self._limbodir)
 
177
            try:
 
178
                if self._deletiondir is not None:
 
179
                    os.rmdir(self._deletiondir)
 
180
            except OSError:
 
181
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
182
        finally:
 
183
            self._tree.unlock()
 
184
            self._tree = None
 
185
 
165
186
    def _assign_id(self):
166
187
        """Produce a new tranform id"""
167
188
        new_id = "new-%s" % self._id_number
177
198
 
178
199
    def adjust_path(self, name, parent, trans_id):
179
200
        """Change the path that is assigned to a transaction id."""
180
 
        if parent is None:
181
 
            raise ValueError("Parent trans-id may not be None")
182
201
        if trans_id == self._new_root:
183
202
            raise CantMoveRoot
 
203
        previous_parent = self._new_parent.get(trans_id)
 
204
        previous_name = self._new_name.get(trans_id)
184
205
        self._new_name[trans_id] = name
185
206
        self._new_parent[trans_id] = parent
 
207
        if parent == ROOT_PARENT:
 
208
            if self._new_root is not None:
 
209
                raise ValueError("Cannot have multiple roots.")
 
210
            self._new_root = trans_id
 
211
        if (trans_id in self._limbo_files and
 
212
            trans_id not in self._needs_rename):
 
213
            self._rename_in_limbo([trans_id])
 
214
            self._limbo_children[previous_parent].remove(trans_id)
 
215
            del self._limbo_children_names[previous_parent][previous_name]
 
216
 
 
217
    def _rename_in_limbo(self, trans_ids):
 
218
        """Fix limbo names so that the right final path is produced.
 
219
 
 
220
        This means we outsmarted ourselves-- we tried to avoid renaming
 
221
        these files later by creating them with their final names in their
 
222
        final parents.  But now the previous name or parent is no longer
 
223
        suitable, so we have to rename them.
 
224
 
 
225
        Even for trans_ids that have no new contents, we must remove their
 
226
        entries from _limbo_files, because they are now stale.
 
227
        """
 
228
        for trans_id in trans_ids:
 
229
            old_path = self._limbo_files.pop(trans_id)
 
230
            if trans_id not in self._new_contents:
 
231
                continue
 
232
            new_path = self._limbo_name(trans_id)
 
233
            os.rename(old_path, new_path)
186
234
 
187
235
    def adjust_root_path(self, name, parent):
188
236
        """Emulate moving the root by moving all children, instead.
216
264
        self.version_file(old_root_file_id, old_root)
217
265
        self.unversion_file(self._new_root)
218
266
 
219
 
    def fixup_new_roots(self):
220
 
        """Reinterpret requests to change the root directory
221
 
 
222
 
        Instead of creating a root directory, or moving an existing directory,
223
 
        all the attributes and children of the new root are applied to the
224
 
        existing root directory.
225
 
 
226
 
        This means that the old root trans-id becomes obsolete, so it is
227
 
        recommended only to invoke this after the root trans-id has become
228
 
        irrelevant.
229
 
 
230
 
        """
231
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
232
 
                     ROOT_PARENT]
233
 
        if len(new_roots) < 1:
234
 
            return
235
 
        if len(new_roots) != 1:
236
 
            raise ValueError('A tree cannot have two roots!')
237
 
        if self._new_root is None:
238
 
            self._new_root = new_roots[0]
239
 
            return
240
 
        old_new_root = new_roots[0]
241
 
        # unversion the new root's directory.
242
 
        if self.final_kind(self._new_root) is None:
243
 
            file_id = self.final_file_id(old_new_root)
244
 
        else:
245
 
            file_id = self.final_file_id(self._new_root)
246
 
        if old_new_root in self._new_id:
247
 
            self.cancel_versioning(old_new_root)
248
 
        else:
249
 
            self.unversion_file(old_new_root)
250
 
        # if, at this stage, root still has an old file_id, zap it so we can
251
 
        # stick a new one in.
252
 
        if (self.tree_file_id(self._new_root) is not None and
253
 
            self._new_root not in self._removed_id):
254
 
            self.unversion_file(self._new_root)
255
 
        if file_id is not None:
256
 
            self.version_file(file_id, self._new_root)
257
 
 
258
 
        # Now move children of new root into old root directory.
259
 
        # Ensure all children are registered with the transaction, but don't
260
 
        # use directly-- some tree children have new parents
261
 
        list(self.iter_tree_children(old_new_root))
262
 
        # Move all children of new root into old root directory.
263
 
        for child in self.by_parent().get(old_new_root, []):
264
 
            self.adjust_path(self.final_name(child), self._new_root, child)
265
 
 
266
 
        # Ensure old_new_root has no directory.
267
 
        if old_new_root in self._new_contents:
268
 
            self.cancel_creation(old_new_root)
269
 
        else:
270
 
            self.delete_contents(old_new_root)
271
 
 
272
 
        # prevent deletion of root directory.
273
 
        if self._new_root in self._removed_contents:
274
 
            self.cancel_deletion(self._new_root)
275
 
 
276
 
        # destroy path info for old_new_root.
277
 
        del self._new_parent[old_new_root]
278
 
        del self._new_name[old_new_root]
279
 
 
280
267
    def trans_id_tree_file_id(self, inventory_id):
281
268
        """Determine the transaction id of a working tree file.
282
269
 
311
298
            else:
312
299
                return self.trans_id_tree_file_id(file_id)
313
300
 
 
301
    def canonical_path(self, path):
 
302
        """Get the canonical tree-relative path"""
 
303
        # don't follow final symlinks
 
304
        abs = self._tree.abspath(path)
 
305
        if abs in self._relpaths:
 
306
            return self._relpaths[abs]
 
307
        dirname, basename = os.path.split(abs)
 
308
        if dirname not in self._realpaths:
 
309
            self._realpaths[dirname] = os.path.realpath(dirname)
 
310
        dirname = self._realpaths[dirname]
 
311
        abs = pathjoin(dirname, basename)
 
312
        if dirname in self._relpaths:
 
313
            relpath = pathjoin(self._relpaths[dirname], basename)
 
314
            relpath = relpath.rstrip('/\\')
 
315
        else:
 
316
            relpath = self._tree.relpath(abs)
 
317
        self._relpaths[abs] = relpath
 
318
        return relpath
 
319
 
314
320
    def trans_id_tree_path(self, path):
315
321
        """Determine (and maybe set) the transaction ID for a tree path."""
316
322
        path = self.canonical_path(path)
326
332
            return ROOT_PARENT
327
333
        return self.trans_id_tree_path(os.path.dirname(path))
328
334
 
 
335
    def create_file(self, contents, trans_id, mode_id=None):
 
336
        """Schedule creation of a new file.
 
337
 
 
338
        See also new_file.
 
339
 
 
340
        Contents is an iterator of strings, all of which will be written
 
341
        to the target destination.
 
342
 
 
343
        New file takes the permissions of any existing file with that id,
 
344
        unless mode_id is specified.
 
345
        """
 
346
        name = self._limbo_name(trans_id)
 
347
        f = open(name, 'wb')
 
348
        try:
 
349
            try:
 
350
                unique_add(self._new_contents, trans_id, 'file')
 
351
            except:
 
352
                # Clean up the file, it never got registered so
 
353
                # TreeTransform.finalize() won't clean it up.
 
354
                f.close()
 
355
                os.unlink(name)
 
356
                raise
 
357
 
 
358
            f.writelines(contents)
 
359
        finally:
 
360
            f.close()
 
361
        self._set_mode(trans_id, mode_id, S_ISREG)
 
362
 
 
363
    def _set_mode(self, trans_id, mode_id, typefunc):
 
364
        """Set the mode of new file contents.
 
365
        The mode_id is the existing file to get the mode from (often the same
 
366
        as trans_id).  The operation is only performed if there's a mode match
 
367
        according to typefunc.
 
368
        """
 
369
        if mode_id is None:
 
370
            mode_id = trans_id
 
371
        try:
 
372
            old_path = self._tree_id_paths[mode_id]
 
373
        except KeyError:
 
374
            return
 
375
        try:
 
376
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
377
        except OSError, e:
 
378
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
379
                # Either old_path doesn't exist, or the parent of the
 
380
                # target is not a directory (but will be one eventually)
 
381
                # Either way, we know it doesn't exist *right now*
 
382
                # See also bug #248448
 
383
                return
 
384
            else:
 
385
                raise
 
386
        if typefunc(mode):
 
387
            os.chmod(self._limbo_name(trans_id), mode)
 
388
 
 
389
    def create_hardlink(self, path, trans_id):
 
390
        """Schedule creation of a hard link"""
 
391
        name = self._limbo_name(trans_id)
 
392
        try:
 
393
            os.link(path, name)
 
394
        except OSError, e:
 
395
            if e.errno != errno.EPERM:
 
396
                raise
 
397
            raise errors.HardLinkNotSupported(path)
 
398
        try:
 
399
            unique_add(self._new_contents, trans_id, 'file')
 
400
        except:
 
401
            # Clean up the file, it never got registered so
 
402
            # TreeTransform.finalize() won't clean it up.
 
403
            os.unlink(name)
 
404
            raise
 
405
 
 
406
    def create_directory(self, trans_id):
 
407
        """Schedule creation of a new directory.
 
408
 
 
409
        See also new_directory.
 
410
        """
 
411
        os.mkdir(self._limbo_name(trans_id))
 
412
        unique_add(self._new_contents, trans_id, 'directory')
 
413
 
 
414
    def create_symlink(self, target, trans_id):
 
415
        """Schedule creation of a new symbolic link.
 
416
 
 
417
        target is a bytestring.
 
418
        See also new_symlink.
 
419
        """
 
420
        if has_symlinks():
 
421
            os.symlink(target, self._limbo_name(trans_id))
 
422
            unique_add(self._new_contents, trans_id, 'symlink')
 
423
        else:
 
424
            try:
 
425
                path = FinalPaths(self).get_path(trans_id)
 
426
            except KeyError:
 
427
                path = None
 
428
            raise UnableCreateSymlink(path=path)
 
429
 
 
430
    def cancel_creation(self, trans_id):
 
431
        """Cancel the creation of new file contents."""
 
432
        del self._new_contents[trans_id]
 
433
        children = self._limbo_children.get(trans_id)
 
434
        # if this is a limbo directory with children, move them before removing
 
435
        # the directory
 
436
        if children is not None:
 
437
            self._rename_in_limbo(children)
 
438
            del self._limbo_children[trans_id]
 
439
            del self._limbo_children_names[trans_id]
 
440
        delete_any(self._limbo_name(trans_id))
 
441
 
329
442
    def delete_contents(self, trans_id):
330
443
        """Schedule the contents of a path entry for deletion"""
331
 
        kind = self.tree_kind(trans_id)
332
 
        if kind is not None:
333
 
            self._removed_contents.add(trans_id)
 
444
        self.tree_kind(trans_id)
 
445
        self._removed_contents.add(trans_id)
334
446
 
335
447
    def cancel_deletion(self, trans_id):
336
448
        """Cancel a scheduled deletion"""
393
505
        return sorted(FinalPaths(self).get_paths(new_ids))
394
506
 
395
507
    def _inventory_altered(self):
396
 
        """Determine which trans_ids need new Inventory entries.
397
 
 
398
 
        An new entry is needed when anything that would be reflected by an
399
 
        inventory entry changes, including file name, file_id, parent file_id,
400
 
        file kind, and the execute bit.
401
 
 
402
 
        Some care is taken to return entries with real changes, not cases
403
 
        where the value is deleted and then restored to its original value,
404
 
        but some actually unchanged values may be returned.
405
 
 
406
 
        :returns: A list of (path, trans_id) for all items requiring an
407
 
            inventory change. Ordered by path.
408
 
        """
409
 
        changed_ids = set()
410
 
        # Find entries whose file_ids are new (or changed).
411
 
        new_file_id = set(t for t in self._new_id
412
 
                          if self._new_id[t] != self.tree_file_id(t))
413
 
        for id_set in [self._new_name, self._new_parent, new_file_id,
 
508
        """Get the trans_ids and paths of files needing new inv entries."""
 
509
        new_ids = set()
 
510
        for id_set in [self._new_name, self._new_parent, self._new_id,
414
511
                       self._new_executability]:
415
 
            changed_ids.update(id_set)
416
 
        # removing implies a kind change
 
512
            new_ids.update(id_set)
417
513
        changed_kind = set(self._removed_contents)
418
 
        # so does adding
419
514
        changed_kind.intersection_update(self._new_contents)
420
 
        # Ignore entries that are already known to have changed.
421
 
        changed_kind.difference_update(changed_ids)
422
 
        #  to keep only the truly changed ones
423
 
        changed_kind = (t for t in changed_kind
424
 
                        if self.tree_kind(t) != self.final_kind(t))
425
 
        # all kind changes will alter the inventory
426
 
        changed_ids.update(changed_kind)
427
 
        # To find entries with changed parent_ids, find parents which existed,
428
 
        # but changed file_id.
429
 
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
430
 
        # Now add all their children to the set.
431
 
        for parent_trans_id in new_file_id:
432
 
            changed_ids.update(self.iter_tree_children(parent_trans_id))
433
 
        return sorted(FinalPaths(self).get_paths(changed_ids))
 
515
        changed_kind.difference_update(new_ids)
 
516
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
517
                        self.final_kind(t))
 
518
        new_ids.update(changed_kind)
 
519
        return sorted(FinalPaths(self).get_paths(new_ids))
 
520
 
 
521
    def tree_kind(self, trans_id):
 
522
        """Determine the file kind in the working tree.
 
523
 
 
524
        Raises NoSuchFile if the file does not exist
 
525
        """
 
526
        path = self._tree_id_paths.get(trans_id)
 
527
        if path is None:
 
528
            raise NoSuchFile(None)
 
529
        try:
 
530
            return file_kind(self._tree.abspath(path))
 
531
        except OSError, e:
 
532
            if e.errno != errno.ENOENT:
 
533
                raise
 
534
            else:
 
535
                raise NoSuchFile(path)
434
536
 
435
537
    def final_kind(self, trans_id):
436
538
        """Determine the final file kind, after any changes applied.
437
539
 
438
 
        :return: None if the file does not exist/has no contents.  (It is
439
 
            conceivable that a path would be created without the corresponding
440
 
            contents insertion command)
 
540
        Raises NoSuchFile if the file does not exist/has no contents.
 
541
        (It is conceivable that a path would be created without the
 
542
        corresponding contents insertion command)
441
543
        """
442
544
        if trans_id in self._new_contents:
443
545
            return self._new_contents[trans_id]
444
546
        elif trans_id in self._removed_contents:
445
 
            return None
 
547
            raise NoSuchFile(None)
446
548
        else:
447
549
            return self.tree_kind(trans_id)
448
550
 
544
646
        conflicts.extend(self._overwrite_conflicts())
545
647
        return conflicts
546
648
 
547
 
    def _check_malformed(self):
548
 
        conflicts = self.find_conflicts()
549
 
        if len(conflicts) != 0:
550
 
            raise MalformedTransform(conflicts=conflicts)
551
 
 
552
649
    def _add_tree_children(self):
553
650
        """Add all the children of all active parents to the known paths.
554
651
 
561
658
        for trans_id in self._removed_id:
562
659
            file_id = self.tree_file_id(trans_id)
563
660
            if file_id is not None:
564
 
                # XXX: This seems like something that should go via a different
565
 
                #      indirection.
566
661
                if self._tree.inventory[file_id].kind == 'directory':
567
662
                    parents.append(trans_id)
568
663
            elif self.tree_kind(trans_id) == 'directory':
572
667
            # ensure that all children are registered with the transaction
573
668
            list(self.iter_tree_children(parent_id))
574
669
 
575
 
    @deprecated_method(deprecated_in((2, 3, 0)))
 
670
    def iter_tree_children(self, parent_id):
 
671
        """Iterate through the entry's tree children, if any"""
 
672
        try:
 
673
            path = self._tree_id_paths[parent_id]
 
674
        except KeyError:
 
675
            return
 
676
        try:
 
677
            children = os.listdir(self._tree.abspath(path))
 
678
        except OSError, e:
 
679
            if not (osutils._is_error_enotdir(e)
 
680
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
681
                raise
 
682
            return
 
683
 
 
684
        for child in children:
 
685
            childpath = joinpath(path, child)
 
686
            if self._tree.is_control_filename(childpath):
 
687
                continue
 
688
            yield self.trans_id_tree_path(childpath)
 
689
 
576
690
    def has_named_child(self, by_parent, parent_id, name):
577
 
        return self._has_named_child(
578
 
            name, parent_id, known_children=by_parent.get(parent_id, []))
579
 
 
580
 
    def _has_named_child(self, name, parent_id, known_children):
581
 
        """Does a parent already have a name child.
582
 
 
583
 
        :param name: The searched for name.
584
 
 
585
 
        :param parent_id: The parent for which the check is made.
586
 
 
587
 
        :param known_children: The already known children. This should have
588
 
            been recently obtained from `self.by_parent.get(parent_id)`
589
 
            (or will be if None is passed).
590
 
        """
591
 
        if known_children is None:
592
 
            known_children = self.by_parent().get(parent_id, [])
593
 
        for child in known_children:
 
691
        try:
 
692
            children = by_parent[parent_id]
 
693
        except KeyError:
 
694
            children = []
 
695
        for child in children:
594
696
            if self.final_name(child) == name:
595
697
                return True
596
 
        parent_path = self._tree_id_paths.get(parent_id, None)
597
 
        if parent_path is None:
598
 
            # No parent... no children
 
698
        try:
 
699
            path = self._tree_id_paths[parent_id]
 
700
        except KeyError:
599
701
            return False
600
 
        child_path = joinpath(parent_path, name)
601
 
        child_id = self._tree_path_ids.get(child_path, None)
 
702
        childpath = joinpath(path, name)
 
703
        child_id = self._tree_path_ids.get(childpath)
602
704
        if child_id is None:
603
 
            # Not known by the tree transform yet, check the filesystem
604
 
            return osutils.lexists(self._tree.abspath(child_path))
 
705
            return lexists(self._tree.abspath(childpath))
605
706
        else:
606
 
            raise AssertionError('child_id is missing: %s, %s, %s'
607
 
                                 % (name, parent_id, child_id))
608
 
 
609
 
    def _available_backup_name(self, name, target_id):
610
 
        """Find an available backup name.
611
 
 
612
 
        :param name: The basename of the file.
613
 
 
614
 
        :param target_id: The directory trans_id where the backup should 
615
 
            be placed.
616
 
        """
617
 
        known_children = self.by_parent().get(target_id, [])
618
 
        return osutils.available_backup_name(
619
 
            name,
620
 
            lambda base: self._has_named_child(
621
 
                base, target_id, known_children))
 
707
            if self.final_parent(child_id) != parent_id:
 
708
                return False
 
709
            if child_id in self._removed_contents:
 
710
                # XXX What about dangling file-ids?
 
711
                return False
 
712
            else:
 
713
                return True
622
714
 
623
715
    def _parent_loops(self):
624
716
        """No entry should be its own ancestor"""
659
751
        """
660
752
        conflicts = []
661
753
        for trans_id in self._new_id.iterkeys():
662
 
            kind = self.final_kind(trans_id)
663
 
            if kind is None:
 
754
            try:
 
755
                kind = self.final_kind(trans_id)
 
756
            except NoSuchFile:
664
757
                conflicts.append(('versioning no contents', trans_id))
665
758
                continue
666
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
759
            if not InventoryEntry.versionable_kind(kind):
667
760
                conflicts.append(('versioning bad kind', trans_id, kind))
668
761
        return conflicts
669
762
 
680
773
            if self.final_file_id(trans_id) is None:
681
774
                conflicts.append(('unversioned executability', trans_id))
682
775
            else:
683
 
                if self.final_kind(trans_id) != "file":
 
776
                try:
 
777
                    non_file = self.final_kind(trans_id) != "file"
 
778
                except NoSuchFile:
 
779
                    non_file = True
 
780
                if non_file is True:
684
781
                    conflicts.append(('non-file executability', trans_id))
685
782
        return conflicts
686
783
 
688
785
        """Check for overwrites (not permitted on Win32)"""
689
786
        conflicts = []
690
787
        for trans_id in self._new_contents:
691
 
            if self.tree_kind(trans_id) is None:
 
788
            try:
 
789
                self.tree_kind(trans_id)
 
790
            except NoSuchFile:
692
791
                continue
693
792
            if trans_id not in self._removed_contents:
694
793
                conflicts.append(('overwrite', trans_id,
701
800
        if (self._new_name, self._new_parent) == ({}, {}):
702
801
            return conflicts
703
802
        for children in by_parent.itervalues():
704
 
            name_ids = []
705
 
            for child_tid in children:
706
 
                name = self.final_name(child_tid)
707
 
                if name is not None:
708
 
                    # Keep children only if they still exist in the end
709
 
                    if not self._case_sensitive_target:
710
 
                        name = name.lower()
711
 
                    name_ids.append((name, child_tid))
 
803
            name_ids = [(self.final_name(t), t) for t in children]
 
804
            if not self._case_sensitive_target:
 
805
                name_ids = [(n.lower(), t) for n, t in name_ids]
712
806
            name_ids.sort()
713
807
            last_name = None
714
808
            last_trans_id = None
715
809
            for name, trans_id in name_ids:
716
 
                kind = self.final_kind(trans_id)
 
810
                try:
 
811
                    kind = self.final_kind(trans_id)
 
812
                except NoSuchFile:
 
813
                    kind = None
717
814
                file_id = self.final_file_id(trans_id)
718
815
                if kind is None and file_id is None:
719
816
                    continue
738
835
        return conflicts
739
836
 
740
837
    def _parent_type_conflicts(self, by_parent):
741
 
        """Children must have a directory parent"""
 
838
        """parents must have directory 'contents'."""
742
839
        conflicts = []
743
840
        for parent_id, children in by_parent.iteritems():
744
841
            if parent_id is ROOT_PARENT:
745
842
                continue
746
 
            no_children = True
747
 
            for child_id in children:
748
 
                if self.final_kind(child_id) is not None:
749
 
                    no_children = False
750
 
                    break
751
 
            if no_children:
 
843
            if not self._any_contents(children):
752
844
                continue
753
 
            # There is at least a child, so we need an existing directory to
754
 
            # contain it.
755
 
            kind = self.final_kind(parent_id)
 
845
            for child in children:
 
846
                try:
 
847
                    self.final_kind(child)
 
848
                except NoSuchFile:
 
849
                    continue
 
850
            try:
 
851
                kind = self.final_kind(parent_id)
 
852
            except NoSuchFile:
 
853
                kind = None
756
854
            if kind is None:
757
 
                # The directory will be deleted
758
855
                conflicts.append(('missing parent', parent_id))
759
856
            elif kind != "directory":
760
 
                # Meh, we need a *directory* to put something in it
761
857
                conflicts.append(('non-directory parent', parent_id))
762
858
        return conflicts
763
859
 
 
860
    def _any_contents(self, trans_ids):
 
861
        """Return true if any of the trans_ids, will have contents."""
 
862
        for trans_id in trans_ids:
 
863
            try:
 
864
                kind = self.final_kind(trans_id)
 
865
            except NoSuchFile:
 
866
                continue
 
867
            return True
 
868
        return False
 
869
 
 
870
    def _limbo_name(self, trans_id):
 
871
        """Generate the limbo name of a file"""
 
872
        limbo_name = self._limbo_files.get(trans_id)
 
873
        if limbo_name is not None:
 
874
            return limbo_name
 
875
        parent = self._new_parent.get(trans_id)
 
876
        # if the parent directory is already in limbo (e.g. when building a
 
877
        # tree), choose a limbo name inside the parent, to reduce further
 
878
        # renames.
 
879
        use_direct_path = False
 
880
        if self._new_contents.get(parent) == 'directory':
 
881
            filename = self._new_name.get(trans_id)
 
882
            if filename is not None:
 
883
                if parent not in self._limbo_children:
 
884
                    self._limbo_children[parent] = set()
 
885
                    self._limbo_children_names[parent] = {}
 
886
                    use_direct_path = True
 
887
                # the direct path can only be used if no other file has
 
888
                # already taken this pathname, i.e. if the name is unused, or
 
889
                # if it is already associated with this trans_id.
 
890
                elif self._case_sensitive_target:
 
891
                    if (self._limbo_children_names[parent].get(filename)
 
892
                        in (trans_id, None)):
 
893
                        use_direct_path = True
 
894
                else:
 
895
                    for l_filename, l_trans_id in\
 
896
                        self._limbo_children_names[parent].iteritems():
 
897
                        if l_trans_id == trans_id:
 
898
                            continue
 
899
                        if l_filename.lower() == filename.lower():
 
900
                            break
 
901
                    else:
 
902
                        use_direct_path = True
 
903
 
 
904
        if use_direct_path:
 
905
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
906
            self._limbo_children[parent].add(trans_id)
 
907
            self._limbo_children_names[parent][filename] = trans_id
 
908
        else:
 
909
            limbo_name = pathjoin(self._limbodir, trans_id)
 
910
            self._needs_rename.add(trans_id)
 
911
        self._limbo_files[trans_id] = limbo_name
 
912
        return limbo_name
 
913
 
764
914
    def _set_executability(self, path, trans_id):
765
915
        """Set the executability of versioned files """
766
916
        if supports_executable():
788
938
        return trans_id
789
939
 
790
940
    def new_file(self, name, parent_id, contents, file_id=None,
791
 
                 executable=None, sha1=None):
 
941
                 executable=None):
792
942
        """Convenience method to create files.
793
943
 
794
944
        name is the name of the file to create.
801
951
        trans_id = self._new_entry(name, parent_id, file_id)
802
952
        # TODO: rather than scheduling a set_executable call,
803
953
        # have create_file create the file with the right mode.
804
 
        self.create_file(contents, trans_id, sha1=sha1)
 
954
        self.create_file(contents, trans_id)
805
955
        if executable is not None:
806
956
            self.set_executability(executable, trans_id)
807
957
        return trans_id
830
980
        self.create_symlink(target, trans_id)
831
981
        return trans_id
832
982
 
833
 
    def new_orphan(self, trans_id, parent_id):
834
 
        """Schedule an item to be orphaned.
835
 
 
836
 
        When a directory is about to be removed, its children, if they are not
837
 
        versioned are moved out of the way: they don't have a parent anymore.
838
 
 
839
 
        :param trans_id: The trans_id of the existing item.
840
 
        :param parent_id: The parent trans_id of the item.
841
 
        """
842
 
        raise NotImplementedError(self.new_orphan)
843
 
 
844
 
    def _get_potential_orphans(self, dir_id):
845
 
        """Find the potential orphans in a directory.
846
 
 
847
 
        A directory can't be safely deleted if there are versioned files in it.
848
 
        If all the contained files are unversioned then they can be orphaned.
849
 
 
850
 
        The 'None' return value means that the directory contains at least one
851
 
        versioned file and should not be deleted.
852
 
 
853
 
        :param dir_id: The directory trans id.
854
 
 
855
 
        :return: A list of the orphan trans ids or None if at least one
856
 
             versioned file is present.
857
 
        """
858
 
        orphans = []
859
 
        # Find the potential orphans, stop if one item should be kept
860
 
        for child_tid in self.by_parent()[dir_id]:
861
 
            if child_tid in self._removed_contents:
862
 
                # The child is removed as part of the transform. Since it was
863
 
                # versioned before, it's not an orphan
864
 
                continue
865
 
            elif self.final_file_id(child_tid) is None:
866
 
                # The child is not versioned
867
 
                orphans.append(child_tid)
868
 
            else:
869
 
                # We have a versioned file here, searching for orphans is
870
 
                # meaningless.
871
 
                orphans = None
872
 
                break
873
 
        return orphans
874
 
 
875
983
    def _affected_ids(self):
876
984
        """Return the set of transform ids affected by the transform"""
877
985
        trans_ids = set(self._removed_id)
936
1044
        Return a (name, parent, kind, executable) tuple
937
1045
        """
938
1046
        to_name = self.final_name(to_trans_id)
939
 
        to_kind = self.final_kind(to_trans_id)
 
1047
        try:
 
1048
            to_kind = self.final_kind(to_trans_id)
 
1049
        except NoSuchFile:
 
1050
            to_kind = None
940
1051
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
941
1052
        if to_trans_id in self._new_executability:
942
1053
            to_executable = self._new_executability[to_trans_id]
1011
1122
    def get_preview_tree(self):
1012
1123
        """Return a tree representing the result of the transform.
1013
1124
 
1014
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
1015
 
        it.
 
1125
        This tree only supports the subset of Tree functionality required
 
1126
        by show_diff_trees.  It must only be compared to tt._tree.
1016
1127
        """
1017
1128
        return _PreviewTree(self)
1018
1129
 
1019
 
    def commit(self, branch, message, merge_parents=None, strict=False,
1020
 
               timestamp=None, timezone=None, committer=None, authors=None,
1021
 
               revprops=None, revision_id=None):
1022
 
        """Commit the result of this TreeTransform to a branch.
1023
 
 
1024
 
        :param branch: The branch to commit to.
1025
 
        :param message: The message to attach to the commit.
1026
 
        :param merge_parents: Additional parent revision-ids specified by
1027
 
            pending merges.
1028
 
        :param strict: If True, abort the commit if there are unversioned
1029
 
            files.
1030
 
        :param timestamp: if not None, seconds-since-epoch for the time and
1031
 
            date.  (May be a float.)
1032
 
        :param timezone: Optional timezone for timestamp, as an offset in
1033
 
            seconds.
1034
 
        :param committer: Optional committer in email-id format.
1035
 
            (e.g. "J Random Hacker <jrandom@example.com>")
1036
 
        :param authors: Optional list of authors in email-id format.
1037
 
        :param revprops: Optional dictionary of revision properties.
1038
 
        :param revision_id: Optional revision id.  (Specifying a revision-id
1039
 
            may reduce performance for some non-native formats.)
1040
 
        :return: The revision_id of the revision committed.
1041
 
        """
1042
 
        self._check_malformed()
1043
 
        if strict:
1044
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
1045
 
            for trans_id in unversioned:
1046
 
                if self.final_file_id(trans_id) is None:
1047
 
                    raise errors.StrictCommitFailed()
1048
 
 
1049
 
        revno, last_rev_id = branch.last_revision_info()
1050
 
        if last_rev_id == _mod_revision.NULL_REVISION:
1051
 
            if merge_parents is not None:
1052
 
                raise ValueError('Cannot supply merge parents for first'
1053
 
                                 ' commit.')
1054
 
            parent_ids = []
1055
 
        else:
1056
 
            parent_ids = [last_rev_id]
1057
 
            if merge_parents is not None:
1058
 
                parent_ids.extend(merge_parents)
1059
 
        if self._tree.get_revision_id() != last_rev_id:
1060
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
1061
 
                             self._tree.get_revision_id())
1062
 
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
1063
 
        builder = branch.get_commit_builder(parent_ids,
1064
 
                                            timestamp=timestamp,
1065
 
                                            timezone=timezone,
1066
 
                                            committer=committer,
1067
 
                                            revprops=revprops,
1068
 
                                            revision_id=revision_id)
1069
 
        preview = self.get_preview_tree()
1070
 
        list(builder.record_iter_changes(preview, last_rev_id,
1071
 
                                         self.iter_changes()))
1072
 
        builder.finish_inventory()
1073
 
        revision_id = builder.commit(message)
1074
 
        branch.set_last_revision_info(revno + 1, revision_id)
1075
 
        return revision_id
1076
 
 
1077
1130
    def _text_parent(self, trans_id):
1078
1131
        file_id = self.tree_file_id(trans_id)
1079
1132
        try:
1123
1176
                                      (('attribs',),))
1124
1177
        for trans_id, kind in self._new_contents.items():
1125
1178
            if kind == 'file':
1126
 
                lines = osutils.chunks_to_lines(
1127
 
                    self._read_file_chunks(trans_id))
 
1179
                cur_file = open(self._limbo_name(trans_id), 'rb')
 
1180
                try:
 
1181
                    lines = osutils.chunks_to_lines(cur_file.readlines())
 
1182
                finally:
 
1183
                    cur_file.close()
1128
1184
                parents = self._get_parents_lines(trans_id)
1129
1185
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1130
1186
                content = ''.join(mpdiff.to_patch())
1131
1187
            if kind == 'directory':
1132
1188
                content = ''
1133
1189
            if kind == 'symlink':
1134
 
                content = self._read_symlink_target(trans_id)
 
1190
                content = os.readlink(self._limbo_name(trans_id))
1135
1191
            yield serializer.bytes_record(content, ((trans_id, kind),))
1136
1192
 
 
1193
 
1137
1194
    def deserialize(self, records):
1138
1195
        """Deserialize a stored TreeTransform.
1139
1196
 
1170
1227
                self.create_symlink(content.decode('utf-8'), trans_id)
1171
1228
 
1172
1229
 
1173
 
class DiskTreeTransform(TreeTransformBase):
1174
 
    """Tree transform storing its contents on disk."""
1175
 
 
1176
 
    def __init__(self, tree, limbodir, pb=None,
1177
 
                 case_sensitive=True):
1178
 
        """Constructor.
1179
 
        :param tree: The tree that will be transformed, but not necessarily
1180
 
            the output tree.
1181
 
        :param limbodir: A directory where new files can be stored until
1182
 
            they are installed in their proper places
1183
 
        :param pb: ignored
1184
 
        :param case_sensitive: If True, the target of the transform is
1185
 
            case sensitive, not just case preserving.
1186
 
        """
1187
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1188
 
        self._limbodir = limbodir
1189
 
        self._deletiondir = None
1190
 
        # A mapping of transform ids to their limbo filename
1191
 
        self._limbo_files = {}
1192
 
        self._possibly_stale_limbo_files = set()
1193
 
        # A mapping of transform ids to a set of the transform ids of children
1194
 
        # that their limbo directory has
1195
 
        self._limbo_children = {}
1196
 
        # Map transform ids to maps of child filename to child transform id
1197
 
        self._limbo_children_names = {}
1198
 
        # List of transform ids that need to be renamed from limbo into place
1199
 
        self._needs_rename = set()
1200
 
        self._creation_mtime = None
1201
 
 
1202
 
    def finalize(self):
1203
 
        """Release the working tree lock, if held, clean up limbo dir.
1204
 
 
1205
 
        This is required if apply has not been invoked, but can be invoked
1206
 
        even after apply.
1207
 
        """
1208
 
        if self._tree is None:
1209
 
            return
1210
 
        try:
1211
 
            limbo_paths = self._limbo_files.values() + list(
1212
 
                self._possibly_stale_limbo_files)
1213
 
            limbo_paths = sorted(limbo_paths, reverse=True)
1214
 
            for path in limbo_paths:
1215
 
                try:
1216
 
                    delete_any(path)
1217
 
                except OSError, e:
1218
 
                    if e.errno != errno.ENOENT:
1219
 
                        raise
1220
 
                    # XXX: warn? perhaps we just got interrupted at an
1221
 
                    # inconvenient moment, but perhaps files are disappearing
1222
 
                    # from under us?
1223
 
            try:
1224
 
                delete_any(self._limbodir)
1225
 
            except OSError:
1226
 
                # We don't especially care *why* the dir is immortal.
1227
 
                raise ImmortalLimbo(self._limbodir)
1228
 
            try:
1229
 
                if self._deletiondir is not None:
1230
 
                    delete_any(self._deletiondir)
1231
 
            except OSError:
1232
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1233
 
        finally:
1234
 
            TreeTransformBase.finalize(self)
1235
 
 
1236
 
    def _limbo_name(self, trans_id):
1237
 
        """Generate the limbo name of a file"""
1238
 
        limbo_name = self._limbo_files.get(trans_id)
1239
 
        if limbo_name is None:
1240
 
            limbo_name = self._generate_limbo_path(trans_id)
1241
 
            self._limbo_files[trans_id] = limbo_name
1242
 
        return limbo_name
1243
 
 
1244
 
    def _generate_limbo_path(self, trans_id):
1245
 
        """Generate a limbo path using the trans_id as the relative path.
1246
 
 
1247
 
        This is suitable as a fallback, and when the transform should not be
1248
 
        sensitive to the path encoding of the limbo directory.
1249
 
        """
1250
 
        self._needs_rename.add(trans_id)
1251
 
        return pathjoin(self._limbodir, trans_id)
1252
 
 
1253
 
    def adjust_path(self, name, parent, trans_id):
1254
 
        previous_parent = self._new_parent.get(trans_id)
1255
 
        previous_name = self._new_name.get(trans_id)
1256
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1257
 
        if (trans_id in self._limbo_files and
1258
 
            trans_id not in self._needs_rename):
1259
 
            self._rename_in_limbo([trans_id])
1260
 
            if previous_parent != parent:
1261
 
                self._limbo_children[previous_parent].remove(trans_id)
1262
 
            if previous_parent != parent or previous_name != name:
1263
 
                del self._limbo_children_names[previous_parent][previous_name]
1264
 
 
1265
 
    def _rename_in_limbo(self, trans_ids):
1266
 
        """Fix limbo names so that the right final path is produced.
1267
 
 
1268
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1269
 
        these files later by creating them with their final names in their
1270
 
        final parents.  But now the previous name or parent is no longer
1271
 
        suitable, so we have to rename them.
1272
 
 
1273
 
        Even for trans_ids that have no new contents, we must remove their
1274
 
        entries from _limbo_files, because they are now stale.
1275
 
        """
1276
 
        for trans_id in trans_ids:
1277
 
            old_path = self._limbo_files[trans_id]
1278
 
            self._possibly_stale_limbo_files.add(old_path)
1279
 
            del self._limbo_files[trans_id]
1280
 
            if trans_id not in self._new_contents:
1281
 
                continue
1282
 
            new_path = self._limbo_name(trans_id)
1283
 
            os.rename(old_path, new_path)
1284
 
            self._possibly_stale_limbo_files.remove(old_path)
1285
 
            for descendant in self._limbo_descendants(trans_id):
1286
 
                desc_path = self._limbo_files[descendant]
1287
 
                desc_path = new_path + desc_path[len(old_path):]
1288
 
                self._limbo_files[descendant] = desc_path
1289
 
 
1290
 
    def _limbo_descendants(self, trans_id):
1291
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1292
 
        descendants = set(self._limbo_children.get(trans_id, []))
1293
 
        for descendant in list(descendants):
1294
 
            descendants.update(self._limbo_descendants(descendant))
1295
 
        return descendants
1296
 
 
1297
 
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1298
 
        """Schedule creation of a new file.
1299
 
 
1300
 
        :seealso: new_file.
1301
 
 
1302
 
        :param contents: an iterator of strings, all of which will be written
1303
 
            to the target destination.
1304
 
        :param trans_id: TreeTransform handle
1305
 
        :param mode_id: If not None, force the mode of the target file to match
1306
 
            the mode of the object referenced by mode_id.
1307
 
            Otherwise, we will try to preserve mode bits of an existing file.
1308
 
        :param sha1: If the sha1 of this content is already known, pass it in.
1309
 
            We can use it to prevent future sha1 computations.
1310
 
        """
1311
 
        name = self._limbo_name(trans_id)
1312
 
        f = open(name, 'wb')
1313
 
        try:
1314
 
            unique_add(self._new_contents, trans_id, 'file')
1315
 
            f.writelines(contents)
1316
 
        finally:
1317
 
            f.close()
1318
 
        self._set_mtime(name)
1319
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1320
 
        # It is unfortunate we have to use lstat instead of fstat, but we just
1321
 
        # used utime and chmod on the file, so we need the accurate final
1322
 
        # details.
1323
 
        if sha1 is not None:
1324
 
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1325
 
 
1326
 
    def _read_file_chunks(self, trans_id):
1327
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1328
 
        try:
1329
 
            return cur_file.readlines()
1330
 
        finally:
1331
 
            cur_file.close()
1332
 
 
1333
 
    def _read_symlink_target(self, trans_id):
1334
 
        return os.readlink(self._limbo_name(trans_id))
1335
 
 
1336
 
    def _set_mtime(self, path):
1337
 
        """All files that are created get the same mtime.
1338
 
 
1339
 
        This time is set by the first object to be created.
1340
 
        """
1341
 
        if self._creation_mtime is None:
1342
 
            self._creation_mtime = time.time()
1343
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1344
 
 
1345
 
    def create_hardlink(self, path, trans_id):
1346
 
        """Schedule creation of a hard link"""
1347
 
        name = self._limbo_name(trans_id)
1348
 
        try:
1349
 
            os.link(path, name)
1350
 
        except OSError, e:
1351
 
            if e.errno != errno.EPERM:
1352
 
                raise
1353
 
            raise errors.HardLinkNotSupported(path)
1354
 
        try:
1355
 
            unique_add(self._new_contents, trans_id, 'file')
1356
 
        except:
1357
 
            # Clean up the file, it never got registered so
1358
 
            # TreeTransform.finalize() won't clean it up.
1359
 
            os.unlink(name)
1360
 
            raise
1361
 
 
1362
 
    def create_directory(self, trans_id):
1363
 
        """Schedule creation of a new directory.
1364
 
 
1365
 
        See also new_directory.
1366
 
        """
1367
 
        os.mkdir(self._limbo_name(trans_id))
1368
 
        unique_add(self._new_contents, trans_id, 'directory')
1369
 
 
1370
 
    def create_symlink(self, target, trans_id):
1371
 
        """Schedule creation of a new symbolic link.
1372
 
 
1373
 
        target is a bytestring.
1374
 
        See also new_symlink.
1375
 
        """
1376
 
        if has_symlinks():
1377
 
            os.symlink(target, self._limbo_name(trans_id))
1378
 
            unique_add(self._new_contents, trans_id, 'symlink')
1379
 
        else:
1380
 
            try:
1381
 
                path = FinalPaths(self).get_path(trans_id)
1382
 
            except KeyError:
1383
 
                path = None
1384
 
            raise UnableCreateSymlink(path=path)
1385
 
 
1386
 
    def cancel_creation(self, trans_id):
1387
 
        """Cancel the creation of new file contents."""
1388
 
        del self._new_contents[trans_id]
1389
 
        if trans_id in self._observed_sha1s:
1390
 
            del self._observed_sha1s[trans_id]
1391
 
        children = self._limbo_children.get(trans_id)
1392
 
        # if this is a limbo directory with children, move them before removing
1393
 
        # the directory
1394
 
        if children is not None:
1395
 
            self._rename_in_limbo(children)
1396
 
            del self._limbo_children[trans_id]
1397
 
            del self._limbo_children_names[trans_id]
1398
 
        delete_any(self._limbo_name(trans_id))
1399
 
 
1400
 
    def new_orphan(self, trans_id, parent_id):
1401
 
        # FIXME: There is no tree config, so we use the branch one (it's weird
1402
 
        # to define it this way as orphaning can only occur in a working tree,
1403
 
        # but that's all we have (for now). It will find the option in
1404
 
        # locations.conf or bazaar.conf though) -- vila 20100916
1405
 
        conf = self._tree.branch.get_config()
1406
 
        conf_var_name = 'bzr.transform.orphan_policy'
1407
 
        orphan_policy = conf.get_user_option(conf_var_name)
1408
 
        default_policy = orphaning_registry.default_key
1409
 
        if orphan_policy is None:
1410
 
            orphan_policy = default_policy
1411
 
        if orphan_policy not in orphaning_registry:
1412
 
            trace.warning('%s (from %s) is not a known policy, defaulting '
1413
 
                'to %s' % (orphan_policy, conf_var_name, default_policy))
1414
 
            orphan_policy = default_policy
1415
 
        handle_orphan = orphaning_registry.get(orphan_policy)
1416
 
        handle_orphan(self, trans_id, parent_id)
1417
 
 
1418
 
 
1419
 
class OrphaningError(errors.BzrError):
1420
 
 
1421
 
    # Only bugs could lead to such exception being seen by the user
1422
 
    internal_error = True
1423
 
    _fmt = "Error while orphaning %s in %s directory"
1424
 
 
1425
 
    def __init__(self, orphan, parent):
1426
 
        errors.BzrError.__init__(self)
1427
 
        self.orphan = orphan
1428
 
        self.parent = parent
1429
 
 
1430
 
 
1431
 
class OrphaningForbidden(OrphaningError):
1432
 
 
1433
 
    _fmt = "Policy: %s doesn't allow creating orphans."
1434
 
 
1435
 
    def __init__(self, policy):
1436
 
        errors.BzrError.__init__(self)
1437
 
        self.policy = policy
1438
 
 
1439
 
 
1440
 
def move_orphan(tt, orphan_id, parent_id):
1441
 
    """See TreeTransformBase.new_orphan.
1442
 
 
1443
 
    This creates a new orphan in the `bzr-orphans` dir at the root of the
1444
 
    `TreeTransform`.
1445
 
 
1446
 
    :param tt: The TreeTransform orphaning `trans_id`.
1447
 
 
1448
 
    :param orphan_id: The trans id that should be orphaned.
1449
 
 
1450
 
    :param parent_id: The orphan parent trans id.
1451
 
    """
1452
 
    # Add the orphan dir if it doesn't exist
1453
 
    orphan_dir_basename = 'bzr-orphans'
1454
 
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
1455
 
    if tt.final_kind(od_id) is None:
1456
 
        tt.create_directory(od_id)
1457
 
    parent_path = tt._tree_id_paths[parent_id]
1458
 
    # Find a name that doesn't exist yet in the orphan dir
1459
 
    actual_name = tt.final_name(orphan_id)
1460
 
    new_name = tt._available_backup_name(actual_name, od_id)
1461
 
    tt.adjust_path(new_name, od_id, orphan_id)
1462
 
    trace.warning('%s has been orphaned in %s'
1463
 
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
1464
 
 
1465
 
 
1466
 
def refuse_orphan(tt, orphan_id, parent_id):
1467
 
    """See TreeTransformBase.new_orphan.
1468
 
 
1469
 
    This refuses to create orphan, letting the caller handle the conflict.
1470
 
    """
1471
 
    raise OrphaningForbidden('never')
1472
 
 
1473
 
 
1474
 
orphaning_registry = registry.Registry()
1475
 
orphaning_registry.register(
1476
 
    'conflict', refuse_orphan,
1477
 
    'Leave orphans in place and create a conflict on the directory.')
1478
 
orphaning_registry.register(
1479
 
    'move', move_orphan,
1480
 
    'Move orphans into the bzr-orphans directory.')
1481
 
orphaning_registry._set_default_key('conflict')
1482
 
 
1483
 
 
1484
 
class TreeTransform(DiskTreeTransform):
 
1230
class TreeTransform(TreeTransformBase):
1485
1231
    """Represent a tree transformation.
1486
1232
 
1487
1233
    This object is designed to support incremental generation of the transform,
1546
1292
    FileMover does not delete files until it is sure that a rollback will not
1547
1293
    happen.
1548
1294
    """
1549
 
    def __init__(self, tree, pb=None):
 
1295
    def __init__(self, tree, pb=DummyProgress()):
1550
1296
        """Note: a tree_write lock is taken on the tree.
1551
1297
 
1552
1298
        Use TreeTransform.finalize() to release the lock (can be omitted if
1573
1319
            tree.unlock()
1574
1320
            raise
1575
1321
 
1576
 
        # Cache of realpath results, to speed up canonical_path
1577
 
        self._realpaths = {}
1578
 
        # Cache of relpath results, to speed up canonical_path
1579
 
        self._relpaths = {}
1580
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1322
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1581
1323
                                   tree.case_sensitive)
1582
1324
        self._deletiondir = deletiondir
1583
1325
 
1584
 
    def canonical_path(self, path):
1585
 
        """Get the canonical tree-relative path"""
1586
 
        # don't follow final symlinks
1587
 
        abs = self._tree.abspath(path)
1588
 
        if abs in self._relpaths:
1589
 
            return self._relpaths[abs]
1590
 
        dirname, basename = os.path.split(abs)
1591
 
        if dirname not in self._realpaths:
1592
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1593
 
        dirname = self._realpaths[dirname]
1594
 
        abs = pathjoin(dirname, basename)
1595
 
        if dirname in self._relpaths:
1596
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1597
 
            relpath = relpath.rstrip('/\\')
1598
 
        else:
1599
 
            relpath = self._tree.relpath(abs)
1600
 
        self._relpaths[abs] = relpath
1601
 
        return relpath
1602
 
 
1603
 
    def tree_kind(self, trans_id):
1604
 
        """Determine the file kind in the working tree.
1605
 
 
1606
 
        :returns: The file kind or None if the file does not exist
1607
 
        """
1608
 
        path = self._tree_id_paths.get(trans_id)
1609
 
        if path is None:
1610
 
            return None
1611
 
        try:
1612
 
            return file_kind(self._tree.abspath(path))
1613
 
        except errors.NoSuchFile:
1614
 
            return None
1615
 
 
1616
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1617
 
        """Set the mode of new file contents.
1618
 
        The mode_id is the existing file to get the mode from (often the same
1619
 
        as trans_id).  The operation is only performed if there's a mode match
1620
 
        according to typefunc.
1621
 
        """
1622
 
        if mode_id is None:
1623
 
            mode_id = trans_id
1624
 
        try:
1625
 
            old_path = self._tree_id_paths[mode_id]
1626
 
        except KeyError:
1627
 
            return
1628
 
        try:
1629
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1630
 
        except OSError, e:
1631
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1632
 
                # Either old_path doesn't exist, or the parent of the
1633
 
                # target is not a directory (but will be one eventually)
1634
 
                # Either way, we know it doesn't exist *right now*
1635
 
                # See also bug #248448
1636
 
                return
1637
 
            else:
1638
 
                raise
1639
 
        if typefunc(mode):
1640
 
            os.chmod(self._limbo_name(trans_id), mode)
1641
 
 
1642
 
    def iter_tree_children(self, parent_id):
1643
 
        """Iterate through the entry's tree children, if any"""
1644
 
        try:
1645
 
            path = self._tree_id_paths[parent_id]
1646
 
        except KeyError:
1647
 
            return
1648
 
        try:
1649
 
            children = os.listdir(self._tree.abspath(path))
1650
 
        except OSError, e:
1651
 
            if not (osutils._is_error_enotdir(e)
1652
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1653
 
                raise
1654
 
            return
1655
 
 
1656
 
        for child in children:
1657
 
            childpath = joinpath(path, child)
1658
 
            if self._tree.is_control_filename(childpath):
1659
 
                continue
1660
 
            yield self.trans_id_tree_path(childpath)
1661
 
 
1662
 
    def _generate_limbo_path(self, trans_id):
1663
 
        """Generate a limbo path using the final path if possible.
1664
 
 
1665
 
        This optimizes the performance of applying the tree transform by
1666
 
        avoiding renames.  These renames can be avoided only when the parent
1667
 
        directory is already scheduled for creation.
1668
 
 
1669
 
        If the final path cannot be used, falls back to using the trans_id as
1670
 
        the relpath.
1671
 
        """
1672
 
        parent = self._new_parent.get(trans_id)
1673
 
        # if the parent directory is already in limbo (e.g. when building a
1674
 
        # tree), choose a limbo name inside the parent, to reduce further
1675
 
        # renames.
1676
 
        use_direct_path = False
1677
 
        if self._new_contents.get(parent) == 'directory':
1678
 
            filename = self._new_name.get(trans_id)
1679
 
            if filename is not None:
1680
 
                if parent not in self._limbo_children:
1681
 
                    self._limbo_children[parent] = set()
1682
 
                    self._limbo_children_names[parent] = {}
1683
 
                    use_direct_path = True
1684
 
                # the direct path can only be used if no other file has
1685
 
                # already taken this pathname, i.e. if the name is unused, or
1686
 
                # if it is already associated with this trans_id.
1687
 
                elif self._case_sensitive_target:
1688
 
                    if (self._limbo_children_names[parent].get(filename)
1689
 
                        in (trans_id, None)):
1690
 
                        use_direct_path = True
1691
 
                else:
1692
 
                    for l_filename, l_trans_id in\
1693
 
                        self._limbo_children_names[parent].iteritems():
1694
 
                        if l_trans_id == trans_id:
1695
 
                            continue
1696
 
                        if l_filename.lower() == filename.lower():
1697
 
                            break
1698
 
                    else:
1699
 
                        use_direct_path = True
1700
 
 
1701
 
        if not use_direct_path:
1702
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1703
 
 
1704
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1705
 
        self._limbo_children[parent].add(trans_id)
1706
 
        self._limbo_children_names[parent][filename] = trans_id
1707
 
        return limbo_name
1708
 
 
1709
 
 
1710
1326
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1711
1327
        """Apply all changes to the inventory and filesystem.
1712
1328
 
1722
1338
        :param _mover: Supply an alternate FileMover, for testing
1723
1339
        """
1724
1340
        if not no_conflicts:
1725
 
            self._check_malformed()
1726
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1341
            conflicts = self.find_conflicts()
 
1342
            if len(conflicts) != 0:
 
1343
                raise MalformedTransform(conflicts=conflicts)
 
1344
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1727
1345
        try:
1728
1346
            if precomputed_delta is None:
1729
1347
                child_pb.update('Apply phase', 0, 2)
1748
1366
                mover.apply_deletions()
1749
1367
        finally:
1750
1368
            child_pb.finished()
1751
 
        if self.final_file_id(self.root) is None:
1752
 
            inventory_delta = [e for e in inventory_delta if e[0] != '']
1753
1369
        self._tree.apply_inventory_delta(inventory_delta)
1754
 
        self._apply_observed_sha1s()
1755
1370
        self._done = True
1756
1371
        self.finalize()
1757
1372
        return _TransformResults(modified_paths, self.rename_count)
1759
1374
    def _generate_inventory_delta(self):
1760
1375
        """Generate an inventory delta for the current transform."""
1761
1376
        inventory_delta = []
1762
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1377
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1763
1378
        new_paths = self._inventory_altered()
1764
1379
        total_entries = len(new_paths) + len(self._removed_id)
1765
1380
        try:
1789
1404
                if file_id is None:
1790
1405
                    continue
1791
1406
                needs_entry = False
1792
 
                kind = self.final_kind(trans_id)
1793
 
                if kind is None:
 
1407
                try:
 
1408
                    kind = self.final_kind(trans_id)
 
1409
                except NoSuchFile:
1794
1410
                    kind = self._tree.stored_kind(file_id)
1795
1411
                parent_trans_id = self.final_parent(trans_id)
1796
1412
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1827
1443
        """
1828
1444
        tree_paths = list(self._tree_path_ids.iteritems())
1829
1445
        tree_paths.sort(reverse=True)
1830
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1446
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1831
1447
        try:
1832
 
            for num, (path, trans_id) in enumerate(tree_paths):
1833
 
                # do not attempt to move root into a subdirectory of itself.
1834
 
                if path == '':
1835
 
                    continue
 
1448
            for num, data in enumerate(tree_paths):
 
1449
                path, trans_id = data
1836
1450
                child_pb.update('removing file', num, len(tree_paths))
1837
1451
                full_path = self._tree.abspath(path)
1838
1452
                if trans_id in self._removed_contents:
1839
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1840
 
                    mover.pre_delete(full_path, delete_path)
1841
 
                elif (trans_id in self._new_name
1842
 
                      or trans_id in self._new_parent):
 
1453
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1454
                                     trans_id))
 
1455
                elif trans_id in self._new_name or trans_id in \
 
1456
                    self._new_parent:
1843
1457
                    try:
1844
1458
                        mover.rename(full_path, self._limbo_name(trans_id))
1845
 
                    except errors.TransformRenameFailed, e:
 
1459
                    except OSError, e:
1846
1460
                        if e.errno != errno.ENOENT:
1847
1461
                            raise
1848
1462
                    else:
1864
1478
        modified_paths = []
1865
1479
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1866
1480
                                 new_paths)
1867
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1481
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1868
1482
        try:
1869
1483
            for num, (path, trans_id) in enumerate(new_paths):
1870
1484
                if (num % 10) == 0:
1873
1487
                if trans_id in self._needs_rename:
1874
1488
                    try:
1875
1489
                        mover.rename(self._limbo_name(trans_id), full_path)
1876
 
                    except errors.TransformRenameFailed, e:
 
1490
                    except OSError, e:
1877
1491
                        # We may be renaming a dangling inventory id
1878
1492
                        if e.errno != errno.ENOENT:
1879
1493
                            raise
1880
1494
                    else:
1881
1495
                        self.rename_count += 1
1882
 
                    # TODO: if trans_id in self._observed_sha1s, we should
1883
 
                    #       re-stat the final target, since ctime will be
1884
 
                    #       updated by the change.
1885
1496
                if (trans_id in self._new_contents or
1886
1497
                    self.path_changed(trans_id)):
1887
1498
                    if trans_id in self._new_contents:
1888
1499
                        modified_paths.append(full_path)
1889
1500
                if trans_id in self._new_executability:
1890
1501
                    self._set_executability(path, trans_id)
1891
 
                if trans_id in self._observed_sha1s:
1892
 
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
1893
 
                    st = osutils.lstat(full_path)
1894
 
                    self._observed_sha1s[trans_id] = (o_sha1, st)
1895
1502
        finally:
1896
1503
            child_pb.finished()
1897
 
        for path, trans_id in new_paths:
1898
 
            # new_paths includes stuff like workingtree conflicts. Only the
1899
 
            # stuff in new_contents actually comes from limbo.
1900
 
            if trans_id in self._limbo_files:
1901
 
                del self._limbo_files[trans_id]
1902
1504
        self._new_contents.clear()
1903
1505
        return modified_paths
1904
1506
 
1905
 
    def _apply_observed_sha1s(self):
1906
 
        """After we have finished renaming everything, update observed sha1s
1907
 
 
1908
 
        This has to be done after self._tree.apply_inventory_delta, otherwise
1909
 
        it doesn't know anything about the files we are updating. Also, we want
1910
 
        to do this as late as possible, so that most entries end up cached.
1911
 
        """
1912
 
        # TODO: this doesn't update the stat information for directories. So
1913
 
        #       the first 'bzr status' will still need to rewrite
1914
 
        #       .bzr/checkout/dirstate. However, we at least don't need to
1915
 
        #       re-read all of the files.
1916
 
        # TODO: If the operation took a while, we could do a time.sleep(3) here
1917
 
        #       to allow the clock to tick over and ensure we won't have any
1918
 
        #       problems. (we could observe start time, and finish time, and if
1919
 
        #       it is less than eg 10% overhead, add a sleep call.)
1920
 
        paths = FinalPaths(self)
1921
 
        for trans_id, observed in self._observed_sha1s.iteritems():
1922
 
            path = paths.get_path(trans_id)
1923
 
            # We could get the file_id, but dirstate prefers to use the path
1924
 
            # anyway, and it is 'cheaper' to determine.
1925
 
            # file_id = self._new_id[trans_id]
1926
 
            self._tree._observed_sha1(None, path, observed)
1927
 
 
1928
 
 
1929
 
class TransformPreview(DiskTreeTransform):
 
1507
 
 
1508
class TransformPreview(TreeTransformBase):
1930
1509
    """A TreeTransform for generating preview trees.
1931
1510
 
1932
1511
    Unlike TreeTransform, this version works when the input tree is a
1934
1513
    unversioned files in the input tree.
1935
1514
    """
1936
1515
 
1937
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1516
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1938
1517
        tree.lock_read()
1939
1518
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1940
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1519
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1941
1520
 
1942
1521
    def canonical_path(self, path):
1943
1522
        return path
1945
1524
    def tree_kind(self, trans_id):
1946
1525
        path = self._tree_id_paths.get(trans_id)
1947
1526
        if path is None:
1948
 
            return None
1949
 
        kind = self._tree.path_content_summary(path)[0]
1950
 
        if kind == 'missing':
1951
 
            kind = None
1952
 
        return kind
 
1527
            raise NoSuchFile(None)
 
1528
        file_id = self._tree.path2id(path)
 
1529
        return self._tree.kind(file_id)
1953
1530
 
1954
1531
    def _set_mode(self, trans_id, mode_id, typefunc):
1955
1532
        """Set the mode of new file contents.
1975
1552
            childpath = joinpath(path, child)
1976
1553
            yield self.trans_id_tree_path(childpath)
1977
1554
 
1978
 
    def new_orphan(self, trans_id, parent_id):
1979
 
        raise NotImplementedError(self.new_orphan)
1980
 
 
1981
 
 
1982
 
class _PreviewTree(tree.InventoryTree):
 
1555
 
 
1556
class _PreviewTree(tree.Tree):
1983
1557
    """Partial implementation of Tree to support show_diff_trees"""
1984
1558
 
1985
1559
    def __init__(self, transform):
1990
1564
        self._all_children_cache = {}
1991
1565
        self._path2trans_id_cache = {}
1992
1566
        self._final_name_cache = {}
1993
 
        self._iter_changes_cache = dict((c[0], c) for c in
1994
 
                                        self._transform.iter_changes())
 
1567
 
 
1568
    def _changes(self, file_id):
 
1569
        for changes in self._transform.iter_changes():
 
1570
            if changes[0] == file_id:
 
1571
                return changes
1995
1572
 
1996
1573
    def _content_change(self, file_id):
1997
1574
        """Return True if the content of this file changed"""
1998
 
        changes = self._iter_changes_cache.get(file_id)
 
1575
        changes = self._changes(file_id)
1999
1576
        # changes[2] is true if the file content changed.  See
2000
1577
        # InterTree.iter_changes.
2001
1578
        return (changes is not None and changes[2])
2014
1591
                yield self._get_repository().revision_tree(revision_id)
2015
1592
 
2016
1593
    def _get_file_revision(self, file_id, vf, tree_revision):
2017
 
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
1594
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
2018
1595
                       self._iter_parent_trees()]
2019
1596
        vf.add_lines((file_id, tree_revision), parent_keys,
2020
 
                     self.get_file_lines(file_id))
 
1597
                     self.get_file(file_id).readlines())
2021
1598
        repo = self._get_repository()
2022
1599
        base_vf = repo.texts
2023
1600
        if base_vf not in vf.fallback_versionedfiles:
2024
1601
            vf.fallback_versionedfiles.append(base_vf)
2025
1602
        return tree_revision
2026
1603
 
2027
 
    def _stat_limbo_file(self, file_id=None, trans_id=None):
2028
 
        if trans_id is None:
2029
 
            trans_id = self._transform.trans_id_file_id(file_id)
 
1604
    def _stat_limbo_file(self, file_id):
 
1605
        trans_id = self._transform.trans_id_file_id(file_id)
2030
1606
        name = self._transform._limbo_name(trans_id)
2031
1607
        return os.lstat(name)
2032
1608
 
2046
1622
            executable = self.is_executable(file_id, path)
2047
1623
        return kind, executable, None
2048
1624
 
2049
 
    def is_locked(self):
2050
 
        return False
2051
 
 
2052
1625
    def lock_read(self):
2053
1626
        # Perhaps in theory, this should lock the TreeTransform?
2054
 
        return self
 
1627
        pass
2055
1628
 
2056
1629
    def unlock(self):
2057
1630
        pass
2074
1647
    def __iter__(self):
2075
1648
        return iter(self.all_file_ids())
2076
1649
 
2077
 
    def _has_id(self, file_id, fallback_check):
 
1650
    def has_id(self, file_id):
2078
1651
        if file_id in self._transform._r_new_id:
2079
1652
            return True
2080
1653
        elif file_id in set([self._transform.tree_file_id(trans_id) for
2081
1654
            trans_id in self._transform._removed_id]):
2082
1655
            return False
2083
1656
        else:
2084
 
            return fallback_check(file_id)
2085
 
 
2086
 
    def has_id(self, file_id):
2087
 
        return self._has_id(file_id, self._transform._tree.has_id)
2088
 
 
2089
 
    def has_or_had_id(self, file_id):
2090
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
1657
            return self._transform._tree.has_id(file_id)
2091
1658
 
2092
1659
    def _path2trans_id(self, path):
2093
1660
        # We must not use None here, because that is a valid value to store.
2146
1713
            if self._transform.final_file_id(trans_id) is None:
2147
1714
                yield self._final_paths._determine_path(trans_id)
2148
1715
 
2149
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2150
 
        yield_parents=False):
 
1716
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
2151
1717
        for trans_id, parent_file_id in ordered_entries:
2152
1718
            file_id = self._transform.final_file_id(trans_id)
2153
1719
            if file_id is None:
2155
1721
            if (specific_file_ids is not None
2156
1722
                and file_id not in specific_file_ids):
2157
1723
                continue
2158
 
            kind = self._transform.final_kind(trans_id)
2159
 
            if kind is None:
 
1724
            try:
 
1725
                kind = self._transform.final_kind(trans_id)
 
1726
            except NoSuchFile:
2160
1727
                kind = self._transform._tree.stored_kind(file_id)
2161
1728
            new_entry = inventory.make_entry(
2162
1729
                kind,
2178
1745
                ordered_ids.append((trans_id, parent_file_id))
2179
1746
        return ordered_ids
2180
1747
 
2181
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
1748
    def iter_entries_by_dir(self, specific_file_ids=None):
2182
1749
        # This may not be a maximally efficient implementation, but it is
2183
1750
        # reasonably straightforward.  An implementation that grafts the
2184
1751
        # TreeTransform changes onto the tree's iter_entries_by_dir results
2186
1753
        # position.
2187
1754
        ordered_ids = self._list_files_by_dir()
2188
1755
        for entry, trans_id in self._make_inv_entries(ordered_ids,
2189
 
            specific_file_ids, yield_parents=yield_parents):
2190
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
2191
 
 
2192
 
    def _iter_entries_for_dir(self, dir_path):
2193
 
        """Return path, entry for items in a directory without recursing down."""
2194
 
        dir_file_id = self.path2id(dir_path)
2195
 
        ordered_ids = []
2196
 
        for file_id in self.iter_children(dir_file_id):
2197
 
            trans_id = self._transform.trans_id_file_id(file_id)
2198
 
            ordered_ids.append((trans_id, file_id))
2199
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
2200
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
2201
 
 
2202
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
2203
 
        """See WorkingTree.list_files."""
 
1756
                                                      specific_file_ids):
 
1757
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1758
 
 
1759
    def list_files(self, include_root=False):
 
1760
        """See Tree.list_files."""
2204
1761
        # XXX This should behave like WorkingTree.list_files, but is really
2205
1762
        # more like RevisionTree.list_files.
2206
 
        if recursive:
2207
 
            prefix = None
2208
 
            if from_dir:
2209
 
                prefix = from_dir + '/'
2210
 
            entries = self.iter_entries_by_dir()
2211
 
            for path, entry in entries:
2212
 
                if entry.name == '' and not include_root:
2213
 
                    continue
2214
 
                if prefix:
2215
 
                    if not path.startswith(prefix):
2216
 
                        continue
2217
 
                    path = path[len(prefix):]
2218
 
                yield path, 'V', entry.kind, entry.file_id, entry
2219
 
        else:
2220
 
            if from_dir is None and include_root is True:
2221
 
                root_entry = inventory.make_entry('directory', '',
2222
 
                    ROOT_PARENT, self.get_root_id())
2223
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
2224
 
            entries = self._iter_entries_for_dir(from_dir or '')
2225
 
            for path, entry in entries:
2226
 
                yield path, 'V', entry.kind, entry.file_id, entry
 
1763
        for path, entry in self.iter_entries_by_dir():
 
1764
            if entry.name == '' and not include_root:
 
1765
                continue
 
1766
            yield path, 'V', entry.kind, entry.file_id, entry
2227
1767
 
2228
1768
    def kind(self, file_id):
2229
1769
        trans_id = self._transform.trans_id_file_id(file_id)
2239
1779
    def get_file_mtime(self, file_id, path=None):
2240
1780
        """See Tree.get_file_mtime"""
2241
1781
        if not self._content_change(file_id):
2242
 
            return self._transform._tree.get_file_mtime(file_id)
 
1782
            return self._transform._tree.get_file_mtime(file_id, path)
2243
1783
        return self._stat_limbo_file(file_id).st_mtime
2244
1784
 
2245
1785
    def _file_size(self, entry, stat_value):
2247
1787
 
2248
1788
    def get_file_size(self, file_id):
2249
1789
        """See Tree.get_file_size"""
2250
 
        trans_id = self._transform.trans_id_file_id(file_id)
2251
 
        kind = self._transform.final_kind(trans_id)
2252
 
        if kind != 'file':
2253
 
            return None
2254
 
        if trans_id in self._transform._new_contents:
2255
 
            return self._stat_limbo_file(trans_id=trans_id).st_size
2256
1790
        if self.kind(file_id) == 'file':
2257
1791
            return self._transform._tree.get_file_size(file_id)
2258
1792
        else:
2259
1793
            return None
2260
1794
 
2261
 
    def get_file_verifier(self, file_id, path=None, stat_value=None):
2262
 
        trans_id = self._transform.trans_id_file_id(file_id)
2263
 
        kind = self._transform._new_contents.get(trans_id)
2264
 
        if kind is None:
2265
 
            return self._transform._tree.get_file_verifier(file_id)
2266
 
        if kind == 'file':
2267
 
            fileobj = self.get_file(file_id)
2268
 
            try:
2269
 
                return ("SHA1", sha_file(fileobj))
2270
 
            finally:
2271
 
                fileobj.close()
2272
 
 
2273
1795
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2274
1796
        trans_id = self._transform.trans_id_file_id(file_id)
2275
1797
        kind = self._transform._new_contents.get(trans_id)
2298
1820
            except errors.NoSuchId:
2299
1821
                return False
2300
1822
 
2301
 
    def has_filename(self, path):
2302
 
        trans_id = self._path2trans_id(path)
2303
 
        if trans_id in self._transform._new_contents:
2304
 
            return True
2305
 
        elif trans_id in self._transform._removed_contents:
2306
 
            return False
2307
 
        else:
2308
 
            return self._transform._tree.has_filename(path)
2309
 
 
2310
1823
    def path_content_summary(self, path):
2311
1824
        trans_id = self._path2trans_id(path)
2312
1825
        tt = self._transform
2326
1839
                statval = os.lstat(limbo_name)
2327
1840
                size = statval.st_size
2328
1841
                if not supports_executable():
2329
 
                    executable = False
 
1842
                    executable = None
2330
1843
                else:
2331
1844
                    executable = statval.st_mode & S_IEXEC
2332
1845
            else:
2334
1847
                executable = None
2335
1848
            if kind == 'symlink':
2336
1849
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2337
 
        executable = tt._new_executability.get(trans_id, executable)
 
1850
        if supports_executable():
 
1851
            executable = tt._new_executability.get(trans_id, executable)
2338
1852
        return kind, size, executable, link_or_sha1
2339
1853
 
2340
1854
    def iter_changes(self, from_tree, include_unchanged=False,
2366
1880
        name = self._transform._limbo_name(trans_id)
2367
1881
        return open(name, 'rb')
2368
1882
 
2369
 
    def get_file_with_stat(self, file_id, path=None):
2370
 
        return self.get_file(file_id, path), None
2371
 
 
2372
1883
    def annotate_iter(self, file_id,
2373
1884
                      default_revision=_mod_revision.CURRENT_REVISION):
2374
 
        changes = self._iter_changes_cache.get(file_id)
 
1885
        changes = self._changes(file_id)
2375
1886
        if changes is None:
2376
1887
            get_old = True
2377
1888
        else:
2389
1900
            return old_annotation
2390
1901
        if not changed_content:
2391
1902
            return old_annotation
2392
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2393
 
        #       doing, however it fails slightly because it doesn't know what
2394
 
        #       the *other* revision_id is, so it doesn't know how to give the
2395
 
        #       other as the origin for some lines, they all get
2396
 
        #       'default_revision'
2397
 
        #       It would be nice to be able to use the new Annotator based
2398
 
        #       approach, as well.
2399
1903
        return annotate.reannotate([old_annotation],
2400
1904
                                   self.get_file(file_id).readlines(),
2401
1905
                                   default_revision)
2402
1906
 
2403
 
    def get_symlink_target(self, file_id, path=None):
 
1907
    def get_symlink_target(self, file_id):
2404
1908
        """See Tree.get_symlink_target"""
2405
1909
        if not self._content_change(file_id):
2406
1910
            return self._transform._tree.get_symlink_target(file_id)
2407
1911
        trans_id = self._transform.trans_id_file_id(file_id)
2408
1912
        name = self._transform._limbo_name(trans_id)
2409
 
        return osutils.readlink(name)
 
1913
        return os.readlink(name)
2410
1914
 
2411
1915
    def walkdirs(self, prefix=''):
2412
1916
        pending = [self._transform.root]
2421
1925
                path_from_root = self._final_paths.get_path(child_id)
2422
1926
                basename = self._transform.final_name(child_id)
2423
1927
                file_id = self._transform.final_file_id(child_id)
2424
 
                kind  = self._transform.final_kind(child_id)
2425
 
                if kind is not None:
 
1928
                try:
 
1929
                    kind = self._transform.final_kind(child_id)
2426
1930
                    versioned_kind = kind
2427
 
                else:
 
1931
                except NoSuchFile:
2428
1932
                    kind = 'unknown'
2429
1933
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2430
1934
                if versioned_kind == 'directory':
2467
1971
        self.transform = transform
2468
1972
 
2469
1973
    def _determine_path(self, trans_id):
2470
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1974
        if trans_id == self.transform.root:
2471
1975
            return ""
2472
1976
        name = self.transform.final_name(trans_id)
2473
1977
        parent_id = self.transform.final_parent(trans_id)
2543
2047
    for num, _unused in enumerate(wt.all_file_ids()):
2544
2048
        if num > 0:  # more than just a root
2545
2049
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2050
    existing_files = set()
 
2051
    for dir, files in wt.walkdirs():
 
2052
        existing_files.update(f[0] for f in files)
2546
2053
    file_trans_id = {}
2547
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
2054
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2548
2055
    pp = ProgressPhase("Build phase", 2, top_pb)
2549
2056
    if tree.inventory.root is not None:
2550
2057
        # This is kind of a hack: we should be altering the root
2563
2070
        pp.next_phase()
2564
2071
        file_trans_id[wt.get_root_id()] = \
2565
2072
            tt.trans_id_tree_file_id(wt.get_root_id())
2566
 
        pb = ui.ui_factory.nested_progress_bar()
 
2073
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2567
2074
        try:
2568
2075
            deferred_contents = []
2569
2076
            num = 0
2572
2079
                precomputed_delta = []
2573
2080
            else:
2574
2081
                precomputed_delta = None
2575
 
            # Check if tree inventory has content. If so, we populate
2576
 
            # existing_files with the directory content. If there are no
2577
 
            # entries we skip populating existing_files as its not used.
2578
 
            # This improves performance and unncessary work on large
2579
 
            # directory trees. (#501307)
2580
 
            if total > 0:
2581
 
                existing_files = set()
2582
 
                for dir, files in wt.walkdirs():
2583
 
                    existing_files.update(f[0] for f in files)
2584
2082
            for num, (tree_path, entry) in \
2585
2083
                enumerate(tree.inventory.iter_entries_by_dir()):
2586
2084
                pb.update("Building tree", num - len(deferred_contents), total)
2616
2114
                    executable = tree.is_executable(file_id, tree_path)
2617
2115
                    if executable:
2618
2116
                        tt.set_executability(executable, trans_id)
2619
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
 
2117
                    trans_data = (trans_id, tree_path)
2620
2118
                    deferred_contents.append((file_id, trans_data))
2621
2119
                else:
2622
2120
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2638
2136
            precomputed_delta = None
2639
2137
        conflicts = cook_conflicts(raw_conflicts, tt)
2640
2138
        for conflict in conflicts:
2641
 
            trace.warning(unicode(conflict))
 
2139
            warning(conflict)
2642
2140
        try:
2643
2141
            wt.add_conflicts(conflicts)
2644
2142
        except errors.UnsupportedOperation:
2659
2157
        new_desired_files = desired_files
2660
2158
    else:
2661
2159
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2662
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2663
 
                     in iter if not (c or e[0] != e[1])]
2664
 
        if accelerator_tree.supports_content_filtering():
2665
 
            unchanged = [(f, p) for (f, p) in unchanged
2666
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2667
 
        unchanged = dict(unchanged)
 
2160
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
2161
                         in iter if not (c or e[0] != e[1]))
2668
2162
        new_desired_files = []
2669
2163
        count = 0
2670
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
2164
        for file_id, (trans_id, tree_path) in desired_files:
2671
2165
            accelerator_path = unchanged.get(file_id)
2672
2166
            if accelerator_path is None:
2673
 
                new_desired_files.append((file_id,
2674
 
                    (trans_id, tree_path, text_sha1)))
 
2167
                new_desired_files.append((file_id, (trans_id, tree_path)))
2675
2168
                continue
2676
2169
            pb.update('Adding file contents', count + offset, total)
2677
2170
            if hardlink:
2684
2177
                    contents = filtered_output_bytes(contents, filters,
2685
2178
                        ContentFilterContext(tree_path, tree))
2686
2179
                try:
2687
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2180
                    tt.create_file(contents, trans_id)
2688
2181
                finally:
2689
2182
                    try:
2690
2183
                        contents.close()
2693
2186
                        pass
2694
2187
            count += 1
2695
2188
        offset += count
2696
 
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
 
2189
    for count, ((trans_id, tree_path), contents) in enumerate(
2697
2190
            tree.iter_files_bytes(new_desired_files)):
2698
2191
        if wt.supports_content_filtering():
2699
2192
            filters = wt._content_filter_stack(tree_path)
2700
2193
            contents = filtered_output_bytes(contents, filters,
2701
2194
                ContentFilterContext(tree_path, tree))
2702
 
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2195
        tt.create_file(contents, trans_id)
2703
2196
        pb.update('Adding file contents', count + offset, total)
2704
2197
 
2705
2198
 
2707
2200
    for child in tt.iter_tree_children(old_parent):
2708
2201
        tt.adjust_path(tt.final_name(child), new_parent, child)
2709
2202
 
2710
 
 
2711
2203
def _reparent_transform_children(tt, old_parent, new_parent):
2712
2204
    by_parent = tt.by_parent()
2713
2205
    for child in by_parent[old_parent]:
2714
2206
        tt.adjust_path(tt.final_name(child), new_parent, child)
2715
2207
    return by_parent[old_parent]
2716
2208
 
2717
 
 
2718
2209
def _content_match(tree, entry, file_id, kind, target_path):
2719
2210
    if entry.kind != kind:
2720
2211
        return False
2721
2212
    if entry.kind == "directory":
2722
2213
        return True
2723
2214
    if entry.kind == "file":
2724
 
        f = file(target_path, 'rb')
2725
 
        try:
2726
 
            if tree.get_file_text(file_id) == f.read():
2727
 
                return True
2728
 
        finally:
2729
 
            f.close()
 
2215
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
2216
            return True
2730
2217
    elif entry.kind == "symlink":
2731
2218
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2732
2219
            return True
2784
2271
        raise errors.BadFileKindError(name, kind)
2785
2272
 
2786
2273
 
2787
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2788
 
    filter_tree_path=None):
2789
 
    """Create new file contents according to tree contents.
2790
 
    
2791
 
    :param filter_tree_path: the tree path to use to lookup
2792
 
      content filters to apply to the bytes output in the working tree.
2793
 
      This only applies if the working tree supports content filtering.
 
2274
@deprecated_function(deprecated_in((1, 9, 0)))
 
2275
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
2276
    """Create new file contents according to an inventory entry.
 
2277
 
 
2278
    DEPRECATED.  Use create_from_tree instead.
2794
2279
    """
 
2280
    if entry.kind == "file":
 
2281
        if lines is None:
 
2282
            lines = tree.get_file(entry.file_id).readlines()
 
2283
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
2284
    elif entry.kind == "symlink":
 
2285
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
2286
    elif entry.kind == "directory":
 
2287
        tt.create_directory(trans_id)
 
2288
 
 
2289
 
 
2290
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
 
2291
    """Create new file contents according to tree contents."""
2795
2292
    kind = tree.kind(file_id)
2796
2293
    if kind == 'directory':
2797
2294
        tt.create_directory(trans_id)
2802
2299
                bytes = tree_file.readlines()
2803
2300
            finally:
2804
2301
                tree_file.close()
2805
 
        wt = tt._tree
2806
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2807
 
            filters = wt._content_filter_stack(filter_tree_path)
2808
 
            bytes = filtered_output_bytes(bytes, filters,
2809
 
                ContentFilterContext(filter_tree_path, tree))
2810
2302
        tt.create_file(bytes, trans_id)
2811
2303
    elif kind == "symlink":
2812
2304
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2820
2312
        tt.set_executability(entry.executable, trans_id)
2821
2313
 
2822
2314
 
2823
 
@deprecated_function(deprecated_in((2, 3, 0)))
2824
2315
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2825
2316
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2826
2317
 
2827
2318
 
2828
 
@deprecated_function(deprecated_in((2, 3, 0)))
2829
2319
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2830
2320
    """Produce a backup-style name that appears to be available"""
2831
2321
    def name_gen():
2866
2356
 
2867
2357
 
2868
2358
def revert(working_tree, target_tree, filenames, backups=False,
2869
 
           pb=None, change_reporter=None):
 
2359
           pb=DummyProgress(), change_reporter=None):
2870
2360
    """Revert a working tree's contents to those of a target tree."""
2871
2361
    target_tree.lock_read()
2872
 
    pb = ui.ui_factory.nested_progress_bar()
2873
2362
    tt = TreeTransform(working_tree, pb)
2874
2363
    try:
2875
2364
        pp = ProgressPhase("Revert phase", 3, pb)
2880
2369
                unversioned_filter=working_tree.is_ignored)
2881
2370
            delta.report_changes(tt.iter_changes(), change_reporter)
2882
2371
        for conflict in conflicts:
2883
 
            trace.warning(unicode(conflict))
 
2372
            warning(conflict)
2884
2373
        pp.next_phase()
2885
2374
        tt.apply()
2886
2375
        working_tree.set_merge_modified(merge_modified)
2894
2383
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2895
2384
                              backups, pp, basis_tree=None,
2896
2385
                              merge_modified=None):
2897
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2386
    pp.next_phase()
 
2387
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2898
2388
    try:
2899
2389
        if merge_modified is None:
2900
2390
            merge_modified = working_tree.merge_modified()
2903
2393
                                      merge_modified, basis_tree)
2904
2394
    finally:
2905
2395
        child_pb.finished()
2906
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2396
    pp.next_phase()
 
2397
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2907
2398
    try:
2908
2399
        raw_conflicts = resolve_conflicts(tt, child_pb,
2909
2400
            lambda t, c: conflict_pass(t, c, target_tree))
2917
2408
                 backups, merge_modified, basis_tree=None):
2918
2409
    if basis_tree is not None:
2919
2410
        basis_tree.lock_read()
2920
 
    # We ask the working_tree for its changes relative to the target, rather
2921
 
    # than the target changes relative to the working tree. Because WT4 has an
2922
 
    # optimizer to compare itself to a target, but no optimizer for the
2923
 
    # reverse.
2924
 
    change_list = working_tree.iter_changes(target_tree,
 
2411
    change_list = target_tree.iter_changes(working_tree,
2925
2412
        specific_files=specific_files, pb=pb)
2926
2413
    if target_tree.get_root_id() is None:
2927
2414
        skip_root = True
2931
2418
        deferred_files = []
2932
2419
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2933
2420
                kind, executable) in enumerate(change_list):
2934
 
            target_path, wt_path = path
2935
 
            target_versioned, wt_versioned = versioned
2936
 
            target_parent, wt_parent = parent
2937
 
            target_name, wt_name = name
2938
 
            target_kind, wt_kind = kind
2939
 
            target_executable, wt_executable = executable
2940
 
            if skip_root and wt_parent is None:
 
2421
            if skip_root and file_id[0] is not None and parent[0] is None:
2941
2422
                continue
2942
2423
            trans_id = tt.trans_id_file_id(file_id)
2943
2424
            mode_id = None
2944
2425
            if changed_content:
2945
2426
                keep_content = False
2946
 
                if wt_kind == 'file' and (backups or target_kind is None):
 
2427
                if kind[0] == 'file' and (backups or kind[1] is None):
2947
2428
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2948
2429
                    if merge_modified.get(file_id) != wt_sha1:
2949
2430
                        # acquire the basis tree lazily to prevent the
2952
2433
                        if basis_tree is None:
2953
2434
                            basis_tree = working_tree.basis_tree()
2954
2435
                            basis_tree.lock_read()
2955
 
                        if basis_tree.has_id(file_id):
 
2436
                        if file_id in basis_tree:
2956
2437
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2957
2438
                                keep_content = True
2958
 
                        elif target_kind is None and not target_versioned:
 
2439
                        elif kind[1] is None and not versioned[1]:
2959
2440
                            keep_content = True
2960
 
                if wt_kind is not None:
 
2441
                if kind[0] is not None:
2961
2442
                    if not keep_content:
2962
2443
                        tt.delete_contents(trans_id)
2963
 
                    elif target_kind is not None:
2964
 
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
2965
 
                        backup_name = tt._available_backup_name(
2966
 
                            wt_name, parent_trans_id)
 
2444
                    elif kind[1] is not None:
 
2445
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2446
                        by_parent = tt.by_parent()
 
2447
                        backup_name = _get_backup_name(name[0], by_parent,
 
2448
                                                       parent_trans_id, tt)
2967
2449
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2968
 
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
2969
 
                        if wt_versioned and target_versioned:
 
2450
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2451
                        if versioned == (True, True):
2970
2452
                            tt.unversion_file(trans_id)
2971
2453
                            tt.version_file(file_id, new_trans_id)
2972
2454
                        # New contents should have the same unix perms as old
2973
2455
                        # contents
2974
2456
                        mode_id = trans_id
2975
2457
                        trans_id = new_trans_id
2976
 
                if target_kind in ('directory', 'tree-reference'):
 
2458
                if kind[1] in ('directory', 'tree-reference'):
2977
2459
                    tt.create_directory(trans_id)
2978
 
                    if target_kind == 'tree-reference':
 
2460
                    if kind[1] == 'tree-reference':
2979
2461
                        revision = target_tree.get_reference_revision(file_id,
2980
 
                                                                      target_path)
 
2462
                                                                      path[1])
2981
2463
                        tt.set_tree_reference(revision, trans_id)
2982
 
                elif target_kind == 'symlink':
 
2464
                elif kind[1] == 'symlink':
2983
2465
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2984
2466
                                      trans_id)
2985
 
                elif target_kind == 'file':
 
2467
                elif kind[1] == 'file':
2986
2468
                    deferred_files.append((file_id, (trans_id, mode_id)))
2987
2469
                    if basis_tree is None:
2988
2470
                        basis_tree = working_tree.basis_tree()
2989
2471
                        basis_tree.lock_read()
2990
2472
                    new_sha1 = target_tree.get_file_sha1(file_id)
2991
 
                    if (basis_tree.has_id(file_id) and
2992
 
                        new_sha1 == basis_tree.get_file_sha1(file_id)):
 
2473
                    if (file_id in basis_tree and new_sha1 ==
 
2474
                        basis_tree.get_file_sha1(file_id)):
2993
2475
                        if file_id in merge_modified:
2994
2476
                            del merge_modified[file_id]
2995
2477
                    else:
2996
2478
                        merge_modified[file_id] = new_sha1
2997
2479
 
2998
2480
                    # preserve the execute bit when backing up
2999
 
                    if keep_content and wt_executable == target_executable:
3000
 
                        tt.set_executability(target_executable, trans_id)
3001
 
                elif target_kind is not None:
3002
 
                    raise AssertionError(target_kind)
3003
 
            if not wt_versioned and target_versioned:
 
2481
                    if keep_content and executable[0] == executable[1]:
 
2482
                        tt.set_executability(executable[1], trans_id)
 
2483
                elif kind[1] is not None:
 
2484
                    raise AssertionError(kind[1])
 
2485
            if versioned == (False, True):
3004
2486
                tt.version_file(file_id, trans_id)
3005
 
            if wt_versioned and not target_versioned:
 
2487
            if versioned == (True, False):
3006
2488
                tt.unversion_file(trans_id)
3007
 
            if (target_name is not None and
3008
 
                (wt_name != target_name or wt_parent != target_parent)):
3009
 
                if target_name == '' and target_parent is None:
 
2489
            if (name[1] is not None and
 
2490
                (name[0] != name[1] or parent[0] != parent[1])):
 
2491
                if name[1] == '' and parent[1] is None:
3010
2492
                    parent_trans = ROOT_PARENT
3011
2493
                else:
3012
 
                    parent_trans = tt.trans_id_file_id(target_parent)
3013
 
                if wt_parent is None and wt_versioned:
3014
 
                    tt.adjust_root_path(target_name, parent_trans)
3015
 
                else:
3016
 
                    tt.adjust_path(target_name, parent_trans, trans_id)
3017
 
            if wt_executable != target_executable and target_kind == "file":
3018
 
                tt.set_executability(target_executable, trans_id)
3019
 
        if working_tree.supports_content_filtering():
3020
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
3021
 
                target_tree.iter_files_bytes(deferred_files)):
3022
 
                file_id = deferred_files[index][0]
3023
 
                # We're reverting a tree to the target tree so using the
3024
 
                # target tree to find the file path seems the best choice
3025
 
                # here IMO - Ian C 27/Oct/2009
3026
 
                filter_tree_path = target_tree.id2path(file_id)
3027
 
                filters = working_tree._content_filter_stack(filter_tree_path)
3028
 
                bytes = filtered_output_bytes(bytes, filters,
3029
 
                    ContentFilterContext(filter_tree_path, working_tree))
3030
 
                tt.create_file(bytes, trans_id, mode_id)
3031
 
        else:
3032
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3033
 
                deferred_files):
3034
 
                tt.create_file(bytes, trans_id, mode_id)
3035
 
        tt.fixup_new_roots()
 
2494
                    parent_trans = tt.trans_id_file_id(parent[1])
 
2495
                tt.adjust_path(name[1], parent_trans, trans_id)
 
2496
            if executable[0] != executable[1] and kind[1] == "file":
 
2497
                tt.set_executability(executable[1], trans_id)
 
2498
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2499
            deferred_files):
 
2500
            tt.create_file(bytes, trans_id, mode_id)
3036
2501
    finally:
3037
2502
        if basis_tree is not None:
3038
2503
            basis_tree.unlock()
3039
2504
    return merge_modified
3040
2505
 
3041
2506
 
3042
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2507
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3043
2508
    """Make many conflict-resolution attempts, but die if they fail"""
3044
2509
    if pass_func is None:
3045
2510
        pass_func = conflict_pass
3046
2511
    new_conflicts = set()
3047
 
    pb = ui.ui_factory.nested_progress_bar()
3048
2512
    try:
3049
2513
        for n in range(10):
3050
2514
            pb.update('Resolution pass', n+1, 10)
3054
2518
            new_conflicts.update(pass_func(tt, conflicts))
3055
2519
        raise MalformedTransform(conflicts=conflicts)
3056
2520
    finally:
3057
 
        pb.finished()
 
2521
        pb.clear()
3058
2522
 
3059
2523
 
3060
2524
def conflict_pass(tt, conflicts, path_tree=None):
3092
2556
 
3093
2557
        elif c_type == 'missing parent':
3094
2558
            trans_id = conflict[1]
3095
 
            if trans_id in tt._removed_contents:
3096
 
                cancel_deletion = True
3097
 
                orphans = tt._get_potential_orphans(trans_id)
3098
 
                if orphans:
3099
 
                    cancel_deletion = False
3100
 
                    # All children are orphans
3101
 
                    for o in orphans:
3102
 
                        try:
3103
 
                            tt.new_orphan(o, trans_id)
3104
 
                        except OrphaningError:
3105
 
                            # Something bad happened so we cancel the directory
3106
 
                            # deletion which will leave it in place with a
3107
 
                            # conflict. The user can deal with it from there.
3108
 
                            # Note that this also catch the case where we don't
3109
 
                            # want to create orphans and leave the directory in
3110
 
                            # place.
3111
 
                            cancel_deletion = True
3112
 
                            break
3113
 
                if cancel_deletion:
3114
 
                    # Cancel the directory deletion
3115
 
                    tt.cancel_deletion(trans_id)
3116
 
                    new_conflicts.add(('deleting parent', 'Not deleting',
3117
 
                                       trans_id))
3118
 
            else:
 
2559
            try:
 
2560
                tt.cancel_deletion(trans_id)
 
2561
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2562
                                   trans_id))
 
2563
            except KeyError:
3119
2564
                create = True
3120
2565
                try:
3121
2566
                    tt.final_name(trans_id)
3124
2569
                        file_id = tt.final_file_id(trans_id)
3125
2570
                        if file_id is None:
3126
2571
                            file_id = tt.inactive_file_id(trans_id)
3127
 
                        _, entry = path_tree.iter_entries_by_dir(
3128
 
                            [file_id]).next()
 
2572
                        entry = path_tree.inventory[file_id]
3129
2573
                        # special-case the other tree root (move its
3130
2574
                        # children to current root)
3131
2575
                        if entry.parent_id is None:
3132
 
                            create = False
 
2576
                            create=False
3133
2577
                            moved = _reparent_transform_children(
3134
2578
                                tt, trans_id, tt.root)
3135
2579
                            for child in moved:
3146
2590
        elif c_type == 'unversioned parent':
3147
2591
            file_id = tt.inactive_file_id(conflict[1])
3148
2592
            # special-case the other tree root (move its children instead)
3149
 
            if path_tree and path_tree.has_id(file_id):
3150
 
                if path_tree.path2id('') == file_id:
3151
 
                    # This is the root entry, skip it
 
2593
            if path_tree and file_id in path_tree:
 
2594
                if path_tree.inventory[file_id].parent_id is None:
3152
2595
                    continue
3153
2596
            tt.version_file(file_id, conflict[1])
3154
2597
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3170
2613
 
3171
2614
def cook_conflicts(raw_conflicts, tt):
3172
2615
    """Generate a list of cooked conflicts, sorted by file path"""
 
2616
    from bzrlib.conflicts import Conflict
3173
2617
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3174
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
2618
    return sorted(conflict_iter, key=Conflict.sort_key)
3175
2619
 
3176
2620
 
3177
2621
def iter_cook_conflicts(raw_conflicts, tt):
 
2622
    from bzrlib.conflicts import Conflict
3178
2623
    fp = FinalPaths(tt)
3179
2624
    for conflict in raw_conflicts:
3180
2625
        c_type = conflict[0]
3182
2627
        modified_path = fp.get_path(conflict[2])
3183
2628
        modified_id = tt.final_file_id(conflict[2])
3184
2629
        if len(conflict) == 3:
3185
 
            yield conflicts.Conflict.factory(
3186
 
                c_type, action=action, path=modified_path, file_id=modified_id)
 
2630
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2631
                                     file_id=modified_id)
3187
2632
 
3188
2633
        else:
3189
2634
            conflicting_path = fp.get_path(conflict[3])
3190
2635
            conflicting_id = tt.final_file_id(conflict[3])
3191
 
            yield conflicts.Conflict.factory(
3192
 
                c_type, action=action, path=modified_path,
3193
 
                file_id=modified_id,
3194
 
                conflict_path=conflicting_path,
3195
 
                conflict_file_id=conflicting_id)
 
2636
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2637
                                   file_id=modified_id,
 
2638
                                   conflict_path=conflicting_path,
 
2639
                                   conflict_file_id=conflicting_id)
3196
2640
 
3197
2641
 
3198
2642
class _FileMover(object):
3203
2647
        self.pending_deletions = []
3204
2648
 
3205
2649
    def rename(self, from_, to):
3206
 
        """Rename a file from one path to another."""
 
2650
        """Rename a file from one path to another.  Functions like os.rename"""
3207
2651
        try:
3208
2652
            os.rename(from_, to)
3209
2653
        except OSError, e:
3210
2654
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3211
2655
                raise errors.FileExists(to, str(e))
3212
 
            # normal OSError doesn't include filenames so it's hard to see where
3213
 
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3214
 
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
 
2656
            raise
3215
2657
        self.past_renames.append((from_, to))
3216
2658
 
3217
2659
    def pre_delete(self, from_, to):
3227
2669
    def rollback(self):
3228
2670
        """Reverse all renames that have been performed"""
3229
2671
        for from_, to in reversed(self.past_renames):
3230
 
            try:
3231
 
                os.rename(to, from_)
3232
 
            except OSError, e:
3233
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
 
2672
            os.rename(to, from_)
3234
2673
        # after rollback, don't reuse _FileMover
3235
2674
        past_renames = None
3236
2675
        pending_deletions = None