~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-10-31 04:39:04 UTC
  • mfrom: (3565.6.16 switch_nick)
  • Revision ID: pqm@pqm.ubuntu.com-20081031043904-52fnbfrloojemvcc
(mbp) branch nickname documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
44
    sha_file,
61
45
    splitpath,
62
 
    )
63
 
from bzrlib.progress import ProgressPhase
 
46
    supports_executable,
 
47
)
 
48
from bzrlib.progress import DummyProgress, ProgressPhase
64
49
from bzrlib.symbol_versioning import (
65
 
    deprecated_function,
66
 
    deprecated_in,
67
 
    deprecated_method,
68
 
    )
 
50
        deprecated_function,
 
51
        deprecated_in,
 
52
        )
 
53
from bzrlib.trace import mutter, warning
 
54
from bzrlib import tree
 
55
import bzrlib.ui
 
56
import bzrlib.urlutils as urlutils
69
57
 
70
58
 
71
59
ROOT_PARENT = "root-parent"
72
60
 
 
61
 
73
62
def unique_add(map, key, value):
74
63
    if key in map:
75
64
        raise DuplicateKey(key=key)
76
65
    map[key] = value
77
66
 
78
67
 
79
 
 
80
68
class _TransformResults(object):
81
69
    def __init__(self, modified_paths, rename_count):
82
70
        object.__init__(self)
85
73
 
86
74
 
87
75
class TreeTransformBase(object):
88
 
    """The base class for TreeTransform and its kin."""
 
76
    """The base class for TreeTransform and TreeTransformBase"""
89
77
 
