← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: John Arbash Meinel
  • Date: 2011-09-26 12:12:40 UTC
  • mto: This revision was merged to the branch mainline in revision 6170.
  • Revision ID: john@arbash-meinel.com-20110926121240-vdlz94tgi2i6py0f
Jelmer caught that getsignal() only takes one parameter.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006-2011 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
import os
18
18
import errno
19
 
from stat import S_ISREG
 
19
from stat import S_ISREG, S_IEXEC
 
20
import time
20
21
 
21
 
from bzrlib import bzrdir, errors
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
from bzrlib import delta
 
22
from bzrlib import (
 
23
    errors,
 
24
    lazy_import,
 
25
    registry,
 
26
    trace,
 
27
    tree,
 
28
    )
 
29
lazy_import.lazy_import(globals(), """
 
30
from bzrlib import (
 
31
    annotate,
 
32
    bencode,
 
33
    bzrdir,
 
34
    commit,
 
35
    conflicts,
 
36
    delta,
 
37
    errors,
 
38
    inventory,
 
39
    multiparent,
 
40
    osutils,
 
41
    revision as _mod_revision,
 
42
    ui,
 
43
    urlutils,
 
44
    )
 
45
from bzrlib.i18n import gettext
25
46
""")
26
47
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
27
 
                           ReusingTransform, NotVersionedError, CantMoveRoot,
28
 
                           ExistingLimbo, ImmortalLimbo, NoFinalPath)
29
 
from bzrlib.inventory import InventoryEntry
30
 
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
31
 
                            delete_any)
32
 
from bzrlib.progress import DummyProgress, ProgressPhase
33
 
from bzrlib.trace import mutter, warning
34
 
from bzrlib import tree
35
 
import bzrlib.ui 
36
 
import bzrlib.urlutils as urlutils
 
48
                           ReusingTransform, CantMoveRoot,
 
49
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
 
50
                           UnableCreateSymlink)
 
51
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
 
52
from bzrlib.osutils import (
 
53
    delete_any,
 
54
    file_kind,
 
55
    has_symlinks,
 
56
    pathjoin,
 
57
    sha_file,
 
58
    splitpath,
 
59
    supports_executable,
 
60
    )
 
61
from bzrlib.progress import ProgressPhase
 
62
from bzrlib.symbol_versioning import (
 
63
    deprecated_function,
 
64
    deprecated_in,
 
65
    deprecated_method,
 
66
    )
37
67
 
38
68
 
39
69
ROOT_PARENT = "root-parent"
40
70
 
41
 
 
42
71
def unique_add(map, key, value):
43
72
    if key in map:
44
73
        raise DuplicateKey(key=key)
45
74
    map[key] = value
46
75
 
47
76
 
 
77
 
48
78
class _TransformResults(object):
49
 
    def __init__(self, modified_paths):
 
79
    def __init__(self, modified_paths, rename_count):
50
80
        object.__init__(self)
51
81
        self.modified_paths = modified_paths
52
 
 
53
 
 
54
 
class TreeTransform(object):
55
 
    """Represent a tree transformation.
56
 
    
57
 
    This object is designed to support incremental generation of the transform,
58
 
    in any order.  
59
 
    
60
 
    It is easy to produce malformed transforms, but they are generally
61
 
    harmless.  Attempting to apply a malformed transform will cause an
62
 
    exception to be raised before any modifications are made to the tree.  
63
 
 
64
 
    Many kinds of malformed transforms can be corrected with the 
65
 
    resolve_conflicts function.  The remaining ones indicate programming error,
66
 
    such as trying to create a file with no path.
67
 
 
68
 
    Two sets of file creation methods are supplied.  Convenience methods are:
69
 
     * new_file
70
 
     * new_directory
71
 
     * new_symlink
72
 
 
73
 
    These are composed of the low-level methods:
74
 
     * create_path
75
 
     * create_file or create_directory or create_symlink
76
 
     * version_file
77
 
     * set_executability
78
 
    """
79
 
    def __init__(self, tree, pb=DummyProgress()):
80
 
        """Note: a tree_write lock is taken on the tree.
81
 
        
82
 
        Use TreeTransform.finalize() to release the lock
 
82
        self.rename_count = rename_count
 
83
 
 
84
 
 
85
class TreeTransformBase(object):
 
86
    """The base class for TreeTransform and its kin."""
 
87
 
 
88
    def __init__(self, tree, pb=None,
 
89
                 case_sensitive=True):
 
90
        """Constructor.
 
91
 
 
92
        :param tree: The tree that will be transformed, but not necessarily
 
93
            the output tree.
 
94
        :param pb: ignored
 
95
        :param case_sensitive: If True, the target of the transform is
 
96
            case sensitive, not just case preserving.
83
97
        """
84
98
        object.__init__(self)
85
99
        self._tree = tree
86
 
        self._tree.lock_tree_write()
87
 
        try:
88
 
            control_files = self._tree._control_files
89
 
            self._limbodir = urlutils.local_path_from_url(
90
 
                control_files.controlfilename('limbo'))
91
 
            try:
92
 
                os.mkdir(self._limbodir)
93
 
            except OSError, e:
94
 
                if e.errno == errno.EEXIST:
95
 
                    raise ExistingLimbo(self._limbodir)
96
 
        except: 
97
 
            self._tree.unlock()
98
 
            raise
99
 
 
100
100
        self._id_number = 0
 
101
        # mapping of trans_id -> new basename
101
102
        self._new_name = {}
 
103
        # mapping of trans_id -> new parent trans_id
102
104
        self._new_parent = {}
 
105
        # mapping of trans_id with new contents -> new file_kind
103
106
        self._new_contents = {}
 
107
        # mapping of trans_id => (sha1 of content, stat_value)
 
108
        self._observed_sha1s = {}
 
109
        # Set of trans_ids whose contents will be removed
104
110
        self._removed_contents = set()
 
111
        # Mapping of trans_id -> new execute-bit value
105
112
        self._new_executability = {}
 
113
        # Mapping of trans_id -> new tree-reference value
 
114
        self._new_reference_revision = {}
 
115
        # Mapping of trans_id -> new file_id
106
116
        self._new_id = {}
 
117
        # Mapping of old file-id -> trans_id
107
118
        self._non_present_ids = {}
 
119
        # Mapping of new file_id -> trans_id
108
120
        self._r_new_id = {}
 
121
        # Set of trans_ids that will be removed
109
122
        self._removed_id = set()
 
123
        # Mapping of path in old tree -> trans_id
110
124
        self._tree_path_ids = {}
 
125
        # Mapping trans_id -> path in old tree
111
126
        self._tree_id_paths = {}
112
 
        self._realpaths = {}
113
 
        # Cache of realpath results, to speed up canonical_path
114
 
        self._relpaths = {}
115
 
        # Cache of relpath results, to speed up canonical_path
116
 
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
117
 
        self.__done = False
 
127
        # The trans_id that will be used as the tree root
 
128
        root_id = tree.get_root_id()
 
129
        if root_id is not None:
 
130
            self._new_root = self.trans_id_tree_file_id(root_id)
 
131
        else:
 
132
            self._new_root = None
 
133
        # Indicator of whether the transform has been applied
 
134
        self._done = False
 
135
        # A progress bar
118
136
        self._pb = pb
 
137
        # Whether the target is case sensitive
 
138
        self._case_sensitive_target = case_sensitive
 
139
        # A counter of how many files have been renamed
 
140
        self.rename_count = 0
 
141
 
 
142
    def __enter__(self):
 
143
        """Support Context Manager API."""
 
144
        return self
 
145
 
 
146
    def __exit__(self, exc_type, exc_val, exc_tb):
 
147
        """Support Context Manager API."""
 
148
        self.finalize()
 
149
 
 
150
    def finalize(self):
 
151
        """Release the working tree lock, if held.
 
152
 
 
153
        This is required if apply has not been invoked, but can be invoked
 
154
        even after apply.
 
155
        """
 
156
        if self._tree is None:
 
157
            return
 
158
        self._tree.unlock()
 
159
        self._tree = None
119
160
 
120
161
    def __get_root(self):
121
162
        return self._new_root
122
163
 
123
164
    root = property(__get_root)
124
165
 
125
 
    def finalize(self):
126
 
        """Release the working tree lock, if held, clean up limbo dir."""
127
 
        if self._tree is None:
128
 
            return
129
 
        try:
130
 
            for trans_id, kind in self._new_contents.iteritems():
131
 
                path = self._limbo_name(trans_id)
132
 
                if kind == "directory":
133
 
                    os.rmdir(path)
134
 
                else:
135
 
                    os.unlink(path)
136
 
            try:
137
 
                os.rmdir(self._limbodir)
138
 
            except OSError:
139
 
                # We don't especially care *why* the dir is immortal.
140
 
                raise ImmortalLimbo(self._limbodir)
141
 
        finally:
142
 
            self._tree.unlock()
143
 
            self._tree = None
144
 
 
145
166
    def _assign_id(self):
146
167
        """Produce a new tranform id"""
147
168
        new_id = "new-%s" % self._id_number
157
178
 
158
179
    def adjust_path(self, name, parent, trans_id):
159
180
        """Change the path that is assigned to a transaction id."""
 
181
        if parent is None:
 
182
            raise ValueError("Parent trans-id may not be None")
160
183
        if trans_id == self._new_root:
161
184
            raise CantMoveRoot
162
185
        self._new_name[trans_id] = name
164
187
 
165
188
    def adjust_root_path(self, name, parent):
166
189
        """Emulate moving the root by moving all children, instead.
167
 
        
 
190
 
168
191
        We do this by undoing the association of root's transaction id with the
169
192
        current tree.  This allows us to create a new directory with that
170
 
        transaction id.  We unversion the root directory and version the 
 
193
        transaction id.  We unversion the root directory and version the
171
194
        physically new directory, and hope someone versions the tree root
172
195
        later.
173
196
        """
176
199
        # force moving all children of root
177
200
        for child_id in self.iter_tree_children(old_root):
178
201
            if child_id != parent:
179
 
                self.adjust_path(self.final_name(child_id), 
 
202
                self.adjust_path(self.final_name(child_id),
180
203
                                 self.final_parent(child_id), child_id)
181
204
            file_id = self.final_file_id(child_id)
182
205
            if file_id is not None:
183
206
                self.unversion_file(child_id)
184
207
            self.version_file(file_id, child_id)
185
 
        
 
208
 
186
209
        # the physical root needs a new transaction id
187
210
        self._tree_path_ids.pop("")
188
211
        self._tree_id_paths.pop(old_root)
194
217
        self.version_file(old_root_file_id, old_root)
195
218
        self.unversion_file(self._new_root)
196
219
 
 
220
    def fixup_new_roots(self):
 
221
        """Reinterpret requests to change the root directory
 
222
 
 
223
        Instead of creating a root directory, or moving an existing directory,
 
224
        all the attributes and children of the new root are applied to the
 
225
        existing root directory.
 
226
 
 
227
        This means that the old root trans-id becomes obsolete, so it is
 
228
        recommended only to invoke this after the root trans-id has become
 
229
        irrelevant.
 
230
 
 
231
        """
 
232
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
 
233
                     ROOT_PARENT]
 
234
        if len(new_roots) < 1:
 
235
            return
 
236
        if len(new_roots) != 1:
 
237
            raise ValueError('A tree cannot have two roots!')
 
238
        if self._new_root is None:
 
239
            self._new_root = new_roots[0]
 
240
            return
 
241
        old_new_root = new_roots[0]
 
242
        # unversion the new root's directory.
 
243
        if self.final_kind(self._new_root) is None:
 
244
            file_id = self.final_file_id(old_new_root)
 
245
        else:
 
246
            file_id = self.final_file_id(self._new_root)
 
247
        if old_new_root in self._new_id:
 
248
            self.cancel_versioning(old_new_root)
 
249
        else:
 
250
            self.unversion_file(old_new_root)
 
251
        # if, at this stage, root still has an old file_id, zap it so we can
 
252
        # stick a new one in.
 
253
        if (self.tree_file_id(self._new_root) is not None and
 
254
            self._new_root not in self._removed_id):
 
255
            self.unversion_file(self._new_root)
 
256
        if file_id is not None:
 
257
            self.version_file(file_id, self._new_root)
 
258
 
 
259
        # Now move children of new root into old root directory.
 
260
        # Ensure all children are registered with the transaction, but don't
 
261
        # use directly-- some tree children have new parents
 
262
        list(self.iter_tree_children(old_new_root))
 
263
        # Move all children of new root into old root directory.
 
264
        for child in self.by_parent().get(old_new_root, []):
 
265
            self.adjust_path(self.final_name(child), self._new_root, child)
 
266
 
 
267
        # Ensure old_new_root has no directory.
 
268
        if old_new_root in self._new_contents:
 
269
            self.cancel_creation(old_new_root)
 
270
        else:
 
271
            self.delete_contents(old_new_root)
 
272
 
 
273
        # prevent deletion of root directory.
 
274
        if self._new_root in self._removed_contents:
 
275
            self.cancel_deletion(self._new_root)
 
276
 
 
277
        # destroy path info for old_new_root.
 
278
        del self._new_parent[old_new_root]
 
279
        del self._new_name[old_new_root]
 
280
 
197
281
    def trans_id_tree_file_id(self, inventory_id):
198
282
        """Determine the transaction id of a working tree file.
199
 
        
 
283
 
200
284
        This reflects only files that already exist, not ones that will be
201
285
        added by transactions.
202
286
        """
203
 
        path = self._tree.inventory.id2path(inventory_id)
 
287
        if inventory_id is None:
 
288
            raise ValueError('None is not a valid file id')
 
289
        path = self._tree.id2path(inventory_id)
204
290
        return self.trans_id_tree_path(path)
205
291
 
206
292
    def trans_id_file_id(self, file_id):
209
295
        a transaction has been unversioned, it is deliberately still returned.
210
296
        (this will likely lead to an unversioned parent conflict.)
211
297
        """
 
298
        if file_id is None:
 
299
            raise ValueError('None is not a valid file id')
212
300
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
213
301
            return self._r_new_id[file_id]
214
 
        elif file_id in self._tree.inventory:
215
 
            return self.trans_id_tree_file_id(file_id)
216
 
        elif file_id in self._non_present_ids:
217
 
            return self._non_present_ids[file_id]
218
 
        else:
219
 
            trans_id = self._assign_id()
220
 
            self._non_present_ids[file_id] = trans_id
221
 
            return trans_id
222
 
 
223
 
    def canonical_path(self, path):
224
 
        """Get the canonical tree-relative path"""
225
 
        # don't follow final symlinks
226
 
        abs = self._tree.abspath(path)
227
 
        if abs in self._relpaths:
228
 
            return self._relpaths[abs]
229
 
        dirname, basename = os.path.split(abs)
230
 
        if dirname not in self._realpaths:
231
 
            self._realpaths[dirname] = os.path.realpath(dirname)
232
 
        dirname = self._realpaths[dirname]
233
 
        abs = pathjoin(dirname, basename)
234
 
        if dirname in self._relpaths:
235
 
            relpath = pathjoin(self._relpaths[dirname], basename)
236
 
            relpath = relpath.rstrip('/\\')
237
 
        else:
238
 
            relpath = self._tree.relpath(abs)
239
 
        self._relpaths[abs] = relpath
240
 
        return relpath
 
302
        else:
 
303
            try:
 
304
                self._tree.iter_entries_by_dir([file_id]).next()
 
305
            except StopIteration:
 
306
                if file_id in self._non_present_ids:
 
307
                    return self._non_present_ids[file_id]
 
308
                else:
 
309
                    trans_id = self._assign_id()
 
310
                    self._non_present_ids[file_id] = trans_id
 
311
                    return trans_id
 
312
            else:
 
313
                return self.trans_id_tree_file_id(file_id)
241
314
 
242
315
    def trans_id_tree_path(self, path):
243
316
        """Determine (and maybe set) the transaction ID for a tree path."""
254
327
            return ROOT_PARENT
255
328
        return self.trans_id_tree_path(os.path.dirname(path))
256
329
 
257
 
    def create_file(self, contents, trans_id, mode_id=None):
258
 
        """Schedule creation of a new file.
259
 
 
260
 
        See also new_file.
261
 
        
262
 
        Contents is an iterator of strings, all of which will be written
263
 
        to the target destination.
264
 
 
265
 
        New file takes the permissions of any existing file with that id,
266
 
        unless mode_id is specified.
267
 
        """
268
 
        name = self._limbo_name(trans_id)
269
 
        f = open(name, 'wb')
270
 
        try:
271
 
            try:
272
 
                unique_add(self._new_contents, trans_id, 'file')
273
 
            except:
274
 
                # Clean up the file, it never got registered so
275
 
                # TreeTransform.finalize() won't clean it up.
276
 
                f.close()
277
 
                os.unlink(name)
278
 
                raise
279
 
 
280
 
            f.writelines(contents)
281
 
        finally:
282
 
            f.close()
283
 
        self._set_mode(trans_id, mode_id, S_ISREG)
284
 
 
285
 
    def _set_mode(self, trans_id, mode_id, typefunc):
286
 
        """Set the mode of new file contents.
287
 
        The mode_id is the existing file to get the mode from (often the same
288
 
        as trans_id).  The operation is only performed if there's a mode match
289
 
        according to typefunc.
290
 
        """
291
 
        if mode_id is None:
292
 
            mode_id = trans_id
293
 
        try:
294
 
            old_path = self._tree_id_paths[mode_id]
295
 
        except KeyError:
296
 
            return
297
 
        try:
298
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
299
 
        except OSError, e:
300
 
            if e.errno == errno.ENOENT:
301
 
                return
302
 
            else:
303
 
                raise
304
 
        if typefunc(mode):
305
 
            os.chmod(self._limbo_name(trans_id), mode)
306
 
 
307
 
    def create_directory(self, trans_id):
308
 
        """Schedule creation of a new directory.
309
 
        
310
 
        See also new_directory.
311
 
        """
312
 
        os.mkdir(self._limbo_name(trans_id))
313
 
        unique_add(self._new_contents, trans_id, 'directory')
314
 
 
315
 
    def create_symlink(self, target, trans_id):
316
 
        """Schedule creation of a new symbolic link.
317
 
 
318
 
        target is a bytestring.
319
 
        See also new_symlink.
320
 
        """
321
 
        os.symlink(target, self._limbo_name(trans_id))
322
 
        unique_add(self._new_contents, trans_id, 'symlink')
323
 
 
324
 
    def cancel_creation(self, trans_id):
325
 
        """Cancel the creation of new file contents."""
326
 
        del self._new_contents[trans_id]
327
 
        delete_any(self._limbo_name(trans_id))
328
 
 
329
330
    def delete_contents(self, trans_id):
330
331
        """Schedule the contents of a path entry for deletion"""
331
 
        self.tree_kind(trans_id)
332
 
        self._removed_contents.add(trans_id)
 
332
        kind = self.tree_kind(trans_id)
 
333
        if kind is not None:
 
