← Back to branch summary

~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: 2008-09-11 06:10:59 UTC
  • mfrom: (3702.1.1 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20080911061059-svzqfejar17ui4zw
(mbp) KnitVersionedFiles repr

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import errno
19
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
 
    multiparent,
40
29
    osutils,
41
30
    revision as _mod_revision,
42
 
    ui,
43
 
    urlutils,
44
31
    )
45
32
""")
46
33
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
47
 
                           ReusingTransform, CantMoveRoot,
 
34
                           ReusingTransform, NotVersionedError, CantMoveRoot,
48
35
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
49
36
                           UnableCreateSymlink)
50
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
 
37
from bzrlib.inventory import InventoryEntry
51
38
from bzrlib.osutils import (
52
39
    delete_any,
53
40
    file_kind,
54
41
    has_symlinks,
 
42
    lexists,
55
43
    pathjoin,
56
 
    sha_file,
57
44
    splitpath,
58
45
    supports_executable,
59
 
    )
60
 
from bzrlib.progress import ProgressPhase
 
46
)
 
47
from bzrlib.progress import DummyProgress, ProgressPhase
61
48
from bzrlib.symbol_versioning import (
62
 
    deprecated_function,
63
 
    deprecated_in,
64
 
    deprecated_method,
65
 
    )
 
49
        deprecated_function,
 
50
        )
 
51
from bzrlib.trace import mutter, warning
 
52
from bzrlib import tree
 
53
import bzrlib.ui
 
54
import bzrlib.urlutils as urlutils
66
55
 
67
56
 
68
57
ROOT_PARENT = "root-parent"
69
58
 
 
59
 
70
60
def unique_add(map, key, value):
71
61
    if key in map:
72
62
        raise DuplicateKey(key=key)
73
63
    map[key] = value
74
64
 
75
65
 
76
 
 
77
66
class _TransformResults(object):
78
67
    def __init__(self, modified_paths, rename_count):
79
68
        object.__init__(self)
82
71
 
83
72
 
84
73
class TreeTransformBase(object):
85
 
    """The base class for TreeTransform and its kin."""
 
74
    """The base class for TreeTransform and TreeTransformBase"""
86
75
 
87
 
    def __init__(self, tree, pb=None,
 
76
    def __init__(self, tree, limbodir, pb=DummyProgress(),
88
77
                 case_sensitive=True):
89
78
        """Constructor.
90
79
 
91
80
        :param tree: The tree that will be transformed, but not necessarily
92
81
            the output tree.
93
 
        :param pb: ignored
 
82
        :param limbodir: A directory where new files can be stored until
 
83
            they are installed in their proper places
 
84
        :param pb: A ProgressBar indicating how much progress is being made
94
85
        :param case_sensitive: If True, the target of the transform is
95
86
            case sensitive, not just case preserving.
96
87
        """
97
88
        object.__init__(self)
98
89
        self._tree = tree
 
90
        self._limbodir = limbodir
 
91
        self._deletiondir = None
99
92
        self._id_number = 0
100
93
        # mapping of trans_id -> new basename
101
94
        self._new_name = {}
103
96
        self._new_parent = {}
104
97
        # mapping of trans_id with new contents -> new file_kind
105
98
        self._new_contents = {}
106
 
        # mapping of trans_id => (sha1 of content, stat_value)
107
 
        self._observed_sha1s = {}
 
99
        # A mapping of transform ids to their limbo filename
 
100
        self._limbo_files = {}
 
101
        # A mapping of transform ids to a set of the transform ids of children
 
102
        # that their limbo directory has
 
103
        self._limbo_children = {}
 
104
        # Map transform ids to maps of child filename to child transform id
 
105
        self._limbo_children_names = {}
 
106
        # List of transform ids that need to be renamed from limbo into place
 
107
        self._needs_rename = set()
108
108
        # Set of trans_ids whose contents will be removed
109
109
        self._removed_contents = set()
110
110
        # Mapping of trans_id -> new execute-bit value
117
117
        self._non_present_ids = {}
118
118
        # Mapping of new file_id -> trans_id
119
119
        self._r_new_id = {}
120
 
        # Set of trans_ids that will be removed
 
120
        # Set of file_ids that will be removed
121
121
        self._removed_id = set()
122
122
        # Mapping of path in old tree -> trans_id
123
123
        self._tree_path_ids = {}
124
124
        # Mapping trans_id -> path in old tree
125
125
        self._tree_id_paths = {}
 
126
        # Cache of realpath results, to speed up canonical_path
 
127
        self._realpaths = {}
 
128
        # Cache of relpath results, to speed up canonical_path
 
129
        self._relpaths = {}
126
130
        # The trans_id that will be used as the tree root
127
131
        root_id = tree.get_root_id()
128
132
        if root_id is not None:
129
133
            self._new_root = self.trans_id_tree_file_id(root_id)
130
134
        else:
131
135
            self._new_root = None
132
 
        # Indicator of whether the transform has been applied
 
136
        # Indictor of whether the transform has been applied
133
137
        self._done = False
134
138
        # A progress bar
135
139
        self._pb = pb
138
142
        # A counter of how many files have been renamed
139
143
        self.rename_count = 0
140
144
 
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
145
    def __get_root(self):
161
146
        return self._new_root
162
147
 
163
148
    root = property(__get_root)
164
149
 
 
150
    def finalize(self):
 
151
        """Release the working tree lock, if held, clean up limbo dir.
 
152
 
 
153
        This is required if apply has not been invoked, but can be invoked
 
154
        even after apply.
 
155
        """
 
156
        if self._tree is None:
 
157
            return
 
158
        try:
 
159
            entries = [(self._limbo_name(t), t, k) for t, k in
 
160
                       self._new_contents.iteritems()]
 
161
            entries.sort(reverse=True)
 
162
            for path, trans_id, kind in entries:
 
163
                if kind == "directory":
 
164
                    os.rmdir(path)
 
165
                else:
 
166
                    os.unlink(path)
 
167
            try:
 
168
                os.rmdir(self._limbodir)
 
169
            except OSError:
 
170
                # We don't especially care *why* the dir is immortal.
 
171
                raise ImmortalLimbo(self._limbodir)
 
172
            try:
 
173
                if self._deletiondir is not None:
 
174
                    os.rmdir(self._deletiondir)
 
175
            except OSError:
 
176
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
177
        finally:
 
178
            self._tree.unlock()
 
179
            self._tree = None
 
180
 
165
181
    def _assign_id(self):
166
182
        """Produce a new tranform id"""
167
183
        new_id = "new-%s" % self._id_number
177
193
 
178
194
    def adjust_path(self, name, parent, trans_id):
179
195
        """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
196
        if trans_id == self._new_root:
183
197
            raise CantMoveRoot
 
198
        previous_parent = self._new_parent.get(trans_id)
 
199
        previous_name = self._new_name.get(trans_id)
184
200
        self._new_name[trans_id] = name
185
201
        self._new_parent[trans_id] = parent
 
202
        if parent == ROOT_PARENT:
 
203
            if self._new_root is not None:
 
204
                raise ValueError("Cannot have multiple roots.")
 
205
            self._new_root = trans_id
 
206
        if (trans_id in self._limbo_files and
 
207
            trans_id not in self._needs_rename):
 
208
            self._rename_in_limbo([trans_id])
 
209
            self._limbo_children[previous_parent].remove(trans_id)
 
210
            del self._limbo_children_names[previous_parent][previous_name]
 
211
 
 
212
    def _rename_in_limbo(self, trans_ids):
 
213
        """Fix limbo names so that the right final path is produced.
 
214
 
 
215
        This means we outsmarted ourselves-- we tried to avoid renaming
 
216
        these files later by creating them with their final names in their
 
217
        final parents.  But now the previous name or parent is no longer
 
218
        suitable, so we have to rename them.
 
219
 
 
220
        Even for trans_ids that have no new contents, we must remove their
 
221
        entries from _limbo_files, because they are now stale.
 
222
        """
 
223
        for trans_id in trans_ids:
 
224
            old_path = self._limbo_files.pop(trans_id)
 
225
            if trans_id not in self._new_contents:
 
226
                continue
 
227
            new_path = self._limbo_name(trans_id)
 
228
            os.rename(old_path, new_path)
186
229
 
187
230
    def adjust_root_path(self, name, parent):
188
231
        """Emulate moving the root by moving all children, instead.
189
 
 
 
232
        
190
233
        We do this by undoing the association of root's transaction id with the
191
234
        current tree.  This allows us to create a new directory with that
192
 
        transaction id.  We unversion the root directory and version the
 
235
        transaction id.  We unversion the root directory and version the 
193
236
        physically new directory, and hope someone versions the tree root
194
237
        later.
195
238
        """
198
241
        # force moving all children of root
199
242
        for child_id in self.iter_tree_children(old_root):
200
243
            if child_id != parent:
201
 
                self.adjust_path(self.final_name(child_id),
 
244
                self.adjust_path(self.final_name(child_id), 
202
245
                                 self.final_parent(child_id), child_id)
203
246
            file_id = self.final_file_id(child_id)
204
247
            if file_id is not None:
205
248
                self.unversion_file(child_id)
206
249
            self.version_file(file_id, child_id)
207
 
 
 
250
        
208
251
        # the physical root needs a new transaction id
209
252
        self._tree_path_ids.pop("")
210
253
        self._tree_id_paths.pop(old_root)
216
259
        self.version_file(old_root_file_id, old_root)
217
260
        self.unversion_file(self._new_root)
218
261
 
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
262
    def trans_id_tree_file_id(self, inventory_id):
281
263
        """Determine the transaction id of a working tree file.
282
 
 
 
264
        
283
265
        This reflects only files that already exist, not ones that will be
284
266
        added by transactions.
285
267
        """
298
280
            raise ValueError('None is not a valid file id')
299
281
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
300
282
            return self._r_new_id[file_id]
301
 
        else:
302
 
            try:
303
 
                self._tree.iter_entries_by_dir([file_id]).next()
304
 
            except StopIteration:
305
 
                if file_id in self._non_present_ids:
306
 
                    return self._non_present_ids[file_id]
307
 
                else:
308
 
                    trans_id = self._assign_id()
309
 
                    self._non_present_ids[file_id] = trans_id
310
 
                    return trans_id
311
 
            else:
312
 
                return self.trans_id_tree_file_id(file_id)
 
283
        elif file_id in self._tree.inventory:
 
284
            return self.trans_id_tree_file_id(file_id)
 
285
        elif file_id in self._non_present_ids:
 
286
            return self._non_present_ids[file_id]
 
287
        else:
 
288
            trans_id = self._assign_id()
 
289
            self._non_present_ids[file_id] = trans_id
 
290
            return trans_id
 
291
 
 
292
    def canonical_path(self, path):
 
293
        """Get the canonical tree-relative path"""
 
294
        # don't follow final symlinks
 
295
        abs = self._tree.abspath(path)
 
296
        if abs in self._relpaths:
 
297
            return self._relpaths[abs]
 
298
        dirname, basename = os.path.split(abs)
 
299
        if dirname not in self._realpaths:
 
300
            self._realpaths[dirname] = os.path.realpath(dirname)
 
301
        dirname = self._realpaths[dirname]
 
302
        abs = pathjoin(dirname, basename)
 
303
        if dirname in self._relpaths:
 
304
            relpath = pathjoin(self._relpaths[dirname], basename)
 
305
            relpath = relpath.rstrip('/\\')
 
306
        else:
 
307
            relpath = self._tree.relpath(abs)
 
308
        self._relpaths[abs] = relpath
 
309
        return relpath
313
310
 
314
311
    def trans_id_tree_path(self, path):
315
312
        """Determine (and maybe set) the transaction ID for a tree path."""
326
323
            return ROOT_PARENT
327
324
        return self.trans_id_tree_path(os.path.dirname(path))
328
325
 
 
326
    def create_file(self, contents, trans_id, mode_id=None):
 
327
        """Schedule creation of a new file.
 
328
 
 
329
        See also new_file.
 
330
        
 
331
        Contents is an iterator of strings, all of which will be written
 
332
        to the target destination.
 
333
 
 
334
        New file takes the permissions of any existing file with that id,
 
335
        unless mode_id is specified.
 
336
        """
 
337
        name = self._limbo_name(trans_id)
 
338
        f = open(name, 'wb')
 
339
        try:
 
340
            try:
 
341
                unique_add(self._new_contents, trans_id, 'file')
 
342
            except:
 
343
                # Clean up the file, it never got registered so
 
344
                # TreeTransform.finalize() won't clean it up.
 
345
                f.close()
 
346
                os.unlink(name)
 
347
                raise
 
348
 
 
349
            f.writelines(contents)
 
350
        finally:
 
351
            f.close()
 
352
        self._set_mode(trans_id, mode_id, S_ISREG)
 
353
 
 
354
    def _set_mode(self, trans_id, mode_id, typefunc):
 
355
        """Set the mode of new file contents.
 
356
        The mode_id is the existing file to get the mode from (often the same
 
357
        as trans_id).  The operation is only performed if there's a mode match
 
358
        according to typefunc.
 
359
        """
 
360
        if mode_id is None:
 
361
            mode_id = trans_id
 
362
        try:
 
363
            old_path = self._tree_id_paths[mode_id]
 
364
        except KeyError:
 
365
            return
 
366
        try:
 
367
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
368
        except OSError, e:
 
369
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
370
                # Either old_path doesn't exist, or the parent of the
 
371
                # target is not a directory (but will be one eventually)
 
372
                # Either way, we know it doesn't exist *right now*
 
373
                # See also bug #248448
 
374
                return
 
375
            else:
 
376
                raise
 
377
        if typefunc(mode):
 
378
            os.chmod(self._limbo_name(trans_id), mode)
 
379
 
 
380
    def create_hardlink(self, path, trans_id):
 
381
        """Schedule creation of a hard link"""
 
382
        name = self._limbo_name(trans_id)
 
383
        try:
 
384
            os.link(path, name)
 
385
        except OSError, e:
 
386
            if e.errno != errno.EPERM:
 
387
                raise
 
388
            raise errors.HardLinkNotSupported(path)
 
389
        try:
 
390
            unique_add(self._new_contents, trans_id, 'file')
 
391
        except:
 
392
            # Clean up the file, it never got registered so
 
393
            # TreeTransform.finalize() won't clean it up.
 
394
            os.unlink(name)
 
395
            raise
 
396
 
 
397
    def create_directory(self, trans_id):
 
398
        """Schedule creation of a new directory.
 
399
        
 
400
        See also new_directory.
 
401
        """
 
402
        os.mkdir(self._limbo_name(trans_id))
 
403
        unique_add(self._new_contents, trans_id, 'directory')
 
404
 
 
405
    def create_symlink(self, target, trans_id):
 
406
        """Schedule creation of a new symbolic link.
 
407
 
 
408
        target is a bytestring.
 
409
        See also new_symlink.
 
410
        """
 
411
        if has_symlinks():
 
412
            os.symlink(target, self._limbo_name(trans_id))
 
413
            unique_add(self._new_contents, trans_id, 'symlink')
 
414
        else:
 
415
            try:
 
416
                path = FinalPaths(self).get_path(trans_id)
 
417
            except KeyError:
 
418
                path = None
 
419
            raise UnableCreateSymlink(path=path)
 
420
 
 
421
    def cancel_creation(self, trans_id):
 
422
        """Cancel the creation of new file contents."""
 
423
        del self._new_contents[trans_id]
 
424
        children = self._limbo_children.get(trans_id)
 
425
        # if this is a limbo directory with children, move them before removing
 
426
        # the directory
 
427
        if children is not None:
 
428
            self._rename_in_limbo(children)
 
429
            del self._limbo_children[trans_id]
 
430
            del self._limbo_children_names[trans_id]
 
431
        delete_any(self._limbo_name(trans_id))
 
432
 
329
433
    def delete_contents(self, trans_id):
330
434
        """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)
 
435
        self.tree_kind(trans_id)
 
436
        self._removed_contents.add(trans_id)
334
437
 
335
438
    def cancel_deletion(self, trans_id):
336
439
        """Cancel a scheduled deletion"""
393
496
        return sorted(FinalPaths(self).get_paths(new_ids))
394
497
 
395
498
    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,
 
499
        """Get the trans_ids and paths of files needing new inv entries."""
 
500
        new_ids = set()
 
501
        for id_set in [self._new_name, self._new_parent, self._new_id,
414
502
                       self._new_executability]:
415
 
            changed_ids.update(id_set)
416
 
        # removing implies a kind change
 
503
            new_ids.update(id_set)
417
504
        changed_kind = set(self._removed_contents)
418
 
        # so does adding
419
505
        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))
 
506
        changed_kind.difference_update(new_ids)
 
507
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
508
                        self.final_kind(t))
 
509
        new_ids.update(changed_kind)
 
510
        return sorted(FinalPaths(self).get_paths(new_ids))
 
511
 
 
512
    def tree_kind(self, trans_id):
 
513
        """Determine the file kind in the working tree.
 
514
 
 
515
        Raises NoSuchFile if the file does not exist
 
516
        """
 
517
        path = self._tree_id_paths.get(trans_id)
 
518
        if path is None:
 
519
            raise NoSuchFile(None)
 
520
        try:
 
521
            return file_kind(self._tree.abspath(path))
 
522
        except OSError, e:
 
523
            if e.errno != errno.ENOENT:
 
524
                raise
 
525
            else:
 
526
                raise NoSuchFile(path)
434
527
 
435
528
    def final_kind(self, trans_id):
436
529
        """Determine the final file kind, after any changes applied.
437
 
 
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)
 
530
        
 
531
        Raises NoSuchFile if the file does not exist/has no contents.
 
532
        (It is conceivable that a path would be created without the
 
533
        corresponding contents insertion command)
441
534
        """
442
535
        if trans_id in self._new_contents:
443
536
            return self._new_contents[trans_id]
444
537
        elif trans_id in self._removed_contents:
445
 
            return None
 
538
            raise NoSuchFile(None)
446
539
        else:
447
540
            return self.tree_kind(trans_id)
448
541
 
456
549
        # the file is old; the old id is still valid
457
550
        if self._new_root == trans_id:
458
551
            return self._tree.get_root_id()
459
 
        return self._tree.path2id(path)
 
552
        return self._tree.inventory.path2id(path)
460
553
 
461
554
    def final_file_id(self, trans_id):
462
555
        """Determine the file id after any changes are applied, or None.
463
 
 
 
556
        
464
557
        None indicates that the file will not be versioned after changes are
465
558
        applied.
466
559
        """
505
598
 
506
599
    def by_parent(self):
507
600
        """Return a map of parent: children for known parents.
508
 
 
 
601
        
509
602
        Only new paths and parents of tree files with assigned ids are used.
