← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-27 22:09:19 UTC
  • mto: This revision was merged to the branch mainline in revision 6463.
  • Revision ID: jelmer@samba.org-20120127220919-tk0fdybtfwi177c6
Use config stacks in a few more places in the test suite.

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