← 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-03 22:30:56 UTC
  • mfrom: (3644.2.13 index_builder_cleanup)
  • Revision ID: pqm@pqm.ubuntu.com-20080903223056-b108iytb38xkznci
(jam) Streamline BTreeBuilder.add_node et al to make btree creation
        faster.

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
16
 
 
17
 
from __future__ import absolute_import
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
17
import os
20
18
import errno
21
19
from stat import S_ISREG, S_IEXEC
22
 
import time
23
20
 
24
 
from bzrlib import (
25
 
    config as _mod_config,
26
 
    errors,
27
 
    lazy_import,
28
 
    registry,
29
 
    trace,
30
 
    tree,
31
 
    )
32
 
lazy_import.lazy_import(globals(), """
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
33
23
from bzrlib import (
34
24
    annotate,
35
 
    bencode,
36
 
    controldir,
37
 
    commit,
38
 
    conflicts,
 
25
    bzrdir,
39
26
    delta,
 
27
    errors,
40
28
    inventory,
41
 
    multiparent,
42
29
    osutils,
43
30
    revision as _mod_revision,
44
 
    ui,
45
 
    urlutils,
46
31
    )
47
 
from bzrlib.i18n import gettext
48
32
""")
49
 
from bzrlib.errors import (DuplicateKey, MalformedTransform,
50
 
                           ReusingTransform, CantMoveRoot,
51
 
                           ImmortalLimbo, NoFinalPath,
 
33
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
 
34
                           ReusingTransform, NotVersionedError, CantMoveRoot,
 
35
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
52
36
                           UnableCreateSymlink)
53
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
54
 
from bzrlib.mutabletree import MutableTree
 
37
from bzrlib.inventory import InventoryEntry
55
38
from bzrlib.osutils import (
56
39
    delete_any,
57
40
    file_kind,
58
41
    has_symlinks,
 
42
    lexists,
59
43
    pathjoin,
60
 
    sha_file,
61
44
    splitpath,
62
 
    )
63
 
from bzrlib.progress import ProgressPhase
 
45
    supports_executable,
 
46
)
 
47
from bzrlib.progress import DummyProgress, ProgressPhase
64
48
from bzrlib.symbol_versioning import (
65
 
    deprecated_function,
66
 
    deprecated_in,
67
 
    deprecated_method,
68
 
    )
 
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
69
55
 
70
56
 
71
57
ROOT_PARENT = "root-parent"
72
58
 
 
59
 
73
60
def unique_add(map, key, value):
74
61
    if key in map:
75
62
        raise DuplicateKey(key=key)
76
63
    map[key] = value
77
64
 
78
65
 
79
 
 
80
66
class _TransformResults(object):
81
67
    def __init__(self, modified_paths, rename_count):
82
68
        object.__init__(self)
85
71
 
86
72
 
87
73
class TreeTransformBase(object):
88
 
    """The base class for TreeTransform and its kin."""
 
74
    """The base class for TreeTransform and TreeTransformBase"""
89
75
 
90
 
    def __init__(self, tree, pb=None,
 
76
    def __init__(self, tree, limbodir, pb=DummyProgress(),
91
77
                 case_sensitive=True):
92
78
        """Constructor.
93
79
 
94
80
        :param tree: The tree that will be transformed, but not necessarily
95
81
            the output tree.
96
 
        :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
97
85
        :param case_sensitive: If True, the target of the transform is
98
86
            case sensitive, not just case preserving.
99
87
        """
100
88
        object.__init__(self)
101
89
        self._tree = tree
 
90
        self._limbodir = limbodir
 
91
        self._deletiondir = None
102
92
        self._id_number = 0
103
93
        # mapping of trans_id -> new basename
104
94
        self._new_name = {}
106
96
        self._new_parent = {}
107
97
        # mapping of trans_id with new contents -> new file_kind
108
98
        self._new_contents = {}
109
 
        # mapping of trans_id => (sha1 of content, stat_value)
110
 
        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()
111
108
        # Set of trans_ids whose contents will be removed
112
109
        self._removed_contents = set()
113
110
        # Mapping of trans_id -> new execute-bit value
120
117
        self._non_present_ids = {}
121
118
        # Mapping of new file_id -> trans_id
122
119
        self._r_new_id = {}
123
 
        # Set of trans_ids that will be removed
 
120
        # Set of file_ids that will be removed
124
121
        self._removed_id = set()
125
122
        # Mapping of path in old tree -> trans_id
126
123
        self._tree_path_ids = {}
127
124
        # Mapping trans_id -> path in old tree
128
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 = {}
129
130
        # The trans_id that will be used as the tree root
130
131
        root_id = tree.get_root_id()
131
132
        if root_id is not None:
132
133
            self._new_root = self.trans_id_tree_file_id(root_id)
133
134
        else:
134
135
            self._new_root = None
135
 
        # Indicator of whether the transform has been applied
 
136
        # Indictor of whether the transform has been applied
136
137
        self._done = False
137
138
        # A progress bar
138
139
        self._pb = pb
141
142
        # A counter of how many files have been renamed
142
143
        self.rename_count = 0
143
144
 
144
 
    def __enter__(self):
145
 
        """Support Context Manager API."""
146
 
        return self
147
 
 
148
 
    def __exit__(self, exc_type, exc_val, exc_tb):
149
 
        """Support Context Manager API."""
150
 
        self.finalize()
151
 
 
152
 
    def finalize(self):
153
 
        """Release the working tree lock, if held.
154
 
 
155
 
        This is required if apply has not been invoked, but can be invoked
156
 
        even after apply.
157
 
        """
158
 
        if self._tree is None:
159
 
            return
160
 
        for hook in MutableTree.hooks['post_transform']:
161
 
            hook(self._tree, self)
162
 
        self._tree.unlock()
163
 
        self._tree = None
164
 
 
165
145
    def __get_root(self):
166
146
        return self._new_root
167
147
 
168
148
    root = property(__get_root)
169
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
 
170
181
    def _assign_id(self):
171
182
        """Produce a new tranform id"""
172
183
        new_id = "new-%s" % self._id_number
182
193
 
183
194
    def adjust_path(self, name, parent, trans_id):
184
195
        """Change the path that is assigned to a transaction id."""
185
 
        if parent is None:
186
 
            raise ValueError("Parent trans-id may not be None")
187
196
        if trans_id == self._new_root:
188
197
            raise CantMoveRoot
 
198
        previous_parent = self._new_parent.get(trans_id)
 
199
        previous_name = self._new_name.get(trans_id)
189
200
        self._new_name[trans_id] = name
190
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)
191
229
 
192
230
    def adjust_root_path(self, name, parent):
193
231
        """Emulate moving the root by moving all children, instead.
194
 
 
 
232
        
195
233
        We do this by undoing the association of root's transaction id with the
196
234
        current tree.  This allows us to create a new directory with that
197
 
        transaction id.  We unversion the root directory and version the
 
235
        transaction id.  We unversion the root directory and version the 
198
236
        physically new directory, and hope someone versions the tree root
199
237
        later.
200
238
        """
203
241
        # force moving all children of root
204
242
        for child_id in self.iter_tree_children(old_root):
205
243
            if child_id != parent:
206
 
                self.adjust_path(self.final_name(child_id),
 
244
                self.adjust_path(self.final_name(child_id), 
207
245
                                 self.final_parent(child_id), child_id)
208
246
            file_id = self.final_file_id(child_id)
209
247
            if file_id is not None:
210
248
                self.unversion_file(child_id)
211
249
            self.version_file(file_id, child_id)
212
 
 
 
250
        
213
251
        # the physical root needs a new transaction id
214
252
        self._tree_path_ids.pop("")
215
253
        self._tree_id_paths.pop(old_root)
221
259
        self.version_file(old_root_file_id, old_root)
222
260
        self.unversion_file(self._new_root)
223
261
 
224
 
    def fixup_new_roots(self):
225
 
        """Reinterpret requests to change the root directory
226
 
 
227
 
        Instead of creating a root directory, or moving an existing directory,
228
 
        all the attributes and children of the new root are applied to the
229
 
        existing root directory.
230
 
 
231
 
        This means that the old root trans-id becomes obsolete, so it is
232
 
        recommended only to invoke this after the root trans-id has become
233
 
        irrelevant.
234
 
 
235
 
        """
236
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v ==
237
 
                     ROOT_PARENT]
238
 
        if len(new_roots) < 1:
239
 
            return
240
 
        if len(new_roots) != 1:
241
 
            raise ValueError('A tree cannot have two roots!')
242
 
        if self._new_root is None:
243
 
            self._new_root = new_roots[0]
244
 
            return
245
 
        old_new_root = new_roots[0]
246
 
        # unversion the new root's directory.
247
 
        if self.final_kind(self._new_root) is None:
248
 
            file_id = self.final_file_id(old_new_root)
249
 
        else:
250
 
            file_id = self.final_file_id(self._new_root)
251
 
        if old_new_root in self._new_id:
252
 
            self.cancel_versioning(old_new_root)
253
 
        else:
254
 
            self.unversion_file(old_new_root)
255
 
        # if, at this stage, root still has an old file_id, zap it so we can
256
 
        # stick a new one in.
257
 
        if (self.tree_file_id(self._new_root) is not None and
258
 
            self._new_root not in self._removed_id):
259
 
            self.unversion_file(self._new_root)
260
 
        if file_id is not None:
261
 
            self.version_file(file_id, self._new_root)
262
 
 
263
 
        # Now move children of new root into old root directory.
264
 
        # Ensure all children are registered with the transaction, but don't
265
 
        # use directly-- some tree children have new parents
266
 
        list(self.iter_tree_children(old_new_root))
267
 
        # Move all children of new root into old root directory.
268
 
        for child in self.by_parent().get(old_new_root, []):
269
 
            self.adjust_path(self.final_name(child), self._new_root, child)
270
 
 
271
 
        # Ensure old_new_root has no directory.
272
 
        if old_new_root in self._new_contents:
273
 
            self.cancel_creation(old_new_root)
274
 
        else:
275
 
            self.delete_contents(old_new_root)
276
 
 
277
 
        # prevent deletion of root directory.
278
 
        if self._new_root in self._removed_contents:
279
 
            self.cancel_deletion(self._new_root)
280
 
 
281
 
        # destroy path info for old_new_root.
282
 
        del self._new_parent[old_new_root]
283
 
        del self._new_name[old_new_root]
284
 
 
285
262
    def trans_id_tree_file_id(self, inventory_id):
286
263
        """Determine the transaction id of a working tree file.
287
 
 
 
264
        
288
265
        This reflects only files that already exist, not ones that will be
289
266
        added by transactions.
290
267
        """
303
280
            raise ValueError('None is not a valid file id')
304
281
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
305
282
            return self._r_new_id[file_id]
306
 
        else:
307
 
            try:
308
 
                self._tree.iter_entries_by_dir([file_id]).next()
309
 
            except StopIteration:
310
 
                if file_id in self._non_present_ids:
311
 
                    return self._non_present_ids[file_id]
312
 
                else:
313
 
                    trans_id = self._assign_id()
314
 
                    self._non_present_ids[file_id] = trans_id
315
 
                    return trans_id
316
 
            else:
317
 
                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
318
310
 
319
311
    def trans_id_tree_path(self, path):
320
312
        """Determine (and maybe set) the transaction ID for a tree path."""
331
323
            return ROOT_PARENT
332
324
        return self.trans_id_tree_path(os.path.dirname(path))
333
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
 
334
433
    def delete_contents(self, trans_id):
335
434
        """Schedule the contents of a path entry for deletion"""
336
 
        kind = self.tree_kind(trans_id)
337
 
        if kind is not None:
338
 
            self._removed_contents.add(trans_id)
 
435
        self.tree_kind(trans_id)
 
436
        self._removed_contents.add(trans_id)
339
437
 
340
438
    def cancel_deletion(self, trans_id):
341
439
        """Cancel a scheduled deletion"""
398
496
        return sorted(FinalPaths(self).get_paths(new_ids))
399
497
 
400
498
    def _inventory_altered(self):
401
 
        """Determine which trans_ids need new Inventory entries.
402
 
 
403
 
        An new entry is needed when anything that would be reflected by an
404
 
        inventory entry changes, including file name, file_id, parent file_id,
405
 
        file kind, and the execute bit.
406
 
 
407
 
        Some care is taken to return entries with real changes, not cases
408
 
        where the value is deleted and then restored to its original value,
409
 
        but some actually unchanged values may be returned.
410
 
 
411
 
        :returns: A list of (path, trans_id) for all items requiring an
412
 
            inventory change. Ordered by path.
413
 
        """
414
 
        changed_ids = set()
415
 
        # Find entries whose file_ids are new (or changed).
416
 
        new_file_id = set(t for t in self._new_id
417
 
                          if self._new_id[t] != self.tree_file_id(t))
418
 
        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,
419
502
                       self._new_executability]:
420
 
            changed_ids.update(id_set)
421
 
        # removing implies a kind change
 
503
            new_ids.update(id_set)
422
504
        changed_kind = set(self._removed_contents)
423
 
        # so does adding
424
505
        changed_kind.intersection_update(self._new_contents)
425
 
        # Ignore entries that are already known to have changed.
426
 
        changed_kind.difference_update(changed_ids)
427
 
        #  to keep only the truly changed ones
428
 
        changed_kind = (t for t in changed_kind
429
 
                        if self.tree_kind(t) != self.final_kind(t))
430
 
        # all kind changes will alter the inventory
431
 
        changed_ids.update(changed_kind)