510
603
        """
511
604
        by_parent = {}
512
605
        items = list(self._new_parent.iteritems())
513
 
        items.extend((t, self.final_parent(t)) for t in
 
606
        items.extend((t, self.final_parent(t)) for t in 
514
607
                      self._tree_id_paths.keys())
515
608
        for trans_id, parent_id in items:
516
609
            if parent_id not in by_parent:
544
637
        conflicts.extend(self._overwrite_conflicts())
545
638
        return conflicts
546
639
 
547
 
    def _check_malformed(self):
548
 
        conflicts = self.find_conflicts()
549
 
        if len(conflicts) != 0:
550
 
            raise MalformedTransform(conflicts=conflicts)
551
 
 
552
640
    def _add_tree_children(self):
553
641
        """Add all the children of all active parents to the known paths.
554
642
 
556
644
        removed.  This is a necessary first step in detecting conflicts.
557
645
        """
558
646
        parents = self.by_parent().keys()
559
 
        parents.extend([t for t in self._removed_contents if
 
647
        parents.extend([t for t in self._removed_contents if 
560
648
                        self.tree_kind(t) == 'directory'])
561
649
        for trans_id in self._removed_id:
562
650
            file_id = self.tree_file_id(trans_id)
563
651
            if file_id is not None:
564
 
                # XXX: This seems like something that should go via a different
565
 
                #      indirection.
566
652
                if self._tree.inventory[file_id].kind == 'directory':
567
653
                    parents.append(trans_id)
568
654
            elif self.tree_kind(trans_id) == 'directory':
572
658
            # ensure that all children are registered with the transaction
573
659
            list(self.iter_tree_children(parent_id))
574
660
 
575
 
    @deprecated_method(deprecated_in((2, 3, 0)))
 
661
    def iter_tree_children(self, parent_id):
 
662
        """Iterate through the entry's tree children, if any"""
 
663
        try:
 
664
            path = self._tree_id_paths[parent_id]
 
665
        except KeyError:
 
666
            return
 
667
        try:
 
668
            children = os.listdir(self._tree.abspath(path))
 
669
        except OSError, e:
 
670
            if not (osutils._is_error_enotdir(e)
 
671
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
672
                raise
 
673
            return
 
674
 
 
675
        for child in children:
 
676
            childpath = joinpath(path, child)
 
677
            if self._tree.is_control_filename(childpath):
 
678
                continue
 
679
            yield self.trans_id_tree_path(childpath)
 
680
 
576
681
    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:
 
682
        try:
 
683
            children = by_parent[parent_id]
 
684
        except KeyError:
 
685
            children = []
 
686
        for child in children:
594
687
            if self.final_name(child) == name:
595
688
                return True
596
 
        parent_path = self._tree_id_paths.get(parent_id, None)
597
 
        if parent_path is None:
598
 
            # No parent... no children
 
689
        try:
 
690
            path = self._tree_id_paths[parent_id]
 
691
        except KeyError:
599
692
            return False
600
 
        child_path = joinpath(parent_path, name)
601
 
        child_id = self._tree_path_ids.get(child_path, None)
 
693
        childpath = joinpath(path, name)
 
694
        child_id = self._tree_path_ids.get(childpath)
602
695
        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))
 
696
            return lexists(self._tree.abspath(childpath))
605
697
        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))
 
698
            if self.final_parent(child_id) != parent_id:
 
699
                return False
 
700
            if child_id in self._removed_contents:
 
701
                # XXX What about dangling file-ids?
 
702
                return False
 
703
            else:
 
704
                return True
622
705
 
623
706
    def _parent_loops(self):
624
707
        """No entry should be its own ancestor"""
654
737
 
655
738
    def _improper_versioning(self):
656
739
        """Cannot version a file with no contents, or a bad type.
657
 
 
 
740
        
658
741
        However, existing entries with no contents are okay.
659
742
        """
660
743
        conflicts = []
661
744
        for trans_id in self._new_id.iterkeys():
662
 
            kind = self.final_kind(trans_id)
663
 
            if kind is None:
 
745
            try:
 
746
                kind = self.final_kind(trans_id)
 
747
            except NoSuchFile:
664
748
                conflicts.append(('versioning no contents', trans_id))
665
749
                continue
666
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
750
            if not InventoryEntry.versionable_kind(kind):
667
751
                conflicts.append(('versioning bad kind', trans_id, kind))
668
752
        return conflicts
669
753
 
670
754
    def _executability_conflicts(self):
671
755
        """Check for bad executability changes.
672
 
 
 
756
        
673
757
        Only versioned files may have their executability set, because
674
758
        1. only versioned entries can have executability under windows
675
759
        2. only files can be executable.  (The execute bit on a directory
680
764
            if self.final_file_id(trans_id) is None:
681
765
                conflicts.append(('unversioned executability', trans_id))
682
766
            else:
683
 
                if self.final_kind(trans_id) != "file":
 
767
                try:
 
768
                    non_file = self.final_kind(trans_id) != "file"
 
769
                except NoSuchFile:
 
770
                    non_file = True
 
771
                if non_file is True:
684
772
                    conflicts.append(('non-file executability', trans_id))
685
773
        return conflicts
686
774
 
688
776
        """Check for overwrites (not permitted on Win32)"""
689
777
        conflicts = []
690
778
        for trans_id in self._new_contents:
691
 
            if self.tree_kind(trans_id) is None:
 
779
            try:
 
780
                self.tree_kind(trans_id)
 
781
            except NoSuchFile:
692
782
                continue
693
783
            if trans_id not in self._removed_contents:
694
784
                conflicts.append(('overwrite', trans_id,
701
791
        if (self._new_name, self._new_parent) == ({}, {}):
702
792
            return conflicts
703
793
        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))
 
794
            name_ids = [(self.final_name(t), t) for t in children]
 
795
            if not self._case_sensitive_target:
 
796
                name_ids = [(n.lower(), t) for n, t in name_ids]
712
797
            name_ids.sort()
713
798
            last_name = None
714
799
            last_trans_id = None
715
800
            for name, trans_id in name_ids:
716
 
                kind = self.final_kind(trans_id)
 
801
                try:
 
802
                    kind = self.final_kind(trans_id)
 
803
                except NoSuchFile:
 
804
                    kind = None
717
805
                file_id = self.final_file_id(trans_id)
718
806
                if kind is None and file_id is None:
719
807
                    continue
738
826
        return conflicts
739
827
 
740
828
    def _parent_type_conflicts(self, by_parent):
741
 
        """Children must have a directory parent"""
 
829
        """parents must have directory 'contents'."""
742
830
        conflicts = []
743
831
        for parent_id, children in by_parent.iteritems():
744
832
            if parent_id is ROOT_PARENT:
745
833
                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:
 
834
            if not self._any_contents(children):
752
835
                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)
 
836
            for child in children:
 
837
                try:
 
838
                    self.final_kind(child)
 
839
                except NoSuchFile:
 
840
                    continue
 
841
            try:
 
842
                kind = self.final_kind(parent_id)
 
843
            except NoSuchFile:
 
844
                kind = None
756
845
            if kind is None:
757
 
                # The directory will be deleted
758
846
                conflicts.append(('missing parent', parent_id))
759
847
            elif kind != "directory":
760
 
                # Meh, we need a *directory* to put something in it
761
848
                conflicts.append(('non-directory parent', parent_id))
762
849
        return conflicts
763
850
 
 
851
    def _any_contents(self, trans_ids):
 
852
        """Return true if any of the trans_ids, will have contents."""
 
853
        for trans_id in trans_ids:
 
854
            try:
 
855
                kind = self.final_kind(trans_id)
 
856
            except NoSuchFile:
 
857
                continue
 
858
            return True
 
859
        return False
 
860
 
 
861
    def _limbo_name(self, trans_id):
 
862
        """Generate the limbo name of a file"""
 
863
        limbo_name = self._limbo_files.get(trans_id)
 
864
        if limbo_name is not None:
 
865
            return limbo_name
 
866
        parent = self._new_parent.get(trans_id)
 
867
        # if the parent directory is already in limbo (e.g. when building a
 
868
        # tree), choose a limbo name inside the parent, to reduce further
 
869
        # renames.
 
870
        use_direct_path = False
 
871
        if self._new_contents.get(parent) == 'directory':
 
872
            filename = self._new_name.get(trans_id)
 
873
            if filename is not None:
 
874
                if parent not in self._limbo_children:
 
875
                    self._limbo_children[parent] = set()
 
876
                    self._limbo_children_names[parent] = {}
 
877
                    use_direct_path = True
 
878
                # the direct path can only be used if no other file has
 
879
                # already taken this pathname, i.e. if the name is unused, or
 
880
                # if it is already associated with this trans_id.
 
881
                elif self._case_sensitive_target:
 
882
                    if (self._limbo_children_names[parent].get(filename)
 
883
                        in (trans_id, None)):
 
884
                        use_direct_path = True
 
885
                else:
 
886
                    for l_filename, l_trans_id in\
 
887
                        self._limbo_children_names[parent].iteritems():
 
888
                        if l_trans_id == trans_id:
 
889
                            continue
 
890
                        if l_filename.lower() == filename.lower():
 
891
                            break
 
892
                    else:
 
893
                        use_direct_path = True
 
894
 
 
895
        if use_direct_path:
 
896
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
897
            self._limbo_children[parent].add(trans_id)
 
898
            self._limbo_children_names[parent][filename] = trans_id
 
899
        else:
 
900
            limbo_name = pathjoin(self._limbodir, trans_id)
 
901
            self._needs_rename.add(trans_id)
 
902
        self._limbo_files[trans_id] = limbo_name
 
903
        return limbo_name
 
904
 
764
905
    def _set_executability(self, path, trans_id):
765
906
        """Set the executability of versioned files """
766
907
        if supports_executable():
787
928
            self.version_file(file_id, trans_id)
788
929
        return trans_id
789
930
 
790
 
    def new_file(self, name, parent_id, contents, file_id=None,
791
 
                 executable=None, sha1=None):
 
931
    def new_file(self, name, parent_id, contents, file_id=None, 
 
932
                 executable=None):
792
933
        """Convenience method to create files.
