← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

(vila) Fix test failures blocking package builds. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

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