← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

merge bzr.dev

Show diffs side-by-side

added added

removed removed

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