90
 
    def __init__(self, tree, pb=None,
 
78
    def __init__(self, tree, limbodir, pb=DummyProgress(),
91
79
                 case_sensitive=True):
92
80
        """Constructor.
93
81
 
94
82
        :param tree: The tree that will be transformed, but not necessarily
95
83
            the output tree.
96
 
        :param pb: ignored
 
84
        :param limbodir: A directory where new files can be stored until
 
85
            they are installed in their proper places
 
86
        :param pb: A ProgressBar indicating how much progress is being made
97
87
        :param case_sensitive: If True, the target of the transform is
98
88
            case sensitive, not just case preserving.
99
89
        """
100
90
        object.__init__(self)
101
91
        self._tree = tree
 
92
        self._limbodir = limbodir
 
93
        self._deletiondir = None
102
94
        self._id_number = 0
103
95
        # mapping of trans_id -> new basename
104
96
        self._new_name = {}
106
98
        self._new_parent = {}
107
99
        # mapping of trans_id with new contents -> new file_kind
108
100
        self._new_contents = {}
109
 
        # mapping of trans_id => (sha1 of content, stat_value)
110
 
        self._observed_sha1s = {}
 
101
        # A mapping of transform ids to their limbo filename
 
102
        self._limbo_files = {}
 
103
        # A mapping of transform ids to a set of the transform ids of children
 
104
        # that their limbo directory has
 
105
        self._limbo_children = {}
 
106
        # Map transform ids to maps of child filename to child transform id
 
107
        self._limbo_children_names = {}
 
108
        # List of transform ids that need to be renamed from limbo into place
 
109
        self._needs_rename = set()
111
110
        # Set of trans_ids whose contents will be removed
112
111
        self._removed_contents = set()
113
112
        # Mapping of trans_id -> new execute-bit value
120
119
        self._non_present_ids = {}
121
120
        # Mapping of new file_id -> trans_id
122
121
        self._r_new_id = {}
123
 
        # Set of trans_ids that will be removed
 
122
        # Set of file_ids that will be removed
124
123
        self._removed_id = set()
125
124
        # Mapping of path in old tree -> trans_id
126
125
        self._tree_path_ids = {}
127
126
        # Mapping trans_id -> path in old tree
128
127
        self._tree_id_paths = {}
 
128
        # Cache of realpath results, to speed up canonical_path
 
129
        self._realpaths = {}
 
130
        # Cache of relpath results, to speed up canonical_path
 
131
        self._relpaths = {}
129
132
        # The trans_id that will be used as the tree root
130
133
        root_id = tree.get_root_id()
131
134
        if root_id is not None:
132
135
            self._new_root = self.trans_id_tree_file_id(root_id)
133
136
        else:
134
137
            self._new_root = None
135
 
        # Indicator of whether the transform has been applied
 
138
        # Indictor of whether the transform has been applied
136
139
        self._done = False
137
140
        # A progress bar
138
141
        self._pb = pb
141
144
        # A counter of how many files have been renamed
142
145
        self.rename_count = 0
143
146
 
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
147
    def __get_root(self):
166
148
        return self._new_root
167
149
 
168
150
    root = property(__get_root)
169
151
 
 
152
    def finalize(self):
 
153
        """Release the working tree lock, if held, clean up limbo dir.
 
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
        try:
 
161
            entries = [(self._limbo_name(t), t, k) for t, k in
 
162
                       self._new_contents.iteritems()]
 
163
            entries.sort(reverse=True)
 
164
            for path, trans_id, kind in entries:
 
165
                if kind == "directory":
 
166
                    os.rmdir(path)
 
167
                else:
 
168
                    os.unlink(path)
 
169
            try:
 
170
                os.rmdir(self._limbodir)
 
171
            except OSError:
 
172
                # We don't especially care *why* the dir is immortal.
 
173
                raise ImmortalLimbo(self._limbodir)
 
174
            try:
 
175
                if self._deletiondir is not None:
 
176
                    os.rmdir(self._deletiondir)
 
177
            except OSError:
 
178
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
179
        finally:
 
180
            self._tree.unlock()
 
181
            self._tree = None
 
182
 
170
183
    def _assign_id(self):
171
184
        """Produce a new tranform id"""
172
185
        new_id = "new-%s" % self._id_number
182
195
 
183
196
    def adjust_path(self, name, parent, trans_id):
184
197
        """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
198
        if trans_id == self._new_root:
188
199
            raise CantMoveRoot
 
200
        previous_parent = self._new_parent.get(trans_id)
 
201
        previous_name = self._new_name.get(trans_id)
189
202
        self._new_name[trans_id] = name
190
203
        self._new_parent[trans_id] = parent
 
204
        if parent == ROOT_PARENT:
 
205
            if self._new_root is not None:
 
206
                raise ValueError("Cannot have multiple roots.")
 
207
            self._new_root = trans_id
 
208
        if (trans_id in self._limbo_files and
 
209
            trans_id not in self._needs_rename):
 
210
            self._rename_in_limbo([trans_id])
 
211
            self._limbo_children[previous_parent].remove(trans_id)
 
212
            del self._limbo_children_names[previous_parent][previous_name]
 
213
 
 
214
    def _rename_in_limbo(self, trans_ids):
 
215
        """Fix limbo names so that the right final path is produced.
 
216
 
 
217
        This means we outsmarted ourselves-- we tried to avoid renaming
 
218
        these files later by creating them with their final names in their
 
219
        final parents.  But now the previous name or parent is no longer
 
220
        suitable, so we have to rename them.
 
221
 
 
222
        Even for trans_ids that have no new contents, we must remove their
 
223
        entries from _limbo_files, because they are now stale.
 
224
        """
 
225
        for trans_id in trans_ids:
 
226
            old_path = self._limbo_files.pop(trans_id)
 
227
            if trans_id not in self._new_contents:
 
228
                continue
 
229
            new_path = self._limbo_name(trans_id)
 
230
            os.rename(old_path, new_path)
191
231
 
192
232
    def adjust_root_path(self, name, parent):
193
233
        """Emulate moving the root by moving all children, instead.
194
 
 
 
234
        
195
235
        We do this by undoing the association of root's transaction id with the
196
236
        current tree.  This allows us to create a new directory with that
197
 
        transaction id.  We unversion the root directory and version the
 
237
        transaction id.  We unversion the root directory and version the 
198
238
        physically new directory, and hope someone versions the tree root
199
239
        later.
200
240
        """
203
243
        # force moving all children of root
204
244
        for child_id in self.iter_tree_children(old_root):
205
245
            if child_id != parent:
206
 
                self.adjust_path(self.final_name(child_id),
 
246
                self.adjust_path(self.final_name(child_id), 
207
247
                                 self.final_parent(child_id), child_id)
208
248
            file_id = self.final_file_id(child_id)
209
249
            if file_id is not None:
210
250
                self.unversion_file(child_id)
211
251
            self.version_file(file_id, child_id)
212
 
 
 
252
        
213
253
        # the physical root needs a new transaction id
214
254
        self._tree_path_ids.pop("")
215
255
        self._tree_id_paths.pop(old_root)
221
261
        self.version_file(old_root_file_id, old_root)
222
262
        self.unversion_file(self._new_root)
223
263
 
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
264
    def trans_id_tree_file_id(self, inventory_id):
286
265
        """Determine the transaction id of a working tree file.
287
 
 
 
266
        
288
267
        This reflects only files that already exist, not ones that will be
289
268
        added by transactions.
290
269
        """
316
295
            else:
317
296
                return self.trans_id_tree_file_id(file_id)
318
297
 
 
298
    def canonical_path(self, path):
 
299
        """Get the canonical tree-relative path"""
 
300
        # don't follow final symlinks
 
301
        abs = self._tree.abspath(path)
 
302
        if abs in self._relpaths:
 
303
            return self._relpaths[abs]
 
304
        dirname, basename = os.path.split(abs)
 
305
        if dirname not in self._realpaths:
 
306
            self._realpaths[dirname] = os.path.realpath(dirname)
 
307
        dirname = self._realpaths[dirname]
 
308
        abs = pathjoin(dirname, basename)
 
309
        if dirname in self._relpaths:
 
310
            relpath = pathjoin(self._relpaths[dirname], basename)
 
311
            relpath = relpath.rstrip('/\\')
 
312
        else:
 
313
            relpath = self._tree.relpath(abs)
 
314
        self._relpaths[abs] = relpath
 
315
        return relpath
 
316
 
319
317
    def trans_id_tree_path(self, path):
320
318
        """Determine (and maybe set) the transaction ID for a tree path."""
321
319
        path = self.canonical_path(path)
331
329
            return ROOT_PARENT
332
330
        return self.trans_id_tree_path(os.path.dirname(path))
333
331
 
 
332
    def create_file(self, contents, trans_id, mode_id=None):
 
333
        """Schedule creation of a new file.
 
334
 
 
335
        See also new_file.
 
336
        
 
337
        Contents is an iterator of strings, all of which will be written
 
338
        to the target destination.
 
339
 
 
340
        New file takes the permissions of any existing file with that id,
 
341
        unless mode_id is specified.
 
342
        """
 
343
        name = self._limbo_name(trans_id)
 
344
        f = open(name, 'wb')
 
345
        try:
 
346
            try:
 
347
                unique_add(self._new_contents, trans_id, 'file')
 
348
            except:
 
349
                # Clean up the file, it never got registered so
 
350
                # TreeTransform.finalize() won't clean it up.
 
351
                f.close()
 
352
                os.unlink(name)
 
353
                raise
 
354
 
 
355
            f.writelines(contents)
 
356
        finally:
 
357
            f.close()
 
358
        self._set_mode(trans_id, mode_id, S_ISREG)
 
359
 
 
360
    def _set_mode(self, trans_id, mode_id, typefunc):
 
361
        """Set the mode of new file contents.
 
362
        The mode_id is the existing file to get the mode from (often the same
 
363
        as trans_id).  The operation is only performed if there's a mode match
 
364
        according to typefunc.
 
365
        """
 
366
        if mode_id is None:
 
367
            mode_id = trans_id
 
368
        try:
 
369
            old_path = self._tree_id_paths[mode_id]
 
370
        except KeyError:
 
371
            return
 
372
        try:
 
373
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
374
        except OSError, e:
 
375
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
376
                # Either old_path doesn't exist, or the parent of the
 
377
                # target is not a directory (but will be one eventually)
 
378
                # Either way, we know it doesn't exist *right now*
 
379
                # See also bug #248448
 
380
                return
 
381
            else:
 
382
                raise
 
383
        if typefunc(mode):
 
384
            os.chmod(self._limbo_name(trans_id), mode)
 
385
 
 
386
    def create_hardlink(self, path, trans_id):
 
387
        """Schedule creation of a hard link"""
 
388
        name = self._limbo_name(trans_id)
 
389
        try:
 
390
            os.link(path, name)
 
391
        except OSError, e:
 
392
            if e.errno != errno.EPERM:
 
393
                raise
 
394
            raise errors.HardLinkNotSupported(path)
 
395
        try:
 
396
            unique_add(self._new_contents, trans_id, 'file')
 
397
        except:
 
398
            # Clean up the file, it never got registered so
 
399
            # TreeTransform.finalize() won't clean it up.
 
400
            os.unlink(name)
 
401
            raise
 
402
 
 
403
    def create_directory(self, trans_id):
 
404
        """Schedule creation of a new directory.
 
405
        
 
406
        See also new_directory.
 
407
        """
 
408
        os.mkdir(self._limbo_name(trans_id))
 
409
        unique_add(self._new_contents, trans_id, 'directory')
 
410
 
 
411
    def create_symlink(self, target, trans_id):
 
412
        """Schedule creation of a new symbolic link.
 
413
 
 
414
        target is a bytestring.
 
415
        See also new_symlink.
 
416
        """
 
417
        if has_symlinks():
 
418
            os.symlink(target, self._limbo_name(trans_id))
 
419
            unique_add(self._new_contents, trans_id, 'symlink')
 
420
        else:
 
421
            try:
 
422
                path = FinalPaths(self).get_path(trans_id)
 
423
            except KeyError:
 
424
                path = None
 
425
            raise UnableCreateSymlink(path=path)
 
426
 
 
427
    def cancel_creation(self, trans_id):
 
428
        """Cancel the creation of new file contents."""
 
429
        del self._new_contents[trans_id]
 
430
        children = self._limbo_children.get(trans_id)
 
431
        # if this is a limbo directory with children, move them before removing
 
432
        # the directory
 
433
        if children is not None:
 
434
            self._rename_in_limbo(children)
 
435
            del self._limbo_children[trans_id]
 
436
            del self._limbo_children_names[trans_id]
 
437
        delete_any(self._limbo_name(trans_id))
 
438
 
334
439
    def delete_contents(self, trans_id):
335
440
        """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)
 
441
        self.tree_kind(trans_id)
 
442
        self._removed_contents.add(trans_id)
339
443
 
340
444
    def cancel_deletion(self, trans_id):
341
445
        """Cancel a scheduled deletion"""
398
502
        return sorted(FinalPaths(self).get_paths(new_ids))
399
503
 
400
504
    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,
 
505
        """Get the trans_ids and paths of files needing new inv entries."""
 
506
        new_ids = set()
 
507
        for id_set in [self._new_name, self._new_parent, self._new_id,
419
508
                       self._new_executability]:
420
 
            changed_ids.update(id_set)
421
 
        # removing implies a kind change
 
509
            new_ids.update(id_set)
422
510
        changed_kind = set(self._removed_contents)
423
 
        # so does adding
424
511
        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))
 
512
        changed_kind.difference_update(new_ids)
 
513
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
514
                        self.final_kind(t))
 
515
        new_ids.update(changed_kind)
 
516
        return sorted(FinalPaths(self).get_paths(new_ids))
 
517
 
 
518
    def tree_kind(self, trans_id):
 
519
        """Determine the file kind in the working tree.
 
520
 
 
521
        Raises NoSuchFile if the file does not exist
 
522
        """
 
523
        path = self._tree_id_paths.get(trans_id)
 
524
        if path is None:
 
525
            raise NoSuchFile(None)
 
526
        try:
 
527
            return file_kind(self._tree.abspath(path))
 
528
        except OSError, e:
 
529
            if e.errno != errno.ENOENT:
 
530
                raise
 
531
            else:
 
532
                raise NoSuchFile(path)
439
533
 
440
534
    def final_kind(self, trans_id):
441
535
        """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)
 
536
        
 
537
        Raises NoSuchFile if the file does not exist/has no contents.
 
538
        (It is conceivable that a path would be created without the
 
539
        corresponding contents insertion command)
446
540
        """
447
541
        if trans_id in self._new_contents:
448
542
            return self._new_contents[trans_id]
449
543
        elif trans_id in self._removed_contents:
450
 
            return None
 
544
            raise NoSuchFile(None)
451
545
        else:
452
546
            return self.tree_kind(trans_id)
453
547
 
465
559
 
466
560
    def final_file_id(self, trans_id):
467
561
        """Determine the file id after any changes are applied, or None.
468
 
 
 
562
        
469
563
        None indicates that the file will not be versioned after changes are
470
564
        applied.
471
565
        """
510
604
 
511
605
    def by_parent(self):
512
606
        """Return a map of parent: children for known parents.
513
 
 
 
607
        
514
608
        Only new paths and parents of tree files with assigned ids are used.
515
609
        """
516
610
        by_parent = {}
517
611
        items = list(self._new_parent.iteritems())
518
 
        items.extend((t, self.final_parent(t)) for t in
 
612
        items.extend((t, self.final_parent(t)) for t in 
519
613
                      self._tree_id_paths.keys())
520
614
        for trans_id, parent_id in items:
521
615
            if parent_id not in by_parent:
549
643
        conflicts.extend(self._overwrite_conflicts())
550
644
        return conflicts
551
645
 
552
 
    def _check_malformed(self):
553
 
        conflicts = self.find_conflicts()
554
 
        if len(conflicts) != 0:
555
 
            raise MalformedTransform(conflicts=conflicts)
556
 
 
557
646
    def _add_tree_children(self):
558
647
        """Add all the children of all active parents to the known paths.
559
648
 
561
650
        removed.  This is a necessary first step in detecting conflicts.
562
651
        """
563
652
        parents = self.by_parent().keys()
564
 
        parents.extend([t for t in self._removed_contents if
 
653
        parents.extend([t for t in self._removed_contents if 
565
654
                        self.tree_kind(t) == 'directory'])
566
655
        for trans_id in self._removed_id:
567
656
            file_id = self.tree_file_id(trans_id)
568
657
            if file_id is not None:
569
 
                if self._tree.stored_kind(file_id) == 'directory':
 
658
                if self._tree.inventory[file_id].kind == 'directory':
570
659
                    parents.append(trans_id)
571
660
            elif self.tree_kind(trans_id) == 'directory':
572
661
                parents.append(trans_id)
575
664
            # ensure that all children are registered with the transaction
576
665
            list(self.iter_tree_children(parent_id))
577
666
 
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:
 
667
    def iter_tree_children(self, parent_id):
 
668
        """Iterate through the entry's tree children, if any"""
 
669
        try:
 
670
            path = self._tree_id_paths[parent_id]
 
671
        except KeyError:
 
672
            return
 
673
        try:
 
674
            children = os.listdir(self._tree.abspath(path))
 
675
        except OSError, e:
 
676
            if not (osutils._is_error_enotdir(e)
 
677
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
678
                raise
 
679
            return
 
680
 
 
681
        for child in children:
 
682
            childpath = joinpath(path, child)
 
683
            if self._tree.is_control_filename(childpath):
 
684
                continue
 
685
            yield self.trans_id_tree_path(childpath)
 
686
 
 
687
    def has_named_child(self, by_parent, parent_id, name):
 
688
        try:
 
689
            children = by_parent[parent_id]
 
690
        except KeyError:
 
691
            children = []
 
692
        for child in children:
592
693
            if self.final_name(child) == name:
593
694
                return True
594
 
        parent_path = self._tree_id_paths.get(parent_id, None)
595
 
        if parent_path is None:
596
 
            # No parent... no children
 
695
        try:
 
696
            path = self._tree_id_paths[parent_id]
 
697
        except KeyError:
597
698
            return False
598
 
        child_path = joinpath(parent_path, name)
599
 
        child_id = self._tree_path_ids.get(child_path, None)
 
699
        childpath = joinpath(path, name)
 
700
        child_id = self._tree_path_ids.get(childpath)
600
701
        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))
 