793
 
 
 
934
        
794
935
        name is the name of the file to create.
795
936
        parent_id is the transaction id of the parent directory of the file.
796
937
        contents is an iterator of bytestrings, which will be used to produce
801
942
        trans_id = self._new_entry(name, parent_id, file_id)
802
943
        # TODO: rather than scheduling a set_executable call,
803
944
        # have create_file create the file with the right mode.
804
 
        self.create_file(contents, trans_id, sha1=sha1)
 
945
        self.create_file(contents, trans_id)
805
946
        if executable is not None:
806
947
            self.set_executability(executable, trans_id)
807
948
        return trans_id
816
957
        """
817
958
        trans_id = self._new_entry(name, parent_id, file_id)
818
959
        self.create_directory(trans_id)
819
 
        return trans_id
 
960
        return trans_id 
820
961
 
821
962
    def new_symlink(self, name, parent_id, target, file_id=None):
822
963
        """Convenience method to create symbolic link.
823
 
 
 
964
        
824
965
        name is the name of the symlink to create.
825
966
        parent_id is the transaction id of the parent directory of the symlink.
826
967
        target is a bytestring of the target of the symlink.
830
971
        self.create_symlink(target, trans_id)
831
972
        return trans_id
832
973
 
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
974
    def _affected_ids(self):
876
975
        """Return the set of transform ids affected by the transform"""
877
976
        trans_ids = set(self._removed_id)
907
1006
        from_path = self._tree_id_paths.get(from_trans_id)
908
1007
        if from_versioned:
909
1008
            # get data from working tree if versioned
910
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1009
            from_entry = self._tree.inventory[file_id]
911
1010
            from_name = from_entry.name
912
1011
            from_parent = from_entry.parent_id
913
1012
        else:
936
1035
        Return a (name, parent, kind, executable) tuple
937
1036
        """
938
1037
        to_name = self.final_name(to_trans_id)
939
 
        to_kind = self.final_kind(to_trans_id)
 
1038
        try:
 
1039
            to_kind = self.final_kind(to_trans_id)
 
1040
        except NoSuchFile:
 
1041
            to_kind = None
940
1042
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
941
1043
        if to_trans_id in self._new_executability:
942
1044
            to_executable = self._new_executability[to_trans_id]
1011
1113
    def get_preview_tree(self):
1012
1114
        """Return a tree representing the result of the transform.
1013
1115
 
1014
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
1015
 
        it.
 
1116
        This tree only supports the subset of Tree functionality required
 
1117
        by show_diff_trees.  It must only be compared to tt._tree.
1016
1118
        """
1017
1119
        return _PreviewTree(self)
1018
1120
 
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
 
    def _text_parent(self, trans_id):
1078
 
        file_id = self.tree_file_id(trans_id)
1079
 
        try:
1080
 
            if file_id is None or self._tree.kind(file_id) != 'file':
1081
 
                return None
1082
 
        except errors.NoSuchFile:
1083
 
            return None
1084
 
        return file_id
1085
 
 
1086
 
    def _get_parents_texts(self, trans_id):
1087
 
        """Get texts for compression parents of this file."""
1088
 
        file_id = self._text_parent(trans_id)
1089
 
        if file_id is None:
1090
 
            return ()
1091
 
        return (self._tree.get_file_text(file_id),)
1092
 
 
1093
 
    def _get_parents_lines(self, trans_id):
1094
 
        """Get lines for compression parents of this file."""
1095
 
        file_id = self._text_parent(trans_id)
1096
 
        if file_id is None:
1097
 
            return ()
1098
 
        return (self._tree.get_file_lines(file_id),)
1099
 
 
1100
 
    def serialize(self, serializer):
1101
 
        """Serialize this TreeTransform.
1102
 
 
1103
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
1104
 
        """
1105
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
1106
 
                        self._new_name.items())
1107
 
        new_executability = dict((k, int(v)) for k, v in
1108
 
                                 self._new_executability.items())
1109
 
        tree_path_ids = dict((k.encode('utf-8'), v)
1110
 
                             for k, v in self._tree_path_ids.items())
1111
 
        attribs = {
1112
 
            '_id_number': self._id_number,
1113
 
            '_new_name': new_name,
1114
 
            '_new_parent': self._new_parent,
1115
 
            '_new_executability': new_executability,
1116
 
            '_new_id': self._new_id,
1117
 
            '_tree_path_ids': tree_path_ids,
1118
 
            '_removed_id': list(self._removed_id),
1119
 
            '_removed_contents': list(self._removed_contents),
1120
 
            '_non_present_ids': self._non_present_ids,
1121
 
            }
1122
 
        yield serializer.bytes_record(bencode.bencode(attribs),
1123
 
                                      (('attribs',),))
1124
 
        for trans_id, kind in self._new_contents.items():
1125
 
            if kind == 'file':
1126
 
                lines = osutils.chunks_to_lines(
1127
 
                    self._read_file_chunks(trans_id))
1128
 
                parents = self._get_parents_lines(trans_id)
1129
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1130
 
                content = ''.join(mpdiff.to_patch())
1131
 
            if kind == 'directory':
1132
 
                content = ''
1133
 
            if kind == 'symlink':
1134
 
                content = self._read_symlink_target(trans_id)
1135
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
1136
 
 
1137
 
    def deserialize(self, records):
1138
 
        """Deserialize a stored TreeTransform.
1139
 
 
1140
 
        :param records: An iterable of (names, content) tuples, as per
1141
 
            pack.ContainerPushParser.
1142
 
        """
1143
 
        names, content = records.next()
1144
 
        attribs = bencode.bdecode(content)
1145
 
        self._id_number = attribs['_id_number']
1146
 
        self._new_name = dict((k, v.decode('utf-8'))
1147
 
                            for k, v in attribs['_new_name'].items())
1148
 
        self._new_parent = attribs['_new_parent']
1149
 
        self._new_executability = dict((k, bool(v)) for k, v in
1150
 
            attribs['_new_executability'].items())
1151
 
        self._new_id = attribs['_new_id']
1152
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1153
 
        self._tree_path_ids = {}
1154
 
        self._tree_id_paths = {}
1155
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
1156
 
            path = bytepath.decode('utf-8')
1157
 
            self._tree_path_ids[path] = trans_id
1158
 
            self._tree_id_paths[trans_id] = path
1159
 
        self._removed_id = set(attribs['_removed_id'])
1160
 
        self._removed_contents = set(attribs['_removed_contents'])
1161
 
        self._non_present_ids = attribs['_non_present_ids']
1162
 
        for ((trans_id, kind),), content in records:
1163
 
            if kind == 'file':
1164
 
                mpdiff = multiparent.MultiParent.from_patch(content)
1165
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1166
 
                self.create_file(lines, trans_id)
1167
 
            if kind == 'directory':
1168
 
                self.create_directory(trans_id)
1169
 
            if kind == 'symlink':
1170
 
                self.create_symlink(content.decode('utf-8'), trans_id)
1171
 
 
1172
 
 
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):
 
1121
 
 
1122
class TreeTransform(TreeTransformBase):
1485
1123
    """Represent a tree transformation.
1486
1124
 
1487
1125
    This object is designed to support incremental generation of the transform,
1546
1184
    FileMover does not delete files until it is sure that a rollback will not
1547
1185
    happen.
1548
1186
    """
1549
 
    def __init__(self, tree, pb=None):
 
1187
    def __init__(self, tree, pb=DummyProgress()):
1550
1188
        """Note: a tree_write lock is taken on the tree.
1551
1189
 
1552
1190
        Use TreeTransform.finalize() to release the lock (can be omitted if
1573
1211
            tree.unlock()
1574
1212
            raise
1575
1213
 
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,
 
1214
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1581
1215
                                   tree.case_sensitive)
1582
1216
        self._deletiondir = deletiondir
1583
1217
 
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
1218
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1711
1219
        """Apply all changes to the inventory and filesystem.
1712
1220
 
1722
1230
        :param _mover: Supply an alternate FileMover, for testing
1723
1231
        """
1724
1232
        if not no_conflicts:
1725
 
            self._check_malformed()
1726
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1233
            conflicts = self.find_conflicts()
 
1234
            if len(conflicts) != 0:
 
1235
                raise MalformedTransform(conflicts=conflicts)
 
1236
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1727
1237
        try:
1728
1238
            if precomputed_delta is None:
1729
1239
                child_pb.update('Apply phase', 0, 2)
1748
1258
                mover.apply_deletions()
1749
1259
        finally:
1750
1260
            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
1261
        self._tree.apply_inventory_delta(inventory_delta)
1754
 
        self._apply_observed_sha1s()
1755
1262
        self._done = True
1756
1263
        self.finalize()
1757
1264
        return _TransformResults(modified_paths, self.rename_count)
1759
1266
    def _generate_inventory_delta(self):
1760
1267
        """Generate an inventory delta for the current transform."""
1761
1268
        inventory_delta = []
1762
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1269
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1763
1270
        new_paths = self._inventory_altered()
1764
1271
        total_entries = len(new_paths) + len(self._removed_id)
1765
1272
        try:
1789
1296
                if file_id is None:
1790
1297
                    continue
1791
1298
                needs_entry = False
1792
 
                kind = self.final_kind(trans_id)
1793
 
                if kind is None:
 
1299
                try:
 
1300
                    kind = self.final_kind(trans_id)
 
1301
                except NoSuchFile:
1794
1302
                    kind = self._tree.stored_kind(file_id)
1795
1303
                parent_trans_id = self.final_parent(trans_id)