432
 
        # To find entries with changed parent_ids, find parents which existed,
433
 
        # but changed file_id.
434
 
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
435
 
        # Now add all their children to the set.
436
 
        for parent_trans_id in new_file_id:
437
 
            changed_ids.update(self.iter_tree_children(parent_trans_id))
438
 
        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)
439
527
 
440
528
    def final_kind(self, trans_id):
441
529
        """Determine the final file kind, after any changes applied.
442
 
 
443
 
        :return: None if the file does not exist/has no contents.  (It is
444
 
            conceivable that a path would be created without the corresponding
445
 
            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)
446
534
        """
447
535
        if trans_id in self._new_contents:
448
536
            return self._new_contents[trans_id]
449
537
        elif trans_id in self._removed_contents:
450
 
            return None
 
538
            raise NoSuchFile(None)
451
539
        else:
452
540
            return self.tree_kind(trans_id)
453
541
 
461
549
        # the file is old; the old id is still valid
462
550
        if self._new_root == trans_id:
463
551
            return self._tree.get_root_id()
464
 
        return self._tree.path2id(path)
 
552
        return self._tree.inventory.path2id(path)
465
553
 
466
554
    def final_file_id(self, trans_id):
467
555
        """Determine the file id after any changes are applied, or None.
468
 
 
 
556
        
469
557
        None indicates that the file will not be versioned after changes are
470
558
        applied.
471
559
        """
510
598
 
511
599
    def by_parent(self):
512
600
        """Return a map of parent: children for known parents.
513
 
 
 
601
        
514
602
        Only new paths and parents of tree files with assigned ids are used.
515
603
        """
516
604
        by_parent = {}
517
605
        items = list(self._new_parent.iteritems())