702
            return lexists(self._tree.abspath(childpath))
603
703
        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))
 
704
            if self.final_parent(child_id) != parent_id:
 
705
                return False
 
706
            if child_id in self._removed_contents:
 
707
                # XXX What about dangling file-ids?
 
708
                return False
 
709
            else:
 
710
                return True
620
711
 
621
712
    def _parent_loops(self):
622
713
        """No entry should be its own ancestor"""
624
715
        for trans_id in self._new_parent:
625
716
            seen = set()
626
717
            parent_id = trans_id
627
 
            while parent_id != ROOT_PARENT:
 
718
            while parent_id is not ROOT_PARENT:
628
719
                seen.add(parent_id)
629
720
                try:
630
721
                    parent_id = self.final_parent(parent_id)
640
731
        """If parent directories are versioned, children must be versioned."""
641
732
        conflicts = []
642
733
        for parent_id, children in by_parent.iteritems():
643
 
            if parent_id == ROOT_PARENT:
 
734
            if parent_id is ROOT_PARENT:
644
735
                continue
645
736
            if self.final_file_id(parent_id) is not None:
646
737
                continue
652
743
 
653
744
    def _improper_versioning(self):
654
745
        """Cannot version a file with no contents, or a bad type.
655
 
 
 
746
        
656
747
        However, existing entries with no contents are okay.
657
748
        """
658
749
        conflicts = []
659
750
        for trans_id in self._new_id.iterkeys():
660
 
            kind = self.final_kind(trans_id)
661
 
            if kind is None:
 
751
            try:
 
752
                kind = self.final_kind(trans_id)
 
753
            except NoSuchFile:
662
754
                conflicts.append(('versioning no contents', trans_id))
663
755
                continue
664
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
756
            if not InventoryEntry.versionable_kind(kind):
665
757
                conflicts.append(('versioning bad kind', trans_id, kind))
666
758
        return conflicts
667
759
 
668
760
    def _executability_conflicts(self):
669
761
        """Check for bad executability changes.
670
 
 
 
762
        
671
763
        Only versioned files may have their executability set, because
672
764
        1. only versioned entries can have executability under windows
673
765
        2. only files can be executable.  (The execute bit on a directory
678
770
            if self.final_file_id(trans_id) is None:
679
771
                conflicts.append(('unversioned executability', trans_id))
680
772
            else:
681
 
                if self.final_kind(trans_id) != "file":
 
773
                try:
 
774
                    non_file = self.final_kind(trans_id) != "file"
 
775
                except NoSuchFile:
 
776
                    non_file = True
 
777
                if non_file is True:
682
778
                    conflicts.append(('non-file executability', trans_id))
683
779
        return conflicts
684
780
 
686
782
        """Check for overwrites (not permitted on Win32)"""
687
783
        conflicts = []
688
784
        for trans_id in self._new_contents:
689
 
            if self.tree_kind(trans_id) is None:
 
785
            try:
 
786
                self.tree_kind(trans_id)
 
787
            except NoSuchFile:
690
788
                continue
691
789
            if trans_id not in self._removed_contents:
692
790
                conflicts.append(('overwrite', trans_id,
699
797
        if (self._new_name, self._new_parent) == ({}, {}):
700
798
            return conflicts
701
799
        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))
 
800
            name_ids = [(self.final_name(t), t) for t in children]
 
801
            if not self._case_sensitive_target:
 
802
                name_ids = [(n.lower(), t) for n, t in name_ids]
710
803
            name_ids.sort()
711
804
            last_name = None
712
805
            last_trans_id = None
713
806
            for name, trans_id in name_ids:
714
 
                kind = self.final_kind(trans_id)
 
807
                try:
 
808
                    kind = self.final_kind(trans_id)
 
809
                except NoSuchFile:
 
810
                    kind = None
715
811
                file_id = self.final_file_id(trans_id)
716
812
                if kind is None and file_id is None:
717
813
                    continue
736
832
        return conflicts
737
833
 
738
834
    def _parent_type_conflicts(self, by_parent):
739
 
        """Children must have a directory parent"""
 
835
        """parents must have directory 'contents'."""
740
836
        conflicts = []
741
837
        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)
 
838
            if parent_id is ROOT_PARENT:
 
839
                continue
 
840
            if not self._any_contents(children):
 
841
                continue
 
842
            for child in children:
 
843
                try:
 
844
                    self.final_kind(child)
 
845
                except NoSuchFile:
 
846
                    continue
 
847
            try:
 
848
                kind = self.final_kind(parent_id)
 
849
            except NoSuchFile:
 
850
                kind = None
754
851
            if kind is None:
755
 
                # The directory will be deleted
756
852
                conflicts.append(('missing parent', parent_id))
757
853
            elif kind != "directory":
758
 
                # Meh, we need a *directory* to put something in it
759
854
                conflicts.append(('non-directory parent', parent_id))
760
855
        return conflicts
761
856
 
 
857
    def _any_contents(self, trans_ids):
 
858
        """Return true if any of the trans_ids, will have contents."""
 
859
        for trans_id in trans_ids:
 
860
            try:
 
861
                kind = self.final_kind(trans_id)
 
862
            except NoSuchFile:
 
863
                continue
 
864
            return True
 
865
        return False
 
866
 
 
867
    def _limbo_name(self, trans_id):
 
868
        """Generate the limbo name of a file"""
 
869
        limbo_name = self._limbo_files.get(trans_id)
 
870
        if limbo_name is not None:
 
871
            return limbo_name
 
872
        parent = self._new_parent.get(trans_id)
 
873
        # if the parent directory is already in limbo (e.g. when building a
 
874
        # tree), choose a limbo name inside the parent, to reduce further
 
875
        # renames.
 
876
        use_direct_path = False
 
877
        if self._new_contents.get(parent) == 'directory':
 
878
            filename = self._new_name.get(trans_id)
 
879
            if filename is not None:
 
880
                if parent not in self._limbo_children:
 
881
                    self._limbo_children[parent] = set()
 
882
                    self._limbo_children_names[parent] = {}
 
883
                    use_direct_path = True
 
884
                # the direct path can only be used if no other file has
 
885
                # already taken this pathname, i.e. if the name is unused, or
 
886
                # if it is already associated with this trans_id.
 
887
                elif self._case_sensitive_target:
 
888
                    if (self._limbo_children_names[parent].get(filename)
 
889
                        in (trans_id, None)):
 
890
                        use_direct_path = True
 
891
                else:
 
892
                    for l_filename, l_trans_id in\
 
893
                        self._limbo_children_names[parent].iteritems():
 
894
                        if l_trans_id == trans_id:
 
895
                            continue
 
896
                        if l_filename.lower() == filename.lower():
 
897
                            break
 
898
                    else:
 
899
                        use_direct_path = True
 
900
 
 
901
        if use_direct_path:
 
902
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
903
            self._limbo_children[parent].add(trans_id)
 
904
            self._limbo_children_names[parent][filename] = trans_id
 
905
        else:
 
906
            limbo_name = pathjoin(self._limbodir, trans_id)
 
907
            self._needs_rename.add(trans_id)
 
908
        self._limbo_files[trans_id] = limbo_name
 
909
        return limbo_name
 
910
 
762
911
    def _set_executability(self, path, trans_id):
763
912
        """Set the executability of versioned files """
764
 
        if self._tree._supports_executable():
 
913
        if supports_executable():
765
914
            new_executability = self._new_executability[trans_id]
766
915
            abspath = self._tree.abspath(path)
767
916
            current_mode = os.stat(abspath).st_mode
776
925
                    to_mode |= 0010 & ~umask
777
926
            else:
778
927
                to_mode = current_mode & ~0111
779
 
            osutils.chmod_if_possible(abspath, to_mode)
 
928
            os.chmod(abspath, to_mode)
780
929
 
781
930
    def _new_entry(self, name, parent_id, file_id):
782
931
        """Helper function to create a new filesystem entry."""
785
934
            self.version_file(file_id, trans_id)
786
935
        return trans_id
787
936
 
788
 
    def new_file(self, name, parent_id, contents, file_id=None,
789
 
                 executable=None, sha1=None):
 
937
    def new_file(self, name, parent_id, contents, file_id=None, 
 
938
                 executable=None):
790
939
        """Convenience method to create files.