1796
1304
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1827
1335
        """
1828
1336
        tree_paths = list(self._tree_path_ids.iteritems())
1829
1337
        tree_paths.sort(reverse=True)
1830
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1338
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1831
1339
        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
 
1340
            for num, data in enumerate(tree_paths):
 
1341
                path, trans_id = data
1836
1342
                child_pb.update('removing file', num, len(tree_paths))
1837
1343
                full_path = self._tree.abspath(path)
1838
1344
                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):
 
1345
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1346
                                     trans_id))
 
1347
                elif trans_id in self._new_name or trans_id in \
 
1348
                    self._new_parent:
1843
1349
                    try:
1844
1350
                        mover.rename(full_path, self._limbo_name(trans_id))
1845
 
                    except errors.TransformRenameFailed, e:
 
1351
                    except OSError, e:
1846
1352
                        if e.errno != errno.ENOENT:
1847
1353
                            raise
1848
1354
                    else:
1864
1370
        modified_paths = []
1865
1371
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1866
1372
                                 new_paths)
1867
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1373
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1868
1374
        try:
1869
1375
            for num, (path, trans_id) in enumerate(new_paths):
1870
1376
                if (num % 10) == 0:
1873
1379
                if trans_id in self._needs_rename:
1874
1380
                    try:
1875
1381
                        mover.rename(self._limbo_name(trans_id), full_path)
1876
 
                    except errors.TransformRenameFailed, e:
 
1382
                    except OSError, e:
1877
1383
                        # We may be renaming a dangling inventory id
1878
1384
                        if e.errno != errno.ENOENT:
1879
1385
                            raise
1880
1386
                    else:
1881
1387
                        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
1388
                if (trans_id in self._new_contents or
1886
1389
                    self.path_changed(trans_id)):
1887
1390
                    if trans_id in self._new_contents:
1888
1391
                        modified_paths.append(full_path)
1889
1392
                if trans_id in self._new_executability:
1890
1393
                    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
1394
        finally:
1896
1395
            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
1396
        self._new_contents.clear()
1903
1397
        return modified_paths
1904
1398
 
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):
 
1399
 
 
1400
class TransformPreview(TreeTransformBase):
1930
1401
    """A TreeTransform for generating preview trees.
1931
1402
 
1932
1403
    Unlike TreeTransform, this version works when the input tree is a
1934
1405
    unversioned files in the input tree.
1935
1406
    """
1936
1407
 
1937
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1408
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1938
1409
        tree.lock_read()
1939
1410
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1940
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1411
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1941
1412
 
1942
1413
    def canonical_path(self, path):
1943
1414
        return path
1945
1416
    def tree_kind(self, trans_id):
1946
1417
        path = self._tree_id_paths.get(trans_id)
1947
1418
        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
 
1419
            raise NoSuchFile(None)
 
1420
        file_id = self._tree.path2id(path)
 
1421
        return self._tree.kind(file_id)
1953
1422
 
1954
1423
    def _set_mode(self, trans_id, mode_id, typefunc):
1955
1424
        """Set the mode of new file contents.
1969
1438
        file_id = self.tree_file_id(parent_id)
1970
1439
        if file_id is None:
1971
1440
            return
1972
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1973
 
        children = getattr(entry, 'children', {})
 
1441
        children = getattr(self._tree.inventory[file_id], 'children', {})
1974
1442
        for child in children:
1975
1443
            childpath = joinpath(path, child)
1976
1444
            yield self.trans_id_tree_path(childpath)
1977
1445
 
1978
 
    def new_orphan(self, trans_id, parent_id):
1979
 
        raise NotImplementedError(self.new_orphan)
1980
 
 
1981
 
 
1982
 
class _PreviewTree(tree.InventoryTree):
 
1446
 
 
1447
class _PreviewTree(tree.Tree):
1983
1448
    """Partial implementation of Tree to support show_diff_trees"""
1984
1449
 
1985
1450
    def __init__(self, transform):
1987
1452
        self._final_paths = FinalPaths(transform)
1988
1453
        self.__by_parent = None
1989
1454
        self._parent_ids = []
1990
 
        self._all_children_cache = {}
1991
 
        self._path2trans_id_cache = {}
1992
 
        self._final_name_cache = {}
1993
 
        self._iter_changes_cache = dict((c[0], c) for c in
1994
 
                                        self._transform.iter_changes())
 
1455
 
 
1456
    def _changes(self, file_id):
 
1457
        for changes in self._transform.iter_changes():
 
1458
            if changes[0] == file_id:
 
1459
                return changes
1995
1460
 
1996
1461
    def _content_change(self, file_id):
1997
1462
        """Return True if the content of this file changed"""
1998
 
        changes = self._iter_changes_cache.get(file_id)
 
1463
        changes = self._changes(file_id)
1999
1464
        # changes[2] is true if the file content changed.  See
2000
1465
        # InterTree.iter_changes.
2001
1466
        return (changes is not None and changes[2])
2014
1479
                yield self._get_repository().revision_tree(revision_id)
2015
1480
 
2016
1481
    def _get_file_revision(self, file_id, vf, tree_revision):
2017
 
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
1482
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
2018
1483
                       self._iter_parent_trees()]
2019
1484
        vf.add_lines((file_id, tree_revision), parent_keys,
2020
 
                     self.get_file_lines(file_id))
 
1485
                     self.get_file(file_id).readlines())
2021
1486
        repo = self._get_repository()
2022
1487
        base_vf = repo.texts
2023
1488
        if base_vf not in vf.fallback_versionedfiles:
2024
1489
            vf.fallback_versionedfiles.append(base_vf)
2025
1490
        return tree_revision
2026
1491
 
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)
 
1492
    def _stat_limbo_file(self, file_id):
 
1493
        trans_id = self._transform.trans_id_file_id(file_id)
2030
1494
        name = self._transform._limbo_name(trans_id)
2031
1495
        return os.lstat(name)
2032
1496
 
2036
1500
            self.__by_parent = self._transform.by_parent()
2037
1501
        return self.__by_parent
2038
1502
 
2039
 
    def _comparison_data(self, entry, path):
2040
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2041
 
        if kind == 'missing':
2042
 
            kind = None
2043
 
            executable = False
2044
 
        else:
2045
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
2046
 
            executable = self.is_executable(file_id, path)
2047
 
        return kind, executable, None
2048
 
 
2049
 
    def is_locked(self):
2050
 
        return False
2051
 
 
2052
1503
    def lock_read(self):
2053
1504
        # Perhaps in theory, this should lock the TreeTransform?
2054
 
        return self
 
1505
        pass
2055
1506
 
2056
1507
    def unlock(self):
2057
1508
        pass
2074
1525
    def __iter__(self):
2075
1526
        return iter(self.all_file_ids())
2076
1527
 
2077
 
    def _has_id(self, file_id, fallback_check):
2078
 
        if file_id in self._transform._r_new_id:
2079
 
            return True
2080
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
2081
 
            trans_id in self._transform._removed_id]):
2082
 
            return False
2083
 
        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)
 
1528
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1529
        """See Tree.paths2ids"""
 
1530
        to_find = set(specific_files)
 
1531
        result = set()
 
1532
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1533
             executable) in self._transform.iter_changes():
 
1534
            if paths[1] in to_find:
 
1535
                result.add(file_id)
 
1536
                to_find.remove(paths[1])
 
1537
        result.update(self._transform._tree.paths2ids(to_find,
 
1538
                      trees=[], require_versioned=require_versioned))
 
1539
        return result
2091
1540
 
2092
1541
    def _path2trans_id(self, path):
2093
 
        # We must not use None here, because that is a valid value to store.
2094
 
        trans_id = self._path2trans_id_cache.get(path, object)
2095
 
        if trans_id is not object:
2096
 
            return trans_id
2097
1542
        segments = splitpath(path)
2098
1543
        cur_parent = self._transform.root
2099
1544
        for cur_segment in segments:
2100
1545
            for child in self._all_children(cur_parent):
2101
 
                final_name = self._final_name_cache.get(child)
2102
 
                if final_name is None:
2103
 
                    final_name = self._transform.final_name(child)
2104
 
                    self._final_name_cache[child] = final_name
2105
 
                if final_name == cur_segment:
 
1546
                if self._transform.final_name(child) == cur_segment:
2106
1547
                    cur_parent = child
2107
1548
                    break
2108
1549
            else:
2109
 
                self._path2trans_id_cache[path] = None
2110
1550
                return None
2111
 
        self._path2trans_id_cache[path] = cur_parent
2112
1551
        return cur_parent
2113
1552
 
2114
1553
    def path2id(self, path):
2122
1561
            raise errors.NoSuchId(self, file_id)
2123
1562
 
2124
1563
    def _all_children(self, trans_id):
2125
 
        children = self._all_children_cache.get(trans_id)
2126
 
        if children is not None:
2127
 
            return children
2128
1564
        children = set(self._transform.iter_tree_children(trans_id))
2129
1565
        # children in the _new_parent set are provided by _by_parent.
2130
1566
        children.difference_update(self._transform._new_parent.keys())
2131
1567
        children.update(self._by_parent.get(trans_id, []))
2132
 
        self._all_children_cache[trans_id] = children
2133
1568
        return children
2134
1569
 
2135
 
    def iter_children(self, file_id):
2136
 
        trans_id = self._transform.trans_id_file_id(file_id)
2137
 
        for child_trans_id in self._all_children(trans_id):
2138
 
            yield self._transform.final_file_id(child_trans_id)
2139
 
 
2140
 
    def extras(self):
2141
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
2142
 
                              in self._transform._tree.extras())
2143
 
        possible_extras.update(self._transform._new_contents)
2144
 
        possible_extras.update(self._transform._removed_id)