334
            self._removed_contents.add(trans_id)
333
335
 
334
336
    def cancel_deletion(self, trans_id):
335
337
        """Cancel a scheduled deletion"""
353
355
        else:
354
356
            unique_add(self._new_executability, trans_id, executability)
355
357
 
 
358
    def set_tree_reference(self, revision_id, trans_id):
 
359
        """Set the reference associated with a directory"""
 
360
        unique_add(self._new_reference_revision, trans_id, revision_id)
 
361
 
356
362
    def version_file(self, file_id, trans_id):
357
363
        """Schedule a file to become versioned."""
358
 
        assert file_id is not None
 
364
        if file_id is None:
 
365
            raise ValueError()
359
366
        unique_add(self._new_id, trans_id, file_id)
360
367
        unique_add(self._r_new_id, file_id, trans_id)
361
368
 
365
372
        del self._new_id[trans_id]
366
373
        del self._r_new_id[file_id]
367
374
 
368
 
    def new_paths(self):
369
 
        """Determine the paths of all new and changed files"""
 
375
    def new_paths(self, filesystem_only=False):
 
376
        """Determine the paths of all new and changed files.
 
377
 
 
378
        :param filesystem_only: if True, only calculate values for files
 
379
            that require renames or execute bit changes.
 
380
        """
370
381
        new_ids = set()
371
 
        fp = FinalPaths(self)
372
 
        for id_set in (self._new_name, self._new_parent, self._new_contents,
373
 
                       self._new_id, self._new_executability):
 
382
        if filesystem_only:
 
383
            stale_ids = self._needs_rename.difference(self._new_name)
 
384
            stale_ids.difference_update(self._new_parent)
 
385
            stale_ids.difference_update(self._new_contents)
 
386
            stale_ids.difference_update(self._new_id)
 
387
            needs_rename = self._needs_rename.difference(stale_ids)
 
388
            id_sets = (needs_rename, self._new_executability)
 
389
        else:
 
390
            id_sets = (self._new_name, self._new_parent, self._new_contents,
 
391
                       self._new_id, self._new_executability)
 
392
        for id_set in id_sets:
374
393
            new_ids.update(id_set)
375
 
        new_paths = [(fp.get_path(t), t) for t in new_ids]
376
 
        new_paths.sort()
377
 
        return new_paths
378
 
 
379
 
    def tree_kind(self, trans_id):
380
 
        """Determine the file kind in the working tree.
381
 
 
382
 
        Raises NoSuchFile if the file does not exist
 
394
        return sorted(FinalPaths(self).get_paths(new_ids))
 
395
 
 
396
    def _inventory_altered(self):
 
397
        """Determine which trans_ids need new Inventory entries.
 
398
 
 
399
        An new entry is needed when anything that would be reflected by an
 
400
        inventory entry changes, including file name, file_id, parent file_id,
 
401
        file kind, and the execute bit.
 
402
 
 
403
        Some care is taken to return entries with real changes, not cases
 
404
        where the value is deleted and then restored to its original value,
 
405
        but some actually unchanged values may be returned.
 
406
 
 
407
        :returns: A list of (path, trans_id) for all items requiring an
 
408
            inventory change. Ordered by path.
383
409
        """
384
 
        path = self._tree_id_paths.get(trans_id)
385
 
        if path is None:
386
 
            raise NoSuchFile(None)
387
 
        try:
388
 
            return file_kind(self._tree.abspath(path))
389
 
        except OSError, e:
390
 
            if e.errno != errno.ENOENT:
391
 
                raise
392
 
            else:
393
 
                raise NoSuchFile(path)
 
410
        changed_ids = set()
 
411
        # Find entries whose file_ids are new (or changed).
 
412
        new_file_id = set(t for t in self._new_id
 
413
                          if self._new_id[t] != self.tree_file_id(t))
 
414
        for id_set in [self._new_name, self._new_parent, new_file_id,
 
415
                       self._new_executability]:
 
416
            changed_ids.update(id_set)
 
417
        # removing implies a kind change
 
418
        changed_kind = set(self._removed_contents)
 
419
        # so does adding
 
420
        changed_kind.intersection_update(self._new_contents)
 
421
        # Ignore entries that are already known to have changed.
 
422
        changed_kind.difference_update(changed_ids)
 
423
        #  to keep only the truly changed ones
 
424
        changed_kind = (t for t in changed_kind
 
425
                        if self.tree_kind(t) != self.final_kind(t))
 
426
        # all kind changes will alter the inventory
 
427
        changed_ids.update(changed_kind)
 
428
        # To find entries with changed parent_ids, find parents which existed,
 
429
        # but changed file_id.
 
430
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
 
431
        # Now add all their children to the set.
 
432
        for parent_trans_id in new_file_id:
 
433
            changed_ids.update(self.iter_tree_children(parent_trans_id))
 
434
        return sorted(FinalPaths(self).get_paths(changed_ids))
394
435
 
395
436
    def final_kind(self, trans_id):
396
437
        """Determine the final file kind, after any changes applied.
397
 
        
398
 
        Raises NoSuchFile if the file does not exist/has no contents.
399
 
        (It is conceivable that a path would be created without the
400
 
        corresponding contents insertion command)
 
438
 
 
439
        :return: None if the file does not exist/has no contents.  (It is
 
440
            conceivable that a path would be created without the corresponding
 
441
            contents insertion command)
401
442
        """
402
443
        if trans_id in self._new_contents:
403
444
            return self._new_contents[trans_id]
404
445
        elif trans_id in self._removed_contents:
405
 
            raise NoSuchFile(None)
 
446
            return None
406
447
        else:
407
448
            return self.tree_kind(trans_id)
408
449
 
415
456
            return None
416
457
        # the file is old; the old id is still valid
417
458
        if self._new_root == trans_id:
418
 
            return self._tree.inventory.root.file_id
419
 
        return self._tree.inventory.path2id(path)
 
459
            return self._tree.get_root_id()
 
460
        return self._tree.path2id(path)
420
461
 
421
462
    def final_file_id(self, trans_id):
422
463
        """Determine the file id after any changes are applied, or None.
423
 
        
 
464
 
424
465
        None indicates that the file will not be versioned after changes are
425
466
        applied.
426
467
        """
427
468
        try:
428
 
            # there is a new id for this file
429
 
            assert self._new_id[trans_id] is not None
430
469
            return self._new_id[trans_id]
431
470
        except KeyError:
432
471
            if trans_id in self._removed_id:
467
506
 
468
507
    def by_parent(self):
469
508
        """Return a map of parent: children for known parents.
470
 
        
 
509
 
471
510
        Only new paths and parents of tree files with assigned ids are used.
472
511
        """
473
512
        by_parent = {}
474
513
        items = list(self._new_parent.iteritems())
475
 
        items.extend((t, self.final_parent(t)) for t in 
 
514
        items.extend((t, self.final_parent(t)) for t in
476
515
                      self._tree_id_paths.keys())
477
516
        for trans_id, parent_id in items:
478
517
            if parent_id not in by_parent:
489
528
 
490
529
    def find_conflicts(self):
491
530
        """Find any violations of inventory or filesystem invariants"""
492
 
        if self.__done is True:
 
531
        if self._done is True:
493
532
            raise ReusingTransform()
494
533
        conflicts = []
495
534
        # ensure all children of all existent parents are known
506
545
        conflicts.extend(self._overwrite_conflicts())
507
546
        return conflicts
508
547
 
 
548
    def _check_malformed(self):
 
549
        conflicts = self.find_conflicts()
 
550
        if len(conflicts) != 0:
 
551
            raise MalformedTransform(conflicts=conflicts)
 
552
 
509
553
    def _add_tree_children(self):
510
554
        """Add all the children of all active parents to the known paths.
511
555
 
513
557
        removed.  This is a necessary first step in detecting conflicts.
514
558
        """
515
559
        parents = self.by_parent().keys()
516
 
        parents.extend([t for t in self._removed_contents if 
 
560
        parents.extend([t for t in self._removed_contents if
517
561
                        self.tree_kind(t) == 'directory'])
518
562
        for trans_id in self._removed_id:
519
563
            file_id = self.tree_file_id(trans_id)
520
 
            if self._tree.inventory[file_id].kind == 'directory':
 
564
            if file_id is not None:
 
565
                # XXX: This seems like something that should go via a different
 
566
                #      indirection.
 
567
                if self._tree.inventory[file_id].kind == 'directory':
 
568
                    parents.append(trans_id)
 
569
            elif self.tree_kind(trans_id) == 'directory':
521
570
                parents.append(trans_id)
522
571
 
523
572
        for parent_id in parents:
524
573
            # ensure that all children are registered with the transaction
525
574
            list(self.iter_tree_children(parent_id))
526
575
 
527
 
    def iter_tree_children(self, parent_id):
528
 
        """Iterate through the entry's tree children, if any"""
529
 
        try:
530
 
            path = self._tree_id_paths[parent_id]
531
 
        except KeyError:
532
 
            return
533
 
        try:
534
 
            children = os.listdir(self._tree.abspath(path))
535
 
        except OSError, e:
536
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
537
 
                raise
538
 
            return
539
 
            
540
 
        for child in children:
541
 
            childpath = joinpath(path, child)
542
 
            if self._tree.is_control_filename(childpath):
543
 
                continue
544
 
            yield self.trans_id_tree_path(childpath)
545
 
 
 
576
    @deprecated_method(deprecated_in((2, 3, 0)))
546
577
    def has_named_child(self, by_parent, parent_id, name):
547
 
        try:
548
 
            children = by_parent[parent_id]
549
 
        except KeyError:
550
 
            children = []
551
 
        for child in children:
 
578
        return self._has_named_child(
 
579
            name, parent_id, known_children=by_parent.get(parent_id, []))
 
580
 
 
581
    def _has_named_child(self, name, parent_id, known_children):
 
582
        """Does a parent already have a name child.
 
583
 
 
584
        :param name: The searched for name.
 
585
 
 
586
        :param parent_id: The parent for which the check is made.
 
587
 
 
588
        :param known_children: The already known children. This should have
 
589
            been recently obtained from `self.by_parent.get(parent_id)`
 
590
            (or will be if None is passed).
 
591
        """
 
592
        if known_children is None:
 
593
            known_children = self.by_parent().get(parent_id, [])
 
594
        for child in known_children:
552
595
            if self.final_name(child) == name:
553
596
                return True
554
 
        try:
555
 
            path = self._tree_id_paths[parent_id]
556
 
        except KeyError:
 
597
        parent_path = self._tree_id_paths.get(parent_id, None)
 
598
        if parent_path is None:
 
599
            # No parent... no children
557
600
            return False
558
 
        childpath = joinpath(path, name)
559
 
        child_id = self._tree_path_ids.get(childpath)
 
601
        child_path = joinpath(parent_path, name)
 
602
        child_id = self._tree_path_ids.get(child_path, None)
560
603
        if child_id is None:
561
 
            return lexists(self._tree.abspath(childpath))
 
604
            # Not known by the tree transform yet, check the filesystem
 
605
            return osutils.lexists(self._tree.abspath(child_path))
562
606
        else:
563
 
            if self.final_parent(child_id) != parent_id:
564
 
                return False
565
 
            if child_id in self._removed_contents:
566
 
                # XXX What about dangling file-ids?
567
 
                return False
568
 
            else:
569
 
                return True
 
607
            raise AssertionError('child_id is missing: %s, %s, %s'
 
608
                                 % (name, parent_id, child_id))
 
609
 
 
610
    def _available_backup_name(self, name, target_id):
 
611
        """Find an available backup name.
 
612
 
 
613
        :param name: The basename of the file.
 
614
 
 
615
        :param target_id: The directory trans_id where the backup should 
 
616
            be placed.
 
617
        """
 
618
        known_children = self.by_parent().get(target_id, [])
 
619
        return osutils.available_backup_name(
 
620
            name,
 
621
            lambda base: self._has_named_child(
 
622
                base, target_id, known_children))
570
623
 
571
624
    def _parent_loops(self):
572
625
        """No entry should be its own ancestor"""
602
655
 
603
656
    def _improper_versioning(self):
604
657
        """Cannot version a file with no contents, or a bad type.
605
 
        
 
658
 
606
659
        However, existing entries with no contents are okay.
607
660
        """
608
661
        conflicts = []
609
662
        for trans_id in self._new_id.iterkeys():
610
 
            try:
611
 
                kind = self.final_kind(trans_id)
612
 
            except NoSuchFile:
 
663
            kind = self.final_kind(trans_id)
 
664
            if kind is None:
613
665
                conflicts.append(('versioning no contents', trans_id))
614
666
                continue
615
 
            if not InventoryEntry.versionable_kind(kind):
 
667
            if not inventory.InventoryEntry.versionable_kind(kind):
616
668
                conflicts.append(('versioning bad kind', trans_id, kind))
617
669
        return conflicts
618
670
 
619
671
    def _executability_conflicts(self):
620
672
        """Check for bad executability changes.
621
 
        
 
673
 
622
674
        Only versioned files may have their executability set, because
623
675
        1. only versioned entries can have executability under windows
624
676
        2. only files can be executable.  (The execute bit on a directory
629
681
            if self.final_file_id(trans_id) is None:
630
682
                conflicts.append(('unversioned executability', trans_id))
631
683
            else:
632
 
                try:
633
 
                    non_file = self.final_kind(trans_id) != "file"
634
 
                except NoSuchFile:
635
 
                    non_file = True
636
 
                if non_file is True:
 
684
                if self.final_kind(trans_id) != "file":
637
685
                    conflicts.append(('non-file executability', trans_id))
638
686
        return conflicts
639
687
 
641
689
        """Check for overwrites (not permitted on Win32)"""
642
690
        conflicts = []
643
691
        for trans_id in self._new_contents:
644
 
            try:
645
 
                self.tree_kind(trans_id)
646
 
            except NoSuchFile:
 
692
            if self.tree_kind(trans_id) is None:
647
693
                continue
648
694
            if trans_id not in self._removed_contents:
649
695
                conflicts.append(('overwrite', trans_id,
653
699
    def _duplicate_entries(self, by_parent):
654
700
        """No directory may have two entries with the same name."""
655
701
        conflicts = []
 
702
        if (self._new_name, self._new_parent) == ({}, {}):
 
703
            return conflicts
656
704
        for children in by_parent.itervalues():
657
 
            name_ids = [(self.final_name(t), t) for t in children]
 
705
            name_ids = []
 
706
            for child_tid in children:
 
707
                name = self.final_name(child_tid)
 
708
                if name is not None:
 
709
                    # Keep children only if they still exist in the end
 
710
                    if not self._case_sensitive_target:
 
711
                        name = name.lower()
 
712
                    name_ids.append((name, child_tid))
658
713
            name_ids.sort()
659
714
            last_name = None
660
715
            last_trans_id = None
661
716
            for name, trans_id in name_ids:
662
 
                try:
663
 
                    kind = self.final_kind(trans_id)
664
 
                except NoSuchFile:
665
 
                    kind = None
 
717
                kind = self.final_kind(trans_id)
666
718
                file_id = self.final_file_id(trans_id)
667
719
                if kind is None and file_id is None:
668
720
                    continue
678
730
        conflicts = []
679
731
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
680
732
                                self._removed_id))
681
 
        active_tree_ids = set((f for f in self._tree.inventory if
682
 
                               f not in removed_tree_ids))
 
733
        all_ids = self._tree.all_file_ids()
 
734
        active_tree_ids = all_ids.difference(removed_tree_ids)
683
735
        for trans_id, file_id in self._new_id.iteritems():
684
736
            if file_id in active_tree_ids:
685
737
                old_trans_id = self.trans_id_tree_file_id(file_id)
687
739
        return conflicts
688
740
 
689
741
    def _parent_type_conflicts(self, by_parent):
690
 
        """parents must have directory 'contents'."""
 
742
        """Children must have a directory parent"""
691
743
        conflicts = []
692
744
        for parent_id, children in by_parent.iteritems():
693
745
            if parent_id is ROOT_PARENT:
694
746
                continue
695
 
            if not self._any_contents(children):
 
747
            no_children = True
 
748
            for child_id in children:
 
749
                if self.final_kind(child_id) is not None:
 
750
                    no_children = False
 
751
                    break
 
752
            if no_children:
696
753
                continue
697
 
            for child in children:
698
 
                try:
699
 
                    self.final_kind(child)
700
 
                except NoSuchFile:
701
 
                    continue
702
 
            try:
703
 
                kind = self.final_kind(parent_id)
704
 
            except NoSuchFile:
705
 
                kind = None
 
754
            # There is at least a child, so we need an existing directory to
 
755
            # contain it.
 
756
            kind = self.final_kind(parent_id)
706
757
            if kind is None:
 
758
                # The directory will be deleted
707
759
                conflicts.append(('missing parent', parent_id))
708
760
            elif kind != "directory":
 
761
                # Meh, we need a *directory* to put something in it
709
762
                conflicts.append(('non-directory parent', parent_id))
710
763
        return conflicts
711
764
 
712
 
    def _any_contents(self, trans_ids):
713
 
        """Return true if any of the trans_ids, will have contents."""
714
 
        for trans_id in trans_ids:
715
 
            try:
716
 
                kind = self.final_kind(trans_id)
717
 
            except NoSuchFile:
718
 
                continue
719
 
            return True
720
 
        return False
721
 
            
722
 
    def apply(self):
723
 
        """Apply all changes to the inventory and filesystem.
724
 
        
725
 
        If filesystem or inventory conflicts are present, MalformedTransform
726
 
        will be thrown.
727
 
        """
728
 
        conflicts = self.find_conflicts()
729
 
        if len(conflicts) != 0:
730
 
            raise MalformedTransform(conflicts=conflicts)
731
 
        limbo_inv = {}
732
 
        inv = self._tree.inventory
733
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
734
 
        try:
735
 
            child_pb.update('Apply phase', 0, 2)
736
 
            self._apply_removals(inv, limbo_inv)
737
 
            child_pb.update('Apply phase', 1, 2)
738
 
            modified_paths = self._apply_insertions(inv, limbo_inv)
739
 
        finally:
740
 
            child_pb.finished()
741
 
        self._tree._write_inventory(inv)
742
 
        self.__done = True
743
 
        self.finalize()
744
 
        return _TransformResults(modified_paths)
745
 
 
746
 
    def _limbo_name(self, trans_id):
747
 
        """Generate the limbo name of a file"""
748
 
        return pathjoin(self._limbodir, trans_id)
749
 
 
750
 
    def _apply_removals(self, inv, limbo_inv):
751
 
        """Perform tree operations that remove directory/inventory names.
752
 
        
753
 
        That is, delete files that are to be deleted, and put any files that
754
 
        need renaming into limbo.  This must be done in strict child-to-parent
755
 
        order.