518
 
        items.extend((t, self.final_parent(t)) for t in
 
606
        items.extend((t, self.final_parent(t)) for t in 
519
607
                      self._tree_id_paths.keys())
520
608
        for trans_id, parent_id in items:
521
609
            if parent_id not in by_parent:
549
637
        conflicts.extend(self._overwrite_conflicts())
550
638
        return conflicts
551
639
 
552
 
    def _check_malformed(self):
553
 
        conflicts = self.find_conflicts()
554
 
        if len(conflicts) != 0:
555
 
            raise MalformedTransform(conflicts=conflicts)
556
 
 
557
640
    def _add_tree_children(self):
558
641
        """Add all the children of all active parents to the known paths.
559
642
 
561
644
        removed.  This is a necessary first step in detecting conflicts.
562
645
        """
563
646
        parents = self.by_parent().keys()
564
 
        parents.extend([t for t in self._removed_contents if
 
647
        parents.extend([t for t in self._removed_contents if 
565
648
                        self.tree_kind(t) == 'directory'])
566
649
        for trans_id in self._removed_id:
567
650
            file_id = self.tree_file_id(trans_id)
568
651
            if file_id is not None:
569
 
                if self._tree.stored_kind(file_id) == 'directory':
 
652
                if self._tree.inventory[file_id].kind == 'directory':
570
653
                    parents.append(trans_id)
571
654
            elif self.tree_kind(trans_id) == 'directory':
572
655
                parents.append(trans_id)
575
658
            # ensure that all children are registered with the transaction
576
659
            list(self.iter_tree_children(parent_id))
577
660
 
578
 
    def _has_named_child(self, name, parent_id, known_children):
579
 
        """Does a parent already have a name child.
580
 
 
581
 
        :param name: The searched for name.
582
 
 
583
 
        :param parent_id: The parent for which the check is made.
584
 
 
585
 
        :param known_children: The already known children. This should have
586
 
            been recently obtained from `self.by_parent.get(parent_id)`
587
 
            (or will be if None is passed).
588
 
        """
589
 
        if known_children is None:
590
 
            known_children = self.by_parent().get(parent_id, [])
591
 
        for child in known_children:
 
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
 
 
681
    def has_named_child(self, by_parent, parent_id, name):
 
682
        try:
 
683
            children = by_parent[parent_id]
 
684
        except KeyError:
 
685
            children = []
 
686
        for child in children:
592
687
            if self.final_name(child) == name:
593
688
                return True
594
 
        parent_path = self._tree_id_paths.get(parent_id, None)
595
 
        if parent_path is None:
596
 
            # No parent... no children
 
689
        try:
 
690
            path = self._tree_id_paths[parent_id]
 
691
        except KeyError:
597
692
            return False
598
 
        child_path = joinpath(parent_path, name)
599
 
        child_id = self._tree_path_ids.get(child_path, None)
 
693
        childpath = joinpath(path, name)
 
694
        child_id = self._tree_path_ids.get(childpath)
600
695
        if child_id is None:
601
 
            # Not known by the tree transform yet, check the filesystem
602
 
            return osutils.lexists(self._tree.abspath(child_path))
 
696
            return lexists(self._tree.abspath(childpath))
603
697
        else:
604
 
            raise AssertionError('child_id is missing: %s, %s, %s'
605
 
                                 % (name, parent_id, child_id))
606
 
 
607
 
    def _available_backup_name(self, name, target_id):
608
 
        """Find an available backup name.
609
 
 
610
 
        :param name: The basename of the file.
611
 
 
612
 
        :param target_id: The directory trans_id where the backup should 
613
 
            be placed.
614
 
        """
615
 
        known_children = self.by_parent().get(target_id, [])
616
 
        return osutils.available_backup_name(
617
 
            name,
618
 
            lambda base: self._has_named_child(
619
 
                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
620
705
 
621
706
    def _parent_loops(self):
622
707
        """No entry should be its own ancestor"""
624
709
        for trans_id in self._new_parent:
625
710
            seen = set()
626
711
            parent_id = trans_id
627
 
            while parent_id != ROOT_PARENT:
 
712
            while parent_id is not ROOT_PARENT:
628
713
                seen.add(parent_id)
629
714
                try:
630
715
                    parent_id = self.final_parent(parent_id)
640
725
        """If parent directories are versioned, children must be versioned."""
641
726
        conflicts = []
642
727
        for parent_id, children in by_parent.iteritems():
643
 
            if parent_id == ROOT_PARENT:
 
728
            if parent_id is ROOT_PARENT:
644
729
                continue
645
730
            if self.final_file_id(parent_id) is not None:
646
731
                continue
652
737
 
653
738
    def _improper_versioning(self):
654
739
        """Cannot version a file with no contents, or a bad type.
655
 
 
 
740
        
656
741
        However, existing entries with no contents are okay.
657
742
        """
658
743
        conflicts = []
659
744
        for trans_id in self._new_id.iterkeys():
660
 
            kind = self.final_kind(trans_id)
661
 
            if kind is None:
 
745
            try:
 
746
                kind = self.final_kind(trans_id)
 
747
            except NoSuchFile:
662
748
                conflicts.append(('versioning no contents', trans_id))
663
749
                continue
664
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
750
            if not InventoryEntry.versionable_kind(kind):
665
751
                conflicts.append(('versioning bad kind', trans_id, kind))
666
752
        return conflicts
667
753
 
668
754
    def _executability_conflicts(self):
669
755
        """Check for bad executability changes.
670
 
 
 
756
        
671
757
        Only versioned files may have their executability set, because
672
758
        1. only versioned entries can have executability under windows
673
759
        2. only files can be executable.  (The execute bit on a directory
678
764
            if self.final_file_id(trans_id) is None:
679
765
                conflicts.append(('unversioned executability', trans_id))
680
766
            else:
681
 
                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:
682
772
                    conflicts.append(('non-file executability', trans_id))
683
773
        return conflicts
684
774
 
686
776
        """Check for overwrites (not permitted on Win32)"""
687
777
        conflicts = []
688
778
        for trans_id in self._new_contents:
689
 
            if self.tree_kind(trans_id) is None:
 
779
            try:
 
780
                self.tree_kind(trans_id)
 
781
            except NoSuchFile:
690
782
                continue
691
783
            if trans_id not in self._removed_contents:
692
784
                conflicts.append(('overwrite', trans_id,
699
791
        if (self._new_name, self._new_parent) == ({}, {}):
700
792
            return conflicts
701
793
        for children in by_parent.itervalues():
702
 
            name_ids = []
703
 
            for child_tid in children:
704
 
                name = self.final_name(child_tid)
705
 
                if name is not None:
706
 
                    # Keep children only if they still exist in the end
707
 
                    if not self._case_sensitive_target:
708
 
                        name = name.lower()
709
 
                    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]
710
797
            name_ids.sort()
711
798
            last_name = None
712
799
            last_trans_id = None
713
800
            for name, trans_id in name_ids:
714
 
                kind = self.final_kind(trans_id)
 
801
                try:
 
802
                    kind = self.final_kind(trans_id)
 
803
                except NoSuchFile:
 
804
                    kind = None
715
805
                file_id = self.final_file_id(trans_id)
716
806
                if kind is None and file_id is None:
717
807
                    continue
736
826
        return conflicts
737
827
 
738
828
    def _parent_type_conflicts(self, by_parent):
739
 
        """Children must have a directory parent"""
 
829
        """parents must have directory 'contents'."""
740
830
        conflicts = []
741
831
        for parent_id, children in by_parent.iteritems():
742
 
            if parent_id == ROOT_PARENT:
743
 
                continue
744
 
            no_children = True
745
 
            for child_id in children:
746
 
                if self.final_kind(child_id) is not None:
747
 
                    no_children = False
748
 
                    break
749
 
            if no_children:
750
 
                continue
751
 
            # There is at least a child, so we need an existing directory to
752
 
            # contain it.
753
 
            kind = self.final_kind(parent_id)
 
832
            if parent_id is ROOT_PARENT:
 
833
                continue
 
834
            if not self._any_contents(children):
 
835
                continue
 
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
754
845
            if kind is None:
755
 
                # The directory will be deleted
756
846
                conflicts.append(('missing parent', parent_id))
757
847
            elif kind != "directory":
758
 
                # Meh, we need a *directory* to put something in it
759
848
                conflicts.append(('non-directory parent', parent_id))
760
849
        return conflicts
761
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
 
762
905
    def _set_executability(self, path, trans_id):
763
906
        """Set the executability of versioned files """
764
 
        if self._tree._supports_executable():
 
907
        if supports_executable():
765
908
            new_executability = self._new_executability[trans_id]
766
909
            abspath = self._tree.abspath(path)
767
910
            current_mode = os.stat(abspath).st_mode
776
919
                    to_mode |= 0010 & ~umask
777
920
            else:
778
921
                to_mode = current_mode & ~0111
779
 
            osutils.chmod_if_possible(abspath, to_mode)
 
922
            os.chmod(abspath, to_mode)
780
923
 
781
924
    def _new_entry(self, name, parent_id, file_id):
782
925
        """Helper function to create a new filesystem entry."""
785
928
            self.version_file(file_id, trans_id)
786
929
        return trans_id
787
930
 
788
 
    def new_file(self, name, parent_id, contents, file_id=None,
789
 
                 executable=None, sha1=None):
 
931
    def new_file(self, name, parent_id, contents, file_id=None, 
 
932
                 executable=None):
790
933
        """Convenience method to create files.
791
 
 
 
934
        
792
935
        name is the name of the file to create.
793
936
        parent_id is the transaction id of the parent directory of the file.
794
937
        contents is an iterator of bytestrings, which will be used to produce
799
942
        trans_id = self._new_entry(name, parent_id, file_id)
800
943
        # TODO: rather than scheduling a set_executable call,
801
944
        # have create_file create the file with the right mode.
802
 
        self.create_file(contents, trans_id, sha1=sha1)
 
945
        self.create_file(contents, trans_id)
803
946
        if executable is not None:
804
947
            self.set_executability(executable, trans_id)
805
948
        return trans_id
814
957
        """
815
958
        trans_id = self._new_entry(name, parent_id, file_id)
816
959
        self.create_directory(trans_id)
817
 
        return trans_id
 
960
        return trans_id 
818
961
 
819
962
    def new_symlink(self, name, parent_id, target, file_id=None):
820
963
        """Convenience method to create symbolic link.
821
 
 
 
964
        
822
965
        name is the name of the symlink to create.
823
966
        parent_id is the transaction id of the parent directory of the symlink.
824
967
        target is a bytestring of the target of the symlink.
828
971
        self.create_symlink(target, trans_id)
829
972
        return trans_id
830
973
 
831
 
    def new_orphan(self, trans_id, parent_id):
832
 
        """Schedule an item to be orphaned.
833
 
 
834
 
        When a directory is about to be removed, its children, if they are not
835
 
        versioned are moved out of the way: they don't have a parent anymore.
836
 
 
837
 
        :param trans_id: The trans_id of the existing item.
838
 
        :param parent_id: The parent trans_id of the item.
839
 
        """
840
 
        raise NotImplementedError(self.new_orphan)
841
 
 
842
 
    def _get_potential_orphans(self, dir_id):
843
 
        """Find the potential orphans in a directory.
844
 
 
845
 
        A directory can't be safely deleted if there are versioned files in it.
846
 
        If all the contained files are unversioned then they can be orphaned.
847
 
 
848
 
        The 'None' return value means that the directory contains at least one
849
 
        versioned file and should not be deleted.
850
 
 
851
 
        :param dir_id: The directory trans id.
852
 
 
853
 
        :return: A list of the orphan trans ids or None if at least one
854
 
             versioned file is present.
855
 
        """
856
 
        orphans = []
857
 
        # Find the potential orphans, stop if one item should be kept
858
 
        for child_tid in self.by_parent()[dir_id]:
859
 
            if child_tid in self._removed_contents:
860
 
                # The child is removed as part of the transform. Since it was
861
 
                # versioned before, it's not an orphan
862
 
                continue
863
 
            elif self.final_file_id(child_tid) is None:
864
 
                # The child is not versioned
865
 
                orphans.append(child_tid)
866
 
            else:
867
 
                # We have a versioned file here, searching for orphans is
868
 
                # meaningless.
869
 
                orphans = None
870
 
                break
871
 
        return orphans
872
 
 
873
974
    def _affected_ids(self):
874
975
        """Return the set of transform ids affected by the transform"""
875
976
        trans_ids = set(self._removed_id)
905
1006
        from_path = self._tree_id_paths.get(from_trans_id)
906
1007
        if from_versioned:
907
1008
            # get data from working tree if versioned
908
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1009
            from_entry = self._tree.inventory[file_id]
909
1010
            from_name = from_entry.name
910
1011
            from_parent = from_entry.parent_id
911
1012
        else:
934
1035
        Return a (name, parent, kind, executable) tuple
935
1036
        """
936
1037
        to_name = self.final_name(to_trans_id)
937
 
        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
938
1042
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
939
1043
        if to_trans_id in self._new_executability:
940
1044
            to_executable = self._new_executability[to_trans_id]
1009
1113
    def get_preview_tree(self):
1010
1114
        """Return a tree representing the result of the transform.
1011
1115
 
1012
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
1013
 
        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.
1014
1118
        """
1015
1119
        return _PreviewTree(self)
1016
1120
 
1017
 
    def commit(self, branch, message, merge_parents=None, strict=False,
1018
 
               timestamp=None, timezone=None, committer=None, authors=None,
1019
 
               revprops=None, revision_id=None):
1020
 
        """Commit the result of this TreeTransform to a branch.
1021
 
 
1022
 
        :param branch: The branch to commit to.
1023
 
        :param message: The message to attach to the commit.
1024
 
        :param merge_parents: Additional parent revision-ids specified by
1025
 
            pending merges.
1026
 
        :param strict: If True, abort the commit if there are unversioned
1027
 
            files.
1028
 
        :param timestamp: if not None, seconds-since-epoch for the time and
1029
 
            date.  (May be a float.)
1030
 
        :param timezone: Optional timezone for timestamp, as an offset in
1031
 
            seconds.
1032
 
        :param committer: Optional committer in email-id format.
1033
 
            (e.g. "J Random Hacker <jrandom@example.com>")
1034
 
        :param authors: Optional list of authors in email-id format.
1035
 
        :param revprops: Optional dictionary of revision properties.
1036
 
        :param revision_id: Optional revision id.  (Specifying a revision-id
1037
 
            may reduce performance for some non-native formats.)
1038
 
        :return: The revision_id of the revision committed.
1039
 
        """
1040
 
        self._check_malformed()
1041
 
        if strict:
1042
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
1043
 
            for trans_id in unversioned:
1044
 
                if self.final_file_id(trans_id) is None:
1045
 
                    raise errors.StrictCommitFailed()
1046
 
 
1047
 
        revno, last_rev_id = branch.last_revision_info()
1048
 
        if last_rev_id == _mod_revision.NULL_REVISION:
1049
 
            if merge_parents is not None:
1050
 
                raise ValueError('Cannot supply merge parents for first'
1051
 
                                 ' commit.')
1052
 
            parent_ids = []
1053
 
        else:
1054
 
            parent_ids = [last_rev_id]
1055
 
            if merge_parents is not None:
1056
 
                parent_ids.extend(merge_parents)
1057
 
        if self._tree.get_revision_id() != last_rev_id:
1058
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
1059
 
                             self._tree.get_revision_id())
1060
 
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
1061
 
        builder = branch.get_commit_builder(parent_ids,
1062
 
                                            timestamp=timestamp,
1063
 
                                            timezone=timezone,
1064
 
                                            committer=committer,
1065
 
                                            revprops=revprops,
1066
 
                                            revision_id=revision_id)
1067
 
        preview = self.get_preview_tree()
1068
 
        list(builder.record_iter_changes(preview, last_rev_id,
1069
 
                                         self.iter_changes()))
1070
 
        builder.finish_inventory()
1071
 
        revision_id = builder.commit(message)
1072
 
        branch.set_last_revision_info(revno + 1, revision_id)
1073
 
        return revision_id
1074
 
 
1075
 
    def _text_parent(self, trans_id):
1076
 
        file_id = self.tree_file_id(trans_id)
1077
 
        try:
1078
 
            if file_id is None or self._tree.kind(file_id) != 'file':
1079
 
                return None
1080
 
        except errors.NoSuchFile:
1081
 
            return None
1082
 
        return file_id
1083
 
 
1084
 
    def _get_parents_texts(self, trans_id):
1085
 
        """Get texts for compression parents of this file."""
1086
 
        file_id = self._text_parent(trans_id)
1087
 
        if file_id is None:
1088
 
            return ()
1089
 
        return (self._tree.get_file_text(file_id),)
1090
 
 
1091
 
    def _get_parents_lines(self, trans_id):
1092
 
        """Get lines for compression parents of this file."""
1093
 
        file_id = self._text_parent(trans_id)
1094
 
        if file_id is None:
1095
 
            return ()
1096
 
        return (self._tree.get_file_lines(file_id),)
1097
 
 
1098
 
    def serialize(self, serializer):
1099
 
        """Serialize this TreeTransform.
1100
 
 
1101
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
1102
 
        """
1103
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
1104
 
                        self._new_name.items())
1105
 
        new_executability = dict((k, int(v)) for k, v in
1106
 
                                 self._new_executability.items())
1107
 
        tree_path_ids = dict((k.encode('utf-8'), v)
1108
 
                             for k, v in self._tree_path_ids.items())
1109
 
        attribs = {
1110
 
            '_id_number': self._id_number,
1111
 
            '_new_name': new_name,
1112
 
            '_new_parent': self._new_parent,
1113
 
            '_new_executability': new_executability,
1114
 
            '_new_id': self._new_id,
1115
 
            '_tree_path_ids': tree_path_ids,
1116
 
            '_removed_id': list(self._removed_id),
1117
 
            '_removed_contents': list(self._removed_contents),
1118
 
            '_non_present_ids': self._non_present_ids,
1119
 
            }
1120
 
        yield serializer.bytes_record(bencode.bencode(attribs),
1121
 
                                      (('attribs',),))
1122
 
        for trans_id, kind in self._new_contents.items():
1123
 
            if kind == 'file':
1124
 
                lines = osutils.chunks_to_lines(
1125
 
                    self._read_file_chunks(trans_id))
1126
 
                parents = self._get_parents_lines(trans_id)
1127
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1128
 
                content = ''.join(mpdiff.to_patch())
1129
 
            if kind == 'directory':
1130
 
                content = ''
1131
 
            if kind == 'symlink':
1132
 
                content = self._read_symlink_target(trans_id)
1133
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
1134
 
 
1135
 
    def deserialize(self, records):
1136
 
        """Deserialize a stored TreeTransform.
1137
 
 
1138
 
        :param records: An iterable of (names, content) tuples, as per
1139
 
            pack.ContainerPushParser.
1140
 
        """
1141
 
        names, content = records.next()
1142
 
        attribs = bencode.bdecode(content)
1143
 
        self._id_number = attribs['_id_number']
1144
 
        self._new_name = dict((k, v.decode('utf-8'))
1145
 
                            for k, v in attribs['_new_name'].items())
1146
 
        self._new_parent = attribs['_new_parent']
1147
 
        self._new_executability = dict((k, bool(v)) for k, v in
1148
 
            attribs['_new_executability'].items())
1149
 
        self._new_id = attribs['_new_id']
1150
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1151
 
        self._tree_path_ids = {}
1152
 
        self._tree_id_paths = {}
1153
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
1154
 
            path = bytepath.decode('utf-8')
1155
 
            self._tree_path_ids[path] = trans_id
1156
 
            self._tree_id_paths[trans_id] = path
1157
 
        self._removed_id = set(attribs['_removed_id'])
1158
 
        self._removed_contents = set(attribs['_removed_contents'])
1159
 
        self._non_present_ids = attribs['_non_present_ids']
1160
 
        for ((trans_id, kind),), content in records:
1161
 
            if kind == 'file':
1162
 
                mpdiff = multiparent.MultiParent.from_patch(content)
1163
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1164
 
                self.create_file(lines, trans_id)
1165
 
            if kind == 'directory':
1166
 
                self.create_directory(trans_id)
1167
 
            if kind == 'symlink':
1168
 
                self.create_symlink(content.decode('utf-8'), trans_id)
1169
 
 
1170
 
 
1171
 
class DiskTreeTransform(TreeTransformBase):
1172
 
    """Tree transform storing its contents on disk."""
1173
 
 
1174
 
    def __init__(self, tree, limbodir, pb=None,
1175
 
                 case_sensitive=True):
1176
 
        """Constructor.
1177
 
        :param tree: The tree that will be transformed, but not necessarily
1178
 
            the output tree.
1179
 
        :param limbodir: A directory where new files can be stored until
1180
 
            they are installed in their proper places
1181
 
        :param pb: ignored
1182
 
        :param case_sensitive: If True, the target of the transform is
1183
 
            case sensitive, not just case preserving.
1184
 
        """
1185
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1186
 
        self._limbodir = limbodir
1187
 
        self._deletiondir = None
1188
 
        # A mapping of transform ids to their limbo filename
1189
 
        self._limbo_files = {}
1190
 
        self._possibly_stale_limbo_files = set()
1191
 
        # A mapping of transform ids to a set of the transform ids of children
1192
 
        # that their limbo directory has
1193
 
        self._limbo_children = {}
1194
 
        # Map transform ids to maps of child filename to child transform id
1195
 
        self._limbo_children_names = {}
1196
 
        # List of transform ids that need to be renamed from limbo into place
1197
 
        self._needs_rename = set()
1198
 
        self._creation_mtime = None
1199
 
 
1200
 
    def finalize(self):
1201
 
        """Release the working tree lock, if held, clean up limbo dir.
1202
 
 
1203
 
        This is required if apply has not been invoked, but can be invoked
1204
 
        even after apply.
1205
 
        """
1206
 
        if self._tree is None:
1207
 
            return
1208
 
        try:
1209
 
            limbo_paths = self._limbo_files.values() + list(
1210
 
                self._possibly_stale_limbo_files)
1211
 
            limbo_paths = sorted(limbo_paths, reverse=True)
1212
 
            for path in limbo_paths:
1213
 
                try:
1214
 
                    delete_any(path)
1215
 
                except OSError, e:
1216
 
                    if e.errno != errno.ENOENT:
1217
 
                        raise
1218
 
                    # XXX: warn? perhaps we just got interrupted at an
1219
 
                    # inconvenient moment, but perhaps files are disappearing
1220
 
                    # from under us?
1221
 
            try:
1222
 
                delete_any(self._limbodir)
1223
 
            except OSError:
1224
 
                # We don't especially care *why* the dir is immortal.
1225
 
                raise ImmortalLimbo(self._limbodir)
1226
 
            try:
1227
 
                if self._deletiondir is not None:
1228
 
                    delete_any(self._deletiondir)
1229
 
            except OSError:
1230
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1231
 
        finally:
1232
 
            TreeTransformBase.finalize(self)
1233
 
 
1234
 
    def _limbo_supports_executable(self):
1235
 
        """Check if the limbo path supports the executable bit."""
1236
 
        # FIXME: Check actual file system capabilities of limbodir
1237
 
        return osutils.supports_executable()
1238
 
 
1239
 
    def _limbo_name(self, trans_id):
1240
 
        """Generate the limbo name of a file"""
1241
 
        limbo_name = self._limbo_files.get(trans_id)
1242
 
        if limbo_name is None:
1243
 
            limbo_name = self._generate_limbo_path(trans_id)
1244
 
            self._limbo_files[trans_id] = limbo_name
1245
 
        return limbo_name
1246
 
 
1247
 
    def _generate_limbo_path(self, trans_id):
1248
 
        """Generate a limbo path using the trans_id as the relative path.
1249
 
 
1250
 
        This is suitable as a fallback, and when the transform should not be
1251
 
        sensitive to the path encoding of the limbo directory.
1252
 
        """
1253
 
        self._needs_rename.add(trans_id)
1254
 
        return pathjoin(self._limbodir, trans_id)
1255
 
 
1256
 
    def adjust_path(self, name, parent, trans_id):
1257
 
        previous_parent = self._new_parent.get(trans_id)
1258
 
        previous_name = self._new_name.get(trans_id)
1259
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1260
 
        if (trans_id in self._limbo_files and
1261
 
            trans_id not in self._needs_rename):
1262
 
            self._rename_in_limbo([trans_id])
1263
 
            if previous_parent != parent:
1264
 
                self._limbo_children[previous_parent].remove(trans_id)
1265
 
            if previous_parent != parent or previous_name != name:
1266
 
                del self._limbo_children_names[previous_parent][previous_name]
1267
 
 
1268
 
    def _rename_in_limbo(self, trans_ids):
1269
 
        """Fix limbo names so that the right final path is produced.
1270
 
 
1271
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1272
 
        these files later by creating them with their final names in their
1273
 
        final parents.  But now the previous name or parent is no longer
1274
 
        suitable, so we have to rename them.
1275
 
 
1276
 
        Even for trans_ids that have no new contents, we must remove their
1277
 
        entries from _limbo_files, because they are now stale.
1278
 
        """
1279
 
        for trans_id in trans_ids:
1280
 
            old_path = self._limbo_files[trans_id]
1281
 
            self._possibly_stale_limbo_files.add(old_path)
1282
 
            del self._limbo_files[trans_id]
1283
 
            if trans_id not in self._new_contents:
1284
 
                continue
1285
 
            new_path = self._limbo_name(trans_id)
1286
 
            os.rename(old_path, new_path)
1287
 
            self._possibly_stale_limbo_files.remove(old_path)
1288
 
            for descendant in self._limbo_descendants(trans_id):
1289
 
                desc_path = self._limbo_files[descendant]
1290
 
                desc_path = new_path + desc_path[len(old_path):]
1291
 
                self._limbo_files[descendant] = desc_path
1292
 
 
1293
 
    def _limbo_descendants(self, trans_id):
1294
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1295
 
        descendants = set(self._limbo_children.get(trans_id, []))
1296
 
        for descendant in list(descendants):
1297
 
            descendants.update(self._limbo_descendants(descendant))
1298
 
        return descendants
1299
 
 
1300
 
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1301
 
        """Schedule creation of a new file.
1302
 
 
1303
 
        :seealso: new_file.
1304
 
 
1305
 
        :param contents: an iterator of strings, all of which will be written
1306
 
            to the target destination.
1307
 
        :param trans_id: TreeTransform handle
1308
 
        :param mode_id: If not None, force the mode of the target file to match
1309
 
            the mode of the object referenced by mode_id.
1310
 
            Otherwise, we will try to preserve mode bits of an existing file.
1311
 
        :param sha1: If the sha1 of this content is already known, pass it in.
1312
 
            We can use it to prevent future sha1 computations.
1313
 
        """
1314
 
        name = self._limbo_name(trans_id)
1315
 
        f = open(name, 'wb')
1316
 
        try:
1317
 
            unique_add(self._new_contents, trans_id, 'file')
1318
 
            f.writelines(contents)
1319
 
        finally:
1320
 
            f.close()
1321
 
        self._set_mtime(name)
1322
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1323
 
        # It is unfortunate we have to use lstat instead of fstat, but we just
1324
 
        # used utime and chmod on the file, so we need the accurate final
1325
 
        # details.
1326
 
        if sha1 is not None:
1327
 
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1328
 
 
1329
 
    def _read_file_chunks(self, trans_id):
1330
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1331
 
        try:
1332
 
            return cur_file.readlines()
1333
 
        finally:
1334
 
            cur_file.close()
1335
 
 
1336
 
    def _read_symlink_target(self, trans_id):
1337
 
        return os.readlink(self._limbo_name(trans_id))
1338
 
 
1339
 
    def _set_mtime(self, path):
1340
 
        """All files that are created get the same mtime.
1341
 
 
1342
 
        This time is set by the first object to be created.
1343
 
        """
1344
 
        if self._creation_mtime is None:
1345
 
            self._creation_mtime = time.time()
1346
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1347
 
 
1348
 
    def create_hardlink(self, path, trans_id):
1349
 
        """Schedule creation of a hard link"""
1350
 
        name = self._limbo_name(trans_id)
1351
 
        try:
1352
 
            os.link(path, name)
1353
 
        except OSError, e:
1354
 
            if e.errno != errno.EPERM:
1355
 
                raise
1356
 
            raise errors.HardLinkNotSupported(path)
1357
 
        try:
1358
 
            unique_add(self._new_contents, trans_id, 'file')
1359
 
        except:
1360
 
            # Clean up the file, it never got registered so
1361
 
            # TreeTransform.finalize() won't clean it up.
1362
 
            os.unlink(name)
1363
 
            raise
1364
 
 
1365
 
    def create_directory(self, trans_id):
1366
 
        """Schedule creation of a new directory.
1367
 
 
1368
 
        See also new_directory.
1369
 
        """
1370
 
        os.mkdir(self._limbo_name(trans_id))
1371
 
        unique_add(self._new_contents, trans_id, 'directory')
1372
 
 
1373
 
    def create_symlink(self, target, trans_id):
1374
 
        """Schedule creation of a new symbolic link.
1375
 
 
1376
 
        target is a bytestring.
1377
 
        See also new_symlink.
1378
 
        """
1379
 
        if has_symlinks():
1380
 
            os.symlink(target, self._limbo_name(trans_id))
1381
 
            unique_add(self._new_contents, trans_id, 'symlink')
1382
 
        else:
1383
 
            try:
1384
 
                path = FinalPaths(self).get_path(trans_id)
1385
 
            except KeyError:
1386
 
                path = None
1387
 
            raise UnableCreateSymlink(path=path)
1388
 
 
1389
 
    def cancel_creation(self, trans_id):
1390
 
        """Cancel the creation of new file contents."""
1391
 
        del self._new_contents[trans_id]
1392
 
        if trans_id in self._observed_sha1s:
1393
 
            del self._observed_sha1s[trans_id]
1394
 
        children = self._limbo_children.get(trans_id)
1395
 
        # if this is a limbo directory with children, move them before removing
1396
 
        # the directory
1397
 
        if children is not None:
1398
 
            self._rename_in_limbo(children)
1399
 
            del self._limbo_children[trans_id]
1400
 
            del self._limbo_children_names[trans_id]
1401
 
        delete_any(self._limbo_name(trans_id))
1402
 
 
1403
 
    def new_orphan(self, trans_id, parent_id):
1404
 
        conf = self._tree.get_config_stack()
1405
 
        handle_orphan = conf.get('bzr.transform.orphan_policy')
1406
 
        handle_orphan(self, trans_id, parent_id)
1407
 
 
1408
 
 
1409
 
class OrphaningError(errors.BzrError):
1410
 
 
1411
 
    # Only bugs could lead to such exception being seen by the user
1412
 
    internal_error = True
1413
 
    _fmt = "Error while orphaning %s in %s directory"
1414
 
 
1415
 
    def __init__(self, orphan, parent):
1416
 
        errors.BzrError.__init__(self)
1417
 
        self.orphan = orphan
1418
 
        self.parent = parent
1419
 
 
1420
 
 
1421
 
class OrphaningForbidden(OrphaningError):
1422
 
 
1423
 
    _fmt = "Policy: %s doesn't allow creating orphans."
1424
 
 
1425
 
    def __init__(self, policy):
1426
 
        errors.BzrError.__init__(self)
1427
 
        self.policy = policy
1428
 
 
1429
 
 
1430
 
def move_orphan(tt, orphan_id, parent_id):
1431
 
    """See TreeTransformBase.new_orphan.
1432
 
 
1433
 
    This creates a new orphan in the `bzr-orphans` dir at the root of the
1434
 
    `TreeTransform`.
1435
 
 
1436
 
    :param tt: The TreeTransform orphaning `trans_id`.
1437
 
 
1438
 
    :param orphan_id: The trans id that should be orphaned.
1439
 
 
1440
 
    :param parent_id: The orphan parent trans id.
1441
 
    """
1442
 
    # Add the orphan dir if it doesn't exist
1443
 
    orphan_dir_basename = 'bzr-orphans'
1444
 
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
1445
 
    if tt.final_kind(od_id) is None:
1446
 
        tt.create_directory(od_id)
1447
 
    parent_path = tt._tree_id_paths[parent_id]
1448
 
    # Find a name that doesn't exist yet in the orphan dir
1449
 
    actual_name = tt.final_name(orphan_id)
1450
 
    new_name = tt._available_backup_name(actual_name, od_id)
1451
 
    tt.adjust_path(new_name, od_id, orphan_id)
1452
 
    trace.warning('%s has been orphaned in %s'
1453
 
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
1454
 
 
1455
 
 
1456
 
def refuse_orphan(tt, orphan_id, parent_id):
1457
 
    """See TreeTransformBase.new_orphan.
1458
 
 
1459
 
    This refuses to create orphan, letting the caller handle the conflict.
1460
 
    """
1461
 
    raise OrphaningForbidden('never')
1462
 
 
1463
 
 
1464
 
orphaning_registry = registry.Registry()
1465
 
orphaning_registry.register(
1466
 
    'conflict', refuse_orphan,
1467
 
    'Leave orphans in place and create a conflict on the directory.')
1468
 
orphaning_registry.register(
1469
 
    'move', move_orphan,
1470
 
    'Move orphans into the bzr-orphans directory.')
1471
 
orphaning_registry._set_default_key('conflict')
1472
 
 
1473
 
 
1474
 
opt_transform_orphan = _mod_config.RegistryOption(
1475
 
    'bzr.transform.orphan_policy', orphaning_registry,
1476
 
    help='Policy for orphaned files during transform operations.',
1477
 
    invalid='warning')
1478
 
 
1479
 
 
1480
 
class TreeTransform(DiskTreeTransform):
 
1121
 
 
1122
class TreeTransform(TreeTransformBase):
1481
1123
    """Represent a tree transformation.
1482
1124
 
1483
1125
    This object is designed to support incremental generation of the transform,
1542
1184
    FileMover does not delete files until it is sure that a rollback will not
1543
1185
    happen.
1544
1186
    """
1545
 
    def __init__(self, tree, pb=None):
 
1187
    def __init__(self, tree, pb=DummyProgress()):
1546
1188
        """Note: a tree_write lock is taken on the tree.
1547
1189
 
1548
1190
        Use TreeTransform.finalize() to release the lock (can be omitted if
1553
1195
        try:
1554
1196
            limbodir = urlutils.local_path_from_url(
1555
1197
                tree._transport.abspath('limbo'))
1556
 
            osutils.ensure_empty_directory_exists(
1557
 
                limbodir,
1558
 
                errors.ExistingLimbo)
 
1198
            try:
 
1199
                os.mkdir(limbodir)
 
1200
            except OSError, e:
 
1201
                if e.errno == errno.EEXIST:
 
1202
                    raise ExistingLimbo(limbodir)
1559
1203
            deletiondir = urlutils.local_path_from_url(
1560
1204
                tree._transport.abspath('pending-deletion'))
1561
 
            osutils.ensure_empty_directory_exists(
1562
 
                deletiondir,
1563
 
                errors.ExistingPendingDeletion)
 
1205
            try:
 
1206
                os.mkdir(deletiondir)
 
1207
            except OSError, e:
 
1208
                if e.errno == errno.EEXIST:
 
1209
                    raise errors.ExistingPendingDeletion(deletiondir)
1564
1210
        except:
1565
1211
            tree.unlock()
1566
1212
            raise
1567
1213
 
1568
 
        # Cache of realpath results, to speed up canonical_path
1569
 
        self._realpaths = {}
1570
 
        # Cache of relpath results, to speed up canonical_path
1571
 
        self._relpaths = {}
1572
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1214
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1573
1215
                                   tree.case_sensitive)
1574
1216
        self._deletiondir = deletiondir
1575
1217
 
1576
 
    def canonical_path(self, path):
1577
 
        """Get the canonical tree-relative path"""
1578
 
        # don't follow final symlinks
1579
 
        abs = self._tree.abspath(path)
1580
 
        if abs in self._relpaths:
1581
 
            return self._relpaths[abs]
1582
 
        dirname, basename = os.path.split(abs)
1583
 
        if dirname not in self._realpaths:
1584
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1585
 
        dirname = self._realpaths[dirname]
1586
 
        abs = pathjoin(dirname, basename)
1587
 
        if dirname in self._relpaths:
1588
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1589
 
            relpath = relpath.rstrip('/\\')
1590
 
        else:
1591
 
            relpath = self._tree.relpath(abs)
1592
 
        self._relpaths[abs] = relpath
1593
 
        return relpath
1594
 
 
1595
 
    def tree_kind(self, trans_id):
1596
 
        """Determine the file kind in the working tree.
1597
 
 
1598
 
        :returns: The file kind or None if the file does not exist
1599
 
        """
1600
 
        path = self._tree_id_paths.get(trans_id)
1601
 
        if path is None:
1602
 
            return None
1603
 
        try:
1604
 
            return file_kind(self._tree.abspath(path))
1605
 
        except errors.NoSuchFile:
1606
 
            return None
1607
 
 
1608
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1609
 
        """Set the mode of new file contents.
1610
 
        The mode_id is the existing file to get the mode from (often the same
1611
 
        as trans_id).  The operation is only performed if there's a mode match
1612
 
        according to typefunc.
1613
 
        """
1614
 
        if mode_id is None:
1615
 
            mode_id = trans_id
1616
 
        try:
1617
 
            old_path = self._tree_id_paths[mode_id]
1618
 
        except KeyError:
1619
 
            return
1620
 
        try:
1621
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1622
 
        except OSError, e:
1623
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1624
 
                # Either old_path doesn't exist, or the parent of the
1625
 
                # target is not a directory (but will be one eventually)
1626
 
                # Either way, we know it doesn't exist *right now*
1627
 
                # See also bug #248448
1628
 
                return
1629
 
            else:
1630
 
                raise
1631
 
        if typefunc(mode):
1632
 
            osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1633
 
 
1634
 
    def iter_tree_children(self, parent_id):
1635
 
        """Iterate through the entry's tree children, if any"""
1636
 
        try:
1637
 
            path = self._tree_id_paths[parent_id]
1638
 
        except KeyError:
1639
 
            return
1640
 
        try:
1641
 
            children = os.listdir(self._tree.abspath(path))
1642
 
        except OSError, e:
1643
 
            if not (osutils._is_error_enotdir(e)
1644
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1645
 
                raise
1646
 
            return
1647
 
 
1648
 
        for child in children:
1649
 
            childpath = joinpath(path, child)
1650
 
            if self._tree.is_control_filename(childpath):
1651
 
                continue
1652
 
            yield self.trans_id_tree_path(childpath)
1653
 
 
1654
 
    def _generate_limbo_path(self, trans_id):
1655
 
        """Generate a limbo path using the final path if possible.
1656
 
 
1657
 
        This optimizes the performance of applying the tree transform by
1658
 
        avoiding renames.  These renames can be avoided only when the parent
1659
 
        directory is already scheduled for creation.
1660
 
 
1661
 
        If the final path cannot be used, falls back to using the trans_id as
1662
 
        the relpath.
1663
 
        """
1664
 
        parent = self._new_parent.get(trans_id)
1665
 
        # if the parent directory is already in limbo (e.g. when building a
1666
 
        # tree), choose a limbo name inside the parent, to reduce further
1667
 
        # renames.
1668
 
        use_direct_path = False
1669
 
        if self._new_contents.get(parent) == 'directory':
1670
 
            filename = self._new_name.get(trans_id)
1671
 
            if filename is not None:
1672
 
                if parent not in self._limbo_children:
1673
 
                    self._limbo_children[parent] = set()
1674
 
                    self._limbo_children_names[parent] = {}
1675
 
                    use_direct_path = True
1676
 
                # the direct path can only be used if no other file has
1677
 
                # already taken this pathname, i.e. if the name is unused, or
1678
 
                # if it is already associated with this trans_id.
1679
 
                elif self._case_sensitive_target:
1680
 
                    if (self._limbo_children_names[parent].get(filename)
1681
 
                        in (trans_id, None)):
1682
 
                        use_direct_path = True
1683
 
                else:
1684
 
                    for l_filename, l_trans_id in\
1685
 
                        self._limbo_children_names[parent].iteritems():
1686
 
                        if l_trans_id == trans_id:
1687
 
                            continue
1688
 
                        if l_filename.lower() == filename.lower():
1689
 
                            break
1690
 
                    else:
1691
 
                        use_direct_path = True
1692
 
 
1693
 
        if not use_direct_path:
1694
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1695
 
 
1696
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1697
 
        self._limbo_children[parent].add(trans_id)
1698
 
        self._limbo_children_names[parent][filename] = trans_id
1699
 
        return limbo_name
1700
 
 
1701
 
 
1702
1218
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1703
1219
        """Apply all changes to the inventory and filesystem.
1704
1220
 
1713
1229
            calculating one.
1714
1230
        :param _mover: Supply an alternate FileMover, for testing
1715
1231
        """
1716
 
        for hook in MutableTree.hooks['pre_transform']:
1717
 
            hook(self._tree, self)
1718
1232
        if not no_conflicts:
1719
 
            self._check_malformed()
1720
 
        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()
1721
1237
        try:
1722
1238
            if precomputed_delta is None:
1723
 
                child_pb.update(gettext('Apply phase'), 0, 2)
 
1239
                child_pb.update('Apply phase', 0, 2)
1724
1240
                inventory_delta = self._generate_inventory_delta()
1725
1241
                offset = 1
1726
1242
            else:
1731
1247
            else:
1732
1248
                mover = _mover
1733
1249
            try:
1734
 
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
 
1250
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
1735
1251
                self._apply_removals(mover)
1736
 
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
 
1252
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
1737
1253
                modified_paths = self._apply_insertions(mover)
1738
1254
            except:
1739
1255
                mover.rollback()
1742
1258
                mover.apply_deletions()
1743
1259
        finally:
1744
1260
            child_pb.finished()
1745
 
        if self.final_file_id(self.root) is None:
1746
 
            inventory_delta = [e for e in inventory_delta if e[0] != '']
1747
1261
        self._tree.apply_inventory_delta(inventory_delta)
1748
 
        self._apply_observed_sha1s()
1749
1262
        self._done = True
1750
1263
        self.finalize()
1751
1264
        return _TransformResults(modified_paths, self.rename_count)
1753
1266
    def _generate_inventory_delta(self):
1754
1267
        """Generate an inventory delta for the current transform."""
1755
1268
        inventory_delta = []
1756
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1269
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1757
1270
        new_paths = self._inventory_altered()
1758
1271
        total_entries = len(new_paths) + len(self._removed_id)
1759
1272
        try:
1760
1273
            for num, trans_id in enumerate(self._removed_id):
1761
1274
                if (num % 10) == 0:
1762
 
                    child_pb.update(gettext('removing file'), num, total_entries)
 
1275
                    child_pb.update('removing file', num, total_entries)
1763
1276
                if trans_id == self._new_root:
1764
1277
                    file_id = self._tree.get_root_id()
1765
1278
                else:
1777
1290
            final_kinds = {}
1778
1291
            for num, (path, trans_id) in enumerate(new_paths):
1779
1292
                if (num % 10) == 0:
1780
 
                    child_pb.update(gettext('adding file'),
 
1293
                    child_pb.update('adding file',
1781
1294
                                    num + len(self._removed_id), total_entries)
1782
1295
                file_id = new_path_file_ids[trans_id]
1783
1296
                if file_id is None:
1784
1297
                    continue
1785
1298
                needs_entry = False
1786
 
                kind = self.final_kind(trans_id)
1787
 
                if kind is None:
 
1299
                try:
 
1300
                    kind = self.final_kind(trans_id)
 
1301
                except NoSuchFile:
1788
1302
                    kind = self._tree.stored_kind(file_id)
1789
1303
                parent_trans_id = self.final_parent(trans_id)
1790
1304
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1821
1335
        """
1822
1336
        tree_paths = list(self._tree_path_ids.iteritems())
1823
1337
        tree_paths.sort(reverse=True)
1824
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1338
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1825
1339
        try:
1826
 
            for num, (path, trans_id) in enumerate(tree_paths):
1827
 
                # do not attempt to move root into a subdirectory of itself.
1828
 
                if path == '':
1829
 
                    continue
1830
 
                child_pb.update(gettext('removing file'), num, len(tree_paths))
 
1340
            for num, data in enumerate(tree_paths):
 
1341
                path, trans_id = data
 
1342
                child_pb.update('removing file', num, len(tree_paths))
1831
1343
                full_path = self._tree.abspath(path)
1832
1344
                if trans_id in self._removed_contents:
1833
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1834
 
                    mover.pre_delete(full_path, delete_path)
1835
 
                elif (trans_id in self._new_name
1836
 
                      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:
1837
1349
                    try:
1838
1350
                        mover.rename(full_path, self._limbo_name(trans_id))
1839
 
                    except errors.TransformRenameFailed, e:
 
1351
                    except OSError, e:
1840
1352
                        if e.errno != errno.ENOENT:
1841
1353
                            raise
1842
1354
                    else:
1858
1370
        modified_paths = []
1859
1371
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1860
1372
                                 new_paths)
1861
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1373
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1862
1374
        try:
1863
1375
            for num, (path, trans_id) in enumerate(new_paths):
1864
1376
                if (num % 10) == 0:
1865
 
                    child_pb.update(gettext('adding file'), num, len(new_paths))
 
1377
                    child_pb.update('adding file', num, len(new_paths))
1866
1378
                full_path = self._tree.abspath(path)
1867
1379
                if trans_id in self._needs_rename:
1868
1380
                    try:
1869
1381
                        mover.rename(self._limbo_name(trans_id), full_path)
1870
 
                    except errors.TransformRenameFailed, e:
 
1382
                    except OSError, e:
1871
1383
                        # We may be renaming a dangling inventory id
1872
1384
                        if e.errno != errno.ENOENT:
1873
1385
                            raise
1874
1386
                    else:
1875
1387
                        self.rename_count += 1
1876
 
                    # TODO: if trans_id in self._observed_sha1s, we should
1877
 
                    #       re-stat the final target, since ctime will be
1878
 
                    #       updated by the change.
1879
1388
                if (trans_id in self._new_contents or
1880
1389
                    self.path_changed(trans_id)):
1881
1390
                    if trans_id in self._new_contents:
1882
1391
                        modified_paths.append(full_path)
1883
1392
                if trans_id in self._new_executability:
1884
1393
                    self._set_executability(path, trans_id)
1885
 
                if trans_id in self._observed_sha1s:
1886
 
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
1887
 
                    st = osutils.lstat(full_path)
1888
 
                    self._observed_sha1s[trans_id] = (o_sha1, st)
1889
1394
        finally:
1890
1395
            child_pb.finished()
1891
 
        for path, trans_id in new_paths:
1892
 
            # new_paths includes stuff like workingtree conflicts. Only the
1893
 
            # stuff in new_contents actually comes from limbo.
1894
 
            if trans_id in self._limbo_files:
1895
 
                del self._limbo_files[trans_id]
1896
1396
        self._new_contents.clear()
1897
1397
        return modified_paths
1898
1398
 
1899
 
    def _apply_observed_sha1s(self):
1900
 
        """After we have finished renaming everything, update observed sha1s
1901
 
 
1902
 
        This has to be done after self._tree.apply_inventory_delta, otherwise
1903
 
        it doesn't know anything about the files we are updating. Also, we want
1904
 
        to do this as late as possible, so that most entries end up cached.
1905
 
        """
1906
 
        # TODO: this doesn't update the stat information for directories. So
1907
 
        #       the first 'bzr status' will still need to rewrite
1908
 
        #       .bzr/checkout/dirstate. However, we at least don't need to
1909
 
        #       re-read all of the files.
1910
 
        # TODO: If the operation took a while, we could do a time.sleep(3) here
1911
 
        #       to allow the clock to tick over and ensure we won't have any
1912
 
        #       problems. (we could observe start time, and finish time, and if
1913
 
        #       it is less than eg 10% overhead, add a sleep call.)
1914
 
        paths = FinalPaths(self)
1915
 
        for trans_id, observed in self._observed_sha1s.iteritems():
1916
 
            path = paths.get_path(trans_id)
1917
 
            # We could get the file_id, but dirstate prefers to use the path
1918
 
            # anyway, and it is 'cheaper' to determine.
1919
 
            # file_id = self._new_id[trans_id]
1920
 
            self._tree._observed_sha1(None, path, observed)
1921
 
 
1922
 
 
1923
 
class TransformPreview(DiskTreeTransform):
 
1399
 
 
1400
class TransformPreview(TreeTransformBase):
1924
1401
    """A TreeTransform for generating preview trees.
1925
1402
 
1926
1403
    Unlike TreeTransform, this version works when the input tree is a
1928
1405
    unversioned files in the input tree.
1929
1406
    """
1930
1407
 
1931
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1408
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1932
1409
        tree.lock_read()
1933
1410
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1934
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1411
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1935
1412
 
1936
1413
    def canonical_path(self, path):
1937
1414
        return path
1939
1416
    def tree_kind(self, trans_id):
1940
1417
        path = self._tree_id_paths.get(trans_id)
1941
1418
        if path is None:
1942
 
            return None
1943
 
        kind = self._tree.path_content_summary(path)[0]
1944
 
        if kind == 'missing':
1945
 
            kind = None
1946
 
        return kind
 
1419
            raise NoSuchFile(None)
 
1420
        file_id = self._tree.path2id(path)
 
1421
        return self._tree.kind(file_id)
1947
1422
 
1948
1423
    def _set_mode(self, trans_id, mode_id, typefunc):
1949
1424
        """Set the mode of new file contents.
1963
1438
        file_id = self.tree_file_id(parent_id)
1964
1439
        if file_id is None:
1965
1440
            return
1966
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1967
 
        children = getattr(entry, 'children', {})
 
1441
        children = getattr(self._tree.inventory[file_id], 'children', {})
1968
1442
        for child in children:
1969
1443
            childpath = joinpath(path, child)
1970
1444
            yield self.trans_id_tree_path(childpath)
1971
1445
 
1972
 
    def new_orphan(self, trans_id, parent_id):
1973
 
        raise NotImplementedError(self.new_orphan)
1974
 
 
1975
 
 
1976
 
class _PreviewTree(tree.InventoryTree):
 
1446
 
 
1447
class _PreviewTree(tree.Tree):
1977
1448
    """Partial implementation of Tree to support show_diff_trees"""
1978
1449
 
1979
1450
    def __init__(self, transform):
1981
1452
        self._final_paths = FinalPaths(transform)
1982
1453
        self.__by_parent = None
1983
1454
        self._parent_ids = []
1984
 
        self._all_children_cache = {}
1985
 
        self._path2trans_id_cache = {}
1986
 
        self._final_name_cache = {}
1987
 
        self._iter_changes_cache = dict((c[0], c) for c in
1988
 
                                        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
1989
1460
 
1990
1461
    def _content_change(self, file_id):
1991
1462
        """Return True if the content of this file changed"""
1992
 
        changes = self._iter_changes_cache.get(file_id)
 
1463
        changes = self._changes(file_id)
1993
1464
        # changes[2] is true if the file content changed.  See
1994
1465
        # InterTree.iter_changes.
1995
1466
        return (changes is not None and changes[2])
2008
1479
                yield self._get_repository().revision_tree(revision_id)
2009
1480
 
2010
1481
    def _get_file_revision(self, file_id, vf, tree_revision):
2011
 
        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
2012
1483
                       self._iter_parent_trees()]
2013
1484
        vf.add_lines((file_id, tree_revision), parent_keys,
2014
 
                     self.get_file_lines(file_id))
 
1485
                     self.get_file(file_id).readlines())
2015
1486
        repo = self._get_repository()
2016
1487
        base_vf = repo.texts
2017
1488
        if base_vf not in vf.fallback_versionedfiles:
2018
1489
            vf.fallback_versionedfiles.append(base_vf)
2019
1490
        return tree_revision
2020
1491
 
2021
 
    def _stat_limbo_file(self, file_id=None, trans_id=None):
2022
 
        if trans_id is None:
2023
 
            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)
2024
1494
        name = self._transform._limbo_name(trans_id)
2025
1495
        return os.lstat(name)
2026
1496
 
2030
1500
            self.__by_parent = self._transform.by_parent()
2031
1501
        return self.__by_parent
2032
1502
 
2033
 
    def _comparison_data(self, entry, path):
2034
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2035
 
        if kind == 'missing':
2036
 
            kind = None
2037
 
            executable = False
2038
 
        else:
2039
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
2040
 
            executable = self.is_executable(file_id, path)
2041
 
        return kind, executable, None
2042
 
 
2043
 
    def is_locked(self):
2044
 
        return False
2045
 
 
2046
1503
    def lock_read(self):
2047
1504
        # Perhaps in theory, this should lock the TreeTransform?
2048
 
        return self
 
1505
        pass
2049
1506
 
2050
1507
    def unlock(self):
2051
1508
        pass
2052
1509
 
2053
1510
    @property
2054
 
    @deprecated_method(deprecated_in((2, 5, 0)))
2055
1511
    def inventory(self):
2056
1512
        """This Tree does not use inventory as its backing data."""
2057
1513
        raise NotImplementedError(_PreviewTree.inventory)
2058
1514
 
2059
 
    @property
2060
 
    def root_inventory(self):
2061
 
        """This Tree does not use inventory as its backing data."""
2062
 
        raise NotImplementedError(_PreviewTree.root_inventory)
2063
 
 
2064
1515
    def get_root_id(self):
2065
1516
        return self._transform.final_file_id(self._transform.root)
2066
1517
 
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):
2115
 
        if isinstance(path, list):
2116
 
            if path == []:
2117
 
                path = [""]
2118
 
            path = osutils.pathjoin(*path)
2119
1554
        return self._transform.final_file_id(self._path2trans_id(path))
2120
1555
 
2121
1556
    def id2path(self, file_id):
2126
1561
            raise errors.NoSuchId(self, file_id)
2127
1562
 
2128
1563
    def _all_children(self, trans_id):
2129
 
        children = self._all_children_cache.get(trans_id)
2130
 
        if children is not None:
2131
 
            return children
2132
1564
        children = set(self._transform.iter_tree_children(trans_id))
2133
1565
        # children in the _new_parent set are provided by _by_parent.
2134
1566
        children.difference_update(self._transform._new_parent.keys())
2135
1567
        children.update(self._by_parent.get(trans_id, []))
2136
 
        self._all_children_cache[trans_id] = children
2137
1568
        return children
2138
1569
 
2139
 
    def iter_children(self, file_id):
2140
 
        trans_id = self._transform.trans_id_file_id(file_id)
2141
 
        for child_trans_id in self._all_children(trans_id):
2142
 
            yield self._transform.final_file_id(child_trans_id)
2143
 
 
2144
 
    def extras(self):
2145
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
2146
 
                              in self._transform._tree.extras())
2147
 
        possible_extras.update(self._transform._new_contents)
2148
 
        possible_extras.update(self._transform._removed_id)
2149
 
        for trans_id in possible_extras:
2150
 
            if self._transform.final_file_id(trans_id) is None:
2151
 
                yield self._final_paths._determine_path(trans_id)
2152
 
 
2153
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2154
 
        yield_parents=False):
 
1570
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
2155
1571
        for trans_id, parent_file_id in ordered_entries:
2156
1572
            file_id = self._transform.final_file_id(trans_id)
2157
1573
            if file_id is None:
2159
1575
            if (specific_file_ids is not None
2160
1576
                and file_id not in specific_file_ids):
2161
1577
                continue
2162
 
            kind = self._transform.final_kind(trans_id)
2163
 
            if kind is None:
 
1578
            try:
 
1579
                kind = self._transform.final_kind(trans_id)
 
1580
            except NoSuchFile:
2164
1581
                kind = self._transform._tree.stored_kind(file_id)
2165
1582
            new_entry = inventory.make_entry(
2166
1583
                kind,
2182
1599
                ordered_ids.append((trans_id, parent_file_id))
2183
1600
        return ordered_ids
2184
1601
 
2185
 
    def iter_child_entries(self, file_id, path=None):
2186
 
        self.id2path(file_id)
2187
 
        trans_id = self._transform.trans_id_file_id(file_id)
2188
 
        todo = [(child_trans_id, trans_id) for child_trans_id in
2189
 
                self._all_children(trans_id)]
2190
 
        for entry, trans_id in self._make_inv_entries(todo):
2191
 
            yield entry
2192
 
 
2193
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
1602
    def iter_entries_by_dir(self, specific_file_ids=None):
2194
1603
        # This may not be a maximally efficient implementation, but it is
2195
1604
        # reasonably straightforward.  An implementation that grafts the
2196
1605
        # TreeTransform changes onto the tree's iter_entries_by_dir results
2198
1607
        # position.
2199
1608
        ordered_ids = self._list_files_by_dir()
2200
1609
        for entry, trans_id in self._make_inv_entries(ordered_ids,
2201
 
            specific_file_ids, yield_parents=yield_parents):
2202
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
2203
 
 
2204
 
    def _iter_entries_for_dir(self, dir_path):
2205
 
        """Return path, entry for items in a directory without recursing down."""
2206
 
        dir_file_id = self.path2id(dir_path)
2207
 
        ordered_ids = []
2208
 
        for file_id in self.iter_children(dir_file_id):
2209
 
            trans_id = self._transform.trans_id_file_id(file_id)
2210
 
            ordered_ids.append((trans_id, file_id))
2211
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
2212
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
2213
 
 
2214
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
2215
 
        """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."""
2216
1615
        # XXX This should behave like WorkingTree.list_files, but is really
2217
1616
        # more like RevisionTree.list_files.
2218
 
        if recursive:
2219
 
            prefix = None
2220
 
            if from_dir:
2221
 
                prefix = from_dir + '/'
2222
 
            entries = self.iter_entries_by_dir()
2223
 
            for path, entry in entries:
2224
 
                if entry.name == '' and not include_root:
2225
 
                    continue
2226
 
                if prefix:
2227
 
                    if not path.startswith(prefix):
2228
 
                        continue
2229
 
                    path = path[len(prefix):]
2230
 
                yield path, 'V', entry.kind, entry.file_id, entry
2231
 
        else:
2232
 
            if from_dir is None and include_root is True:
2233
 
                root_entry = inventory.make_entry('directory', '',
2234
 
                    ROOT_PARENT, self.get_root_id())
2235
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
2236
 
            entries = self._iter_entries_for_dir(from_dir or '')
2237
 
            for path, entry in entries:
2238
 
                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
2239
1621
 
2240
1622
    def kind(self, file_id):
2241
1623
        trans_id = self._transform.trans_id_file_id(file_id)
2251
1633
    def get_file_mtime(self, file_id, path=None):
2252
1634
        """See Tree.get_file_mtime"""
2253
1635
        if not self._content_change(file_id):
2254
 
            return self._transform._tree.get_file_mtime(file_id)
 
1636
            return self._transform._tree.get_file_mtime(file_id, path)
2255
1637
        return self._stat_limbo_file(file_id).st_mtime
2256
1638
 
2257
 
    def _file_size(self, entry, stat_value):
2258
 
        return self.get_file_size(entry.file_id)
2259
 
 
2260
1639
    def get_file_size(self, file_id):
2261
1640
        """See Tree.get_file_size"""
2262
 
        trans_id = self._transform.trans_id_file_id(file_id)
2263
 
        kind = self._transform.final_kind(trans_id)
2264
 
        if kind != 'file':
2265
 
            return None
2266
 
        if trans_id in self._transform._new_contents:
2267
 
            return self._stat_limbo_file(trans_id=trans_id).st_size
2268
1641
        if self.kind(file_id) == 'file':
2269
1642
            return self._transform._tree.get_file_size(file_id)
2270
1643
        else:
2271
1644
            return None
2272
1645
 
2273
 
    def get_file_verifier(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_verifier(file_id)
2278
 
        if kind == 'file':
2279
 
            fileobj = self.get_file(file_id)
2280
 
            try:
2281
 
                return ("SHA1", sha_file(fileobj))
2282
 
            finally:
2283
 
                fileobj.close()
2284
 
 
2285
1646
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2286
 
        trans_id = self._transform.trans_id_file_id(file_id)
2287
 
        kind = self._transform._new_contents.get(trans_id)
2288
 
        if kind is None:
2289
 
            return self._transform._tree.get_file_sha1(file_id)
2290
 
        if kind == 'file':
2291
 
            fileobj = self.get_file(file_id)
2292
 
            try:
2293
 
                return sha_file(fileobj)
2294
 
            finally:
2295
 
                fileobj.close()
 
1647
        return self._transform._tree.get_file_sha1(file_id)
2296
1648
 
2297
1649
    def is_executable(self, file_id, path=None):
2298
 
        if file_id is None:
2299
 
            return False
2300
1650
        trans_id = self._transform.trans_id_file_id(file_id)
2301
1651
        try:
2302
1652
            return self._transform._new_executability[trans_id]
2303
1653
        except KeyError:
2304
 
            try:
2305
 
                return self._transform._tree.is_executable(file_id, path)
2306
 
            except OSError, e:
2307
 
                if e.errno == errno.ENOENT:
2308
 
                    return False
2309
 
                raise
2310
 
            except errors.NoSuchId:
2311
 
                return False
2312
 
 
2313
 
    def has_filename(self, path):
2314
 
        trans_id = self._path2trans_id(path)
2315
 
        if trans_id in self._transform._new_contents:
2316
 
            return True
2317
 
        elif trans_id in self._transform._removed_contents:
2318
 
            return False
2319
 
        else:
2320
 
            return self._transform._tree.has_filename(path)
 
1654
            return self._transform._tree.is_executable(file_id, path)
2321
1655
 
2322
1656
    def path_content_summary(self, path):
2323
1657
        trans_id = self._path2trans_id(path)
2337
1671
            if kind == 'file':
2338
1672
                statval = os.lstat(limbo_name)
2339
1673
                size = statval.st_size
2340
 
                if not tt._limbo_supports_executable():
2341
 
                    executable = False
 
1674
                if not supports_executable():
 
1675
                    executable = None
2342
1676
                else:
2343
1677
                    executable = statval.st_mode & S_IEXEC
2344
1678
            else:
2345
1679
                size = None
2346
1680
                executable = None
2347
1681
            if kind == 'symlink':
2348
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2349
 
        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)
2350
1685
        return kind, size, executable, link_or_sha1
2351
1686
 
2352
1687
    def iter_changes(self, from_tree, include_unchanged=False,
2354
1689
                      require_versioned=True, want_unversioned=False):
2355
1690
        """See InterTree.iter_changes.
2356
1691
 
2357
 
        This has a fast path that is only used when the from_tree matches
2358
 
        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.
2359
1695
        """
2360
 
        if (from_tree is not self._transform._tree or include_unchanged or
2361
 
            specific_files or want_unversioned):
2362
 
            return tree.InterTree(from_tree, self).iter_changes(
2363
 
                include_unchanged=include_unchanged,
2364
 
                specific_files=specific_files,
2365
 
                pb=pb,
2366
 
                extra_trees=extra_trees,
2367
 
                require_versioned=require_versioned,
2368
 
                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')
2369
1702
        if want_unversioned:
2370
1703
            raise ValueError('want_unversioned is not supported')
2371
1704
        return self._transform.iter_changes()
2378
1711
        name = self._transform._limbo_name(trans_id)
2379
1712
        return open(name, 'rb')
2380
1713
 
2381
 
    def get_file_with_stat(self, file_id, path=None):
2382
 
        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()
2383
1720
 
2384
1721
    def annotate_iter(self, file_id,
2385
1722
                      default_revision=_mod_revision.CURRENT_REVISION):
2386
 
        changes = self._iter_changes_cache.get(file_id)
 
1723
        changes = self._changes(file_id)
2387
1724
        if changes is None:
2388
1725
            get_old = True
2389
1726
        else:
2401
1738
            return old_annotation
2402
1739
        if not changed_content:
2403
1740
            return old_annotation
2404
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2405
 
        #       doing, however it fails slightly because it doesn't know what
2406
 
        #       the *other* revision_id is, so it doesn't know how to give the
2407
 
        #       other as the origin for some lines, they all get
2408
 
        #       'default_revision'
2409
 
        #       It would be nice to be able to use the new Annotator based
2410
 
        #       approach, as well.
2411
1741
        return annotate.reannotate([old_annotation],
2412
1742
                                   self.get_file(file_id).readlines(),
2413
1743
                                   default_revision)
2414
1744
 
2415
 
    def get_symlink_target(self, file_id, path=None):
 
1745
    def get_symlink_target(self, file_id):
2416
1746
        """See Tree.get_symlink_target"""
2417
1747
        if not self._content_change(file_id):
2418
1748
            return self._transform._tree.get_symlink_target(file_id)
2419
1749
        trans_id = self._transform.trans_id_file_id(file_id)
2420
1750
        name = self._transform._limbo_name(trans_id)
2421
 
        return osutils.readlink(name)
 
1751
        return os.readlink(name)
2422
1752
 
2423
1753
    def walkdirs(self, prefix=''):
2424
1754
        pending = [self._transform.root]
2433
1763
                path_from_root = self._final_paths.get_path(child_id)
2434
1764
                basename = self._transform.final_name(child_id)
2435
1765
                file_id = self._transform.final_file_id(child_id)
2436
 
                kind  = self._transform.final_kind(child_id)
2437
 
                if kind is not None:
 
1766
                try:
 
1767
                    kind = self._transform.final_kind(child_id)
2438
1768
                    versioned_kind = kind
2439
 
                else:
 
1769
                except NoSuchFile:
2440
1770
                    kind = 'unknown'
2441
1771
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2442
1772
                if versioned_kind == 'directory':
2479
1809
        self.transform = transform
2480
1810
 
2481
1811
    def _determine_path(self, trans_id):
2482
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1812
        if trans_id == self.transform.root:
2483
1813
            return ""
2484
1814
        name = self.transform.final_name(trans_id)
2485
1815
        parent_id = self.transform.final_parent(trans_id)
2509
1839
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2510
1840
               delta_from_tree=False):
2511
1841
    """Create working tree for a branch, using a TreeTransform.
2512
 
 
 
1842
    
2513
1843
    This function should be used on empty trees, having a tree root at most.
2514
1844
    (see merge and revert functionality for working with existing trees)
2515
1845
 
2516
1846
    Existing files are handled like so:
2517
 
 
 
1847
    
2518
1848
    - Existing bzrdirs take precedence over creating new items.  They are
2519
1849
      created as '%s.diverted' % name.
2520
1850
    - Otherwise, if the content on disk matches the content we are building,
2555
1885
    for num, _unused in enumerate(wt.all_file_ids()):
2556
1886
        if num > 0:  # more than just a root
2557
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)
2558
1891
    file_trans_id = {}
2559
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
1892
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2560
1893
    pp = ProgressPhase("Build phase", 2, top_pb)
2561
 
    if tree.get_root_id() is not None:
 
1894
    if tree.inventory.root is not None:
2562
1895
        # This is kind of a hack: we should be altering the root
2563
1896
        # as part of the regular tree shape diff logic.
2564
1897
        # The conditional test here is to avoid doing an
2575
1908
        pp.next_phase()
2576
1909
        file_trans_id[wt.get_root_id()] = \
2577
1910
            tt.trans_id_tree_file_id(wt.get_root_id())
2578
 
        pb = ui.ui_factory.nested_progress_bar()
 
1911
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2579
1912
        try:
2580
1913
            deferred_contents = []
2581
1914
            num = 0
2582
 
            total = len(tree.all_file_ids())
 
1915
            total = len(tree.inventory)
2583
1916
            if delta_from_tree:
2584
1917
                precomputed_delta = []
2585
1918
            else:
2586
1919
                precomputed_delta = None
2587
 
            # Check if tree inventory has content. If so, we populate
2588
 
            # existing_files with the directory content. If there are no
2589
 
            # entries we skip populating existing_files as its not used.
2590
 
            # This improves performance and unncessary work on large
2591
 
            # directory trees. (#501307)
2592
 
            if total > 0:
2593
 
                existing_files = set()
2594
 
                for dir, files in wt.walkdirs():
2595
 
                    existing_files.update(f[0] for f in files)
2596
1920
            for num, (tree_path, entry) in \
2597
 
                enumerate(tree.iter_entries_by_dir()):
2598
 
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
 
1921
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1922
                pb.update("Building tree", num - len(deferred_contents), total)
2599
1923
                if entry.parent_id is None:
2600
1924
                    continue
2601
1925
                reparent = False
2607
1931
                    kind = file_kind(target_path)
2608
1932
                    if kind == "directory":
2609
1933
                        try:
2610
 
                            controldir.ControlDir.open(target_path)
 
1934
                            bzrdir.BzrDir.open(target_path)
2611
1935
                        except errors.NotBranchError:
2612
1936
                            pass
2613
1937
                        else:
2628
1952
                    executable = tree.is_executable(file_id, tree_path)
2629
1953
                    if executable:
2630
1954
                        tt.set_executability(executable, trans_id)
2631
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
2632
 
                    deferred_contents.append((file_id, trans_data))
 
1955
                    deferred_contents.append((file_id, trans_id))
2633
1956
                else:
2634
1957
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2635
1958
                                                          tree)
2650
1973
            precomputed_delta = None
2651
1974
        conflicts = cook_conflicts(raw_conflicts, tt)
2652
1975
        for conflict in conflicts:
2653
 
            trace.warning(unicode(conflict))
 
1976
            warning(conflict)
2654
1977
        try:
2655
1978
            wt.add_conflicts(conflicts)
2656
1979
        except errors.UnsupportedOperation:
2666
1989
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2667
1990
                  hardlink):
2668
1991
    total = len(desired_files) + offset
2669
 
    wt = tt._tree
2670
1992
    if accelerator_tree is None:
2671
1993
        new_desired_files = desired_files
2672
1994
    else:
2673
1995
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2674
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2675
 
                     in iter if not (c or e[0] != e[1])]
2676
 
        if accelerator_tree.supports_content_filtering():
2677
 
            unchanged = [(f, p) for (f, p) in unchanged
2678
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2679
 
        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]))
2680
1998
        new_desired_files = []
2681
1999
        count = 0
2682
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
2000
        for file_id, trans_id in desired_files:
2683
2001
            accelerator_path = unchanged.get(file_id)
2684
2002
            if accelerator_path is None:
2685
 
                new_desired_files.append((file_id,
2686
 
                    (trans_id, tree_path, text_sha1)))
 
2003
                new_desired_files.append((file_id, trans_id))
2687
2004
                continue
2688
 
            pb.update(gettext('Adding file contents'), count + offset, total)
 
2005
            pb.update('Adding file contents', count + offset, total)
2689
2006
            if hardlink:
2690
2007
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2691
2008
                                   trans_id)
2692
2009
            else:
2693
2010
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2694
 
                if wt.supports_content_filtering():
2695
 
                    filters = wt._content_filter_stack(tree_path)
2696
 
                    contents = filtered_output_bytes(contents, filters,
2697
 
                        ContentFilterContext(tree_path, tree))
2698
2011
                try:
2699
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2012
                    tt.create_file(contents, trans_id)
2700
2013
                finally:
2701
 
                    try:
2702
 
                        contents.close()
2703
 
                    except AttributeError:
2704
 
                        # after filtering, contents may no longer be file-like
2705
 
                        pass
 
2014
                    contents.close()
2706
2015
            count += 1
2707
2016
        offset += count
2708
 
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2709
 
            tree.iter_files_bytes(new_desired_files)):
2710
 
        if wt.supports_content_filtering():
2711
 
            filters = wt._content_filter_stack(tree_path)
2712
 
            contents = filtered_output_bytes(contents, filters,
2713
 
                ContentFilterContext(tree_path, tree))
2714
 
        tt.create_file(contents, trans_id, sha1=text_sha1)
2715
 
        pb.update(gettext('Adding file contents'), count + offset, total)
 
2017
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
2018
                                                 new_desired_files)):
 
2019
        tt.create_file(contents, trans_id)
 
2020
        pb.update('Adding file contents', count + offset, total)
2716
2021
 
2717
2022
 
2718
2023
def _reparent_children(tt, old_parent, new_parent):
2719
2024
    for child in tt.iter_tree_children(old_parent):
2720
2025
        tt.adjust_path(tt.final_name(child), new_parent, child)
2721
2026
 
2722
 
 
2723
2027
def _reparent_transform_children(tt, old_parent, new_parent):
2724
2028
    by_parent = tt.by_parent()
2725
2029
    for child in by_parent[old_parent]:
2726
2030
        tt.adjust_path(tt.final_name(child), new_parent, child)
2727
2031
    return by_parent[old_parent]
2728
2032
 
2729
 
 
2730
2033
def _content_match(tree, entry, file_id, kind, target_path):
2731
2034
    if entry.kind != kind:
2732
2035
        return False
2733
2036
    if entry.kind == "directory":
2734
2037
        return True
2735
2038
    if entry.kind == "file":
2736
 
        f = file(target_path, 'rb')
2737
 
        try:
2738
 
            if tree.get_file_text(file_id) == f.read():
2739
 
                return True
2740
 
        finally:
2741
 
            f.close()
 
2039
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
2040
            return True
2742
2041
    elif entry.kind == "symlink":
2743
2042
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2744
2043
            return True
2782
2081
    if kind == 'file':
2783
2082
        contents = tree.get_file(entry.file_id).readlines()
2784
2083
        executable = tree.is_executable(entry.file_id)
2785
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
2084
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2786
2085
                           executable)
2787
2086
    elif kind in ('directory', 'tree-reference'):
2788
2087
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2789
2088
        if kind == 'tree-reference':
2790
2089
            tt.set_tree_reference(entry.reference_revision, trans_id)
2791
 
        return trans_id
 
2090
        return trans_id 
2792
2091
    elif kind == 'symlink':
2793
2092
        target = tree.get_symlink_target(entry.file_id)
2794
2093
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2796
2095
        raise errors.BadFileKindError(name, kind)
2797
2096
 
2798
2097
 
2799
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2800
 
    filter_tree_path=None):
2801
 
    """Create new file contents according to tree contents.
2802
 
    
2803
 
    :param filter_tree_path: the tree path to use to lookup
2804
 
      content filters to apply to the bytes output in the working tree.
2805
 
      This only applies if the working tree supports content filtering.
2806
 
    """
2807
 
    kind = tree.kind(file_id)
2808
 
    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":
2809
2107
        tt.create_directory(trans_id)
2810
 
    elif kind == "file":
2811
 
        if bytes is None:
2812
 
            tree_file = tree.get_file(file_id)
2813
 
            try:
2814
 
                bytes = tree_file.readlines()
2815
 
            finally:
2816
 
                tree_file.close()
2817
 
        wt = tt._tree
2818
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2819
 
            filters = wt._content_filter_stack(filter_tree_path)
2820
 
            bytes = filtered_output_bytes(bytes, filters,
2821
 
                ContentFilterContext(filter_tree_path, tree))
2822
 
        tt.create_file(bytes, trans_id)
2823
 
    elif kind == "symlink":
2824
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2825
 
    else:
2826
 
        raise AssertionError('Unknown kind %r' % kind)
2827
2108
 
2828
2109
 
2829
2110
def create_entry_executability(tt, entry, trans_id):
2832
2113
        tt.set_executability(entry.executable, trans_id)
2833
2114
 
2834
2115
 
 
2116
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
2117
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
2118
 
 
2119
 
 
2120
def _get_backup_name(name, by_parent, parent_trans_id, tt):
 
2121
    """Produce a backup-style name that appears to be available"""
 
2122
    def name_gen():
 
2123
        counter = 1
 
2124
        while True:
 
2125
            yield "%s.~%d~" % (name, counter)
 
2126
            counter += 1
 
2127
    for new_name in name_gen():
 
2128
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
2129
            return new_name
 
2130
 
 
2131
 
 
2132
def _entry_changes(file_id, entry, working_tree):
 
2133
    """Determine in which ways the inventory entry has changed.
 
2134
 
 
2135
    Returns booleans: has_contents, content_mod, meta_mod
 
2136
    has_contents means there are currently contents, but they differ
 
2137
    contents_mod means contents need to be modified
 
2138
    meta_mod means the metadata needs to be modified
 
2139
    """
 
2140
    cur_entry = working_tree.inventory[file_id]
 
2141
    try:
 
2142
        working_kind = working_tree.kind(file_id)
 
2143
        has_contents = True
 
2144
    except NoSuchFile:
 
2145
        has_contents = False
 
2146
        contents_mod = True
 
2147
        meta_mod = False
 
2148
    if has_contents is True:
 
2149
        if entry.kind != working_kind:
 
2150
            contents_mod, meta_mod = True, False
 
2151
        else:
 
2152
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2153
                                       working_tree)
 
2154
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
 
2155
            cur_entry._forget_tree_state()
 
2156
    return has_contents, contents_mod, meta_mod
 
2157
 
 
2158
 
2835
2159
def revert(working_tree, target_tree, filenames, backups=False,
2836
 
           pb=None, change_reporter=None):
 
2160
           pb=DummyProgress(), change_reporter=None):
2837
2161
    """Revert a working tree's contents to those of a target tree."""
2838
2162
    target_tree.lock_read()
2839
 
    pb = ui.ui_factory.nested_progress_bar()
2840
2163
    tt = TreeTransform(working_tree, pb)
2841
2164
    try:
2842
2165
        pp = ProgressPhase("Revert phase", 3, pb)
2847
2170
                unversioned_filter=working_tree.is_ignored)
2848
2171
            delta.report_changes(tt.iter_changes(), change_reporter)
2849
2172
        for conflict in conflicts:
2850
 
            trace.warning(unicode(conflict))
 
2173
            warning(conflict)
2851
2174
        pp.next_phase()
2852
2175
        tt.apply()
2853
2176
        working_tree.set_merge_modified(merge_modified)
2861
2184
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2862
2185
                              backups, pp, basis_tree=None,
2863
2186
                              merge_modified=None):
2864
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2187
    pp.next_phase()
 
2188
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2865
2189
    try:
2866
2190
        if merge_modified is None:
2867
2191
            merge_modified = working_tree.merge_modified()
2870
2194
                                      merge_modified, basis_tree)