2145
 
        for trans_id in possible_extras:
2146
 
            if self._transform.final_file_id(trans_id) is None:
2147
 
                yield self._final_paths._determine_path(trans_id)
2148
 
 
2149
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2150
 
        yield_parents=False):
 
1570
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
2151
1571
        for trans_id, parent_file_id in ordered_entries:
2152
1572
            file_id = self._transform.final_file_id(trans_id)
2153
1573
            if file_id is None:
2155
1575
            if (specific_file_ids is not None
2156
1576
                and file_id not in specific_file_ids):
2157
1577
                continue
2158
 
            kind = self._transform.final_kind(trans_id)
2159
 
            if kind is None:
 
1578
            try:
 
1579
                kind = self._transform.final_kind(trans_id)
 
1580
            except NoSuchFile:
2160
1581
                kind = self._transform._tree.stored_kind(file_id)
2161
1582
            new_entry = inventory.make_entry(
2162
1583
                kind,
2178
1599
                ordered_ids.append((trans_id, parent_file_id))
2179
1600
        return ordered_ids
2180
1601
 
2181
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
1602
    def iter_entries_by_dir(self, specific_file_ids=None):
2182
1603
        # This may not be a maximally efficient implementation, but it is
2183
1604
        # reasonably straightforward.  An implementation that grafts the
2184
1605
        # TreeTransform changes onto the tree's iter_entries_by_dir results
2186
1607
        # position.
2187
1608
        ordered_ids = self._list_files_by_dir()
2188
1609
        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."""
 
1610
                                                      specific_file_ids):
 
1611
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1612
 
 
1613
    def list_files(self, include_root=False):
 
1614
        """See Tree.list_files."""
2204
1615
        # XXX This should behave like WorkingTree.list_files, but is really
2205
1616
        # 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
 
1617
        for path, entry in self.iter_entries_by_dir():
 
1618
            if entry.name == '' and not include_root:
 
1619
                continue
 
1620
            yield path, 'V', entry.kind, entry.file_id, entry
2227
1621
 
2228
1622
    def kind(self, file_id):
2229
1623
        trans_id = self._transform.trans_id_file_id(file_id)
2239
1633
    def get_file_mtime(self, file_id, path=None):
2240
1634
        """See Tree.get_file_mtime"""
2241
1635
        if not self._content_change(file_id):
2242
 
            return self._transform._tree.get_file_mtime(file_id)
 
1636
            return self._transform._tree.get_file_mtime(file_id, path)
2243
1637
        return self._stat_limbo_file(file_id).st_mtime
2244
1638
 
2245
 
    def _file_size(self, entry, stat_value):
2246
 
        return self.get_file_size(entry.file_id)
2247
 
 
2248
1639
    def get_file_size(self, file_id):
2249
1640
        """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
1641
        if self.kind(file_id) == 'file':
2257
1642
            return self._transform._tree.get_file_size(file_id)
2258
1643
        else:
2259
1644
            return None
2260
1645
 
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
1646
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2274
 
        trans_id = self._transform.trans_id_file_id(file_id)
2275
 
        kind = self._transform._new_contents.get(trans_id)
2276
 
        if kind is None:
2277
 
            return self._transform._tree.get_file_sha1(file_id)
2278
 
        if kind == 'file':
2279
 
            fileobj = self.get_file(file_id)
2280
 
            try:
2281
 
                return sha_file(fileobj)
2282
 
            finally:
2283
 
                fileobj.close()
 
1647
        return self._transform._tree.get_file_sha1(file_id)
2284
1648
 
2285
1649
    def is_executable(self, file_id, path=None):
2286
 
        if file_id is None:
2287
 
            return False
2288
1650
        trans_id = self._transform.trans_id_file_id(file_id)
2289
1651
        try:
2290
1652
            return self._transform._new_executability[trans_id]
2291
1653
        except KeyError:
2292
 
            try:
2293
 
                return self._transform._tree.is_executable(file_id, path)
2294
 
            except OSError, e:
2295
 
                if e.errno == errno.ENOENT:
2296
 
                    return False
2297
 
                raise
2298
 
            except errors.NoSuchId:
2299
 
                return False
2300
 
 
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)
 
1654
            return self._transform._tree.is_executable(file_id, path)
2309
1655
 
2310
1656
    def path_content_summary(self, path):
2311
1657
        trans_id = self._path2trans_id(path)
2326
1672
                statval = os.lstat(limbo_name)
2327
1673
                size = statval.st_size
2328
1674
                if not supports_executable():
2329
 
                    executable = False
 
1675
                    executable = None
2330
1676
                else:
2331
1677
                    executable = statval.st_mode & S_IEXEC
2332
1678
            else:
2333
1679
                size = None
2334
1680
                executable = None
2335
1681
            if kind == 'symlink':
2336
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2337
 
        executable = tt._new_executability.get(trans_id, executable)
 
1682
                link_or_sha1 = os.readlink(limbo_name)
 
1683
        if supports_executable():
 
1684
            executable = tt._new_executability.get(trans_id, executable)
2338
1685
        return kind, size, executable, link_or_sha1
2339
1686
 
2340
1687
    def iter_changes(self, from_tree, include_unchanged=False,
2342
1689
                      require_versioned=True, want_unversioned=False):
2343
1690
        """See InterTree.iter_changes.
2344
1691
 
2345
 
        This has a fast path that is only used when the from_tree matches
2346
 
        the transform tree, and no fancy options are supplied.
 
1692
        This implementation does not support include_unchanged, specific_files,
 
1693
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1694
        ignored.
2347
1695
        """
2348
 
        if (from_tree is not self._transform._tree or include_unchanged or
2349
 
            specific_files or want_unversioned):
2350
 
            return tree.InterTree(from_tree, self).iter_changes(
2351
 
                include_unchanged=include_unchanged,
2352
 
                specific_files=specific_files,
2353
 
                pb=pb,
2354
 
                extra_trees=extra_trees,
2355
 
                require_versioned=require_versioned,
2356
 
                want_unversioned=want_unversioned)
 
1696
        if from_tree is not self._transform._tree:
 
1697
            raise ValueError('from_tree must be transform source tree.')
 
1698
        if include_unchanged:
 
1699
            raise ValueError('include_unchanged is not supported')
 
1700
        if specific_files is not None:
 
1701
            raise ValueError('specific_files is not supported')
2357
1702
        if want_unversioned:
2358
1703
            raise ValueError('want_unversioned is not supported')
2359
1704
        return self._transform.iter_changes()
2366
1711
        name = self._transform._limbo_name(trans_id)
2367
1712
        return open(name, 'rb')
2368
1713
 
2369
 
    def get_file_with_stat(self, file_id, path=None):
2370
 
        return self.get_file(file_id, path), None
 
1714
    def get_file_text(self, file_id):
 
1715
        text_file = self.get_file(file_id)
 
1716
        try:
 
1717
            return text_file.read()
 
1718
        finally:
 
1719
            text_file.close()
2371
1720
 
2372
1721
    def annotate_iter(self, file_id,
2373
1722
                      default_revision=_mod_revision.CURRENT_REVISION):
2374
 
        changes = self._iter_changes_cache.get(file_id)
 
1723
        changes = self._changes(file_id)
2375
1724
        if changes is None:
2376
1725
            get_old = True
2377
1726
        else:
2389
1738
            return old_annotation
2390
1739
        if not changed_content:
2391
1740
            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
1741
        return annotate.reannotate([old_annotation],
2400
1742
                                   self.get_file(file_id).readlines(),
2401
1743
                                   default_revision)
2402
1744
 
2403
 
    def get_symlink_target(self, file_id, path=None):
 
1745
    def get_symlink_target(self, file_id):
2404
1746
        """See Tree.get_symlink_target"""
2405
1747
        if not self._content_change(file_id):
2406
1748
            return self._transform._tree.get_symlink_target(file_id)
2407
1749
        trans_id = self._transform.trans_id_file_id(file_id)
2408
1750
        name = self._transform._limbo_name(trans_id)
2409
 
        return osutils.readlink(name)
 
1751
        return os.readlink(name)
2410
1752
 
2411
1753
    def walkdirs(self, prefix=''):
2412
1754
        pending = [self._transform.root]
2421
1763
                path_from_root = self._final_paths.get_path(child_id)
2422
1764
                basename = self._transform.final_name(child_id)
2423
1765
                file_id = self._transform.final_file_id(child_id)
2424
 
                kind  = self._transform.final_kind(child_id)
2425
 
                if kind is not None:
 
1766
                try:
 
1767
                    kind = self._transform.final_kind(child_id)
2426
1768
                    versioned_kind = kind
2427
 
                else:
 
1769
                except NoSuchFile:
2428
1770
                    kind = 'unknown'
2429
1771
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2430
1772
                if versioned_kind == 'directory':
2467
1809
        self.transform = transform
2468
1810
 
2469
1811
    def _determine_path(self, trans_id):
2470
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1812
        if trans_id == self.transform.root:
2471
1813
            return ""
2472
1814
        name = self.transform.final_name(trans_id)
2473
1815
        parent_id = self.transform.final_parent(trans_id)
2497
1839
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2498
1840
               delta_from_tree=False):