756
 
        """
757
 
        tree_paths = list(self._tree_path_ids.iteritems())
758
 
        tree_paths.sort(reverse=True)
759
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
760
 
        try:
761
 
            for num, data in enumerate(tree_paths):
762
 
                path, trans_id = data
763
 
                child_pb.update('removing file', num, len(tree_paths))
764
 
                full_path = self._tree.abspath(path)
765
 
                if trans_id in self._removed_contents:
766
 
                    delete_any(full_path)
767
 
                elif trans_id in self._new_name or trans_id in \
768
 
                    self._new_parent:
769
 
                    try:
770
 
                        os.rename(full_path, self._limbo_name(trans_id))
771
 
                    except OSError, e:
772
 
                        if e.errno != errno.ENOENT:
773
 
                            raise
774
 
                if trans_id in self._removed_id:
775
 
                    if trans_id == self._new_root:
776
 
                        file_id = self._tree.inventory.root.file_id
777
 
                    else:
778
 
                        file_id = self.tree_file_id(trans_id)
779
 
                    del inv[file_id]
780
 
                elif trans_id in self._new_name or trans_id in self._new_parent:
781
 
                    file_id = self.tree_file_id(trans_id)
782
 
                    if file_id is not None:
783
 
                        limbo_inv[trans_id] = inv[file_id]
784
 
                        del inv[file_id]
785
 
        finally:
786
 
            child_pb.finished()
787
 
 
788
 
    def _apply_insertions(self, inv, limbo_inv):
789
 
        """Perform tree operations that insert directory/inventory names.
790
 
        
791
 
        That is, create any files that need to be created, and restore from
792
 
        limbo any files that needed renaming.  This must be done in strict
793
 
        parent-to-child order.
794
 
        """
795
 
        new_paths = self.new_paths()
796
 
        modified_paths = []
797
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
798
 
        try:
799
 
            for num, (path, trans_id) in enumerate(new_paths):
800
 
                child_pb.update('adding file', num, len(new_paths))
801
 
                try:
802
 
                    kind = self._new_contents[trans_id]
803
 
                except KeyError:
804
 
                    kind = contents = None
805
 
                if trans_id in self._new_contents or \
806
 
                    self.path_changed(trans_id):
807
 
                    full_path = self._tree.abspath(path)
808
 
                    try:
809
 
                        os.rename(self._limbo_name(trans_id), full_path)
810
 
                    except OSError, e:
811
 
                        # We may be renaming a dangling inventory id
812
 
                        if e.errno != errno.ENOENT:
813
 
                            raise
814
 
                    if trans_id in self._new_contents:
815
 
                        modified_paths.append(full_path)
816
 
                        del self._new_contents[trans_id]
817
 
 
818
 
                if trans_id in self._new_id:
819
 
                    if kind is None:
820
 
                        kind = file_kind(self._tree.abspath(path))
821
 
                    inv.add_path(path, kind, self._new_id[trans_id])
822
 
                elif trans_id in self._new_name or trans_id in\
823
 
                    self._new_parent:
824
 
                    entry = limbo_inv.get(trans_id)
825
 
                    if entry is not None:
826
 
                        entry.name = self.final_name(trans_id)
827
 
                        parent_path = os.path.dirname(path)
828
 
                        entry.parent_id = \
829
 
                            self._tree.inventory.path2id(parent_path)
830
 
                        inv.add(entry)
831
 
 
832
 
                # requires files and inventory entries to be in place
833
 
                if trans_id in self._new_executability:
834
 
                    self._set_executability(path, inv, trans_id)
835
 
        finally:
836
 
            child_pb.finished()
837
 
        return modified_paths
838
 
 
839
 
    def _set_executability(self, path, inv, trans_id):
 
765
    def _set_executability(self, path, trans_id):
840
766
        """Set the executability of versioned files """
841
 
        file_id = inv.path2id(path)
842
 
        new_executability = self._new_executability[trans_id]
843
 
        inv[file_id].executable = new_executability
844
767
        if supports_executable():
 
768
            new_executability = self._new_executability[trans_id]
845
769
            abspath = self._tree.abspath(path)
846
770
            current_mode = os.stat(abspath).st_mode
847
771
            if new_executability:
864
788
            self.version_file(file_id, trans_id)
865
789
        return trans_id
866
790
 
867
 
    def new_file(self, name, parent_id, contents, file_id=None, 
868
 
                 executable=None):
 
791
    def new_file(self, name, parent_id, contents, file_id=None,
 
792
                 executable=None, sha1=None):
869
793
        """Convenience method to create files.
870
 
        
 
794
 
871
795
        name is the name of the file to create.
872
796
        parent_id is the transaction id of the parent directory of the file.
873
797
        contents is an iterator of bytestrings, which will be used to produce
878
802
        trans_id = self._new_entry(name, parent_id, file_id)
879
803
        # TODO: rather than scheduling a set_executable call,
880
804
        # have create_file create the file with the right mode.
881
 
        self.create_file(contents, trans_id)
 
805
        self.create_file(contents, trans_id, sha1=sha1)
882
806
        if executable is not None:
883
807
            self.set_executability(executable, trans_id)
884
808
        return trans_id
893
817
        """
894
818
        trans_id = self._new_entry(name, parent_id, file_id)
895
819
        self.create_directory(trans_id)
896
 
        return trans_id 
 
820
        return trans_id
897
821
 
898
822
    def new_symlink(self, name, parent_id, target, file_id=None):
899
823
        """Convenience method to create symbolic link.
900
 
        
 
824
 
901
825
        name is the name of the symlink to create.
902
826
        parent_id is the transaction id of the parent directory of the symlink.
903
827
        target is a bytestring of the target of the symlink.
907
831
        self.create_symlink(target, trans_id)
908
832
        return trans_id
909
833
 
 
834
    def new_orphan(self, trans_id, parent_id):
 
835
        """Schedule an item to be orphaned.
 
836
 
 
837
        When a directory is about to be removed, its children, if they are not
 
838
        versioned are moved out of the way: they don't have a parent anymore.
 
839
 
 
840
        :param trans_id: The trans_id of the existing item.
 
841
        :param parent_id: The parent trans_id of the item.
 
842
        """
 
843
        raise NotImplementedError(self.new_orphan)
 
844
 
 
845
    def _get_potential_orphans(self, dir_id):
 
846
        """Find the potential orphans in a directory.
 
847
 
 
848
        A directory can't be safely deleted if there are versioned files in it.
 
849
        If all the contained files are unversioned then they can be orphaned.
 
850
 
 
851
        The 'None' return value means that the directory contains at least one
 
852
        versioned file and should not be deleted.
 
853
 
 
854
        :param dir_id: The directory trans id.
 
855
 
 
856
        :return: A list of the orphan trans ids or None if at least one
 
857
             versioned file is present.
 
858
        """
 
859
        orphans = []
 
860
        # Find the potential orphans, stop if one item should be kept
 
861
        for child_tid in self.by_parent()[dir_id]:
 
862
            if child_tid in self._removed_contents:
 
863
                # The child is removed as part of the transform. Since it was
 
864
                # versioned before, it's not an orphan
 
865
                continue
 
866
            elif self.final_file_id(child_tid) is None:
 
867
                # The child is not versioned
 
868
                orphans.append(child_tid)
 
869
            else:
 
870
                # We have a versioned file here, searching for orphans is
 
871
                # meaningless.
 
872
                orphans = None
 
873
                break
 
874
        return orphans
 
875
 
910
876
    def _affected_ids(self):
911
877
        """Return the set of transform ids affected by the transform"""
912
878
        trans_ids = set(self._removed_id)
942
908
        from_path = self._tree_id_paths.get(from_trans_id)
943
909
        if from_versioned:
944
910
            # get data from working tree if versioned
945
 
            from_entry = self._tree.inventory[file_id]
 
911
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
946
912
            from_name = from_entry.name
947
913
            from_parent = from_entry.parent_id
948
914
        else:
971
937
        Return a (name, parent, kind, executable) tuple
972
938
        """
973
939
        to_name = self.final_name(to_trans_id)
974
 
        try:
975
 
            to_kind = self.final_kind(to_trans_id)
976
 
        except NoSuchFile:
977
 
            to_kind = None
 
940
        to_kind = self.final_kind(to_trans_id)
978
941
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
979
942
        if to_trans_id in self._new_executability:
980
943
            to_executable = self._new_executability[to_trans_id]
984
947
            to_executable = False
985
948
        return to_name, to_parent, to_kind, to_executable
986
949
 
987
 
    def _iter_changes(self):
988
 
        """Produce output in the same format as Tree._iter_changes.
 
950
    def iter_changes(self):
 
951
        """Produce output in the same format as Tree.iter_changes.
989
952
 
990
953
        Will produce nonsensical results if invoked while inventory/filesystem
991
954
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
1020
983
            to_name, to_parent, to_kind, to_executable = \
1021
984
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
1022
985
 
1023
 
            to_path = final_paths.get_path(to_trans_id)
 
986
            if not from_versioned:
 
987
                from_path = None
 
988
            else:
 
989
                from_path = self._tree_id_paths.get(from_trans_id)
 
990
            if not to_versioned:
 
991
                to_path = None
 
992
            else:
 
993
                to_path = final_paths.get_path(to_trans_id)
1024
994
            if from_kind != to_kind:
1025
995
                modified = True
1026
 
            elif to_kind in ('file' or 'symlink') and (
 
996
            elif to_kind in ('file', 'symlink') and (
1027
997
                to_trans_id != from_trans_id or
1028
998
                to_trans_id in self._new_contents):
1029
999
                modified = True
1031
1001
                from_parent==to_parent and from_name == to_name and
1032
1002
                from_executable == to_executable):
1033
1003
                continue
1034
 
            results.append((file_id, to_path, modified,
 
1004
            results.append((file_id, (from_path, to_path), modified,
1035
1005
                   (from_versioned, to_versioned),
1036
1006
                   (from_parent, to_parent),
1037
1007
                   (from_name, to_name),
1039
1009
                   (from_executable, to_executable)))
1040
1010
        return iter(sorted(results, key=lambda x:x[1]))
1041
1011
 
 
1012
    def get_preview_tree(self):
 
1013
        """Return a tree representing the result of the transform.
 
1014
 
 
1015
        The tree is a snapshot, and altering the TreeTransform will invalidate
 
1016
        it.
 
1017
        """
 
1018
        return _PreviewTree(self)
 
1019
 
 
1020
    def commit(self, branch, message, merge_parents=None, strict=False,
 
1021
               timestamp=None, timezone=None, committer=None, authors=None,
 
1022
               revprops=None, revision_id=None):
 
1023
        """Commit the result of this TreeTransform to a branch.
 
1024
 
 
1025
        :param branch: The branch to commit to.
 
1026
        :param message: The message to attach to the commit.
 
1027
        :param merge_parents: Additional parent revision-ids specified by
 
1028
            pending merges.
 
1029
        :param strict: If True, abort the commit if there are unversioned
 
1030
            files.
 
1031
        :param timestamp: if not None, seconds-since-epoch for the time and
 
1032
            date.  (May be a float.)
 
1033
        :param timezone: Optional timezone for timestamp, as an offset in
 
1034
            seconds.
 
1035
        :param committer: Optional committer in email-id format.
 
1036
            (e.g. "J Random Hacker <jrandom@example.com>")
 
1037
        :param authors: Optional list of authors in email-id format.
 
1038
        :param revprops: Optional dictionary of revision properties.
 
1039
        :param revision_id: Optional revision id.  (Specifying a revision-id
 
1040
            may reduce performance for some non-native formats.)
 
1041
        :return: The revision_id of the revision committed.
 
1042
        """
 
1043
        self._check_malformed()
 
1044
        if strict:
 
1045
            unversioned = set(self._new_contents).difference(set(self._new_id))
 
1046
            for trans_id in unversioned:
 
1047
                if self.final_file_id(trans_id) is None:
 
1048
                    raise errors.StrictCommitFailed()
 
1049
 
 
1050
        revno, last_rev_id = branch.last_revision_info()
 
1051
        if last_rev_id == _mod_revision.NULL_REVISION:
 
1052
            if merge_parents is not None:
 
1053
                raise ValueError('Cannot supply merge parents for first'
 
1054
                                 ' commit.')
 
1055
            parent_ids = []
 
1056
        else:
 
1057
            parent_ids = [last_rev_id]
 
1058
            if merge_parents is not None:
 
1059
                parent_ids.extend(merge_parents)
 
1060
        if self._tree.get_revision_id() != last_rev_id:
 
1061
            raise ValueError('TreeTransform not based on branch basis: %s' %
 
1062
                             self._tree.get_revision_id())
 
1063
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
 
1064
        builder = branch.get_commit_builder(parent_ids,
 
1065
                                            timestamp=timestamp,
 
1066
                                            timezone=timezone,
 
1067
                                            committer=committer,
 
1068
                                            revprops=revprops,
 
1069
                                            revision_id=revision_id)
 
1070
        preview = self.get_preview_tree()
 
1071
        list(builder.record_iter_changes(preview, last_rev_id,
 
1072
                                         self.iter_changes()))
 
1073
        builder.finish_inventory()
 
1074
        revision_id = builder.commit(message)
 
1075
        branch.set_last_revision_info(revno + 1, revision_id)
 
1076
        return revision_id
 
1077
 
 
1078
    def _text_parent(self, trans_id):
 
1079
        file_id = self.tree_file_id(trans_id)
 
1080
        try:
 
1081
            if file_id is None or self._tree.kind(file_id) != 'file':
 
1082
                return None
 
1083
        except errors.NoSuchFile:
 
1084
            return None
 
1085
        return file_id
 
1086
 
 
1087
    def _get_parents_texts(self, trans_id):
 
1088
        """Get texts for compression parents of this file."""
 
1089
        file_id = self._text_parent(trans_id)
 
1090
        if file_id is None:
 
1091
            return ()
 
1092
        return (self._tree.get_file_text(file_id),)
 
1093
 
 
1094
    def _get_parents_lines(self, trans_id):
 
1095
        """Get lines for compression parents of this file."""
 
1096
        file_id = self._text_parent(trans_id)
 
1097
        if file_id is None:
 
1098
            return ()
 
1099
        return (self._tree.get_file_lines(file_id),)
 
1100
 
 
1101
    def serialize(self, serializer):
 
1102
        """Serialize this TreeTransform.
 
1103
 
 
1104
        :param serializer: A Serialiser like pack.ContainerSerializer.
 
1105
        """
 
1106
        new_name = dict((k, v.encode('utf-8')) for k, v in
 
1107
                        self._new_name.items())
 
1108
        new_executability = dict((k, int(v)) for k, v in
 
1109
                                 self._new_executability.items())
 
1110
        tree_path_ids = dict((k.encode('utf-8'), v)
 
1111
                             for k, v in self._tree_path_ids.items())
 
1112
        attribs = {
 
1113
            '_id_number': self._id_number,
 
1114
            '_new_name': new_name,
 
1115
            '_new_parent': self._new_parent,
 
1116
            '_new_executability': new_executability,
 
1117
            '_new_id': self._new_id,
 
1118
            '_tree_path_ids': tree_path_ids,
 
1119
            '_removed_id': list(self._removed_id),
 
1120
            '_removed_contents': list(self._removed_contents),
 
1121
            '_non_present_ids': self._non_present_ids,
 
1122
            }
 
1123
        yield serializer.bytes_record(bencode.bencode(attribs),
 
1124
                                      (('attribs',),))
 
1125
        for trans_id, kind in self._new_contents.items():
 
1126
            if kind == 'file':
 
1127
                lines = osutils.chunks_to_lines(
 
1128
                    self._read_file_chunks(trans_id))
 
1129
                parents = self._get_parents_lines(trans_id)
 
1130
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
 
1131
                content = ''.join(mpdiff.to_patch())
 
1132
            if kind == 'directory':
 
1133
                content = ''
 
1134
            if kind == 'symlink':
 
1135
                content = self._read_symlink_target(trans_id)
 
1136
            yield serializer.bytes_record(content, ((trans_id, kind),))
 
1137
 
 
1138
    def deserialize(self, records):
 
1139
        """Deserialize a stored TreeTransform.
 
1140
 
 
1141
        :param records: An iterable of (names, content) tuples, as per
 
1142
            pack.ContainerPushParser.
 
1143
        """
 
1144
        names, content = records.next()
 
1145
        attribs = bencode.bdecode(content)
 
1146
        self._id_number = attribs['_id_number']
 
1147
        self._new_name = dict((k, v.decode('utf-8'))
 
1148
                            for k, v in attribs['_new_name'].items())
 
1149
        self._new_parent = attribs['_new_parent']
 
1150
        self._new_executability = dict((k, bool(v)) for k, v in
 
1151
            attribs['_new_executability'].items())
 
1152
        self._new_id = attribs['_new_id']
 
1153
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
 
1154
        self._tree_path_ids = {}
 
1155
        self._tree_id_paths = {}
 
1156
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
 
1157
            path = bytepath.decode('utf-8')
 
1158
            self._tree_path_ids[path] = trans_id
 
1159
            self._tree_id_paths[trans_id] = path
 
1160
        self._removed_id = set(attribs['_removed_id'])
 
1161
        self._removed_contents = set(attribs['_removed_contents'])
 
1162
        self._non_present_ids = attribs['_non_present_ids']
 
1163
        for ((trans_id, kind),), content in records:
 
1164
            if kind == 'file':
 
1165
                mpdiff = multiparent.MultiParent.from_patch(content)
 
1166
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
 
1167
                self.create_file(lines, trans_id)
 
1168
            if kind == 'directory':
 
1169
                self.create_directory(trans_id)
 
1170
            if kind == 'symlink':
 
1171
                self.create_symlink(content.decode('utf-8'), trans_id)
 
1172
 
 
1173
 
 
1174
class DiskTreeTransform(TreeTransformBase):
 
1175
    """Tree transform storing its contents on disk."""
 
1176
 
 
1177
    def __init__(self, tree, limbodir, pb=None,
 
1178
                 case_sensitive=True):
 
1179
        """Constructor.
 
1180
        :param tree: The tree that will be transformed, but not necessarily
 
1181
            the output tree.
 
1182
        :param limbodir: A directory where new files can be stored until
 
1183
            they are installed in their proper places
 
1184
        :param pb: ignored
 
1185
        :param case_sensitive: If True, the target of the transform is
 
1186
            case sensitive, not just case preserving.
 
1187
        """
 
1188
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
 
1189
        self._limbodir = limbodir
 
1190
        self._deletiondir = None
 
1191
        # A mapping of transform ids to their limbo filename
 
1192
        self._limbo_files = {}
 
1193
        self._possibly_stale_limbo_files = set()
 
1194
        # A mapping of transform ids to a set of the transform ids of children
 
1195
        # that their limbo directory has
 
1196
        self._limbo_children = {}
 
1197
        # Map transform ids to maps of child filename to child transform id
 
1198
        self._limbo_children_names = {}
 
1199
        # List of transform ids that need to be renamed from limbo into place
 
1200
        self._needs_rename = set()
 
1201
        self._creation_mtime = None
 
1202
 
 
1203
    def finalize(self):
 
1204
        """Release the working tree lock, if held, clean up limbo dir.
 