791
 
 
 
940
        
792
941
        name is the name of the file to create.
793
942
        parent_id is the transaction id of the parent directory of the file.
794
943
        contents is an iterator of bytestrings, which will be used to produce
799
948
        trans_id = self._new_entry(name, parent_id, file_id)
800
949
        # TODO: rather than scheduling a set_executable call,
801
950
        # have create_file create the file with the right mode.
802
 
        self.create_file(contents, trans_id, sha1=sha1)
 
951
        self.create_file(contents, trans_id)
803
952
        if executable is not None:
804
953
            self.set_executability(executable, trans_id)
805
954
        return trans_id
814
963
        """
815
964
        trans_id = self._new_entry(name, parent_id, file_id)
816
965
        self.create_directory(trans_id)
817
 
        return trans_id
 
966
        return trans_id 
818
967
 
819
968
    def new_symlink(self, name, parent_id, target, file_id=None):
820
969
        """Convenience method to create symbolic link.
821
 
 
 
970
        
822
971
        name is the name of the symlink to create.
823
972
        parent_id is the transaction id of the parent directory of the symlink.
824
973
        target is a bytestring of the target of the symlink.
828
977
        self.create_symlink(target, trans_id)
829
978
        return trans_id
830
979
 
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
980
    def _affected_ids(self):
874
981
        """Return the set of transform ids affected by the transform"""
875
982
        trans_ids = set(self._removed_id)
934
1041
        Return a (name, parent, kind, executable) tuple
935
1042
        """
936
1043
        to_name = self.final_name(to_trans_id)
937
 
        to_kind = self.final_kind(to_trans_id)
 
1044
        try:
 
1045
            to_kind = self.final_kind(to_trans_id)
 
1046
        except NoSuchFile:
 
1047
            to_kind = None
938
1048
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
939
1049
        if to_trans_id in self._new_executability:
940
1050
            to_executable = self._new_executability[to_trans_id]
1009
1119
    def get_preview_tree(self):
1010
1120
        """Return a tree representing the result of the transform.
1011
1121
 
1012
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
1013
 
        it.
 
1122
        This tree only supports the subset of Tree functionality required
 
1123
        by show_diff_trees.  It must only be compared to tt._tree.
1014
1124
        """
1015
1125
        return _PreviewTree(self)
1016
1126
 
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):
 
1127
 
 
1128
class TreeTransform(TreeTransformBase):
1481
1129
    """Represent a tree transformation.
1482
1130
 
1483
1131
    This object is designed to support incremental generation of the transform,
1542
1190
    FileMover does not delete files until it is sure that a rollback will not
1543
1191
    happen.
1544
1192
    """
1545
 
    def __init__(self, tree, pb=None):
 
1193
    def __init__(self, tree, pb=DummyProgress()):
1546
1194
        """Note: a tree_write lock is taken on the tree.
1547
1195
 
1548
1196
        Use TreeTransform.finalize() to release the lock (can be omitted if
1553
1201
        try:
1554
1202
            limbodir = urlutils.local_path_from_url(
1555
1203
                tree._transport.abspath('limbo'))
1556
 
            osutils.ensure_empty_directory_exists(
1557
 
                limbodir,
1558
 
                errors.ExistingLimbo)
 
1204
            try:
 
1205
                os.mkdir(limbodir)
 
1206
            except OSError, e:
 
1207
                if e.errno == errno.EEXIST:
 
1208
                    raise ExistingLimbo(limbodir)
1559
1209
            deletiondir = urlutils.local_path_from_url(
1560
1210
                tree._transport.abspath('pending-deletion'))
1561
 
            osutils.ensure_empty_directory_exists(
1562
 
                deletiondir,
1563
 
                errors.ExistingPendingDeletion)
 
1211
            try:
 
1212
                os.mkdir(deletiondir)
 
1213
            except OSError, e:
 
1214
                if e.errno == errno.EEXIST:
 
1215
                    raise errors.ExistingPendingDeletion(deletiondir)
1564
1216
        except:
1565
1217
            tree.unlock()
1566
1218
            raise
1567
1219
 
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,
 
1220
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1573
1221
                                   tree.case_sensitive)
1574
1222
        self._deletiondir = deletiondir
1575
1223
 
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
1224
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1703
1225
        """Apply all changes to the inventory and filesystem.
1704
1226
 
1713
1235
            calculating one.
1714
1236
        :param _mover: Supply an alternate FileMover, for testing
1715
1237
        """
1716
 
        for hook in MutableTree.hooks['pre_transform']:
1717
 
            hook(self._tree, self)
1718
1238
        if not no_conflicts:
1719
 
            self._check_malformed()
1720
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1239
            conflicts = self.find_conflicts()
 
1240
            if len(conflicts) != 0:
 
1241
                raise MalformedTransform(conflicts=conflicts)
 
1242
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1721
1243
        try:
1722
1244
            if precomputed_delta is None:
1723
 
                child_pb.update(gettext('Apply phase'), 0, 2)
 
1245
                child_pb.update('Apply phase', 0, 2)
1724
1246
                inventory_delta = self._generate_inventory_delta()
1725
1247
                offset = 1
1726
1248
            else:
1731
1253
            else:
1732
1254
                mover = _mover
1733
1255
            try:
1734
 
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
 
1256
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
1735
1257
                self._apply_removals(mover)
1736
 
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
 
1258
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
1737
1259
                modified_paths = self._apply_insertions(mover)
1738
1260
            except:
1739
1261
                mover.rollback()
1742
1264
                mover.apply_deletions()
1743
1265
        finally:
1744
1266
            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
1267
        self._tree.apply_inventory_delta(inventory_delta)
1748
 
        self._apply_observed_sha1s()
1749
1268
        self._done = True
1750
1269
        self.finalize()
1751
1270
        return _TransformResults(modified_paths, self.rename_count)
1753
1272
    def _generate_inventory_delta(self):
1754
1273
        """Generate an inventory delta for the current transform."""
1755
1274
        inventory_delta = []
1756
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1275
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1757
1276
        new_paths = self._inventory_altered()
1758
1277
        total_entries = len(new_paths) + len(self._removed_id)
1759
1278
        try:
1760
1279
            for num, trans_id in enumerate(self._removed_id):
1761
1280
                if (num % 10) == 0:
1762
 
                    child_pb.update(gettext('removing file'), num, total_entries)
 
1281
                    child_pb.update('removing file', num, total_entries)
1763
1282
                if trans_id == self._new_root:
1764
1283
                    file_id = self._tree.get_root_id()
1765
1284
                else:
1777
1296
            final_kinds = {}
1778
1297
            for num, (path, trans_id) in enumerate(new_paths):
1779
1298
                if (num % 10) == 0:
1780
 
                    child_pb.update(gettext('adding file'),
 
1299
                    child_pb.update('adding file',
1781
1300
                                    num + len(self._removed_id), total_entries)
1782
1301
                file_id = new_path_file_ids[trans_id]
1783
1302
                if file_id is None:
1784
1303
                    continue
1785
1304
                needs_entry = False
1786
 
                kind = self.final_kind(trans_id)
1787
 
                if kind is None:
 
1305
                try:
 
1306
                    kind = self.final_kind(trans_id)
 
1307
                except NoSuchFile:
1788
1308
                    kind = self._tree.stored_kind(file_id)
1789
1309
                parent_trans_id = self.final_parent(trans_id)
1790
1310
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1821
1341
        """
1822
1342
        tree_paths = list(self._tree_path_ids.iteritems())
1823
1343
        tree_paths.sort(reverse=True)
1824
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1344
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1825
1345
        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))
 
1346
            for num, data in enumerate(tree_paths):
 
1347
                path, trans_id = data
 
1348
                child_pb.update('removing file', num, len(tree_paths))
1831
1349
                full_path = self._tree.abspath(path)
1832
1350
                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):
 
1351
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1352
                                     trans_id))
 
1353
                elif trans_id in self._new_name or trans_id in \
 
1354
                    self._new_parent:
1837
1355
                    try:
1838
1356
                        mover.rename(full_path, self._limbo_name(trans_id))
1839
 
                    except errors.TransformRenameFailed, e:
 
1357
                    except OSError, e:
1840
1358
                        if e.errno != errno.ENOENT:
1841
1359
                            raise
1842
1360
                    else:
1858
1376
        modified_paths = []
1859
1377
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1860
1378
                                 new_paths)
1861
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1379
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1862
1380
        try:
1863
1381
            for num, (path, trans_id) in enumerate(new_paths):
1864
1382
                if (num % 10) == 0:
1865
 
                    child_pb.update(gettext('adding file'), num, len(new_paths))
 
1383
                    child_pb.update('adding file', num, len(new_paths))
1866
1384
                full_path = self._tree.abspath(path)
1867
1385
                if trans_id in self._needs_rename:
1868
1386
                    try:
1869
1387
                        mover.rename(self._limbo_name(trans_id), full_path)
1870
 
                    except errors.TransformRenameFailed, e:
 
1388
                    except OSError, e:
1871
1389
                        # We may be renaming a dangling inventory id
1872
1390
                        if e.errno != errno.ENOENT:
1873
1391
                            raise
1874
1392
                    else:
1875
1393
                        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
1394
                if (trans_id in self._new_contents or
1880
1395
                    self.path_changed(trans_id)):
1881
1396
                    if trans_id in self._new_contents:
1882
1397
                        modified_paths.append(full_path)
1883
1398
                if trans_id in self._new_executability:
1884
1399
                    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
1400
        finally:
1890
1401
            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
1402
        self._new_contents.clear()
1897
1403
        return modified_paths
1898
1404
 
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):
 
1405
 
 
1406
class TransformPreview(TreeTransformBase):
1924
1407
    """A TreeTransform for generating preview trees.
1925
1408
 
1926
1409
    Unlike TreeTransform, this version works when the input tree is a
1928
1411
    unversioned files in the input tree.
1929
1412
    """
1930
1413
 
1931
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1414
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1932
1415
        tree.lock_read()
1933
1416
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1934
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1417
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1935
1418
 
1936
1419
    def canonical_path(self, path):
1937
1420
        return path
1939
1422
    def tree_kind(self, trans_id):
1940
1423
        path = self._tree_id_paths.get(trans_id)
1941
1424
        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
 
1425
            raise NoSuchFile(None)
 
1426
        file_id = self._tree.path2id(path)
 
1427
        return self._tree.kind(file_id)
1947
1428
 
1948
1429
    def _set_mode(self, trans_id, mode_id, typefunc):
1949
1430
        """Set the mode of new file contents.
1969
1450
            childpath = joinpath(path, child)
1970
1451
            yield self.trans_id_tree_path(childpath)
1971
1452
 
1972
 
    def new_orphan(self, trans_id, parent_id):
1973
 
        raise NotImplementedError(self.new_orphan)
1974
 
 
1975
 
 
1976
 
class _PreviewTree(tree.InventoryTree):
 
1453
 
 
1454
class _PreviewTree(tree.Tree):
1977
1455
    """Partial implementation of Tree to support show_diff_trees"""
1978
1456
 
1979
1457
    def __init__(self, transform):
1984
1462
        self._all_children_cache = {}
1985
1463
        self._path2trans_id_cache = {}
1986
1464
        self._final_name_cache = {}
1987
 
        self._iter_changes_cache = dict((c[0], c) for c in
1988
 
                                        self._transform.iter_changes())
 
1465
 
 
1466
    def _changes(self, file_id):
 
1467
        for changes in self._transform.iter_changes():
 
1468
            if changes[0] == file_id:
 
1469
                return changes
1989
1470
 
1990
1471
    def _content_change(self, file_id):
1991
1472
        """Return True if the content of this file changed"""
1992
 
        changes = self._iter_changes_cache.get(file_id)
 
1473
        changes = self._changes(file_id)
1993
1474
        # changes[2] is true if the file content changed.  See
1994
1475
        # InterTree.iter_changes.
1995
1476
        return (changes is not None and changes[2])
2008
1489
                yield self._get_repository().revision_tree(revision_id)
2009
1490
 
2010
1491
    def _get_file_revision(self, file_id, vf, tree_revision):
2011
 
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
1492
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
2012
1493
                       self._iter_parent_trees()]
2013
1494
        vf.add_lines((file_id, tree_revision), parent_keys,
2014
 
                     self.get_file_lines(file_id))
 
1495
                     self.get_file(file_id).readlines())
2015
1496
        repo = self._get_repository()
2016
1497
        base_vf = repo.texts
2017
1498
        if base_vf not in vf.fallback_versionedfiles:
2018
1499
            vf.fallback_versionedfiles.append(base_vf)
2019
1500
        return tree_revision
2020
1501
 
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)
 
1502
    def _stat_limbo_file(self, file_id):
 
1503
        trans_id = self._transform.trans_id_file_id(file_id)
2024
1504
        name = self._transform._limbo_name(trans_id)
2025
1505
        return os.lstat(name)
2026
1506
 
2040
1520
            executable = self.is_executable(file_id, path)
2041
1521
        return kind, executable, None
2042
1522
 
2043
 
    def is_locked(self):
2044
 
        return False
2045
 
 
2046
1523
    def lock_read(self):
2047
1524
        # Perhaps in theory, this should lock the TreeTransform?
2048
 
        return self
 
1525
        pass
2049
1526
 
2050
1527
    def unlock(self):
2051
1528
        pass
2052
1529
 
2053
1530
    @property
2054
 
    @deprecated_method(deprecated_in((2, 5, 0)))
2055
1531
    def inventory(self):
2056
1532
        """This Tree does not use inventory as its backing data."""
2057
1533
        raise NotImplementedError(_PreviewTree.inventory)
2058
1534
 
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
1535
    def get_root_id(self):
2065
1536
        return self._transform.final_file_id(self._transform.root)
2066
1537
 
2074
1545
    def __iter__(self):
2075
1546
        return iter(self.all_file_ids())
2076
1547
 
2077
 
    def _has_id(self, file_id, fallback_check):
 
1548
    def has_id(self, file_id):
2078
1549
        if file_id in self._transform._r_new_id:
2079
1550
            return True
2080
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
2081
 
            trans_id in self._transform._removed_id]):
 
1551
        elif file_id in self._transform._removed_id:
2082
1552
            return False
2083
1553
        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)
 
1554
            return self._transform._tree.has_id(file_id)
2091
1555
 
2092
1556
    def _path2trans_id(self, path):
2093
1557
        # We must not use None here, because that is a valid value to store.
2112
1576
        return cur_parent
2113
1577
 
2114
1578
    def path2id(self, path):
2115
 
        if isinstance(path, list):
2116
 
            if path == []:
2117
 
                path = [""]
2118
 
            path = osutils.pathjoin(*path)
2119
1579
        return self._transform.final_file_id(self._path2trans_id(path))
2120
1580
 
2121
1581
    def id2path(self, file_id):
2150
1610
            if self._transform.final_file_id(trans_id) is None:
2151
1611
                yield self._final_paths._determine_path(trans_id)
2152
1612
 
2153
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2154
 
        yield_parents=False):
 
1613
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
2155
1614
        for trans_id, parent_file_id in ordered_entries:
2156
1615
            file_id = self._transform.final_file_id(trans_id)
2157
1616
            if file_id is None:
2159
1618
            if (specific_file_ids is not None
2160
1619
                and file_id not in specific_file_ids):
2161
1620
                continue
2162
 
            kind = self._transform.final_kind(trans_id)
2163
 
            if kind is None:
 
1621
            try:
 
1622
                kind = self._transform.final_kind(trans_id)
 
1623
            except NoSuchFile:
2164
1624
                kind = self._transform._tree.stored_kind(file_id)
2165
1625
            new_entry = inventory.make_entry(
2166
1626
                kind,
2182
1642
                ordered_ids.append((trans_id, parent_file_id))
2183
1643
        return ordered_ids
2184
1644
 
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):
 
1645
    def iter_entries_by_dir(self, specific_file_ids=None):
2194
1646
        # This may not be a maximally efficient implementation, but it is
2195
1647
        # reasonably straightforward.  An implementation that grafts the
2196
1648
        # TreeTransform changes onto the tree's iter_entries_by_dir results
