/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2011-02-19 22:39:03 UTC
  • mto: This revision was merged to the branch mainline in revision 5674.
  • Revision ID: jelmer@samba.org-20110219223903-li6ddcm9d3jic2ug
Remove unused serializer class.

Avoid unnecessary level of Serializer inheritance.

Show diffs side-by-side

added added

removed removed

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