1205
 
 
1206
        This is required if apply has not been invoked, but can be invoked
 
1207
        even after apply.
 
1208
        """
 
1209
        if self._tree is None:
 
1210
            return
 
1211
        try:
 
1212
            limbo_paths = self._limbo_files.values() + list(
 
1213
                self._possibly_stale_limbo_files)
 
1214
            limbo_paths = sorted(limbo_paths, reverse=True)
 
1215
            for path in limbo_paths:
 
1216
                try:
 
1217
                    delete_any(path)
 
1218
                except OSError, e:
 
1219
                    if e.errno != errno.ENOENT:
 
1220
                        raise
 
1221
                    # XXX: warn? perhaps we just got interrupted at an
 
1222
                    # inconvenient moment, but perhaps files are disappearing
 
1223
                    # from under us?
 
1224
            try:
 
1225
                delete_any(self._limbodir)
 
1226
            except OSError:
 
1227
                # We don't especially care *why* the dir is immortal.
 
1228
                raise ImmortalLimbo(self._limbodir)
 
1229
            try:
 
1230
                if self._deletiondir is not None:
 
1231
                    delete_any(self._deletiondir)
 
1232
            except OSError:
 
1233
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
1234
        finally:
 
1235
            TreeTransformBase.finalize(self)
 
1236
 
 
1237
    def _limbo_name(self, trans_id):
 
1238
        """Generate the limbo name of a file"""
 
1239
        limbo_name = self._limbo_files.get(trans_id)
 
1240
        if limbo_name is None:
 
1241
            limbo_name = self._generate_limbo_path(trans_id)
 
1242
            self._limbo_files[trans_id] = limbo_name
 
1243
        return limbo_name
 
1244
 
 
1245
    def _generate_limbo_path(self, trans_id):
 
1246
        """Generate a limbo path using the trans_id as the relative path.
 
1247
 
 
1248
        This is suitable as a fallback, and when the transform should not be
 
1249
        sensitive to the path encoding of the limbo directory.
 
1250
        """
 
1251
        self._needs_rename.add(trans_id)
 
1252
        return pathjoin(self._limbodir, trans_id)
 
1253
 
 
1254
    def adjust_path(self, name, parent, trans_id):
 
1255
        previous_parent = self._new_parent.get(trans_id)
 
1256
        previous_name = self._new_name.get(trans_id)
 
1257
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
 
1258
        if (trans_id in self._limbo_files and
 
1259
            trans_id not in self._needs_rename):
 
1260
            self._rename_in_limbo([trans_id])
 
1261
            if previous_parent != parent:
 
1262
                self._limbo_children[previous_parent].remove(trans_id)
 
1263
            if previous_parent != parent or previous_name != name:
 
1264
                del self._limbo_children_names[previous_parent][previous_name]
 
1265
 
 
1266
    def _rename_in_limbo(self, trans_ids):
 
1267
        """Fix limbo names so that the right final path is produced.
 
1268
 
 
1269
        This means we outsmarted ourselves-- we tried to avoid renaming
 
1270
        these files later by creating them with their final names in their
 
1271
        final parents.  But now the previous name or parent is no longer
 
1272
        suitable, so we have to rename them.
 
1273
 
 
1274
        Even for trans_ids that have no new contents, we must remove their
 
1275
        entries from _limbo_files, because they are now stale.
 
1276
        """
 
1277
        for trans_id in trans_ids:
 
1278
            old_path = self._limbo_files[trans_id]
 
1279
            self._possibly_stale_limbo_files.add(old_path)
 
1280
            del self._limbo_files[trans_id]
 
1281
            if trans_id not in self._new_contents:
 
1282
                continue
 
1283
            new_path = self._limbo_name(trans_id)
 
1284
            os.rename(old_path, new_path)
 
1285
            self._possibly_stale_limbo_files.remove(old_path)
 
1286
            for descendant in self._limbo_descendants(trans_id):
 
1287
                desc_path = self._limbo_files[descendant]
 
1288
                desc_path = new_path + desc_path[len(old_path):]
 
1289
                self._limbo_files[descendant] = desc_path
 
1290
 
 
1291
    def _limbo_descendants(self, trans_id):
 
1292
        """Return the set of trans_ids whose limbo paths descend from this."""
 
1293
        descendants = set(self._limbo_children.get(trans_id, []))
 
1294
        for descendant in list(descendants):
 
1295
            descendants.update(self._limbo_descendants(descendant))
 
1296
        return descendants
 
1297
 
 
1298
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
 
1299
        """Schedule creation of a new file.
 
1300
 
 
1301
        :seealso: new_file.
 
1302
 
 
1303
        :param contents: an iterator of strings, all of which will be written
 
1304
            to the target destination.
 
1305
        :param trans_id: TreeTransform handle
 
1306
        :param mode_id: If not None, force the mode of the target file to match
 
1307
            the mode of the object referenced by mode_id.
 
1308
            Otherwise, we will try to preserve mode bits of an existing file.
 
1309
        :param sha1: If the sha1 of this content is already known, pass it in.
 
1310
            We can use it to prevent future sha1 computations.
 
1311
        """
 
1312
        name = self._limbo_name(trans_id)
 
1313
        f = open(name, 'wb')
 
1314
        try:
 
1315
            unique_add(self._new_contents, trans_id, 'file')
 
1316
            f.writelines(contents)
 
1317
        finally:
 
1318
            f.close()
 
1319
        self._set_mtime(name)
 
1320
        self._set_mode(trans_id, mode_id, S_ISREG)
 
1321
        # It is unfortunate we have to use lstat instead of fstat, but we just
 
1322
        # used utime and chmod on the file, so we need the accurate final
 
1323
        # details.
 
1324
        if sha1 is not None:
 
1325
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
 
1326
 
 
1327
    def _read_file_chunks(self, trans_id):
 
1328
        cur_file = open(self._limbo_name(trans_id), 'rb')
 
1329
        try:
 
1330
            return cur_file.readlines()
 
1331
        finally:
 
1332
            cur_file.close()
 
1333
 
 
1334
    def _read_symlink_target(self, trans_id):
 
1335
        return os.readlink(self._limbo_name(trans_id))
 
1336
 
 
1337
    def _set_mtime(self, path):
 
1338
        """All files that are created get the same mtime.
 
1339
 
 
1340
        This time is set by the first object to be created.
 
1341
        """
 
1342
        if self._creation_mtime is None:
 
1343
            self._creation_mtime = time.time()
 
1344
        os.utime(path, (self._creation_mtime, self._creation_mtime))
 
1345
 
 
1346
    def create_hardlink(self, path, trans_id):
 
1347
        """Schedule creation of a hard link"""
 
1348
        name = self._limbo_name(trans_id)
 
1349
        try:
 
1350
            os.link(path, name)
 
1351
        except OSError, e:
 
1352
            if e.errno != errno.EPERM:
 
1353
                raise
 
1354
            raise errors.HardLinkNotSupported(path)
 
1355
        try:
 
1356
            unique_add(self._new_contents, trans_id, 'file')
 
1357
        except:
 
1358
            # Clean up the file, it never got registered so
 
1359
            # TreeTransform.finalize() won't clean it up.
 
1360
            os.unlink(name)
 
1361
            raise
 
1362
 
 
1363
    def create_directory(self, trans_id):
 
1364
        """Schedule creation of a new directory.
 
1365
 
 
1366
        See also new_directory.
 
1367
        """
 
1368
        os.mkdir(self._limbo_name(trans_id))
 
1369
        unique_add(self._new_contents, trans_id, 'directory')
 
1370
 
 
1371
    def create_symlink(self, target, trans_id):
 
1372
        """Schedule creation of a new symbolic link.
 
1373
 
 
1374
        target is a bytestring.
 
1375
        See also new_symlink.
 
1376
        """
 
1377
        if has_symlinks():
 
1378
            os.symlink(target, self._limbo_name(trans_id))
 
1379
            unique_add(self._new_contents, trans_id, 'symlink')
 
1380
        else:
 
1381
            try:
 
1382
                path = FinalPaths(self).get_path(trans_id)
 
1383
            except KeyError:
 
1384
                path = None
 
1385
            raise UnableCreateSymlink(path=path)
 
1386
 
 
1387
    def cancel_creation(self, trans_id):
 
1388
        """Cancel the creation of new file contents."""
 
1389
        del self._new_contents[trans_id]
 
1390
        if trans_id in self._observed_sha1s:
 
1391
            del self._observed_sha1s[trans_id]
 
1392
        children = self._limbo_children.get(trans_id)
 
1393
        # if this is a limbo directory with children, move them before removing
 
1394
        # the directory
 
1395
        if children is not None:
 
1396
            self._rename_in_limbo(children)
 
1397
            del self._limbo_children[trans_id]
 
1398
            del self._limbo_children_names[trans_id]
 
1399
        delete_any(self._limbo_name(trans_id))
 
1400
 
 
1401
    def new_orphan(self, trans_id, parent_id):
 
1402
        # FIXME: There is no tree config, so we use the branch one (it's weird
 
1403
        # to define it this way as orphaning can only occur in a working tree,
 
1404
        # but that's all we have (for now). It will find the option in
 
1405
        # locations.conf or bazaar.conf though) -- vila 20100916
 
1406
        conf = self._tree.branch.get_config()
 
1407
        conf_var_name = 'bzr.transform.orphan_policy'
 
1408
        orphan_policy = conf.get_user_option(conf_var_name)
 
1409
        default_policy = orphaning_registry.default_key
 
1410
        if orphan_policy is None:
 
1411
            orphan_policy = default_policy
 
1412
        if orphan_policy not in orphaning_registry:
 
1413
            trace.warning('%s (from %s) is not a known policy, defaulting '
 
1414
                'to %s' % (orphan_policy, conf_var_name, default_policy))
 
1415
            orphan_policy = default_policy
 
1416
        handle_orphan = orphaning_registry.get(orphan_policy)
 
1417
        handle_orphan(self, trans_id, parent_id)
 
1418
 
 
1419
 
 
1420
class OrphaningError(errors.BzrError):
 
1421
 
 
1422
    # Only bugs could lead to such exception being seen by the user
 
1423
    internal_error = True
 
1424
    _fmt = "Error while orphaning %s in %s directory"
 
1425
 
 
1426
    def __init__(self, orphan, parent):
 
1427
        errors.BzrError.__init__(self)
 
1428
        self.orphan = orphan
 
1429
        self.parent = parent
 
1430
 
 
1431
 
 
1432
class OrphaningForbidden(OrphaningError):
 
1433
 
 
1434
    _fmt = "Policy: %s doesn't allow creating orphans."
 
1435
 
 
1436
    def __init__(self, policy):
 
1437
        errors.BzrError.__init__(self)
 
1438
        self.policy = policy
 
1439
 
 
1440
 
 
1441
def move_orphan(tt, orphan_id, parent_id):
 
1442
    """See TreeTransformBase.new_orphan.
 
1443
 
 
1444
    This creates a new orphan in the `bzr-orphans` dir at the root of the
 
1445
    `TreeTransform`.
 
1446
 
 
1447
    :param tt: The TreeTransform orphaning `trans_id`.
 
1448
 
 
1449
    :param orphan_id: The trans id that should be orphaned.
 
1450
 
 
1451
    :param parent_id: The orphan parent trans id.
 
1452
    """
 
1453
    # Add the orphan dir if it doesn't exist
 
1454
    orphan_dir_basename = 'bzr-orphans'
 
1455
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
 
1456
    if tt.final_kind(od_id) is None:
 
1457
        tt.create_directory(od_id)
 
1458
    parent_path = tt._tree_id_paths[parent_id]
 
1459
    # Find a name that doesn't exist yet in the orphan dir
 
1460
    actual_name = tt.final_name(orphan_id)
 
1461
    new_name = tt._available_backup_name(actual_name, od_id)
 
1462
    tt.adjust_path(new_name, od_id, orphan_id)
 
1463
    trace.warning('%s has been orphaned in %s'
 
1464
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
 
1465
 
 
1466
 
 
1467
def refuse_orphan(tt, orphan_id, parent_id):
 
1468
    """See TreeTransformBase.new_orphan.
 
1469
 
 
1470
    This refuses to create orphan, letting the caller handle the conflict.
 
1471
    """
 
1472
    raise OrphaningForbidden('never')
 
1473
 
 
1474
 
 
1475
orphaning_registry = registry.Registry()
 
1476
orphaning_registry.register(
 
1477
    'conflict', refuse_orphan,
 
1478
    'Leave orphans in place and create a conflict on the directory.')
 
1479
orphaning_registry.register(
 
1480
    'move', move_orphan,
 
1481
    'Move orphans into the bzr-orphans directory.')
 
1482
orphaning_registry._set_default_key('conflict')
 
1483
 
 
1484
 
 
1485
class TreeTransform(DiskTreeTransform):
 
1486
    """Represent a tree transformation.
 
1487
 
 
1488
    This object is designed to support incremental generation of the transform,
 
1489
    in any order.
 
1490
 
 
1491
    However, it gives optimum performance when parent directories are created
 
1492
    before their contents.  The transform is then able to put child files
 
1493
    directly in their parent directory, avoiding later renames.
 
1494
 
 
1495
    It is easy to produce malformed transforms, but they are generally
 
1496
    harmless.  Attempting to apply a malformed transform will cause an
 
1497
    exception to be raised before any modifications are made to the tree.
 
1498
 
 
1499
    Many kinds of malformed transforms can be corrected with the
 
1500
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1501
    such as trying to create a file with no path.
 
1502
 
 
1503
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1504
     * new_file
 
1505
     * new_directory
 
1506
     * new_symlink
 
1507
 
 
1508
    These are composed of the low-level methods:
 
1509
     * create_path
 
1510
     * create_file or create_directory or create_symlink
 
1511
     * version_file
 
1512
     * set_executability
 
1513
 
 
1514
    Transform/Transaction ids
 
1515
    -------------------------
 
1516
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1517
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1518
 
 
1519
    trans_ids are used because filenames and file_ids are not good enough
 
1520
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1521
    are also associated with trans-ids, so that moving a file moves its
 
1522
    file-id.
 
1523
 
 
1524
    trans_ids are only valid for the TreeTransform that generated them.
 
1525
 
 
1526
    Limbo
 
1527
    -----
 
1528
    Limbo is a temporary directory use to hold new versions of files.
 
1529
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1530
    and their convenience variants (new_*).  Files may be removed from limbo
 
1531
    using cancel_creation.  Files are renamed from limbo into their final
 
1532
    location as part of TreeTransform.apply
 
1533
 
 
1534
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1535
    calling TreeTransform.finalize.
 
1536
 
 
1537
    Files are placed into limbo inside their parent directories, where
 
1538
    possible.  This reduces subsequent renames, and makes operations involving
 
1539
    lots of files faster.  This optimization is only possible if the parent
 
1540
    directory is created *before* creating any of its children, so avoid
 
1541
    creating children before parents, where possible.
 
1542
 
 
1543
    Pending-deletion
 
1544
    ----------------
 
1545
    This temporary directory is used by _FileMover for storing files that are
 
1546
    about to be deleted.  In case of rollback, the files will be restored.
 
1547
    FileMover does not delete files until it is sure that a rollback will not
 
1548
    happen.
 
1549
    """
 
1550
    def __init__(self, tree, pb=None):
 
1551
        """Note: a tree_write lock is taken on the tree.
 
1552
 
 
1553
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1554
        TreeTransform.apply() called).
 
1555
        """
 
1556
        tree.lock_tree_write()
 
1557
 
 
1558
        try:
 
1559
            limbodir = urlutils.local_path_from_url(
 
1560
                tree._transport.abspath('limbo'))
 
1561
            try:
 
1562
                os.mkdir(limbodir)
 
1563
            except OSError, e:
 
1564
                if e.errno == errno.EEXIST:
 
1565
                    raise ExistingLimbo(limbodir)
 
1566
            deletiondir = urlutils.local_path_from_url(
 
1567
                tree._transport.abspath('pending-deletion'))
 
1568
            try:
 
1569
                os.mkdir(deletiondir)
 
1570
            except OSError, e:
 
1571
                if e.errno == errno.EEXIST:
 
1572
                    raise errors.ExistingPendingDeletion(deletiondir)
 
1573
        except:
 
1574
            tree.unlock()
 
1575
            raise
 
1576
 
 
1577
        # Cache of realpath results, to speed up canonical_path
 
1578
        self._realpaths = {}
 
1579
        # Cache of relpath results, to speed up canonical_path
 
1580
        self._relpaths = {}
 
1581
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1582
                                   tree.case_sensitive)
 
1583
        self._deletiondir = deletiondir
 
1584
 
 
1585
    def canonical_path(self, path):
 
1586
        """Get the canonical tree-relative path"""
 
1587
        # don't follow final symlinks
 
1588
        abs = self._tree.abspath(path)
 
1589
        if abs in self._relpaths:
 
1590
            return self._relpaths[abs]
 
1591
        dirname, basename = os.path.split(abs)
 
1592
        if dirname not in self._realpaths:
 
1593
            self._realpaths[dirname] = os.path.realpath(dirname)
 
1594
        dirname = self._realpaths[dirname]
 
1595
        abs = pathjoin(dirname, basename)
 
1596
        if dirname in self._relpaths:
 
1597
            relpath = pathjoin(self._relpaths[dirname], basename)
 
1598
            relpath = relpath.rstrip('/\\')
 
1599
        else:
 
1600
            relpath = self._tree.relpath(abs)
 
1601
        self._relpaths[abs] = relpath
 
1602
        return relpath
 
1603
 
 
1604
    def tree_kind(self, trans_id):
 
1605
        """Determine the file kind in the working tree.
 
1606
 
 
1607
        :returns: The file kind or None if the file does not exist
 
1608
        """
 
1609
        path = self._tree_id_paths.get(trans_id)
 
1610
        if path is None:
 
1611
            return None
 
1612
        try:
 
1613
            return file_kind(self._tree.abspath(path))
 
1614
        except errors.NoSuchFile:
 
1615
            return None
 
1616
 
 
1617
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1618
        """Set the mode of new file contents.
 
1619
        The mode_id is the existing file to get the mode from (often the same
 
1620
        as trans_id).  The operation is only performed if there's a mode match
 
1621
        according to typefunc.
 
1622
        """
 
1623
        if mode_id is None:
 
1624
            mode_id = trans_id
 
1625
        try:
 
1626
            old_path = self._tree_id_paths[mode_id]
 
1627
        except KeyError:
 
1628
            return
 
1629
        try:
 
1630
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
1631
        except OSError, e:
 
1632
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
1633
                # Either old_path doesn't exist, or the parent of the
 
1634
                # target is not a directory (but will be one eventually)
 
1635
                # Either way, we know it doesn't exist *right now*
 
1636
                # See also bug #248448
 
1637
                return
 
1638
            else:
 
1639
                raise
 
1640
        if typefunc(mode):
 
1641
            os.chmod(self._limbo_name(trans_id), mode)
 
1642
 
 
1643
    def iter_tree_children(self, parent_id):
 
1644
        """Iterate through the entry's tree children, if any"""
 