2871
2195
    finally:
2872
2196
        child_pb.finished()
2873
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2197
    pp.next_phase()
 
2198
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2874
2199
    try:
2875
2200
        raw_conflicts = resolve_conflicts(tt, child_pb,
2876
2201
            lambda t, c: conflict_pass(t, c, target_tree))
2884
2209
                 backups, merge_modified, basis_tree=None):
2885
2210
    if basis_tree is not None:
2886
2211
        basis_tree.lock_read()
2887
 
    # We ask the working_tree for its changes relative to the target, rather
2888
 
    # than the target changes relative to the working tree. Because WT4 has an
2889
 
    # optimizer to compare itself to a target, but no optimizer for the
2890
 
    # reverse.
2891
 
    change_list = working_tree.iter_changes(target_tree,
 
2212
    change_list = target_tree.iter_changes(working_tree,
2892
2213
        specific_files=specific_files, pb=pb)
2893
2214
    if target_tree.get_root_id() is None:
2894
2215
        skip_root = True
2898
2219
        deferred_files = []
2899
2220
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2900
2221
                kind, executable) in enumerate(change_list):
2901
 
            target_path, wt_path = path
2902
 
            target_versioned, wt_versioned = versioned
2903
 
            target_parent, wt_parent = parent
2904
 
            target_name, wt_name = name