2198
1650
        # position.
2199
1651
        ordered_ids = self._list_files_by_dir()
2200
1652
        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."""
 
1653
                                                      specific_file_ids):
 
1654
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1655
 
 
1656
    def list_files(self, include_root=False):
 
1657
        """See Tree.list_files."""
2216
1658
        # XXX This should behave like WorkingTree.list_files, but is really
2217
1659
        # 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
 
1660
        for path, entry in self.iter_entries_by_dir():
 
1661
            if entry.name == '' and not include_root:
 
1662
                continue
 
1663
            yield path, 'V', entry.kind, entry.file_id, entry
2239
1664
 
2240
1665
    def kind(self, file_id):
2241
1666
        trans_id = self._transform.trans_id_file_id(file_id)
2251
1676
    def get_file_mtime(self, file_id, path=None):
2252
1677
        """See Tree.get_file_mtime"""
2253
1678
        if not self._content_change(file_id):
2254
 
            return self._transform._tree.get_file_mtime(file_id)
 
1679
            return self._transform._tree.get_file_mtime(file_id, path)
2255
1680
        return self._stat_limbo_file(file_id).st_mtime
2256
1681
 
2257
1682
    def _file_size(self, entry, stat_value):
2259
1684
 
2260
1685
    def get_file_size(self, file_id):
2261
1686
        """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
1687
        if self.kind(file_id) == 'file':
2269
1688
            return self._transform._tree.get_file_size(file_id)
2270
1689
        else:
2271
1690
            return None
2272
1691
 
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
1692
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2286
1693
        trans_id = self._transform.trans_id_file_id(file_id)
2287
1694
        kind = self._transform._new_contents.get(trans_id)
2310
1717
            except errors.NoSuchId:
2311
1718
                return False
2312
1719
 
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)
2321
 
 
2322
1720
    def path_content_summary(self, path):
2323
1721
        trans_id = self._path2trans_id(path)
2324
1722
        tt = self._transform
2337
1735
            if kind == 'file':
2338
1736
                statval = os.lstat(limbo_name)
2339
1737
                size = statval.st_size
2340
 
                if not tt._limbo_supports_executable():
2341
 
                    executable = False
 
1738
                if not supports_executable():
 
1739
                    executable = None
2342
1740
                else:
2343
1741
                    executable = statval.st_mode & S_IEXEC
2344
1742
            else:
2345
1743
                size = None
2346
1744
                executable = None
2347
1745
            if kind == 'symlink':
2348
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2349
 
        executable = tt._new_executability.get(trans_id, executable)
 
1746
                link_or_sha1 = os.readlink(limbo_name)
 
1747
        if supports_executable():
 
1748
            executable = tt._new_executability.get(trans_id, executable)
2350
1749
        return kind, size, executable, link_or_sha1
2351
1750
 
2352
1751
    def iter_changes(self, from_tree, include_unchanged=False,
2378
1777
        name = self._transform._limbo_name(trans_id)
2379
1778
        return open(name, 'rb')
2380
1779
 
2381
 
    def get_file_with_stat(self, file_id, path=None):
2382
 
        return self.get_file(file_id, path), None
2383
 
 
2384
1780
    def annotate_iter(self, file_id,
2385
1781
                      default_revision=_mod_revision.CURRENT_REVISION):
2386
 
        changes = self._iter_changes_cache.get(file_id)
 
1782
        changes = self._changes(file_id)
2387
1783
        if changes is None:
2388
1784
            get_old = True
2389
1785
        else:
2401
1797
            return old_annotation
2402
1798
        if not changed_content:
2403
1799
            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
1800
        return annotate.reannotate([old_annotation],
2412
1801
                                   self.get_file(file_id).readlines(),
2413
1802
                                   default_revision)
2414
1803
 
2415
 
    def get_symlink_target(self, file_id, path=None):
 
1804
    def get_symlink_target(self, file_id):
2416
1805
        """See Tree.get_symlink_target"""
2417
1806
        if not self._content_change(file_id):
2418
1807
            return self._transform._tree.get_symlink_target(file_id)
2419
1808
        trans_id = self._transform.trans_id_file_id(file_id)
2420
1809
        name = self._transform._limbo_name(trans_id)
2421
 
        return osutils.readlink(name)
 
1810
        return os.readlink(name)
2422
1811
 
2423
1812
    def walkdirs(self, prefix=''):
2424
1813
        pending = [self._transform.root]
2433
1822
                path_from_root = self._final_paths.get_path(child_id)
2434
1823
                basename = self._transform.final_name(child_id)
2435
1824
                file_id = self._transform.final_file_id(child_id)
2436
 
                kind  = self._transform.final_kind(child_id)
2437
 
                if kind is not None:
 
1825
                try:
 
1826
                    kind = self._transform.final_kind(child_id)
2438
1827
                    versioned_kind = kind
2439
 
                else:
 
1828
                except NoSuchFile:
2440
1829
                    kind = 'unknown'
2441
1830
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2442
1831
                if versioned_kind == 'directory':
2479
1868
        self.transform = transform
2480
1869
 
2481
1870
    def _determine_path(self, trans_id):
2482
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1871
        if trans_id == self.transform.root:
2483
1872
            return ""
2484
1873
        name = self.transform.final_name(trans_id)
2485
1874
        parent_id = self.transform.final_parent(trans_id)
2509
1898
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2510
1899
               delta_from_tree=False):
2511
1900
    """Create working tree for a branch, using a TreeTransform.
2512
 
 
 
1901
    
2513
1902
    This function should be used on empty trees, having a tree root at most.
2514
1903
    (see merge and revert functionality for working with existing trees)
2515
1904
 
2516
1905
    Existing files are handled like so:
2517
 
 
 
1906
    
2518
1907
    - Existing bzrdirs take precedence over creating new items.  They are
2519
1908
      created as '%s.diverted' % name.
2520
1909
    - Otherwise, if the content on disk matches the content we are building,
2555
1944
    for num, _unused in enumerate(wt.all_file_ids()):
2556
1945
        if num > 0:  # more than just a root
2557
1946
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
1947
    existing_files = set()
 
1948
    for dir, files in wt.walkdirs():
 
1949
        existing_files.update(f[0] for f in files)
2558
1950
    file_trans_id = {}
2559
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
1951
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2560
1952
    pp = ProgressPhase("Build phase", 2, top_pb)
2561
 
    if tree.get_root_id() is not None:
 
1953
    if tree.inventory.root is not None:
2562
1954
        # This is kind of a hack: we should be altering the root
2563
1955
        # as part of the regular tree shape diff logic.
2564
1956
        # The conditional test here is to avoid doing an
2575
1967
        pp.next_phase()
2576
1968
        file_trans_id[wt.get_root_id()] = \
2577
1969
            tt.trans_id_tree_file_id(wt.get_root_id())
2578
 
        pb = ui.ui_factory.nested_progress_bar()
 
1970
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2579
1971
        try:
2580
1972
            deferred_contents = []
2581
1973
            num = 0
2582
 
            total = len(tree.all_file_ids())
 
1974
            total = len(tree.inventory)
2583
1975
            if delta_from_tree:
2584
1976
                precomputed_delta = []
2585
1977
            else:
2586
1978
                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
1979
            for num, (tree_path, entry) in \
2597
 
                enumerate(tree.iter_entries_by_dir()):
2598
 
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
 
1980
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1981
                pb.update("Building tree", num - len(deferred_contents), total)
2599
1982
                if entry.parent_id is None:
2600
1983
                    continue
2601
1984
                reparent = False
2607
1990
                    kind = file_kind(target_path)
2608
1991
                    if kind == "directory":
2609
1992
                        try:
2610
 
                            controldir.ControlDir.open(target_path)
 
1993
                            bzrdir.BzrDir.open(target_path)
2611
1994
                        except errors.NotBranchError:
2612
1995
                            pass
2613
1996
                        else:
2628
2011
                    executable = tree.is_executable(file_id, tree_path)
2629
2012
                    if executable:
2630
2013
                        tt.set_executability(executable, trans_id)
2631
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
2632
 
                    deferred_contents.append((file_id, trans_data))
 
2014
                    deferred_contents.append((file_id, trans_id))
2633
2015
                else:
2634
2016
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2635
2017
                                                          tree)
2650
2032
            precomputed_delta = None
2651
2033
        conflicts = cook_conflicts(raw_conflicts, tt)
2652
2034
        for conflict in conflicts:
2653
 
            trace.warning(unicode(conflict))
 
2035
            warning(conflict)
2654
2036
        try:
2655
2037
            wt.add_conflicts(conflicts)
2656
2038
        except errors.UnsupportedOperation:
2666
2048
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2667
2049
                  hardlink):
2668
2050
    total = len(desired_files) + offset
2669
 
    wt = tt._tree
2670
2051
    if accelerator_tree is None:
2671
2052
        new_desired_files = desired_files
2672
2053
    else:
2673
2054
        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)
 
2055
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
2056
                         in iter if not (c or e[0] != e[1]))
2680
2057
        new_desired_files = []
2681
2058
        count = 0
2682
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
2059
        for file_id, trans_id in desired_files:
2683
2060
            accelerator_path = unchanged.get(file_id)
2684
2061
            if accelerator_path is None:
2685
 
                new_desired_files.append((file_id,
2686
 
                    (trans_id, tree_path, text_sha1)))
 
2062
                new_desired_files.append((file_id, trans_id))
2687
2063
                continue
2688
 
            pb.update(gettext('Adding file contents'), count + offset, total)
 
2064
            pb.update('Adding file contents', count + offset, total)
2689
2065
            if hardlink:
2690
2066
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2691
2067
                                   trans_id)
2692
2068
            else:
2693
2069
                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
2070
                try:
2699
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2071
                    tt.create_file(contents, trans_id)
2700
2072
                finally:
2701
 
                    try:
2702
 
                        contents.close()
2703
 
                    except AttributeError:
2704
 
                        # after filtering, contents may no longer be file-like
2705
 
                        pass
 
2073
                    contents.close()
2706
2074
            count += 1
2707
2075
        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)
 
2076
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
2077
                                                 new_desired_files)):
 
2078
        tt.create_file(contents, trans_id)
 
2079
        pb.update('Adding file contents', count + offset, total)
2716
2080
 
2717
2081
 
2718
2082
def _reparent_children(tt, old_parent, new_parent):
2719
2083
    for child in tt.iter_tree_children(old_parent):
2720
2084
        tt.adjust_path(tt.final_name(child), new_parent, child)
2721
2085
 
2722
 
 
2723
2086
def _reparent_transform_children(tt, old_parent, new_parent):
2724
2087
    by_parent = tt.by_parent()
2725
2088
    for child in by_parent[old_parent]:
2726
2089
        tt.adjust_path(tt.final_name(child), new_parent, child)
2727
2090
    return by_parent[old_parent]
2728
2091
 
2729
 
 
2730
2092
def _content_match(tree, entry, file_id, kind, target_path):
2731
2093
    if entry.kind != kind:
2732
2094
        return False
2733
2095
    if entry.kind == "directory":
2734
2096
        return True
2735
2097
    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()
 
2098
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
2099
            return True
2742
2100
    elif entry.kind == "symlink":
2743
2101
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2744
2102
            return True
2782
2140
    if kind == 'file':
2783
2141
        contents = tree.get_file(entry.file_id).readlines()
2784
2142
        executable = tree.is_executable(entry.file_id)
2785
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
2143
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2786
2144
                           executable)
2787
2145
    elif kind in ('directory', 'tree-reference'):
2788
2146
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2789
2147
        if kind == 'tree-reference':
2790
2148
            tt.set_tree_reference(entry.reference_revision, trans_id)
2791
 
        return trans_id
 
2149
        return trans_id 
2792
2150
    elif kind == 'symlink':
2793
2151
        target = tree.get_symlink_target(entry.file_id)
2794
2152
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2796
2154
        raise errors.BadFileKindError(name, kind)
2797
2155
 
2798
2156
 
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.
 
2157
@deprecated_function(deprecated_in((1, 9, 0)))
 
2158
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
2159
    """Create new file contents according to an inventory entry.
 