1645
        try:
 
1646
            path = self._tree_id_paths[parent_id]
 
1647
        except KeyError:
 
1648
            return
 
1649
        try:
 
1650
            children = os.listdir(self._tree.abspath(path))
 
1651
        except OSError, e:
 
1652
            if not (osutils._is_error_enotdir(e)
 
1653
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
1654
                raise
 
1655
            return
 
1656
 
 
1657
        for child in children:
 
1658
            childpath = joinpath(path, child)
 
1659
            if self._tree.is_control_filename(childpath):
 
1660
                continue
 
1661
            yield self.trans_id_tree_path(childpath)
 
1662
 
 
1663
    def _generate_limbo_path(self, trans_id):
 
1664
        """Generate a limbo path using the final path if possible.
 
1665
 
 
1666
        This optimizes the performance of applying the tree transform by
 
1667
        avoiding renames.  These renames can be avoided only when the parent
 
1668
        directory is already scheduled for creation.
 
1669
 
 
1670
        If the final path cannot be used, falls back to using the trans_id as
 
1671
        the relpath.
 
1672
        """
 
1673
        parent = self._new_parent.get(trans_id)
 
1674
        # if the parent directory is already in limbo (e.g. when building a
 
1675
        # tree), choose a limbo name inside the parent, to reduce further
 
1676
        # renames.
 
1677
        use_direct_path = False
 
1678
        if self._new_contents.get(parent) == 'directory':
 
1679
            filename = self._new_name.get(trans_id)
 
1680
            if filename is not None:
 
1681
                if parent not in self._limbo_children:
 
1682
                    self._limbo_children[parent] = set()
 
1683
                    self._limbo_children_names[parent] = {}
 
1684
                    use_direct_path = True
 
1685
                # the direct path can only be used if no other file has
 
1686
                # already taken this pathname, i.e. if the name is unused, or
 
1687
                # if it is already associated with this trans_id.
 
1688
                elif self._case_sensitive_target:
 
1689
                    if (self._limbo_children_names[parent].get(filename)
 
1690
                        in (trans_id, None)):
 
1691
                        use_direct_path = True
 
1692
                else:
 
1693
                    for l_filename, l_trans_id in\
 
1694
                        self._limbo_children_names[parent].iteritems():
 
1695
                        if l_trans_id == trans_id:
 
1696
                            continue
 
1697
                        if l_filename.lower() == filename.lower():
 
1698
                            break
 
1699
                    else:
 
1700
                        use_direct_path = True
 
1701
 
 
1702
        if not use_direct_path:
 
1703
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
 
1704
 
 
1705
        limbo_name = pathjoin(self._limbo_files[parent], filename)
 
1706
        self._limbo_children[parent].add(trans_id)
 
1707
        self._limbo_children_names[parent][filename] = trans_id
 
1708
        return limbo_name
 
1709
 
 
1710
 
 
1711
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1712
        """Apply all changes to the inventory and filesystem.
 
1713
 
 
1714
        If filesystem or inventory conflicts are present, MalformedTransform
 
1715
        will be thrown.
 
1716
 
 
1717
        If apply succeeds, finalize is not necessary.
 
1718
 
 
1719
        :param no_conflicts: if True, the caller guarantees there are no
 
1720
            conflicts, so no check is made.
 
1721
        :param precomputed_delta: An inventory delta to use instead of
 
1722
            calculating one.
 
1723
        :param _mover: Supply an alternate FileMover, for testing
 
1724
        """
 
1725
        if not no_conflicts:
 
1726
            self._check_malformed()
 
1727
        child_pb = ui.ui_factory.nested_progress_bar()
 
1728
        try:
 
1729
            if precomputed_delta is None:
 
1730
                child_pb.update(gettext('Apply phase'), 0, 2)
 
1731
                inventory_delta = self._generate_inventory_delta()
 
1732
                offset = 1
 
1733
            else:
 
1734
                inventory_delta = precomputed_delta
 
1735
                offset = 0
 
1736
            if _mover is None:
 
1737
                mover = _FileMover()
 
1738
            else:
 
1739
                mover = _mover
 
1740
            try:
 
1741
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
 
1742
                self._apply_removals(mover)
 
1743
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
 
1744
                modified_paths = self._apply_insertions(mover)
 
1745
            except:
 
1746
                mover.rollback()
 
1747
                raise
 
1748
            else:
 
1749
                mover.apply_deletions()
 
1750
        finally:
 
1751
            child_pb.finished()
 
1752
        if self.final_file_id(self.root) is None:
 
1753
            inventory_delta = [e for e in inventory_delta if e[0] != '']
 
1754
        self._tree.apply_inventory_delta(inventory_delta)
 
1755
        self._apply_observed_sha1s()
 
1756
        self._done = True
 
1757
        self.finalize()
 
1758
        return _TransformResults(modified_paths, self.rename_count)
 
1759
 
 
1760
    def _generate_inventory_delta(self):
 
1761
        """Generate an inventory delta for the current transform."""
 
1762
        inventory_delta = []
 
1763
        child_pb = ui.ui_factory.nested_progress_bar()
 
1764
        new_paths = self._inventory_altered()
 
1765
        total_entries = len(new_paths) + len(self._removed_id)
 
1766
        try:
 
1767
            for num, trans_id in enumerate(self._removed_id):
 
1768
                if (num % 10) == 0:
 
1769
                    child_pb.update(gettext('removing file'), num, total_entries)
 
1770
                if trans_id == self._new_root:
 
1771
                    file_id = self._tree.get_root_id()
 
1772
                else:
 
1773
                    file_id = self.tree_file_id(trans_id)
 
1774
                # File-id isn't really being deleted, just moved
 
1775
                if file_id in self._r_new_id:
 
1776
                    continue
 
1777
                path = self._tree_id_paths[trans_id]
 
1778
                inventory_delta.append((path, None, file_id, None))
 
1779
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1780
                                     new_paths)
 
1781
            entries = self._tree.iter_entries_by_dir(
 
1782
                new_path_file_ids.values())
 
1783
            old_paths = dict((e.file_id, p) for p, e in entries)
 
1784
            final_kinds = {}
 
1785
            for num, (path, trans_id) in enumerate(new_paths):
 
1786
                if (num % 10) == 0:
 
1787
                    child_pb.update(gettext('adding file'),
 
1788
                                    num + len(self._removed_id), total_entries)
 
1789
                file_id = new_path_file_ids[trans_id]
 
1790
                if file_id is None:
 
1791
                    continue
 
1792
                needs_entry = False
 
1793
                kind = self.final_kind(trans_id)
 
1794
                if kind is None:
 
1795
                    kind = self._tree.stored_kind(file_id)
 
1796
                parent_trans_id = self.final_parent(trans_id)
 
1797
                parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1798
                if parent_file_id is None:
 
1799
                    parent_file_id = self.final_file_id(parent_trans_id)
 
1800
                if trans_id in self._new_reference_revision:
 
1801
                    new_entry = inventory.TreeReference(
 
1802
                        file_id,
 
1803
                        self._new_name[trans_id],
 
1804
                        self.final_file_id(self._new_parent[trans_id]),
 
1805
                        None, self._new_reference_revision[trans_id])
 
1806
                else:
 
1807
                    new_entry = inventory.make_entry(kind,
 
1808
                        self.final_name(trans_id),
 
1809
                        parent_file_id, file_id)
 
1810
                old_path = old_paths.get(new_entry.file_id)
 
1811
                new_executability = self._new_executability.get(trans_id)
 
1812
                if new_executability is not None:
 
1813
                    new_entry.executable = new_executability
 
1814
                inventory_delta.append(
 
1815
                    (old_path, path, new_entry.file_id, new_entry))
 
1816
        finally:
 
1817
            child_pb.finished()
 
1818
        return inventory_delta
 
1819
 
 
1820
    def _apply_removals(self, mover):
 
1821
        """Perform tree operations that remove directory/inventory names.
 
1822
 
 
1823
        That is, delete files that are to be deleted, and put any files that
 
1824
        need renaming into limbo.  This must be done in strict child-to-parent
 
1825
        order.
 
1826
 
 
1827
        If inventory_delta is None, no inventory delta generation is performed.
 
1828
        """
 
1829
        tree_paths = list(self._tree_path_ids.iteritems())
 
1830
        tree_paths.sort(reverse=True)
 
1831
        child_pb = ui.ui_factory.nested_progress_bar()
 
1832
        try:
 
1833
            for num, (path, trans_id) in enumerate(tree_paths):
 
1834
                # do not attempt to move root into a subdirectory of itself.
 
1835
                if path == '':
 
1836
                    continue
 
1837
                child_pb.update(gettext('removing file'), num, len(tree_paths))
 
1838
                full_path = self._tree.abspath(path)
 
1839
                if trans_id in self._removed_contents:
 
1840
                    delete_path = os.path.join(self._deletiondir, trans_id)
 
1841
                    mover.pre_delete(full_path, delete_path)
 
1842
                elif (trans_id in self._new_name
 
1843
                      or trans_id in self._new_parent):
 
1844
                    try:
 
1845
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1846
                    except errors.TransformRenameFailed, e:
 
1847
                        if e.errno != errno.ENOENT:
 
1848
                            raise
 
1849
                    else:
 
1850
                        self.rename_count += 1
 
1851
        finally:
 
1852
            child_pb.finished()
 
1853
 
 
1854
    def _apply_insertions(self, mover):
 
1855
        """Perform tree operations that insert directory/inventory names.
 
1856
 
 
1857
        That is, create any files that need to be created, and restore from
 
1858
        limbo any files that needed renaming.  This must be done in strict
 
1859
        parent-to-child order.
 
1860
 
 
1861
        If inventory_delta is None, no inventory delta is calculated, and
 
1862
        no list of modified paths is returned.
 
1863
        """
 
1864
        new_paths = self.new_paths(filesystem_only=True)
 
1865
        modified_paths = []
 
1866
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1867
                                 new_paths)
 
1868
        child_pb = ui.ui_factory.nested_progress_bar()
 
1869
        try:
 
1870
            for num, (path, trans_id) in enumerate(new_paths):
 
1871
                if (num % 10) == 0:
 
1872
                    child_pb.update(gettext('adding file'), num, len(new_paths))
 
1873
                full_path = self._tree.abspath(path)
 
1874
                if trans_id in self._needs_rename:
 
1875
                    try:
 
1876
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1877
                    except errors.TransformRenameFailed, e:
 
1878
                        # We may be renaming a dangling inventory id
 
1879
                        if e.errno != errno.ENOENT:
 
1880
                            raise
 
1881
                    else:
 
1882
                        self.rename_count += 1
 
1883
                    # TODO: if trans_id in self._observed_sha1s, we should
 
1884
                    #       re-stat the final target, since ctime will be
 
1885
                    #       updated by the change.
 
1886
                if (trans_id in self._new_contents or
 
1887
                    self.path_changed(trans_id)):
 
1888
                    if trans_id in self._new_contents:
 
1889
                        modified_paths.append(full_path)
 
1890
                if trans_id in self._new_executability:
 
1891
                    self._set_executability(path, trans_id)
 
1892
                if trans_id in self._observed_sha1s:
 
1893
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
 
1894
                    st = osutils.lstat(full_path)
 
1895
                    self._observed_sha1s[trans_id] = (o_sha1, st)
 
1896
        finally:
 
1897
            child_pb.finished()
 
1898
        for path, trans_id in new_paths:
 
1899
            # new_paths includes stuff like workingtree conflicts. Only the
 
1900
            # stuff in new_contents actually comes from limbo.
 
1901
            if trans_id in self._limbo_files:
 
1902
                del self._limbo_files[trans_id]
 
1903
        self._new_contents.clear()
 
1904
        return modified_paths
 
1905
 
 
1906
    def _apply_observed_sha1s(self):
 
1907
        """After we have finished renaming everything, update observed sha1s
 
1908
 
 
1909
        This has to be done after self._tree.apply_inventory_delta, otherwise
 
1910
        it doesn't know anything about the files we are updating. Also, we want
 
1911
        to do this as late as possible, so that most entries end up cached.
 
1912
        """
 
1913
        # TODO: this doesn't update the stat information for directories. So
 
1914
        #       the first 'bzr status' will still need to rewrite
 
1915
        #       .bzr/checkout/dirstate. However, we at least don't need to
 
1916
        #       re-read all of the files.
 
1917
        # TODO: If the operation took a while, we could do a time.sleep(3) here
 
1918
        #       to allow the clock to tick over and ensure we won't have any
 
1919
        #       problems. (we could observe start time, and finish time, and if
 
1920
        #       it is less than eg 10% overhead, add a sleep call.)
 
1921
        paths = FinalPaths(self)
 
1922
        for trans_id, observed in self._observed_sha1s.iteritems():
 
1923
            path = paths.get_path(trans_id)
 
1924
            # We could get the file_id, but dirstate prefers to use the path
 
1925
            # anyway, and it is 'cheaper' to determine.
 
1926
            # file_id = self._new_id[trans_id]
 
1927
            self._tree._observed_sha1(None, path, observed)
 
1928
 
 
1929
 
 
1930
class TransformPreview(DiskTreeTransform):
 
1931
    """A TreeTransform for generating preview trees.
 
1932
 
 
1933
    Unlike TreeTransform, this version works when the input tree is a
 
1934
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1935
    unversioned files in the input tree.
 
1936
    """
 
1937
 
 
1938
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1939
        tree.lock_read()
 
1940
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
 
1941
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1942
 
 
1943
    def canonical_path(self, path):
 
1944
        return path
 
1945
 
 
1946
    def tree_kind(self, trans_id):
 
1947
        path = self._tree_id_paths.get(trans_id)
 
1948
        if path is None:
 
1949
            return None
 
1950
        kind = self._tree.path_content_summary(path)[0]
 
1951
        if kind == 'missing':
 
1952
            kind = None
 
1953
        return kind
 
1954
 
 
1955
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1956
        """Set the mode of new file contents.
 
1957
        The mode_id is the existing file to get the mode from (often the same
 
1958
        as trans_id).  The operation is only performed if there's a mode match
 
1959
        according to typefunc.
 
1960
        """
 
1961
        # is it ok to ignore this?  probably
 
1962
        pass
 
1963
 
 
1964
    def iter_tree_children(self, parent_id):
 
1965
        """Iterate through the entry's tree children, if any"""
 
1966
        try:
 
1967
            path = self._tree_id_paths[parent_id]
 
1968
        except KeyError:
 
1969
            return
 
1970
        file_id = self.tree_file_id(parent_id)
 
1971
        if file_id is None:
 
1972
            return
 
1973
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1974
        children = getattr(entry, 'children', {})
 
1975
        for child in children:
 
1976
            childpath = joinpath(path, child)
 
1977
            yield self.trans_id_tree_path(childpath)
 
1978
 
 
1979
    def new_orphan(self, trans_id, parent_id):
 
1980
        raise NotImplementedError(self.new_orphan)
 
1981
 
 
1982
 
 
1983
class _PreviewTree(tree.InventoryTree):
 
1984
    """Partial implementation of Tree to support show_diff_trees"""
 
1985
 
 
1986
    def __init__(self, transform):
 
1987
        self._transform = transform
 
1988
        self._final_paths = FinalPaths(transform)
 
1989
        self.__by_parent = None
 
1990
        self._parent_ids = []
 
1991
        self._all_children_cache = {}
 
1992
        self._path2trans_id_cache = {}
 
1993
        self._final_name_cache = {}
 
1994
        self._iter_changes_cache = dict((c[0], c) for c in
 
1995
                                        self._transform.iter_changes())
 
1996
 
 
1997
    def _content_change(self, file_id):
 
1998
        """Return True if the content of this file changed"""
 
1999
        changes = self._iter_changes_cache.get(file_id)
 
2000
        # changes[2] is true if the file content changed.  See
 
2001
        # InterTree.iter_changes.
 
2002
        return (changes is not None and changes[2])
 
2003
 
 
2004
    def _get_repository(self):
 
2005
        repo = getattr(self._transform._tree, '_repository', None)
 
2006
        if repo is None:
 
2007
            repo = self._transform._tree.branch.repository
 
2008
        return repo
 
2009
 
 
2010
    def _iter_parent_trees(self):
 
2011
        for revision_id in self.get_parent_ids():
 
2012
            try:
 
2013
                yield self.revision_tree(revision_id)
 
2014
            except errors.NoSuchRevisionInTree:
 
2015
                yield self._get_repository().revision_tree(revision_id)
 
2016
 
 
2017
    def _get_file_revision(self, file_id, vf, tree_revision):
 
2018
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
2019
                       self._iter_parent_trees()]
 
2020
        vf.add_lines((file_id, tree_revision), parent_keys,
 
2021
                     self.get_file_lines(file_id))
 
2022
        repo = self._get_repository()
 
2023
        base_vf = repo.texts
 
2024
        if base_vf not in vf.fallback_versionedfiles:
 
2025
            vf.fallback_versionedfiles.append(base_vf)
 
2026
        return tree_revision
 
2027
 
 
2028
    def _stat_limbo_file(self, file_id=None, trans_id=None):
 
2029
        if trans_id is None:
 
2030
            trans_id = self._transform.trans_id_file_id(file_id)
 
2031
        name = self._transform._limbo_name(trans_id)
 
2032
        return os.lstat(name)
 
2033
 
 
2034
    @property
 
2035
    def _by_parent(self):
 
2036
        if self.__by_parent is None:
 
2037
            self.__by_parent = self._transform.by_parent()
 
2038
        return self.__by_parent
 
2039
 
 
2040
    def _comparison_data(self, entry, path):
 
2041
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
 
2042
        if kind == 'missing':
 
2043
            kind = None
 
2044
            executable = False
 
2045
        else:
 
2046
            file_id = self._transform.final_file_id(self._path2trans_id(path))
 
2047
            executable = self.is_executable(file_id, path)
 
2048
        return kind, executable, None
 
2049
 
 
2050
    def is_locked(self):
 
2051
        return False
 
2052
 
 
2053
    def lock_read(self):
 
2054
        # Perhaps in theory, this should lock the TreeTransform?
 
2055
        return self
 
2056
 
 
2057
    def unlock(self):
 
2058
        pass
 
2059
 
 
2060
    @property
 
2061
    def inventory(self):
 
2062
        """This Tree does not use inventory as its backing data."""
 
2063
        raise NotImplementedError(_PreviewTree.inventory)
 
2064
 
 
2065
    def get_root_id(self):
 
2066
        return self._transform.final_file_id(self._transform.root)
 
2067
 
 
2068
    def all_file_ids(self):
 
2069
        tree_ids = set(self._transform._tree.all_file_ids())
 
2070
        tree_ids.difference_update(self._transform.tree_file_id(t)
 
2071
                                   for t in self._transform._removed_id)
 
2072
        tree_ids.update(self._transform._new_id.values())
 
2073
        return tree_ids
 
2074
 
 
2075
    def __iter__(self):
 