2905
 
            target_kind, wt_kind = kind
2906
 
            target_executable, wt_executable = executable
2907
 
            if skip_root and wt_parent is None:
 
2222
            if skip_root and file_id[0] is not None and parent[0] is None:
2908
2223
                continue
2909
2224
            trans_id = tt.trans_id_file_id(file_id)
2910
2225
            mode_id = None
2911
2226
            if changed_content:
2912
2227
                keep_content = False
2913
 
                if wt_kind == 'file' and (backups or target_kind is None):
 
2228
                if kind[0] == 'file' and (backups or kind[1] is None):
2914
2229
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2915
2230
                    if merge_modified.get(file_id) != wt_sha1:
2916
2231
                        # acquire the basis tree lazily to prevent the
2919
2234
                        if basis_tree is None:
2920
2235
                            basis_tree = working_tree.basis_tree()
2921
2236
                            basis_tree.lock_read()
2922
 
                        if basis_tree.has_id(file_id):
 
2237
                        if file_id in basis_tree:
2923
2238
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2924
2239
                                keep_content = True
2925
 
                        elif target_kind is None and not target_versioned:
 
2240
                        elif kind[1] is None and not versioned[1]:
2926
2241
                            keep_content = True
2927
 
                if wt_kind is not None:
 
2242
                if kind[0] is not None:
2928
2243
                    if not keep_content:
2929
2244
                        tt.delete_contents(trans_id)
2930
 
                    elif target_kind is not None:
2931
 
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
2932
 
                        backup_name = tt._available_backup_name(
2933
 
                            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)
2934
2250
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2935
 
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
2936
 
                        if wt_versioned and target_versioned:
 
2251
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2252
                        if versioned == (True, True):
2937
2253
                            tt.unversion_file(trans_id)
2938
2254
                            tt.version_file(file_id, new_trans_id)
2939
2255
                        # New contents should have the same unix perms as old
2940
2256
                        # contents
2941
2257
                        mode_id = trans_id
2942
2258
                        trans_id = new_trans_id
2943
 
                if target_kind in ('directory', 'tree-reference'):
 
2259
                if kind[1] in ('directory', 'tree-reference'):
2944
2260
                    tt.create_directory(trans_id)
2945
 
                    if target_kind == 'tree-reference':
 
2261
                    if kind[1] == 'tree-reference':
2946
2262
                        revision = target_tree.get_reference_revision(file_id,
2947
 
                                                                      target_path)
 
2263
                                                                      path[1])
2948
2264
                        tt.set_tree_reference(revision, trans_id)
2949
 
                elif target_kind == 'symlink':
 
2265
                elif kind[1] == 'symlink':