2160
 
 
2161
    DEPRECATED.  Use create_from_tree instead.
2806
2162
    """
 
2163
    if entry.kind == "file":
 
2164
        if lines is None:
 
2165
            lines = tree.get_file(entry.file_id).readlines()
 
2166
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
2167
    elif entry.kind == "symlink":
 
2168
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
2169
    elif entry.kind == "directory":
 
2170
        tt.create_directory(trans_id)
 
2171
 
 
2172
 
 
2173
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
 
2174
    """Create new file contents according to tree contents."""
2807
2175
    kind = tree.kind(file_id)
2808
2176
    if kind == 'directory':
2809
2177
        tt.create_directory(trans_id)
2814
2182
                bytes = tree_file.readlines()
2815
2183
            finally:
2816
2184
                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
2185
        tt.create_file(bytes, trans_id)
2823
2186
    elif kind == "symlink":
2824
2187
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2832
2195
        tt.set_executability(entry.executable, trans_id)
2833
2196
 
2834
2197
 
 
2198
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
2199
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
2200
 
 
2201
 
 
2202
def _get_backup_name(name, by_parent, parent_trans_id, tt):
 
2203
    """Produce a backup-style name that appears to be available"""
 
2204
    def name_gen():
 
2205
        counter = 1
 
2206
        while True:
 
2207
            yield "%s.~%d~" % (name, counter)
 
2208
            counter += 1
 
2209
    for new_name in name_gen():
 
2210
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
2211
            return new_name
 
2212
 
 
2213
 
 
2214
def _entry_changes(file_id, entry, working_tree):
 
2215
    """Determine in which ways the inventory entry has changed.
 
2216
 
 
2217
    Returns booleans: has_contents, content_mod, meta_mod
 
2218
    has_contents means there are currently contents, but they differ
 
2219
    contents_mod means contents need to be modified
 
2220
    meta_mod means the metadata needs to be modified
 
2221
    """
 
2222
    cur_entry = working_tree.inventory[file_id]
 
2223
    try:
 
2224
        working_kind = working_tree.kind(file_id)
 
2225
        has_contents = True
 
2226
    except NoSuchFile:
 
2227
        has_contents = False
 
2228
        contents_mod = True
 
2229
        meta_mod = False
 
2230
    if has_contents is True:
 
2231
        if entry.kind != working_kind:
 
2232
            contents_mod, meta_mod = True, False
 
2233
        else:
 
2234
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2235
                                       working_tree)
 
2236
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
 
2237
            cur_entry._forget_tree_state()
 
2238
    return has_contents, contents_mod, meta_mod
 
2239
 
 
2240
 
2835
2241
def revert(working_tree, target_tree, filenames, backups=False,
2836
 
           pb=None, change_reporter=None):
 
2242
           pb=DummyProgress(), change_reporter=None):
2837
2243
    """Revert a working tree's contents to those of a target tree."""
2838
2244
    target_tree.lock_read()
2839
 
    pb = ui.ui_factory.nested_progress_bar()
2840
2245
    tt = TreeTransform(working_tree, pb)
2841
2246
    try:
2842
2247
        pp = ProgressPhase("Revert phase", 3, pb)
2847
2252
                unversioned_filter=working_tree.is_ignored)
2848
2253
            delta.report_changes(tt.iter_changes(), change_reporter)
2849
2254
        for conflict in conflicts:
2850
 
            trace.warning(unicode(conflict))
 
2255
            warning(conflict)
2851
2256
        pp.next_phase()
2852
2257
        tt.apply()
2853
2258
        working_tree.set_merge_modified(merge_modified)
2861
2266
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2862
2267
                              backups, pp, basis_tree=None,
2863
2268
                              merge_modified=None):
2864
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2269
    pp.next_phase()
 
2270
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2865
2271
    try:
2866
2272
        if merge_modified is None:
2867
2273
            merge_modified = working_tree.merge_modified()
2870
2276
                                      merge_modified, basis_tree)
2871
2277
    finally:
2872
2278
        child_pb.finished()
2873
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2279
    pp.next_phase()
 
2280
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2874
2281
    try:
2875
2282
        raw_conflicts = resolve_conflicts(tt, child_pb,
2876
2283
            lambda t, c: conflict_pass(t, c, target_tree))
2884
2291
                 backups, merge_modified, basis_tree=None):
2885
2292
    if basis_tree is not None:
2886
2293
        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,
 
2294
    change_list = target_tree.iter_changes(working_tree,
2892
2295
        specific_files=specific_files, pb=pb)
2893
2296
    if target_tree.get_root_id() is None:
2894
2297
        skip_root = True
2898
2301
        deferred_files = []
2899
2302
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2900
2303
                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:
 
2304
            if skip_root and file_id[0] is not None and parent[0] is None:
2908
2305
                continue
2909
2306
            trans_id = tt.trans_id_file_id(file_id)
2910
2307
            mode_id = None
2911
2308
            if changed_content:
2912
2309
                keep_content = False
2913
 
                if wt_kind == 'file' and (backups or target_kind is None):
 
2310
                if kind[0] == 'file' and (backups or kind[1] is None):
2914
2311
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2915
2312
                    if merge_modified.get(file_id) != wt_sha1:
2916
2313
                        # acquire the basis tree lazily to prevent the
2919
2316
                        if basis_tree is None:
2920
2317
                            basis_tree = working_tree.basis_tree()
2921
2318
                            basis_tree.lock_read()
2922
 
                        if basis_tree.has_id(file_id):
 
2319
                        if file_id in basis_tree:
2923
2320
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2924
2321
                                keep_content = True
2925
 
                        elif target_kind is None and not target_versioned:
 
2322
                        elif kind[1] is None and not versioned[1]:
2926
2323
                            keep_content = True