2076
        return iter(self.all_file_ids())
 
2077
 
 
2078
    def _has_id(self, file_id, fallback_check):
 
2079
        if file_id in self._transform._r_new_id:
 
2080
            return True
 
2081
        elif file_id in set([self._transform.tree_file_id(trans_id) for
 
2082
            trans_id in self._transform._removed_id]):
 
2083
            return False
 
2084
        else:
 
2085
            return fallback_check(file_id)
 
2086
 
 
2087
    def has_id(self, file_id):
 
2088
        return self._has_id(file_id, self._transform._tree.has_id)
 
2089
 
 
2090
    def has_or_had_id(self, file_id):
 
2091
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
2092
 
 
2093
    def _path2trans_id(self, path):
 
2094
        # We must not use None here, because that is a valid value to store.
 
2095
        trans_id = self._path2trans_id_cache.get(path, object)
 
2096
        if trans_id is not object:
 
2097
            return trans_id
 
2098
        segments = splitpath(path)
 
2099
        cur_parent = self._transform.root
 
2100
        for cur_segment in segments:
 
2101
            for child in self._all_children(cur_parent):
 
2102
                final_name = self._final_name_cache.get(child)
 
2103
                if final_name is None:
 
2104
                    final_name = self._transform.final_name(child)
 
2105
                    self._final_name_cache[child] = final_name
 
2106
                if final_name == cur_segment:
 
2107
                    cur_parent = child
 
2108
                    break
 
2109
            else:
 
2110
                self._path2trans_id_cache[path] = None
 
2111
                return None
 
2112
        self._path2trans_id_cache[path] = cur_parent
 
2113
        return cur_parent
 
2114
 
 
2115
    def path2id(self, path):
 
2116
        return self._transform.final_file_id(self._path2trans_id(path))
 
2117
 
 
2118
    def id2path(self, file_id):
 
2119
        trans_id = self._transform.trans_id_file_id(file_id)
 
2120
        try:
 
2121
            return self._final_paths._determine_path(trans_id)
 
2122
        except NoFinalPath:
 
2123
            raise errors.NoSuchId(self, file_id)
 
2124
 
 
2125
    def _all_children(self, trans_id):
 
2126
        children = self._all_children_cache.get(trans_id)
 
2127
        if children is not None:
 
2128
            return children
 
2129
        children = set(self._transform.iter_tree_children(trans_id))
 
2130
        # children in the _new_parent set are provided by _by_parent.
 
2131
        children.difference_update(self._transform._new_parent.keys())
 
2132
        children.update(self._by_parent.get(trans_id, []))
 
2133
        self._all_children_cache[trans_id] = children
 
2134
        return children
 
2135
 
 
2136
    def iter_children(self, file_id):
 
2137
        trans_id = self._transform.trans_id_file_id(file_id)
 
2138
        for child_trans_id in self._all_children(trans_id):
 
2139
            yield self._transform.final_file_id(child_trans_id)
 
2140
 
 
2141
    def extras(self):
 
2142
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
 
2143
                              in self._transform._tree.extras())
 
2144
        possible_extras.update(self._transform._new_contents)
 
2145
        possible_extras.update(self._transform._removed_id)
 
2146
        for trans_id in possible_extras:
 
2147
            if self._transform.final_file_id(trans_id) is None:
 
2148
                yield self._final_paths._determine_path(trans_id)
 
2149
 
 
2150
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
 
2151
        yield_parents=False):
 
2152
        for trans_id, parent_file_id in ordered_entries:
 
2153
            file_id = self._transform.final_file_id(trans_id)
 
2154
            if file_id is None:
 
2155
                continue
 
2156
            if (specific_file_ids is not None
 
2157
                and file_id not in specific_file_ids):
 
2158
                continue
 
2159
            kind = self._transform.final_kind(trans_id)
 
2160
            if kind is None:
 
2161
                kind = self._transform._tree.stored_kind(file_id)
 
2162
            new_entry = inventory.make_entry(
 
2163
                kind,
 
2164
                self._transform.final_name(trans_id),
 
2165
                parent_file_id, file_id)
 
2166
            yield new_entry, trans_id
 
2167
 
 
2168
    def _list_files_by_dir(self):
 
2169
        todo = [ROOT_PARENT]
 
2170
        ordered_ids = []
 
2171
        while len(todo) > 0:
 
2172
            parent = todo.pop()
 
2173
            parent_file_id = self._transform.final_file_id(parent)
 
2174
            children = list(self._all_children(parent))
 
2175
            paths = dict(zip(children, self._final_paths.get_paths(children)))
 
2176
            children.sort(key=paths.get)
 
2177
            todo.extend(reversed(children))
 
2178
            for trans_id in children:
 
2179
                ordered_ids.append((trans_id, parent_file_id))
 
2180
        return ordered_ids
 
2181
 
 
2182
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
2183
        # This may not be a maximally efficient implementation, but it is
 
2184
        # reasonably straightforward.  An implementation that grafts the
 
2185
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
2186
        # might be more efficient, but requires tricky inferences about stack
 
2187
        # position.
 
2188
        ordered_ids = self._list_files_by_dir()
 
2189
        for entry, trans_id in self._make_inv_entries(ordered_ids,
 
2190
            specific_file_ids, yield_parents=yield_parents):
 
2191
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
2192
 
 
2193
    def _iter_entries_for_dir(self, dir_path):
 
2194
        """Return path, entry for items in a directory without recursing down."""
 
2195
        dir_file_id = self.path2id(dir_path)
 
2196
        ordered_ids = []
 
2197
        for file_id in self.iter_children(dir_file_id):
 
2198
            trans_id = self._transform.trans_id_file_id(file_id)
 
2199
            ordered_ids.append((trans_id, file_id))
 
2200
        for entry, trans_id in self._make_inv_entries(ordered_ids):
 
2201
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
2202
 
 
2203
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2204
        """See WorkingTree.list_files."""
 
2205
        # XXX This should behave like WorkingTree.list_files, but is really
 
2206
        # more like RevisionTree.list_files.
 
2207
        if recursive:
 
2208
            prefix = None
 
2209
            if from_dir:
 
2210
                prefix = from_dir + '/'
 
2211
            entries = self.iter_entries_by_dir()
 
2212
            for path, entry in entries:
 
2213
                if entry.name == '' and not include_root:
 
2214
                    continue
 
2215
                if prefix:
 
2216
                    if not path.startswith(prefix):
 
2217
                        continue
 
2218
                    path = path[len(prefix):]
 
2219
                yield path, 'V', entry.kind, entry.file_id, entry
 
2220
        else:
 
2221
            if from_dir is None and include_root is True:
 
2222
                root_entry = inventory.make_entry('directory', '',
 
2223
                    ROOT_PARENT, self.get_root_id())
 
2224
                yield '', 'V', 'directory', root_entry.file_id, root_entry
 
2225
            entries = self._iter_entries_for_dir(from_dir or '')
 
2226
            for path, entry in entries:
 
2227
                yield path, 'V', entry.kind, entry.file_id, entry
 
2228
 
 
2229
    def kind(self, file_id):
 
2230
        trans_id = self._transform.trans_id_file_id(file_id)
 
2231
        return self._transform.final_kind(trans_id)
 
2232
 
 
2233
    def stored_kind(self, file_id):
 
2234
        trans_id = self._transform.trans_id_file_id(file_id)
 
2235
        try:
 
2236
            return self._transform._new_contents[trans_id]
 
2237
        except KeyError:
 
2238
            return self._transform._tree.stored_kind(file_id)
 
2239
 
 
2240
    def get_file_mtime(self, file_id, path=None):
 
2241
        """See Tree.get_file_mtime"""
 
2242
        if not self._content_change(file_id):
 
2243
            return self._transform._tree.get_file_mtime(file_id)
 
2244
        return self._stat_limbo_file(file_id).st_mtime
 
2245
 
 
2246
    def _file_size(self, entry, stat_value):
 
2247
        return self.get_file_size(entry.file_id)
 
2248
 
 
2249
    def get_file_size(self, file_id):
 
2250
        """See Tree.get_file_size"""
 
2251
        trans_id = self._transform.trans_id_file_id(file_id)
 
2252
        kind = self._transform.final_kind(trans_id)
 
2253
        if kind != 'file':
 
2254
            return None
 
2255
        if trans_id in self._transform._new_contents:
 
2256
            return self._stat_limbo_file(trans_id=trans_id).st_size
 
2257
        if self.kind(file_id) == 'file':
 
2258
            return self._transform._tree.get_file_size(file_id)
 
2259
        else:
 
2260
            return None
 
2261
 
 
2262
    def get_file_verifier(self, file_id, path=None, stat_value=None):
 
2263
        trans_id = self._transform.trans_id_file_id(file_id)
 
2264
        kind = self._transform._new_contents.get(trans_id)
 
2265
        if kind is None:
 
2266
            return self._transform._tree.get_file_verifier(file_id)
 
2267
        if kind == 'file':
 
2268
            fileobj = self.get_file(file_id)
 
2269
            try:
 
2270
                return ("SHA1", sha_file(fileobj))
 
2271
            finally:
 
2272
                fileobj.close()
 
2273
 
 
2274
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
2275
        trans_id = self._transform.trans_id_file_id(file_id)
 
2276
        kind = self._transform._new_contents.get(trans_id)
 
2277
        if kind is None:
 
2278
            return self._transform._tree.get_file_sha1(file_id)
 
2279
        if kind == 'file':
 
2280
            fileobj = self.get_file(file_id)
 
2281
            try:
 
2282
                return sha_file(fileobj)
 
2283
            finally:
 
2284
                fileobj.close()
 
2285
 
 
2286
    def is_executable(self, file_id, path=None):
 
2287
        if file_id is None:
 
2288
            return False
 
2289
        trans_id = self._transform.trans_id_file_id(file_id)
 
2290
        try:
 
2291
            return self._transform._new_executability[trans_id]
 
2292
        except KeyError:
 
2293
            try:
 
2294
                return self._transform._tree.is_executable(file_id, path)
 
2295
            except OSError, e:
 
2296
                if e.errno == errno.ENOENT:
 
2297
                    return False
 
2298
                raise
 
2299
            except errors.NoSuchId:
 
2300
                return False
 
2301
 
 
2302
    def has_filename(self, path):
 
2303
        trans_id = self._path2trans_id(path)
 
2304
        if trans_id in self._transform._new_contents:
 
2305
            return True
 
2306
        elif trans_id in self._transform._removed_contents:
 
2307
            return False
 
2308
        else:
 
2309
            return self._transform._tree.has_filename(path)
 
2310
 
 
2311
    def path_content_summary(self, path):
 
2312
        trans_id = self._path2trans_id(path)
 
2313
        tt = self._transform
 
2314
        tree_path = tt._tree_id_paths.get(trans_id)
 
2315
        kind = tt._new_contents.get(trans_id)
 
2316
        if kind is None:
 
2317
            if tree_path is None or trans_id in tt._removed_contents:
 
2318
                return 'missing', None, None, None
 
2319
            summary = tt._tree.path_content_summary(tree_path)
 
2320
            kind, size, executable, link_or_sha1 = summary
 
2321
        else:
 
2322
            link_or_sha1 = None
 
2323
            limbo_name = tt._limbo_name(trans_id)
 
2324
            if trans_id in tt._new_reference_revision:
 
2325
                kind = 'tree-reference'
 
2326
            if kind == 'file':
 
2327
                statval = os.lstat(limbo_name)
 
2328
                size = statval.st_size
 
2329
                if not supports_executable():
 
2330
                    executable = False
 
2331
                else:
 
2332
                    executable = statval.st_mode & S_IEXEC
 
2333
            else:
 
2334
                size = None
 
2335
                executable = None
 
2336
            if kind == 'symlink':
 
2337
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
2338
        executable = tt._new_executability.get(trans_id, executable)
 
2339
        return kind, size, executable, link_or_sha1
 
2340
 
 
2341
    def iter_changes(self, from_tree, include_unchanged=False,
 
2342
                      specific_files=None, pb=None, extra_trees=None,
 
2343
                      require_versioned=True, want_unversioned=False):
 
2344
        """See InterTree.iter_changes.
 
2345
 
 
2346
        This has a fast path that is only used when the from_tree matches
 
2347
        the transform tree, and no fancy options are supplied.
 
2348
        """
 
2349
        if (from_tree is not self._transform._tree or include_unchanged or
 
2350
            specific_files or want_unversioned):
 
2351
            return tree.InterTree(from_tree, self).iter_changes(
 
2352
                include_unchanged=include_unchanged,
 
2353
                specific_files=specific_files,
 
2354
                pb=pb,
 
2355
                extra_trees=extra_trees,
 
2356
                require_versioned=require_versioned,
 
2357
                want_unversioned=want_unversioned)
 
2358
        if want_unversioned:
 
2359
            raise ValueError('want_unversioned is not supported')
 
2360
        return self._transform.iter_changes()
 
2361
 
 
2362
    def get_file(self, file_id, path=None):
 
2363
        """See Tree.get_file"""
 
2364
        if not self._content_change(file_id):
 
2365
            return self._transform._tree.get_file(file_id, path)
 
2366
        trans_id = self._transform.trans_id_file_id(file_id)
 
2367
        name = self._transform._limbo_name(trans_id)
 
2368
        return open(name, 'rb')
 
2369
 
 
2370
    def get_file_with_stat(self, file_id, path=None):
 
2371
        return self.get_file(file_id, path), None
 
2372
 
 
2373
    def annotate_iter(self, file_id,
 
2374
                      default_revision=_mod_revision.CURRENT_REVISION):
 
2375
        changes = self._iter_changes_cache.get(file_id)
 
2376
        if changes is None:
 
2377
            get_old = True
 
2378
        else:
 
2379
            changed_content, versioned, kind = (changes[2], changes[3],
 
2380
                                                changes[6])
 
2381
            if kind[1] is None:
 
2382
                return None
 
2383
            get_old = (kind[0] == 'file' and versioned[0])
 
2384
        if get_old:
 
2385
            old_annotation = self._transform._tree.annotate_iter(file_id,
 
2386
                default_revision=default_revision)
 
2387
        else:
 
2388
            old_annotation = []
 
2389
        if changes is None:
 
2390
            return old_annotation
 
2391
        if not changed_content:
 
2392
            return old_annotation
 
2393
        # TODO: This is doing something similar to what WT.annotate_iter is
 
2394
        #       doing, however it fails slightly because it doesn't know what
 
2395
        #       the *other* revision_id is, so it doesn't know how to give the
 
2396
        #       other as the origin for some lines, they all get
 
2397
        #       'default_revision'
 
2398
        #       It would be nice to be able to use the new Annotator based
 
2399
        #       approach, as well.
 
2400
        return annotate.reannotate([old_annotation],
 
2401
                                   self.get_file(file_id).readlines(),
 
2402
                                   default_revision)
 
2403
 
 
2404
    def get_symlink_target(self, file_id, path=None):
 
2405
        """See Tree.get_symlink_target"""
 
2406
        if not self._content_change(file_id):
 
2407
            return self._transform._tree.get_symlink_target(file_id)
 
2408
        trans_id = self._transform.trans_id_file_id(file_id)
 
2409
        name = self._transform._limbo_name(trans_id)
 
2410
        return osutils.readlink(name)
 
2411
 
 
2412
    def walkdirs(self, prefix=''):
 
2413
        pending = [self._transform.root]
 
2414
        while len(pending) > 0:
 
2415
            parent_id = pending.pop()
 
2416
            children = []
 
2417
            subdirs = []
 
2418
            prefix = prefix.rstrip('/')
 
2419
            parent_path = self._final_paths.get_path(parent_id)
 
2420
            parent_file_id = self._transform.final_file_id(parent_id)
 
2421
            for child_id in self._all_children(parent_id):
 
2422
                path_from_root = self._final_paths.get_path(child_id)
 
2423
                basename = self._transform.final_name(child_id)
 
2424
                file_id = self._transform.final_file_id(child_id)
 
2425
                kind  = self._transform.final_kind(child_id)
 
2426
                if kind is not None:
 
2427
                    versioned_kind = kind
 
2428
                else:
 
2429
                    kind = 'unknown'
 
2430
                    versioned_kind = self._transform._tree.stored_kind(file_id)
 
2431
                if versioned_kind == 'directory':
 
2432
                    subdirs.append(child_id)
 
2433
                children.append((path_from_root, basename, kind, None,
 
2434
                                 file_id, versioned_kind))
 
2435
            children.sort()
 
2436
            if parent_path.startswith(prefix):
 
2437
                yield (parent_path, parent_file_id), children
 
2438
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
 
2439
                                  reverse=True))
 
2440
 
 
2441
    def get_parent_ids(self):
 
2442
        return self._parent_ids
 
2443
 
 
2444
    def set_parent_ids(self, parent_ids):
 
2445
        self._parent_ids = parent_ids
 
2446
 
 
2447
    def get_revision_tree(self, revision_id):
 
2448
        return self._transform._tree.get_revision_tree(revision_id)
 
2449
 
1042
2450
 
1043
2451
def joinpath(parent, child):
1044
2452
    """Join tree-relative paths, handling the tree root specially"""
1060
2468
        self.transform = transform
1061
2469
 
1062
2470
    def _determine_path(self, trans_id):
1063
 
        if trans_id == self.transform.root:
 
2471
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
1064
2472
            return ""
1065
2473
        name = self.transform.final_name(trans_id)
1066
2474
        parent_id = self.transform.final_parent(trans_id)
1075
2483
            self._known_paths[trans_id] = self._determine_path(trans_id)
1076
2484
        return self._known_paths[trans_id]
1077
2485
 
 
2486
    def get_paths(self, trans_ids):
 
2487
        return [(self.get_path(t), t) for t in trans_ids]
 
2488
 
 
2489
 
 
2490
 
1078
2491
def topology_sorted_ids(tree):
1079
2492
    """Determine the topological order of the ids in a tree"""
1080
2493
    file_ids = list(tree)
1082
2495
    return file_ids
1083
2496
 
1084
2497
 
1085
 
def build_tree(tree, wt):
 
2498
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
 
2499
               delta_from_tree=False):
1086
2500
    """Create working tree for a branch, using a TreeTransform.
1087
 
    
 
2501
 
1088
2502
    This function should be used on empty trees, having a tree root at most.
1089
2503
    (see merge and revert functionality for working with existing trees)
1090
2504
 
1091
2505
    Existing files are handled like so:
1092
 
    
 
2506
 
1093
2507
    - Existing bzrdirs take precedence over creating new items.  They are
1094
2508
      created as '%s.diverted' % name.
1095
2509
    - Otherwise, if the content on disk matches the content we are building,
1096
2510
      it is silently replaced.
1097
2511
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
2512
 
 
2513
    :param tree: The tree to convert wt into a copy of
 
2514
    :param wt: The working tree that files will be placed into
 
2515
    :param accelerator_tree: A tree which can be used for retrieving file
 
2516
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
2517
        will be used for cases where accelerator_tree's content is different.
 
2518
    :param hardlink: If true, hard-link files to accelerator_tree, where
 
2519
        possible.  accelerator_tree must implement abspath, i.e. be a
 
2520
        working tree.
 
2521
    :param delta_from_tree: If true, build_tree may use the input Tree to
 
2522
        generate the inventory delta.
1098
2523
    """