2499
1841
    """Create working tree for a branch, using a TreeTransform.
2500
 
 
 
1842
    
2501
1843
    This function should be used on empty trees, having a tree root at most.
2502
1844
    (see merge and revert functionality for working with existing trees)
2503
1845
 
2504
1846
    Existing files are handled like so:
2505
 
 
 
1847
    
2506
1848
    - Existing bzrdirs take precedence over creating new items.  They are
2507
1849
      created as '%s.diverted' % name.
2508
1850
    - Otherwise, if the content on disk matches the content we are building,
2543
1885
    for num, _unused in enumerate(wt.all_file_ids()):
2544
1886
        if num > 0:  # more than just a root
2545
1887
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
1888
    existing_files = set()
 
1889
    for dir, files in wt.walkdirs():
 
1890
        existing_files.update(f[0] for f in files)
2546
1891
    file_trans_id = {}
2547
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
1892
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2548
1893
    pp = ProgressPhase("Build phase", 2, top_pb)
2549
1894
    if tree.inventory.root is not None:
2550
1895
        # This is kind of a hack: we should be altering the root
2563
1908
        pp.next_phase()
2564
1909
        file_trans_id[wt.get_root_id()] = \
2565
1910
            tt.trans_id_tree_file_id(wt.get_root_id())
2566
 
        pb = ui.ui_factory.nested_progress_bar()
 
1911
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2567
1912
        try:
2568
1913
            deferred_contents = []
2569
1914
            num = 0
2572
1917
                precomputed_delta = []
2573
1918
            else:
2574
1919
                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
1920
            for num, (tree_path, entry) in \
2585
1921
                enumerate(tree.inventory.iter_entries_by_dir()):
2586
1922
                pb.update("Building tree", num - len(deferred_contents), total)
2616
1952
                    executable = tree.is_executable(file_id, tree_path)
2617
1953
                    if executable:
2618
1954
                        tt.set_executability(executable, trans_id)
2619
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
2620
 
                    deferred_contents.append((file_id, trans_data))
 
1955
                    deferred_contents.append((file_id, trans_id))
2621
1956
                else:
2622
1957
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2623
1958
                                                          tree)
2638
1973
            precomputed_delta = None
2639
1974
        conflicts = cook_conflicts(raw_conflicts, tt)
2640
1975
        for conflict in conflicts:
2641
 
            trace.warning(unicode(conflict))
 
1976
            warning(conflict)
2642
1977
        try:
2643
1978
            wt.add_conflicts(conflicts)
2644
1979
        except errors.UnsupportedOperation:
2654
1989
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2655
1990
                  hardlink):
2656
1991
    total = len(desired_files) + offset
2657
 
    wt = tt._tree
2658
1992
    if accelerator_tree is None:
2659
1993
        new_desired_files = desired_files
2660
1994
    else:
2661
1995
        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)
 
1996
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1997
                         in iter if not (c or e[0] != e[1]))
2668
1998
        new_desired_files = []
2669
1999
        count = 0
2670
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
2000
        for file_id, trans_id in desired_files:
2671
2001
            accelerator_path = unchanged.get(file_id)
2672
2002
            if accelerator_path is None:
2673
 
                new_desired_files.append((file_id,
2674
 
                    (trans_id, tree_path, text_sha1)))
 
2003
                new_desired_files.append((file_id, trans_id))
2675
2004
                continue
2676
2005
            pb.update('Adding file contents', count + offset, total)
2677
2006
            if hardlink:
2679
2008
                                   trans_id)
2680
2009
            else:
2681
2010
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2682
 
                if wt.supports_content_filtering():
2683
 
                    filters = wt._content_filter_stack(tree_path)
2684
 
                    contents = filtered_output_bytes(contents, filters,
2685
 
                        ContentFilterContext(tree_path, tree))
2686
2011
                try:
2687
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2012
                    tt.create_file(contents, trans_id)
2688
2013
                finally:
2689
 
                    try:
2690
 
                        contents.close()
2691
 
                    except AttributeError:
2692
 
                        # after filtering, contents may no longer be file-like
2693
 
                        pass
 
2014
                    contents.close()
2694
2015
            count += 1
2695
2016
        offset += count
2696
 
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2697
 
            tree.iter_files_bytes(new_desired_files)):
2698
 
        if wt.supports_content_filtering():
2699
 
            filters = wt._content_filter_stack(tree_path)
2700
 
            contents = filtered_output_bytes(contents, filters,
2701
 
                ContentFilterContext(tree_path, tree))
2702
 
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2017
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
2018
                                                 new_desired_files)):
 
2019
        tt.create_file(contents, trans_id)
2703
2020
        pb.update('Adding file contents', count + offset, total)
2704
2021
 
2705
2022
 
2707
2024
    for child in tt.iter_tree_children(old_parent):
2708
2025
        tt.adjust_path(tt.final_name(child), new_parent, child)
2709
2026
 
2710
 
 
2711
2027
def _reparent_transform_children(tt, old_parent, new_parent):
2712
2028
    by_parent = tt.by_parent()
2713
2029
    for child in by_parent[old_parent]:
2714
2030
        tt.adjust_path(tt.final_name(child), new_parent, child)
2715
2031
    return by_parent[old_parent]
2716
2032
 
2717
 
 
2718
2033
def _content_match(tree, entry, file_id, kind, target_path):
2719
2034
    if entry.kind != kind:
2720
2035
        return False
2721
2036
    if entry.kind == "directory":
2722
2037
        return True
2723
2038
    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()
 
2039
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
2040
            return True
2730
2041
    elif entry.kind == "symlink":
2731
2042
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2732
2043
            return True
2770
2081
    if kind == 'file':
2771
2082
        contents = tree.get_file(entry.file_id).readlines()
2772
2083
        executable = tree.is_executable(entry.file_id)
2773
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
2084
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2774
2085
                           executable)
2775
2086
    elif kind in ('directory', 'tree-reference'):
2776
2087
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2777
2088
        if kind == 'tree-reference':
2778
2089
            tt.set_tree_reference(entry.reference_revision, trans_id)
2779
 
        return trans_id
 
2090
        return trans_id 
2780
2091
    elif kind == 'symlink':
2781
2092
        target = tree.get_symlink_target(entry.file_id)
2782
2093
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2784
2095
        raise errors.BadFileKindError(name, kind)
2785
2096
 
2786
2097
 
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.
2794
 
    """
2795
 
    kind = tree.kind(file_id)
2796
 
    if kind == 'directory':
 
2098
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
2099
    """Create new file contents according to an inventory entry."""
 
2100
    if entry.kind == "file":
 
2101
        if lines is None:
 
2102
            lines = tree.get_file(entry.file_id).readlines()
 
2103
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
2104
    elif entry.kind == "symlink":
 
2105
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
2106
    elif entry.kind == "directory":
2797
2107
        tt.create_directory(trans_id)
2798
 
    elif kind == "file":
2799
 
        if bytes is None:
2800
 
            tree_file = tree.get_file(file_id)
2801
 
            try:
2802
 
                bytes = tree_file.readlines()
2803
 
            finally:
2804
 
                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
 
        tt.create_file(bytes, trans_id)
2811
 
    elif kind == "symlink":
2812
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2813
 
    else:
2814
 
        raise AssertionError('Unknown kind %r' % kind)
2815
2108
 
2816
2109
 
2817
2110
def create_entry_executability(tt, entry, trans_id):
2820
2113
        tt.set_executability(entry.executable, trans_id)
2821
2114
 
2822
2115
 
2823
 
@deprecated_function(deprecated_in((2, 3, 0)))
2824
2116
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2825
2117
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2826
2118
 
2827
2119
 
2828
 
@deprecated_function(deprecated_in((2, 3, 0)))
2829
2120
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2830
2121
    """Produce a backup-style name that appears to be available"""
2831
2122
    def name_gen():
2858
2149
        if entry.kind != working_kind:
2859
2150
            contents_mod, meta_mod = True, False
2860
2151
        else:
2861
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
2152
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2862
2153
                                       working_tree)
2863
2154
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2864
2155
            cur_entry._forget_tree_state()
2866
2157
 
2867
2158
 
2868
2159
def revert(working_tree, target_tree, filenames, backups=False,
2869
 
           pb=None, change_reporter=None):
 
2160
           pb=DummyProgress(), change_reporter=None):
2870
2161
    """Revert a working tree's contents to those of a target tree."""
2871
2162
    target_tree.lock_read()
2872
 
    pb = ui.ui_factory.nested_progress_bar()
2873
2163
    tt = TreeTransform(working_tree, pb)
2874
2164
    try:
2875
2165
        pp = ProgressPhase("Revert phase", 3, pb)
2880
2170
                unversioned_filter=working_tree.is_ignored)
2881
2171
            delta.report_changes(tt.iter_changes(), change_reporter)
2882
2172
        for conflict in conflicts:
2883
 
            trace.warning(unicode(conflict))
 
2173
            warning(conflict)
2884
2174
        pp.next_phase()
2885
2175
        tt.apply()
2886
2176
        working_tree.set_merge_modified(merge_modified)
2894
2184
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2895
2185
                              backups, pp, basis_tree=None,
2896
2186
                              merge_modified=None):
2897
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2187
    pp.next_phase()
 
2188
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2898
2189
    try:
2899
2190
        if merge_modified is None:
2900
2191
            merge_modified = working_tree.merge_modified()
2903
2194
                                      merge_modified, basis_tree)
2904
2195
    finally:
2905
2196
        child_pb.finished()
2906
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2197
    pp.next_phase()
 
2198
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2907
2199
    try:
2908
2200
        raw_conflicts = resolve_conflicts(tt, child_pb,
2909
2201
            lambda t, c: conflict_pass(t, c, target_tree))
2917
2209
                 backups, merge_modified, basis_tree=None):
2918
2210
    if basis_tree is not None:
2919
2211
        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,
 
2212
    change_list = target_tree.iter_changes(working_tree,
2925
2213
        specific_files=specific_files, pb=pb)
2926
2214
    if target_tree.get_root_id() is None:
2927
2215
        skip_root = True
2931
2219
        deferred_files = []