2927
 
                if wt_kind is not None:
 
2324
                if kind[0] is not None:
2928
2325
                    if not keep_content:
2929
2326
                        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)
 
2327
                    elif kind[1] is not None:
 
2328
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2329
                        by_parent = tt.by_parent()
 
2330
                        backup_name = _get_backup_name(name[0], by_parent,
 
2331
                                                       parent_trans_id, tt)
2934
2332
                        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:
 
2333
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2334
                        if versioned == (True, True):
2937
2335
                            tt.unversion_file(trans_id)
2938
2336
                            tt.version_file(file_id, new_trans_id)
2939
2337
                        # New contents should have the same unix perms as old
2940
2338
                        # contents
2941
2339
                        mode_id = trans_id
2942
2340
                        trans_id = new_trans_id
2943
 
                if target_kind in ('directory', 'tree-reference'):
 
2341
                if kind[1] in ('directory', 'tree-reference'):
2944
2342
                    tt.create_directory(trans_id)
2945
 
                    if target_kind == 'tree-reference':
 
2343
                    if kind[1] == 'tree-reference':
2946
2344
                        revision = target_tree.get_reference_revision(file_id,
2947
 
                                                                      target_path)
 
2345
                                                                      path[1])
2948
2346
                        tt.set_tree_reference(revision, trans_id)
2949
 
                elif target_kind == 'symlink':
 
2347
                elif kind[1] == 'symlink':
2950
2348
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2951
2349
                                      trans_id)
2952
 
                elif target_kind == 'file':
 
2350
                elif kind[1] == 'file':
2953
2351
                    deferred_files.append((file_id, (trans_id, mode_id)))
2954
2352
                    if basis_tree is None:
2955
2353
                        basis_tree = working_tree.basis_tree()
2956
2354
                        basis_tree.lock_read()
2957
2355
                    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)):
 
2356
                    if (file_id in basis_tree and new_sha1 ==
 
2357
                        basis_tree.get_file_sha1(file_id)):
2960
2358
                        if file_id in merge_modified:
2961
2359
                            del merge_modified[file_id]
2962
2360
                    else:
2963
2361
                        merge_modified[file_id] = new_sha1
2964
2362
 
2965
2363
                    # 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:
 
2364
                    if keep_content and executable[0] == executable[1]:
 
2365
                        tt.set_executability(executable[1], trans_id)
 
2366
                elif kind[1] is not None:
 
2367
                    raise AssertionError(kind[1])
 
2368
            if versioned == (False, True):
2971
2369
                tt.version_file(file_id, trans_id)
2972
 
            if wt_versioned and not target_versioned:
 
2370
            if versioned == (True, False):
2973
2371
                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:
 
2372
            if (name[1] is not None and
 
2373
                (name[0] != name[1] or parent[0] != parent[1])):
 
2374
                if name[1] == '' and parent[1] is None:
2977
2375
                    parent_trans = ROOT_PARENT
2978
2376
                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()
 
2377
                    parent_trans = tt.trans_id_file_id(parent[1])
 
2378
                tt.adjust_path(name[1], parent_trans, trans_id)
 
2379
            if executable[0] != executable[1] and kind[1] == "file":
 
2380
                tt.set_executability(executable[1], trans_id)
 
2381
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2382
            deferred_files):
 
2383
            tt.create_file(bytes, trans_id, mode_id)
3003
2384
    finally:
3004
2385
        if basis_tree is not None:
3005
2386
            basis_tree.unlock()
3006
2387
    return merge_modified
3007
2388
 
3008
2389
 
3009
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2390
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3010
2391
    """Make many conflict-resolution attempts, but die if they fail"""
3011
2392
    if pass_func is None:
3012
2393
        pass_func = conflict_pass
3013
2394
    new_conflicts = set()
3014
 
    pb = ui.ui_factory.nested_progress_bar()
3015
2395
    try:
3016
2396
        for n in range(10):
3017
 
            pb.update(gettext('Resolution pass'), n+1, 10)
 
2397
            pb.update('Resolution pass', n+1, 10)
3018
2398
            conflicts = tt.find_conflicts()
3019
2399
            if len(conflicts) == 0:
3020
2400
                return new_conflicts
3021
2401
            new_conflicts.update(pass_func(tt, conflicts))
3022
2402
        raise MalformedTransform(conflicts=conflicts)
3023
2403
    finally:
3024
 
        pb.finished()
 
2404
        pb.clear()
3025
2405
 
3026
2406
 
3027
2407
def conflict_pass(tt, conflicts, path_tree=None):
3044
2424
                existing_file, new_file = conflict[2], conflict[1]
3045
2425
            else:
3046
2426
                existing_file, new_file = conflict[1], conflict[2]
3047
 
            new_name = tt.final_name(existing_file) + '.moved'
 
2427
            new_name = tt.final_name(existing_file)+'.moved'
3048
2428
            tt.adjust_path(new_name, final_parent, existing_file)
3049
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2429
            new_conflicts.add((c_type, 'Moved existing file to', 
3050
2430
                               existing_file, new_file))
3051
2431
        elif c_type == 'parent loop':
3052
2432
            # break the loop by undoing one of the ops that caused the loop
3056
2436
            new_conflicts.add((c_type, 'Cancelled move', cur,
3057
2437
                               tt.final_parent(cur),))
3058
2438
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3059
 
 
 
2439
            
3060
2440
        elif c_type == 'missing parent':
3061
2441
            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:
 
2442
            try:
 
2443
                tt.cancel_deletion(trans_id)
 
2444
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2445
                                   trans_id))
 
2446
            except KeyError:
3086
2447
                create = True
3087
2448
                try:
3088
2449
                    tt.final_name(trans_id)
3091
2452
                        file_id = tt.final_file_id(trans_id)
3092
2453
                        if file_id is None:
3093
2454
                            file_id = tt.inactive_file_id(trans_id)
3094
 
                        _, entry = path_tree.iter_entries_by_dir(
3095
 
                            [file_id]).next()
 
2455
                        entry = path_tree.inventory[file_id]
3096
2456
                        # special-case the other tree root (move its
3097
2457
                        # children to current root)
3098
2458
                        if entry.parent_id is None:
3099
 
                            create = False
 
2459
                            create=False
3100
2460
                            moved = _reparent_transform_children(
3101
2461
                                tt, trans_id, tt.root)
3102
2462
                            for child in moved:
3113
2473
        elif c_type == 'unversioned parent':
3114
2474
            file_id = tt.inactive_file_id(conflict[1])
3115
2475
            # 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
 
2476
            if path_tree and file_id in path_tree:
 
2477
                if path_tree.inventory[file_id].parent_id is None:
3119
2478
                    continue
3120
2479
            tt.version_file(file_id, conflict[1])
3121
2480
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3137
2496
 
3138
2497
def cook_conflicts(raw_conflicts, tt):
3139
2498
    """Generate a list of cooked conflicts, sorted by file path"""
 
2499
    from bzrlib.conflicts import Conflict
3140
2500
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3141
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
2501
    return sorted(conflict_iter, key=Conflict.sort_key)
3142
2502
 
3143
2503
 
3144
2504
def iter_cook_conflicts(raw_conflicts, tt):
 
2505
    from bzrlib.conflicts import Conflict
3145
2506
    fp = FinalPaths(tt)
3146
2507
    for conflict in raw_conflicts:
3147
2508
        c_type = conflict[0]
3149
2510
        modified_path = fp.get_path(conflict[2])
3150
2511
        modified_id = tt.final_file_id(conflict[2])
3151
2512
        if len(conflict) == 3:
3152
 
            yield conflicts.Conflict.factory(
3153
 
                c_type, action=action, path=modified_path, file_id=modified_id)
3154
 
 
 
2513
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2514
                                     file_id=modified_id)
 
2515
             
3155
2516
        else:
3156
2517
            conflicting_path = fp.get_path(conflict[3])
3157
2518
            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)
 
2519
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2520
                                   file_id=modified_id, 
 
2521
                                   conflict_path=conflicting_path,
 
2522
                                   conflict_file_id=conflicting_id)
3163
2523
 
3164
2524
 
3165
2525
class _FileMover(object):
3170
2530
        self.pending_deletions = []
3171
2531
 
3172
2532
    def rename(self, from_, to):
3173
 
        """Rename a file from one path to another."""
 
2533
        """Rename a file from one path to another.  Functions like os.rename"""
3174
2534
        try:
3175
2535
            os.rename(from_, to)
3176
2536
        except OSError, e:
3177
2537
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3178
2538
                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)
 
2539
            raise
3182
2540
        self.past_renames.append((from_, to))
3183
2541
 
3184
2542
    def pre_delete(self, from_, to):
3194
2552
    def rollback(self):
3195
2553
        """Reverse all renames that have been performed"""
3196
2554
        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)
 
2555
            os.rename(to, from_)
3201
2556
        # after rollback, don't reuse _FileMover
3202
2557
        past_renames = None
3203
2558
        pending_deletions = None