1099
 
    if len(wt.inventory) > 1:  # more than just a root
1100
 
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2524
    wt.lock_tree_write()
 
2525
    try:
 
2526
        tree.lock_read()
 
2527
        try:
 
2528
            if accelerator_tree is not None:
 
2529
                accelerator_tree.lock_read()
 
2530
            try:
 
2531
                return _build_tree(tree, wt, accelerator_tree, hardlink,
 
2532
                                   delta_from_tree)
 
2533
            finally:
 
2534
                if accelerator_tree is not None:
 
2535
                    accelerator_tree.unlock()
 
2536
        finally:
 
2537
            tree.unlock()
 
2538
    finally:
 
2539
        wt.unlock()
 
2540
 
 
2541
 
 
2542
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
2543
    """See build_tree."""
 
2544
    for num, _unused in enumerate(wt.all_file_ids()):
 
2545
        if num > 0:  # more than just a root
 
2546
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1101
2547
    file_trans_id = {}
1102
 
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2548
    top_pb = ui.ui_factory.nested_progress_bar()
1103
2549
    pp = ProgressPhase("Build phase", 2, top_pb)
1104
2550
    if tree.inventory.root is not None:
1105
 
        wt.set_root_id(tree.inventory.root.file_id)
 
2551
        # This is kind of a hack: we should be altering the root
 
2552
        # as part of the regular tree shape diff logic.
 
2553
        # The conditional test here is to avoid doing an
 
2554
        # expensive operation (flush) every time the root id
 
2555
        # is set within the tree, nor setting the root and thus
 
2556
        # marking the tree as dirty, because we use two different
 
2557
        # idioms here: tree interfaces and inventory interfaces.
 
2558
        if wt.get_root_id() != tree.get_root_id():
 
2559
            wt.set_root_id(tree.get_root_id())
 
2560
            wt.flush()
1106
2561
    tt = TreeTransform(wt)
1107
2562
    divert = set()
1108
2563
    try:
1109
2564
        pp.next_phase()
1110
2565
        file_trans_id[wt.get_root_id()] = \
1111
2566
            tt.trans_id_tree_file_id(wt.get_root_id())
1112
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2567
        pb = ui.ui_factory.nested_progress_bar()
1113
2568
        try:
 
2569
            deferred_contents = []
 
2570
            num = 0
 
2571
            total = len(tree.inventory)
 
2572
            if delta_from_tree:
 
2573
                precomputed_delta = []
 
2574
            else:
 
2575
                precomputed_delta = None
 
2576
            # Check if tree inventory has content. If so, we populate
 
2577
            # existing_files with the directory content. If there are no
 
2578
            # entries we skip populating existing_files as its not used.
 
2579
            # This improves performance and unncessary work on large
 
2580
            # directory trees. (#501307)
 
2581
            if total > 0:
 
2582
                existing_files = set()
 
2583
                for dir, files in wt.walkdirs():
 
2584
                    existing_files.update(f[0] for f in files)
1114
2585
            for num, (tree_path, entry) in \
1115
2586
                enumerate(tree.inventory.iter_entries_by_dir()):
1116
 
                pb.update("Building tree", num, len(tree.inventory))
 
2587
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
1117
2588
                if entry.parent_id is None:
1118
2589
                    continue
1119
2590
                reparent = False
1120
2591
                file_id = entry.file_id
1121
 
                target_path = wt.abspath(tree_path)
1122
 
                try:
 
2592
                if delta_from_tree:
 
2593
                    precomputed_delta.append((None, tree_path, file_id, entry))
 
2594
                if tree_path in existing_files:
 
2595
                    target_path = wt.abspath(tree_path)
1123
2596
                    kind = file_kind(target_path)
1124
 
                except NoSuchFile:
1125
 
                    pass
1126
 
                else:
1127
2597
                    if kind == "directory":
1128
2598
                        try:
1129
2599
                            bzrdir.BzrDir.open(target_path)
1137
2607
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
1138
2608
                        if kind == 'directory':
1139
2609
                            reparent = True
1140
 
                if entry.parent_id not in file_trans_id:
1141
 
                    raise repr(entry.parent_id)
1142
2610
                parent_id = file_trans_id[entry.parent_id]
1143
 
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1144
 
                                                      tree)
 
2611
                if entry.kind == 'file':
 
2612
                    # We *almost* replicate new_by_entry, so that we can defer
 
2613
                    # getting the file text, and get them all at once.
 
2614
                    trans_id = tt.create_path(entry.name, parent_id)
 
2615
                    file_trans_id[file_id] = trans_id
 
2616
                    tt.version_file(file_id, trans_id)
 
2617
                    executable = tree.is_executable(file_id, tree_path)
 
2618
                    if executable:
 
2619
                        tt.set_executability(executable, trans_id)
 
2620
                    trans_data = (trans_id, tree_path, entry.text_sha1)
 
2621
                    deferred_contents.append((file_id, trans_data))
 
2622
                else:
 
2623
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
2624
                                                          tree)
1145
2625
                if reparent:
1146
2626
                    new_trans_id = file_trans_id[file_id]
1147
2627
                    old_parent = tt.trans_id_tree_path(tree_path)
1148
2628
                    _reparent_children(tt, old_parent, new_trans_id)
 
2629
            offset = num + 1 - len(deferred_contents)
 
2630
            _create_files(tt, tree, deferred_contents, pb, offset,
 
2631
                          accelerator_tree, hardlink)
1149
2632
        finally:
1150
2633
            pb.finished()
1151
2634
        pp.next_phase()
1152
2635
        divert_trans = set(file_trans_id[f] for f in divert)
1153
2636
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1154
2637
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
2638
        if len(raw_conflicts) > 0:
 
2639
            precomputed_delta = None
1155
2640
        conflicts = cook_conflicts(raw_conflicts, tt)
1156
2641
        for conflict in conflicts:
1157
 
            warning(conflict)
 
2642
            trace.warning(unicode(conflict))
1158
2643
        try:
1159
2644
            wt.add_conflicts(conflicts)
1160
2645
        except errors.UnsupportedOperation:
1161
2646
            pass
1162
 
        tt.apply()
 
2647
        result = tt.apply(no_conflicts=True,
 
2648
                          precomputed_delta=precomputed_delta)
1163
2649
    finally:
1164
2650
        tt.finalize()
1165
2651
        top_pb.finished()
 
2652
    return result
 
2653
 
 
2654
 
 
2655
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
 
2656
                  hardlink):
 
2657
    total = len(desired_files) + offset
 
2658
    wt = tt._tree
 
2659
    if accelerator_tree is None:
 
2660
        new_desired_files = desired_files
 
2661
    else:
 
2662
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
 
2663
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
 
2664
                     in iter if not (c or e[0] != e[1])]
 
2665
        if accelerator_tree.supports_content_filtering():
 
2666
            unchanged = [(f, p) for (f, p) in unchanged
 
2667
                         if not accelerator_tree.iter_search_rules([p]).next()]
 
2668
        unchanged = dict(unchanged)
 
2669
        new_desired_files = []
 
2670
        count = 0
 
2671
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
2672
            accelerator_path = unchanged.get(file_id)
 
2673
            if accelerator_path is None:
 
2674
                new_desired_files.append((file_id,
 
2675
                    (trans_id, tree_path, text_sha1)))
 
2676
                continue
 
2677
            pb.update(gettext('Adding file contents'), count + offset, total)
 
2678
            if hardlink:
 
2679
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
 
2680
                                   trans_id)
 
2681
            else:
 
2682
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
2683
                if wt.supports_content_filtering():
 
2684
                    filters = wt._content_filter_stack(tree_path)
 
2685
                    contents = filtered_output_bytes(contents, filters,
 
2686
                        ContentFilterContext(tree_path, tree))
 
2687
                try:
 
2688
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2689
                finally:
 
2690
                    try:
 
2691
                        contents.close()
 
2692
                    except AttributeError:
 
2693
                        # after filtering, contents may no longer be file-like
 
2694
                        pass
 
2695
            count += 1
 
2696
        offset += count
 
2697
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
 
2698
            tree.iter_files_bytes(new_desired_files)):
 
2699
        if wt.supports_content_filtering():
 
2700
            filters = wt._content_filter_stack(tree_path)
 
2701
            contents = filtered_output_bytes(contents, filters,
 
2702
                ContentFilterContext(tree_path, tree))
 
2703
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2704
        pb.update(gettext('Adding file contents'), count + offset, total)
1166
2705
 
1167
2706
 
1168
2707
def _reparent_children(tt, old_parent, new_parent):
1170
2709
        tt.adjust_path(tt.final_name(child), new_parent, child)
1171
2710
 
1172
2711
 
 
2712
def _reparent_transform_children(tt, old_parent, new_parent):
 
2713
    by_parent = tt.by_parent()
 
2714
    for child in by_parent[old_parent]:
 
2715
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
2716
    return by_parent[old_parent]
 
2717
 
 
2718
 
1173
2719
def _content_match(tree, entry, file_id, kind, target_path):
1174
2720
    if entry.kind != kind:
1175
2721
        return False
1176
2722
    if entry.kind == "directory":
1177
2723
        return True
1178
2724
    if entry.kind == "file":
1179
 
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1180
 
            return True
 
2725
        f = file(target_path, 'rb')
 
2726
        try:
 
2727
            if tree.get_file_text(file_id) == f.read():
 
2728
                return True
 
2729
        finally:
 
2730
            f.close()
1181
2731
    elif entry.kind == "symlink":
1182
2732
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
1183
2733
            return True
1188
2738
    new_conflicts = set()
1189
2739
    for c_type, conflict in ((c[0], c) for c in conflicts):
1190
2740
        # Anything but a 'duplicate' would indicate programmer error
1191
 
        assert c_type == 'duplicate', c_type
 
2741
        if c_type != 'duplicate':
 
2742
            raise AssertionError(c_type)
1192
2743
        # Now figure out which is new and which is old
1193
2744
        if tt.new_contents(conflict[1]):
1194
2745
            new_file = conflict[1]
1220
2771
    if kind == 'file':
1221
2772
        contents = tree.get_file(entry.file_id).readlines()
1222
2773
        executable = tree.is_executable(entry.file_id)
1223
 
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
2774
        return tt.new_file(name, parent_id, contents, entry.file_id,
1224
2775
                           executable)
1225
 
    elif kind == 'directory':
1226
 
        return tt.new_directory(name, parent_id, entry.file_id)
 
2776
    elif kind in ('directory', 'tree-reference'):
 
2777
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
 
2778
        if kind == 'tree-reference':
 
2779
            tt.set_tree_reference(entry.reference_revision, trans_id)
 
2780
        return trans_id
1227
2781
    elif kind == 'symlink':
1228
2782
        target = tree.get_symlink_target(entry.file_id)
1229
2783
        return tt.new_symlink(name, parent_id, target, entry.file_id)
1230
 
 
1231
 
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1232
 
    """Create new file contents according to an inventory entry."""
1233
 
    if entry.kind == "file":
1234
 
        if lines is None:
1235
 
            lines = tree.get_file(entry.file_id).readlines()
1236
 
        tt.create_file(lines, trans_id, mode_id=mode_id)
1237
 
    elif entry.kind == "symlink":
1238
 
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1239
 
    elif entry.kind == "directory":
 
2784
    else:
 
2785
        raise errors.BadFileKindError(name, kind)
 
2786
 
 
2787
 
 
2788
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
 
2789
    filter_tree_path=None):
 
2790
    """Create new file contents according to tree contents.
 
2791
    
 
2792
    :param filter_tree_path: the tree path to use to lookup
 
2793
      content filters to apply to the bytes output in the working tree.
 
2794
      This only applies if the working tree supports content filtering.
 
2795
    """
 
2796
    kind = tree.kind(file_id)
 
2797
    if kind == 'directory':
1240
2798
        tt.create_directory(trans_id)
 
2799
    elif kind == "file":
 
2800
        if bytes is None:
 
2801
            tree_file = tree.get_file(file_id)
 
2802
            try:
 
2803
                bytes = tree_file.readlines()
 
2804
            finally:
 
2805
                tree_file.close()
 
2806
        wt = tt._tree
 
2807
        if wt.supports_content_filtering() and filter_tree_path is not None:
 
2808
            filters = wt._content_filter_stack(filter_tree_path)
 
2809
            bytes = filtered_output_bytes(bytes, filters,
 
2810
                ContentFilterContext(filter_tree_path, tree))
 
2811
        tt.create_file(bytes, trans_id)
 
2812
    elif kind == "symlink":
 
2813
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
 
2814
    else:
 
2815
        raise AssertionError('Unknown kind %r' % kind)
 
2816
 
1241
2817
 
1242
2818
def create_entry_executability(tt, entry, trans_id):
1243
2819
    """Set the executability of a trans_id according to an inventory entry"""
1245
2821
        tt.set_executability(entry.executable, trans_id)
1246
2822
 
1247
2823
 
1248
 
def find_interesting(working_tree, target_tree, filenames):
1249
 
    """Find the ids corresponding to specified filenames."""
1250
 
    trees = (working_tree, target_tree)
1251
 
    return tree.find_ids_across_trees(filenames, trees)
1252
 
 
1253
 
 
1254
 
def change_entry(tt, file_id, working_tree, target_tree, 
1255
 
                 trans_id_file_id, backups, trans_id, by_parent):
1256
 
    """Replace a file_id's contents with those from a target tree."""
1257
 
    e_trans_id = trans_id_file_id(file_id)
1258
 
    entry = target_tree.inventory[file_id]
1259
 
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1260
 
                                                           working_tree)
1261
 
    if contents_mod:
1262
 
        mode_id = e_trans_id
1263
 
        if has_contents:
1264
 
            if not backups:
1265
 
                tt.delete_contents(e_trans_id)
1266
 
            else:
1267
 
                parent_trans_id = trans_id_file_id(entry.parent_id)
1268
 
                backup_name = get_backup_name(entry, by_parent,
1269
 
                                              parent_trans_id, tt)
1270
 
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1271
 
                tt.unversion_file(e_trans_id)
1272
 
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
1273
 
                tt.version_file(file_id, e_trans_id)
1274
 
                trans_id[file_id] = e_trans_id
1275
 
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1276
 
        create_entry_executability(tt, entry, e_trans_id)
1277
 
 
1278
 
    elif meta_mod:
1279
 
        tt.set_executability(entry.executable, e_trans_id)
1280
 
    if tt.final_name(e_trans_id) != entry.name:
1281
 
        adjust_path  = True
1282
 
    else:
1283
 
        parent_id = tt.final_parent(e_trans_id)
1284
 
        parent_file_id = tt.final_file_id(parent_id)
1285
 
        if parent_file_id != entry.parent_id:
1286
 
            adjust_path = True
1287
 
        else:
1288
 
            adjust_path = False
1289
 
    if adjust_path:
1290
 
        parent_trans_id = trans_id_file_id(entry.parent_id)
1291
 
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1292
 
 
1293
 
 
 
2824
@deprecated_function(deprecated_in((2, 3, 0)))
1294
2825
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1295
2826
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1296
2827
 
1297
2828
 
 
2829
@deprecated_function(deprecated_in((2, 3, 0)))
1298
2830
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1299
2831
    """Produce a backup-style name that appears to be available"""
1300
2832
    def name_gen():
1327
2859
        if entry.kind != working_kind:
1328
2860
            contents_mod, meta_mod = True, False
1329
2861
        else:
1330
 
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2862
            cur_entry._read_tree_state(working_tree.id2path(file_id),
1331
2863
                                       working_tree)
1332
2864
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
1333
2865
            cur_entry._forget_tree_state()
1335
2867
 
1336
2868
 
1337
2869
def revert(working_tree, target_tree, filenames, backups=False,
1338
 
           pb=DummyProgress(), change_reporter=None):
 
2870
           pb=None, change_reporter=None):
1339
2871
    """Revert a working tree's contents to those of a target tree."""
1340
2872
    target_tree.lock_read()
 
2873
    pb = ui.ui_factory.nested_progress_bar()
1341
2874
    tt = TreeTransform(working_tree, pb)
1342
2875
    try:
1343
 
        interesting_ids = find_interesting(working_tree, target_tree, filenames)
1344
2876
        pp = ProgressPhase("Revert phase", 3, pb)
1345
 
        pp.next_phase()
1346
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1347
 
        try:
1348
 
            _alter_files(working_tree, target_tree, tt, child_pb,
1349
 
                         interesting_ids, backups)
1350
 
        finally:
1351
 
            child_pb.finished()
1352
 
        pp.next_phase()
1353
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1354
 
        try:
1355
 
            raw_conflicts = resolve_conflicts(tt, child_pb)
1356
 
        finally:
1357
 
            child_pb.finished()
1358
 
        conflicts = cook_conflicts(raw_conflicts, tt)
 
2877
        conflicts, merge_modified = _prepare_revert_transform(
 
2878
            working_tree, target_tree, tt, filenames, backups, pp)
1359
2879
        if change_reporter:
1360
 
            change_reporter = delta.ChangeReporter(working_tree.inventory)
1361
 
            delta.report_changes(tt._iter_changes(), change_reporter)
 
2880
            change_reporter = delta._ChangeReporter(
 
2881
                unversioned_filter=working_tree.is_ignored)
 
2882
            delta.report_changes(tt.iter_changes(), change_reporter)
1362
2883
        for conflict in conflicts:
1363
 
            warning(conflict)
 
2884
            trace.warning(unicode(conflict))
1364
2885
        pp.next_phase()
1365
2886
        tt.apply()
1366
 
        working_tree.set_merge_modified({})
 
2887
        working_tree.set_merge_modified(merge_modified)
1367
2888
    finally:
1368
2889
        target_tree.unlock()
1369
2890
        tt.finalize()
1371
2892
    return conflicts
1372
2893
 
1373
2894
 
1374
 
def _alter_files(working_tree, target_tree, tt, pb, interesting_ids,
1375
 
                 backups):
1376
 
    merge_modified = working_tree.merge_modified()
1377
 
    change_list = target_tree._iter_changes(working_tree,
1378
 
        specific_file_ids=interesting_ids, pb=pb)
1379
 
    if target_tree.inventory.root is None:
 
2895
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
 
2896
                              backups, pp, basis_tree=None,
 
2897
                              merge_modified=None):
 
2898
    child_pb = ui.ui_factory.nested_progress_bar()
 
2899
    try:
 
2900
        if merge_modified is None:
 
2901
            merge_modified = working_tree.merge_modified()
 
2902
        merge_modified = _alter_files(working_tree, target_tree, tt,
 
2903
                                      child_pb, filenames, backups,
 
2904
                                      merge_modified, basis_tree)
 
