/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

Merge register-branch plugin into default plugins directory

Show diffs side-by-side

added added

removed removed

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