2932
2220
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2933
2221
                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:
 
2222
            if skip_root and file_id[0] is not None and parent[0] is None:
2941
2223
                continue
2942
2224
            trans_id = tt.trans_id_file_id(file_id)
2943
2225
            mode_id = None
2944
2226
            if changed_content:
2945
2227
                keep_content = False
2946
 
                if wt_kind == 'file' and (backups or target_kind is None):
 
2228
                if kind[0] == 'file' and (backups or kind[1] is None):
2947
2229
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2948
2230
                    if merge_modified.get(file_id) != wt_sha1:
2949
2231
                        # acquire the basis tree lazily to prevent the
2952
2234
                        if basis_tree is None:
2953
2235
                            basis_tree = working_tree.basis_tree()
2954
2236
                            basis_tree.lock_read()
2955
 
                        if basis_tree.has_id(file_id):
 
2237
                        if file_id in basis_tree:
2956
2238
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2957
2239
                                keep_content = True
2958
 
                        elif target_kind is None and not target_versioned:
 
2240
                        elif kind[1] is None and not versioned[1]:
2959
2241
                            keep_content = True
2960
 
                if wt_kind is not None:
 
2242
                if kind[0] is not None:
2961
2243
                    if not keep_content:
2962
2244
                        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)
 
2245
                    elif kind[1] is not None:
 
2246
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2247
                        by_parent = tt.by_parent()
 
2248
                        backup_name = _get_backup_name(name[0], by_parent,
 
2249
                                                       parent_trans_id, tt)
2967
2250
                        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:
 
2251
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2252
                        if versioned == (True, True):
2970
2253
                            tt.unversion_file(trans_id)
2971
2254
                            tt.version_file(file_id, new_trans_id)
2972
2255
                        # New contents should have the same unix perms as old
2973
2256
                        # contents
2974
2257
                        mode_id = trans_id
2975
2258
                        trans_id = new_trans_id
2976
 
                if target_kind in ('directory', 'tree-reference'):
 
2259
                if kind[1] in ('directory', 'tree-reference'):
2977
2260
                    tt.create_directory(trans_id)
2978
 
                    if target_kind == 'tree-reference':
 
2261
                    if kind[1] == 'tree-reference':
2979
2262
                        revision = target_tree.get_reference_revision(file_id,
2980
 
                                                                      target_path)
 
2263
                                                                      path[1])
2981
2264
                        tt.set_tree_reference(revision, trans_id)
2982
 
                elif target_kind == 'symlink':
 
2265
                elif kind[1] == 'symlink':
2983
2266
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2984
2267
                                      trans_id)
2985
 
                elif target_kind == 'file':
 
2268
                elif kind[1] == 'file':
2986
2269
                    deferred_files.append((file_id, (trans_id, mode_id)))
2987
2270
                    if basis_tree is None:
2988
2271
                        basis_tree = working_tree.basis_tree()
2989
2272
                        basis_tree.lock_read()
2990
2273
                    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)):
 
2274
                    if (file_id in basis_tree and new_sha1 ==
 
2275
                        basis_tree.get_file_sha1(file_id)):
2993
2276
                        if file_id in merge_modified:
2994
2277
                            del merge_modified[file_id]
2995
2278
                    else:
2996
2279
                        merge_modified[file_id] = new_sha1
2997
2280
 
2998
2281
                    # 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:
 
2282
                    if keep_content and executable[0] == executable[1]:
 
2283
                        tt.set_executability(executable[1], trans_id)
 
2284
                elif kind[1] is not None:
 
2285
                    raise AssertionError(kind[1])
 
2286
            if versioned == (False, True):
3004
2287
                tt.version_file(file_id, trans_id)
3005
 
            if wt_versioned and not target_versioned:
 
2288
            if versioned == (True, False):
3006
2289
                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:
 
2290
            if (name[1] is not None and
 
2291
                (name[0] != name[1] or parent[0] != parent[1])):
 
2292
                if name[1] == '' and parent[1] is None:
3010
2293
                    parent_trans = ROOT_PARENT
3011
2294
                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()
 
2295
                    parent_trans = tt.trans_id_file_id(parent[1])
 
2296
                tt.adjust_path(name[1], parent_trans, trans_id)
 
2297
            if executable[0] != executable[1] and kind[1] == "file":
 
2298
                tt.set_executability(executable[1], trans_id)
 
2299
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2300
            deferred_files):
 
2301
            tt.create_file(bytes, trans_id, mode_id)
3036
2302
    finally:
3037
2303
        if basis_tree is not None:
3038
2304
            basis_tree.unlock()
3039
2305
    return merge_modified
3040
2306
 
3041
2307
 
3042
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2308
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3043
2309
    """Make many conflict-resolution attempts, but die if they fail"""
3044
2310
    if pass_func is None:
3045
2311
        pass_func = conflict_pass
3046
2312
    new_conflicts = set()
3047
 
    pb = ui.ui_factory.nested_progress_bar()
3048
2313
    try:
3049
2314
        for n in range(10):
3050
2315
            pb.update('Resolution pass', n+1, 10)
3054
2319
            new_conflicts.update(pass_func(tt, conflicts))
3055
2320
        raise MalformedTransform(conflicts=conflicts)
3056
2321
    finally:
3057
 
        pb.finished()
 
2322
        pb.clear()
3058
2323
 
3059
2324
 
3060
2325
def conflict_pass(tt, conflicts, path_tree=None):
3079
2344
                existing_file, new_file = conflict[1], conflict[2]
3080
2345
            new_name = tt.final_name(existing_file)+'.moved'
3081
2346
            tt.adjust_path(new_name, final_parent, existing_file)
3082
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2347
            new_conflicts.add((c_type, 'Moved existing file to', 
3083
2348
                               existing_file, new_file))
3084
2349
        elif c_type == 'parent loop':
3085
2350
            # break the loop by undoing one of the ops that caused the loop
3089
2354
            new_conflicts.add((c_type, 'Cancelled move', cur,
3090
2355
                               tt.final_parent(cur),))
3091
2356
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3092
 
 
 
2357
            
3093
2358
        elif c_type == 'missing parent':
3094
2359
            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:
 
2360
            try:
 
2361
                tt.cancel_deletion(trans_id)
 
2362
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2363
                                   trans_id))
 
2364
            except KeyError:
3119
2365
                create = True
3120
2366
                try:
3121
2367
                    tt.final_name(trans_id)
3124
2370
                        file_id = tt.final_file_id(trans_id)
3125
2371
                        if file_id is None:
3126
2372
                            file_id = tt.inactive_file_id(trans_id)
3127
 
                        _, entry = path_tree.iter_entries_by_dir(
3128
 
                            [file_id]).next()
 
2373
                        entry = path_tree.inventory[file_id]
3129
2374
                        # special-case the other tree root (move its
3130
2375
                        # children to current root)
3131
2376
                        if entry.parent_id is None:
3132
 
                            create = False
 
2377
                            create=False
3133
2378
                            moved = _reparent_transform_children(
3134
2379
                                tt, trans_id, tt.root)
3135
2380
                            for child in moved:
3146
2391
        elif c_type == 'unversioned parent':
3147
2392
            file_id = tt.inactive_file_id(conflict[1])
3148
2393
            # 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
 
2394
            if path_tree and file_id in path_tree:
 
2395
                if path_tree.inventory[file_id].parent_id is None:
3152
2396
                    continue
3153
2397
            tt.version_file(file_id, conflict[1])
3154
2398
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3170
2414
 
3171
2415
def cook_conflicts(raw_conflicts, tt):
3172
2416
    """Generate a list of cooked conflicts, sorted by file path"""
 
2417
    from bzrlib.conflicts import Conflict
3173
2418
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3174
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
2419
    return sorted(conflict_iter, key=Conflict.sort_key)
3175
2420
 
3176
2421
 
3177
2422
def iter_cook_conflicts(raw_conflicts, tt):
 
2423
    from bzrlib.conflicts import Conflict
3178
2424
    fp = FinalPaths(tt)
3179
2425
    for conflict in raw_conflicts:
3180
2426
        c_type = conflict[0]
3182
2428
        modified_path = fp.get_path(conflict[2])
3183
2429
        modified_id = tt.final_file_id(conflict[2])
3184
2430
        if len(conflict) == 3:
3185
 
            yield conflicts.Conflict.factory(
3186
 
                c_type, action=action, path=modified_path, file_id=modified_id)
3187
 
 
 
2431
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2432
                                     file_id=modified_id)
 
2433
             
3188
2434
        else:
3189
2435
            conflicting_path = fp.get_path(conflict[3])
3190
2436
            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)
 
2437
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2438
                                   file_id=modified_id, 
 
2439
                                   conflict_path=conflicting_path,
 
2440
                                   conflict_file_id=conflicting_id)
3196
2441
 
3197
2442
 
3198
2443
class _FileMover(object):
3203
2448
        self.pending_deletions = []
3204
2449
 
3205
2450
    def rename(self, from_, to):
3206
 
        """Rename a file from one path to another."""
 
2451
        """Rename a file from one path to another.  Functions like os.rename"""
3207
2452
        try:
3208
2453
            os.rename(from_, to)
3209
2454
        except OSError, e:
3210
2455
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3211
2456
                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)
 
2457
            raise
3215
2458
        self.past_renames.append((from_, to))
3216
2459
 
3217
2460
    def pre_delete(self, from_, to):
3227
2470
    def rollback(self):
3228
2471
        """Reverse all renames that have been performed"""
3229
2472
        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)
 
2473
            os.rename(to, from_)
3234
2474
        # after rollback, don't reuse _FileMover
3235
2475
        past_renames = None
3236
2476
        pending_deletions = None