2905
    finally:
 
2906
        child_pb.finished()
 
2907
    child_pb = ui.ui_factory.nested_progress_bar()
 
2908
    try:
 
2909
        raw_conflicts = resolve_conflicts(tt, child_pb,
 
2910
            lambda t, c: conflict_pass(t, c, target_tree))
 
2911
    finally:
 
2912
        child_pb.finished()
 
2913
    conflicts = cook_conflicts(raw_conflicts, tt)
 
2914
    return conflicts, merge_modified
 
2915
 
 
2916
 
 
2917
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
 
2918
                 backups, merge_modified, basis_tree=None):
 
2919
    if basis_tree is not None:
 
2920
        basis_tree.lock_read()
 
2921
    # We ask the working_tree for its changes relative to the target, rather
 
2922
    # than the target changes relative to the working tree. Because WT4 has an
 
2923
    # optimizer to compare itself to a target, but no optimizer for the
 
2924
    # reverse.
 
2925
    change_list = working_tree.iter_changes(target_tree,
 
2926
        specific_files=specific_files, pb=pb)
 
2927
    if target_tree.get_root_id() is None:
1380
2928
        skip_root = True
1381
2929
    else:
1382
2930
        skip_root = False
1383
 
    basis_tree = None
1384
2931
    try:
 
2932
        deferred_files = []
1385
2933
        for id_num, (file_id, path, changed_content, versioned, parent, name,
1386
2934
                kind, executable) in enumerate(change_list):
1387
 
            if skip_root and file_id[0] is not None and parent[0] is None:
 
2935
            target_path, wt_path = path
 
2936
            target_versioned, wt_versioned = versioned
 
2937
            target_parent, wt_parent = parent
 
2938
            target_name, wt_name = name
 
2939
            target_kind, wt_kind = kind
 
2940
            target_executable, wt_executable = executable
 
2941
            if skip_root and wt_parent is None:
1388
2942
                continue
1389
2943
            trans_id = tt.trans_id_file_id(file_id)
1390
2944
            mode_id = None
1391
2945
            if changed_content:
1392
2946
                keep_content = False
1393
 
                if kind[0] == 'file' and (backups or kind[1] is None):
 
2947
                if wt_kind == 'file' and (backups or target_kind is None):
1394
2948
                    wt_sha1 = working_tree.get_file_sha1(file_id)
1395
2949
                    if merge_modified.get(file_id) != wt_sha1:
1396
 
                        # acquire the basis tree lazyily to prevent the expense
1397
 
                        # of accessing it when its not needed ? (Guessing, RBC,
1398
 
                        # 200702)
 
2950
                        # acquire the basis tree lazily to prevent the
 
2951
                        # expense of accessing it when it's not needed ?
 
2952
                        # (Guessing, RBC, 200702)
1399
2953
                        if basis_tree is None:
1400
2954
                            basis_tree = working_tree.basis_tree()
1401
2955
                            basis_tree.lock_read()
1402
 
                        if file_id in basis_tree:
 
2956
                        if basis_tree.has_id(file_id):
1403
2957
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
1404
2958
                                keep_content = True
1405
 
                        elif kind[1] is None and not versioned[1]:
 
2959
                        elif target_kind is None and not target_versioned:
1406
2960
                            keep_content = True
1407
 
                if kind[0] is not None:
 
2961
                if wt_kind is not None:
1408
2962
                    if not keep_content:
1409
2963
                        tt.delete_contents(trans_id)
1410
 
                    elif kind[1] is not None:
1411
 
                        parent_trans_id = tt.trans_id_file_id(parent[0])
1412
 
                        by_parent = tt.by_parent()
1413
 
                        backup_name = _get_backup_name(name[0], by_parent,
1414
 
                                                       parent_trans_id, tt)
 
2964
                    elif target_kind is not None:
 
2965
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
 
2966
                        backup_name = tt._available_backup_name(
 
2967
                            wt_name, parent_trans_id)
1415
2968
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
1416
 
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
1417
 
                        if versioned == (True, True):
 
2969
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
 
2970
                        if wt_versioned and target_versioned:
1418
2971
                            tt.unversion_file(trans_id)
1419
2972
                            tt.version_file(file_id, new_trans_id)
1420
2973
                        # New contents should have the same unix perms as old
1421
2974
                        # contents
1422
2975
                        mode_id = trans_id
1423
2976
                        trans_id = new_trans_id
1424
 
                if kind[1] == 'directory':
 
2977
                if target_kind in ('directory', 'tree-reference'):
1425
2978
                    tt.create_directory(trans_id)
1426
 
                elif kind[1] == 'symlink':
 
2979
                    if target_kind == 'tree-reference':
 
2980
                        revision = target_tree.get_reference_revision(file_id,
 
2981
                                                                      target_path)
 
2982
                        tt.set_tree_reference(revision, trans_id)
 
2983
                elif target_kind == 'symlink':
1427
2984
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
1428
2985
                                      trans_id)
1429
 
                elif kind[1] == 'file':
1430
 
                    tt.create_file(target_tree.get_file_lines(file_id),
1431
 
                                   trans_id, mode_id)
 
2986
                elif target_kind == 'file':
 
2987
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
2988
                    if basis_tree is None:
 
2989
                        basis_tree = working_tree.basis_tree()
 
2990
                        basis_tree.lock_read()
 
2991
                    new_sha1 = target_tree.get_file_sha1(file_id)
 
2992
                    if (basis_tree.has_id(file_id) and
 
2993
                        new_sha1 == basis_tree.get_file_sha1(file_id)):
 
2994
                        if file_id in merge_modified:
 
2995
                            del merge_modified[file_id]
 
2996
                    else:
 
2997
                        merge_modified[file_id] = new_sha1
 
2998
 
1432
2999
                    # preserve the execute bit when backing up
1433
 
                    if keep_content and executable[0] == executable[1]:
1434
 
                        tt.set_executability(executable[1], trans_id)
1435
 
                else:
1436
 
                    assert kind[1] is None
1437
 
            if versioned == (False, True):
 
3000
                    if keep_content and wt_executable == target_executable:
 
3001
                        tt.set_executability(target_executable, trans_id)
 
3002
                elif target_kind is not None:
 
3003
                    raise AssertionError(target_kind)
 
3004
            if not wt_versioned and target_versioned:
1438
3005
                tt.version_file(file_id, trans_id)
1439
 
            if versioned == (True, False):
 
3006
            if wt_versioned and not target_versioned:
1440
3007
                tt.unversion_file(trans_id)
1441
 
            if (name[1] is not None and 
1442
 
                (name[0] != name[1] or parent[0] != parent[1])):
1443
 
                tt.adjust_path(
1444
 
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
1445
 
            if executable[0] != executable[1] and kind[1] == "file":
1446
 
                tt.set_executability(executable[1], trans_id)
 
3008
            if (target_name is not None and
 
3009
                (wt_name != target_name or wt_parent != target_parent)):
 
3010
                if target_name == '' and target_parent is None:
 
3011
                    parent_trans = ROOT_PARENT
 
3012
                else:
 
3013
                    parent_trans = tt.trans_id_file_id(target_parent)
 
3014
                if wt_parent is None and wt_versioned:
 
3015
                    tt.adjust_root_path(target_name, parent_trans)
 
3016
                else:
 
3017
                    tt.adjust_path(target_name, parent_trans, trans_id)
 
3018
            if wt_executable != target_executable and target_kind == "file":
 
3019
                tt.set_executability(target_executable, trans_id)
 
3020
        if working_tree.supports_content_filtering():
 
3021
            for index, ((trans_id, mode_id), bytes) in enumerate(
 
3022
                target_tree.iter_files_bytes(deferred_files)):
 
3023
                file_id = deferred_files[index][0]
 
3024
                # We're reverting a tree to the target tree so using the
 
3025
                # target tree to find the file path seems the best choice
 
3026
                # here IMO - Ian C 27/Oct/2009
 
3027
                filter_tree_path = target_tree.id2path(file_id)
 
3028
                filters = working_tree._content_filter_stack(filter_tree_path)
 
3029
                bytes = filtered_output_bytes(bytes, filters,
 
3030
                    ContentFilterContext(filter_tree_path, working_tree))
 
3031
                tt.create_file(bytes, trans_id, mode_id)
 
3032
        else:
 
3033
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
3034
                deferred_files):
 
3035
                tt.create_file(bytes, trans_id, mode_id)
 
3036
        tt.fixup_new_roots()
1447
3037
    finally:
1448
3038
        if basis_tree is not None:
1449
3039
            basis_tree.unlock()
1450
 
 
1451
 
 
1452
 
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
3040
    return merge_modified
 
3041
 
 
3042
 
 
3043
def resolve_conflicts(tt, pb=None, pass_func=None):
1453
3044
    """Make many conflict-resolution attempts, but die if they fail"""
1454
3045
    if pass_func is None:
1455
3046
        pass_func = conflict_pass
1456
3047
    new_conflicts = set()
 
3048
    pb = ui.ui_factory.nested_progress_bar()
1457
3049
    try:
1458
3050
        for n in range(10):
1459
 
            pb.update('Resolution pass', n+1, 10)
 
3051
            pb.update(gettext('Resolution pass'), n+1, 10)
1460
3052
            conflicts = tt.find_conflicts()
1461
3053
            if len(conflicts) == 0:
1462
3054
                return new_conflicts
1463
3055
            new_conflicts.update(pass_func(tt, conflicts))
1464
3056
        raise MalformedTransform(conflicts=conflicts)
1465
3057
    finally:
1466
 
        pb.clear()
1467
 
 
1468
 
 
1469
 
def conflict_pass(tt, conflicts):
1470
 
    """Resolve some classes of conflicts."""
 
3058
        pb.finished()
 
3059
 
 
3060
 
 
3061
def conflict_pass(tt, conflicts, path_tree=None):
 
3062
    """Resolve some classes of conflicts.
 
3063
 
 
3064
    :param tt: The transform to resolve conflicts in
 
3065
    :param conflicts: The conflicts to resolve
 
3066
    :param path_tree: A Tree to get supplemental paths from
 
3067
    """
1471
3068
    new_conflicts = set()
1472
3069
    for c_type, conflict in ((c[0], c) for c in conflicts):
1473
3070
        if c_type == 'duplicate id':
1476
3073
                               conflict[1], conflict[2], ))
1477
3074
        elif c_type == 'duplicate':
1478
3075
            # files that were renamed take precedence
1479
 
            new_name = tt.final_name(conflict[1])+'.moved'
1480
3076
            final_parent = tt.final_parent(conflict[1])
1481
3077
            if tt.path_changed(conflict[1]):
1482
 
                tt.adjust_path(new_name, final_parent, conflict[2])
1483
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1484
 
                                   conflict[2], conflict[1]))
 
3078
                existing_file, new_file = conflict[2], conflict[1]
1485
3079
            else:
1486
 
                tt.adjust_path(new_name, final_parent, conflict[1])
1487
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1488
 
                                  conflict[1], conflict[2]))
 
3080
                existing_file, new_file = conflict[1], conflict[2]
 
3081
            new_name = tt.final_name(existing_file)+'.moved'
 
3082
            tt.adjust_path(new_name, final_parent, existing_file)
 
3083
            new_conflicts.add((c_type, 'Moved existing file to',
 
3084
                               existing_file, new_file))
1489
3085
        elif c_type == 'parent loop':
1490
3086
            # break the loop by undoing one of the ops that caused the loop
1491
3087
            cur = conflict[1]
1494
3090
            new_conflicts.add((c_type, 'Cancelled move', cur,
1495
3091
                               tt.final_parent(cur),))
1496
3092
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1497
 
            
 
3093
 
1498
3094
        elif c_type == 'missing parent':
1499
3095
            trans_id = conflict[1]
1500
 
            try:
1501
 
                tt.cancel_deletion(trans_id)
1502
 
                new_conflicts.add(('deleting parent', 'Not deleting', 
1503
 
                                   trans_id))
1504
 
            except KeyError:
1505
 
                tt.create_directory(trans_id)
1506
 
                new_conflicts.add((c_type, 'Created directory', trans_id))
 
3096
            if trans_id in tt._removed_contents:
 
3097
                cancel_deletion = True
 
3098
                orphans = tt._get_potential_orphans(trans_id)
 
3099
                if orphans:
 
3100
                    cancel_deletion = False
 
3101
                    # All children are orphans
 
3102
                    for o in orphans:
 
3103
                        try:
 
3104
                            tt.new_orphan(o, trans_id)
 
3105
                        except OrphaningError:
 
3106
                            # Something bad happened so we cancel the directory
 
3107
                            # deletion which will leave it in place with a
 
3108
                            # conflict. The user can deal with it from there.
 
3109
                            # Note that this also catch the case where we don't
 
3110
                            # want to create orphans and leave the directory in
 
3111
                            # place.
 
3112
                            cancel_deletion = True
 
3113
                            break
 
3114
                if cancel_deletion:
 
3115
                    # Cancel the directory deletion
 
3116
                    tt.cancel_deletion(trans_id)
 
3117
                    new_conflicts.add(('deleting parent', 'Not deleting',
 
3118
                                       trans_id))
 
3119
            else:
 
3120
                create = True
 
3121
                try:
 
3122
                    tt.final_name(trans_id)
 
3123
                except NoFinalPath:
 
3124
                    if path_tree is not None:
 
3125
                        file_id = tt.final_file_id(trans_id)
 
3126
                        if file_id is None:
 
3127
                            file_id = tt.inactive_file_id(trans_id)
 
3128
                        _, entry = path_tree.iter_entries_by_dir(
 
3129
                            [file_id]).next()
 
3130
                        # special-case the other tree root (move its
 
3131
                        # children to current root)
 
3132
                        if entry.parent_id is None:
 
3133
                            create = False
 
3134
                            moved = _reparent_transform_children(
 
3135
                                tt, trans_id, tt.root)
 
3136
                            for child in moved:
 
3137
                                new_conflicts.add((c_type, 'Moved to root',
 
3138
                                                   child))
 
3139
                        else:
 
3140
                            parent_trans_id = tt.trans_id_file_id(
 
3141
                                entry.parent_id)
 
3142
                            tt.adjust_path(entry.name, parent_trans_id,
 
3143
                                           trans_id)
 
3144
                if create:
 
3145
                    tt.create_directory(trans_id)
 
3146
                    new_conflicts.add((c_type, 'Created directory', trans_id))
1507
3147
        elif c_type == 'unversioned parent':
1508
 
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
 
3148
            file_id = tt.inactive_file_id(conflict[1])
 
3149
            # special-case the other tree root (move its children instead)
 
3150
            if path_tree and path_tree.has_id(file_id):
 
3151
                if path_tree.path2id('') == file_id:
 
3152
                    # This is the root entry, skip it
 
3153
                    continue
 
3154
            tt.version_file(file_id, conflict[1])
1509
3155
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
3156
        elif c_type == 'non-directory parent':
 
3157
            parent_id = conflict[1]
 
3158
            parent_parent = tt.final_parent(parent_id)
 
3159
            parent_name = tt.final_name(parent_id)
 
3160
            parent_file_id = tt.final_file_id(parent_id)
 
3161
            new_parent_id = tt.new_directory(parent_name + '.new',
 
3162
                parent_parent, parent_file_id)
 
3163
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
3164
            if parent_file_id is not None:
 
3165
                tt.unversion_file(parent_id)
 
3166
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
 
3167
        elif c_type == 'versioning no contents':
 
3168
            tt.cancel_versioning(conflict[1])
1510
3169
    return new_conflicts
1511
3170
 
1512
3171
 
1513
3172
def cook_conflicts(raw_conflicts, tt):
1514
3173
    """Generate a list of cooked conflicts, sorted by file path"""
1515
 
    from bzrlib.conflicts import Conflict
1516
3174
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
1517
 
    return sorted(conflict_iter, key=Conflict.sort_key)
 
3175
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
1518
3176
 
1519
3177
 
1520
3178
def iter_cook_conflicts(raw_conflicts, tt):
1521
 
    from bzrlib.conflicts import Conflict
1522
3179
    fp = FinalPaths(tt)
1523
3180
    for conflict in raw_conflicts:
1524
3181
        c_type = conflict[0]
1526
3183
        modified_path = fp.get_path(conflict[2])
1527
3184
        modified_id = tt.final_file_id(conflict[2])
1528
3185
        if len(conflict) == 3:
1529
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
1530
 
                                     file_id=modified_id)
1531
 
             
 
3186
            yield conflicts.Conflict.factory(
 
3187
                c_type, action=action, path=modified_path, file_id=modified_id)
 
3188
 
1532
3189
        else:
1533
3190
            conflicting_path = fp.get_path(conflict[3])
1534
3191
            conflicting_id = tt.final_file_id(conflict[3])
1535
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
1536
 
                                   file_id=modified_id, 
1537
 
                                   conflict_path=conflicting_path,
1538
 
                                   conflict_file_id=conflicting_id)
 
3192
            yield conflicts.Conflict.factory(
 
3193
                c_type, action=action, path=modified_path,
 
3194
                file_id=modified_id,
 
3195
                conflict_path=conflicting_path,
 
3196
                conflict_file_id=conflicting_id)
 
3197
 
 
3198
 
 
3199
class _FileMover(object):
 
3200
    """Moves and deletes files for TreeTransform, tracking operations"""
 
3201
 
 
3202
    def __init__(self):
 
3203
        self.past_renames = []
 
3204
        self.pending_deletions = []
 
3205
 
 
3206
    def rename(self, from_, to):
 
3207
        """Rename a file from one path to another."""
 
3208
        try:
 
3209
            os.rename(from_, to)
 
3210
        except OSError, e:
 
3211
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
 
3212
                raise errors.FileExists(to, str(e))
 
3213
            # normal OSError doesn't include filenames so it's hard to see where
 
3214
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
 
3215
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
 
3216
        self.past_renames.append((from_, to))
 
3217
 
 
3218
    def pre_delete(self, from_, to):
 
3219
        """Rename a file out of the way and mark it for deletion.
 
3220
 
 
3221
        Unlike os.unlink, this works equally well for files and directories.
 
3222
        :param from_: The current file path
 
3223
        :param to: A temporary path for the file
 
3224
        """
 
3225
        self.rename(from_, to)
 
3226
        self.pending_deletions.append(to)
 
3227
 
 
3228
    def rollback(self):
 
3229
        """Reverse all renames that have been performed"""
 
3230
        for from_, to in reversed(self.past_renames):
 
3231
            try:
 
3232
                os.rename(to, from_)
 
3233
            except OSError, e:
 
3234
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
 
3235
        # after rollback, don't reuse _FileMover
 
3236
        past_renames = None
 
3237
        pending_deletions = None
 
3238
 
 
3239
    def apply_deletions(self):
 
3240
        """Apply all marked deletions"""
 
3241
        for path in self.pending_deletions:
 
3242
            delete_any(path)
 
3243
        # after apply_deletions, don't reuse _FileMover
 
3244
        past_renames = None
 
3245
        pending_deletions = None