2950
2266
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2951
2267
                                      trans_id)
2952
 
                elif target_kind == 'file':
 
2268
                elif kind[1] == 'file':
2953
2269
                    deferred_files.append((file_id, (trans_id, mode_id)))
2954
2270
                    if basis_tree is None:
2955
2271
                        basis_tree = working_tree.basis_tree()
2956
2272
                        basis_tree.lock_read()
2957
2273
                    new_sha1 = target_tree.get_file_sha1(file_id)
2958
 
                    if (basis_tree.has_id(file_id) and
2959
 
                        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)):
2960
2276
                        if file_id in merge_modified:
2961
2277
                            del merge_modified[file_id]
2962
2278
                    else:
2963
2279
                        merge_modified[file_id] = new_sha1
2964
2280
 
2965
2281
                    # preserve the execute bit when backing up
2966
 
                    if keep_content and wt_executable == target_executable:
2967
 
                        tt.set_executability(target_executable, trans_id)
2968
 
                elif target_kind is not None:
2969
 
                    raise AssertionError(target_kind)
2970
 
            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):
2971
2287
                tt.version_file(file_id, trans_id)
2972
 
            if wt_versioned and not target_versioned:
 
2288
            if versioned == (True, False):
2973
2289
                tt.unversion_file(trans_id)
