← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Robert Collins
  • Date: 2006-06-09 07:45:35 UTC
  • mto: (1755.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1756.
  • Revision ID: robertc@robertcollins.net-20060609074535-3002a0209179b35c
Fixup '== None' usage in inventory.py.

Show diffs side-by-side

added added

removed removed

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