2974
 
            if (target_name is not None and
2975
 
                (wt_name != target_name or wt_parent != target_parent)):
2976
 
                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:
2977
2293
                    parent_trans = ROOT_PARENT
2978
2294
                else:
2979
 
                    parent_trans = tt.trans_id_file_id(target_parent)
2980
 
                if wt_parent is None and wt_versioned:
2981
 
                    tt.adjust_root_path(target_name, parent_trans)
2982
 
                else:
2983
 
                    tt.adjust_path(target_name, parent_trans, trans_id)
2984
 
            if wt_executable != target_executable and target_kind == "file":
2985
 
                tt.set_executability(target_executable, trans_id)
2986
 
        if working_tree.supports_content_filtering():
2987
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2988
 
                target_tree.iter_files_bytes(deferred_files)):
2989
 
                file_id = deferred_files[index][0]
2990
 
                # We're reverting a tree to the target tree so using the
2991
 
                # target tree to find the file path seems the best choice
2992
 
                # here IMO - Ian C 27/Oct/2009
2993
 
                filter_tree_path = target_tree.id2path(file_id)
2994
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2995
 
                bytes = filtered_output_bytes(bytes, filters,
2996
 
                    ContentFilterContext(filter_tree_path, working_tree))
2997
 
                tt.create_file(bytes, trans_id, mode_id)
2998
 
        else:
2999
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3000
 
                deferred_files):
3001
 
                tt.create_file(bytes, trans_id, mode_id)
3002
 
        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)
3003
2302
    finally:
3004
2303
        if basis_tree is not None:
3005
2304
            basis_tree.unlock()
3006
2305
    return merge_modified
3007
2306
 
3008
2307
 
3009
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2308
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3010
2309
    """Make many conflict-resolution attempts, but die if they fail"""
3011
2310
    if pass_func is None:
3012
2311
        pass_func = conflict_pass
3013
2312
    new_conflicts = set()
3014
 
    pb = ui.ui_factory.nested_progress_bar()
3015
2313
    try:
3016
2314
        for n in range(10):
3017
 
            pb.update(gettext('Resolution pass'), n+1, 10)
 
2315
            pb.update('Resolution pass', n+1, 10)
3018
2316
            conflicts = tt.find_conflicts()
3019
2317
            if len(conflicts) == 0:
3020
2318
                return new_conflicts
3021
2319
            new_conflicts.update(pass_func(tt, conflicts))
3022
2320
        raise MalformedTransform(conflicts=conflicts)
3023
2321
    finally:
3024
 
        pb.finished()
 
2322
        pb.clear()
3025
2323
 
3026
2324
 
3027
2325
def conflict_pass(tt, conflicts, path_tree=None):
3044
2342
                existing_file, new_file = conflict[2], conflict[1]
3045
2343
            else:
3046
2344
                existing_file, new_file = conflict[1], conflict[2]
3047
 
            new_name = tt.final_name(existing_file) + '.moved'
 
2345
            new_name = tt.final_name(existing_file)+'.moved'
3048
2346
            tt.adjust_path(new_name, final_parent, existing_file)
3049
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2347
            new_conflicts.add((c_type, 'Moved existing file to', 
3050
2348
                               existing_file, new_file))
3051
2349
        elif c_type == 'parent loop':
3052
2350
            # break the loop by undoing one of the ops that caused the loop
3056
2354
            new_conflicts.add((c_type, 'Cancelled move', cur,
3057
2355
                               tt.final_parent(cur),))
3058
2356
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3059
 
 
 
2357
            
3060
2358
        elif c_type == 'missing parent':
3061
2359
            trans_id = conflict[1]
3062
 
            if trans_id in tt._removed_contents:
3063
 
                cancel_deletion = True
3064
 
                orphans = tt._get_potential_orphans(trans_id)
3065
 
                if orphans:
3066
 
                    cancel_deletion = False
3067
 
                    # All children are orphans
3068
 
                    for o in orphans:
3069
 
                        try:
3070
 
                            tt.new_orphan(o, trans_id)
3071
 
                        except OrphaningError:
3072
 
                            # Something bad happened so we cancel the directory
3073
 
                            # deletion which will leave it in place with a
3074
 
                            # conflict. The user can deal with it from there.
3075
 
                            # Note that this also catch the case where we don't
3076
 
                            # want to create orphans and leave the directory in
3077
 
                            # place.
3078
 
                            cancel_deletion = True
3079
 
                            break
3080
 
                if cancel_deletion:
3081
 
                    # Cancel the directory deletion
3082
 
                    tt.cancel_deletion(trans_id)
3083
 
                    new_conflicts.add(('deleting parent', 'Not deleting',
3084
 
                                       trans_id))
3085
 
            else:
 
2360
            try:
 
2361
                tt.cancel_deletion(trans_id)
 
2362
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2363
                                   trans_id))
 
2364
            except KeyError:
3086
2365
                create = True
3087
2366
                try:
3088
2367
                    tt.final_name(trans_id)
3091
2370
                        file_id = tt.final_file_id(trans_id)
3092
2371
                        if file_id is None:
3093
2372
                            file_id = tt.inactive_file_id(trans_id)
3094
 
                        _, entry = path_tree.iter_entries_by_dir(
3095
 
                            [file_id]).next()
 
2373
                        entry = path_tree.inventory[file_id]
3096
2374
                        # special-case the other tree root (move its
3097
2375
                        # children to current root)
3098
2376
                        if entry.parent_id is None:
3099
 
                            create = False
 
2377
                            create=False
3100
2378
                            moved = _reparent_transform_children(
3101
2379
                                tt, trans_id, tt.root)
3102
2380
                            for child in moved:
3113
2391
        elif c_type == 'unversioned parent':
3114
2392
            file_id = tt.inactive_file_id(conflict[1])
3115
2393
            # special-case the other tree root (move its children instead)
3116
 
            if path_tree and path_tree.has_id(file_id):
3117
 
                if path_tree.path2id('') == file_id:
3118
 
                    # 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:
3119
2396
                    continue
3120
2397
            tt.version_file(file_id, conflict[1])
3121
2398
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3137
2414
 
3138
2415
def cook_conflicts(raw_conflicts, tt):
3139
2416
    """Generate a list of cooked conflicts, sorted by file path"""
 
2417
    from bzrlib.conflicts import Conflict
3140
2418
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3141
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
2419
    return sorted(conflict_iter, key=Conflict.sort_key)
3142
2420
 
3143
2421
 
3144
2422
def iter_cook_conflicts(raw_conflicts, tt):
 
2423
    from bzrlib.conflicts import Conflict
3145
2424
    fp = FinalPaths(tt)
3146
2425
    for conflict in raw_conflicts:
3147
2426
        c_type = conflict[0]
3149
2428
        modified_path = fp.get_path(conflict[2])
3150
2429
        modified_id = tt.final_file_id(conflict[2])
3151
2430
        if len(conflict) == 3:
3152
 
            yield conflicts.Conflict.factory(
3153
 
                c_type, action=action, path=modified_path, file_id=modified_id)
3154
 
 
 
2431
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2432
                                     file_id=modified_id)
 
2433
             
3155
2434
        else:
3156
2435
            conflicting_path = fp.get_path(conflict[3])
3157
2436
            conflicting_id = tt.final_file_id(conflict[3])
3158
 
            yield conflicts.Conflict.factory(
3159
 
                c_type, action=action, path=modified_path,
3160
 
                file_id=modified_id,
3161
 
                conflict_path=conflicting_path,
3162
 
                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)
3163
2441
 
3164
2442
 
3165
2443
class _FileMover(object):
3170
2448
        self.pending_deletions = []
3171
2449
 
3172
2450
    def rename(self, from_, to):
3173
 
        """Rename a file from one path to another."""
 
2451
        """Rename a file from one path to another.  Functions like os.rename"""
3174
2452
        try:
3175
2453
            os.rename(from_, to)
3176
2454
        except OSError, e:
3177
2455
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3178
2456
                raise errors.FileExists(to, str(e))
3179
 
            # normal OSError doesn't include filenames so it's hard to see where
3180
 
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3181
 
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
 
2457
            raise
3182
2458
        self.past_renames.append((from_, to))
3183
2459
 
3184
2460
    def pre_delete(self, from_, to):
3194
2470
    def rollback(self):
3195
2471
        """Reverse all renames that have been performed"""
3196
2472
        for from_, to in reversed(self.past_renames):
3197
 
            try:
3198
 
                os.rename(to, from_)
3199
 
            except OSError, e:
3200
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
 
2473
            os.rename(to, from_)
3201
2474
        # after rollback, don't reuse _FileMover
3202
2475
        past_renames = None
3203
2476
        pending_deletions = None