~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: John Arbash Meinel
  • Date: 2008-05-20 02:34:01 UTC
  • mto: This revision was merged to the branch mainline in revision 3441.
  • Revision ID: john@arbash-meinel.com-20080520023401-42mkw5g7dhq9f5bh
review feedback from Ian

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import errno
19
 
from stat import S_ISREG, S_IEXEC
20
 
import time
 
19
from stat import S_ISREG
 
20
import tempfile
21
21
 
22
22
from bzrlib.lazy_import import lazy_import
23
23
lazy_import(globals(), """
24
24
from bzrlib import (
25
 
    annotate,
26
 
    bencode,
27
25
    bzrdir,
28
26
    delta,
29
27
    errors,
30
28
    inventory,
31
 
    multiparent,
32
 
    osutils,
33
29
    revision as _mod_revision,
34
 
    ui,
35
30
    )
36
31
""")
37
32
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
38
 
                           ReusingTransform, CantMoveRoot,
 
33
                           ReusingTransform, NotVersionedError, CantMoveRoot,
39
34
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
40
35
                           UnableCreateSymlink)
41
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
42
36
from bzrlib.inventory import InventoryEntry
43
 
from bzrlib.osutils import (
44
 
    delete_any,
45
 
    file_kind,
46
 
    has_symlinks,
47
 
    lexists,
48
 
    pathjoin,
49
 
    sha_file,
50
 
    splitpath,
51
 
    supports_executable,
52
 
)
53
 
from bzrlib.progress import ProgressPhase
 
37
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
 
38
                            delete_any, has_symlinks)
 
39
from bzrlib.progress import DummyProgress, ProgressPhase
54
40
from bzrlib.symbol_versioning import (
55
41
        deprecated_function,
56
 
        deprecated_in,
57
42
        )
58
43
from bzrlib.trace import mutter, warning
59
44
from bzrlib import tree
78
63
 
79
64
 
80
65
class TreeTransformBase(object):
81
 
    """The base class for TreeTransform and its kin."""
 
66
    """The base class for TreeTransform and TreeTransformBase"""
82
67
 
83
 
    def __init__(self, tree, pb=None,
 
68
    def __init__(self, tree, limbodir, pb=DummyProgress(),
84
69
                 case_sensitive=True):
85
70
        """Constructor.
86
71
 
87
72
        :param tree: The tree that will be transformed, but not necessarily
88
73
            the output tree.
89
 
        :param pb: ignored
 
74
        :param limbodir: A directory where new files can be stored until
 
75
            they are installed in their proper places
 
76
        :param pb: A ProgressBar indicating how much progress is being made
90
77
        :param case_sensitive: If True, the target of the transform is
91
78
            case sensitive, not just case preserving.
92
79
        """
93
80
        object.__init__(self)
94
81
        self._tree = tree
 
82
        self._limbodir = limbodir
 
83
        self._deletiondir = None
95
84
        self._id_number = 0
96
85
        # mapping of trans_id -> new basename
97
86
        self._new_name = {}
99
88
        self._new_parent = {}
100
89
        # mapping of trans_id with new contents -> new file_kind
101
90
        self._new_contents = {}
 
91
        # A mapping of transform ids to their limbo filename
 
92
        self._limbo_files = {}
 
93
        # A mapping of transform ids to a set of the transform ids of children
 
94
        # that their limbo directory has
 
95
        self._limbo_children = {}
 
96
        # Map transform ids to maps of child filename to child transform id
 
97
        self._limbo_children_names = {}
 
98
        # List of transform ids that need to be renamed from limbo into place
 
99
        self._needs_rename = set()
102
100
        # Set of trans_ids whose contents will be removed
103
101
        self._removed_contents = set()
104
102
        # Mapping of trans_id -> new execute-bit value
111
109
        self._non_present_ids = {}
112
110
        # Mapping of new file_id -> trans_id
113
111
        self._r_new_id = {}
114
 
        # Set of trans_ids that will be removed
 
112
        # Set of file_ids that will be removed
115
113
        self._removed_id = set()
116
114
        # Mapping of path in old tree -> trans_id
117
115
        self._tree_path_ids = {}
118
116
        # Mapping trans_id -> path in old tree
119
117
        self._tree_id_paths = {}
 
118
        # Cache of realpath results, to speed up canonical_path
 
119
        self._realpaths = {}
 
120
        # Cache of relpath results, to speed up canonical_path
 
121
        self._relpaths = {}
120
122
        # The trans_id that will be used as the tree root
121
 
        root_id = tree.get_root_id()
122
 
        if root_id is not None:
123
 
            self._new_root = self.trans_id_tree_file_id(root_id)
124
 
        else:
125
 
            self._new_root = None
 
123
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
126
124
        # Indictor of whether the transform has been applied
127
125
        self._done = False
128
126
        # A progress bar
132
130
        # A counter of how many files have been renamed
133
131
        self.rename_count = 0
134
132
 
135
 
    def finalize(self):
136
 
        """Release the working tree lock, if held.
137
 
 
138
 
        This is required if apply has not been invoked, but can be invoked
139
 
        even after apply.
140
 
        """
141
 
        if self._tree is None:
142
 
            return
143
 
        self._tree.unlock()
144
 
        self._tree = None
145
 
 
146
133
    def __get_root(self):
147
134
        return self._new_root
148
135
 
149
136
    root = property(__get_root)
150
137
 
 
138
    def finalize(self):
 
139
        """Release the working tree lock, if held, clean up limbo dir.
 
140
 
 
141
        This is required if apply has not been invoked, but can be invoked
 
142
        even after apply.
 
143
        """
 
144
        if self._tree is None:
 
145
            return
 
146
        try:
 
147
            entries = [(self._limbo_name(t), t, k) for t, k in
 
148
                       self._new_contents.iteritems()]
 
149
            entries.sort(reverse=True)
 
150
            for path, trans_id, kind in entries:
 
151
                if kind == "directory":
 
152
                    os.rmdir(path)
 
153
                else:
 
154
                    os.unlink(path)
 
155
            try:
 
156
                os.rmdir(self._limbodir)
 
157
            except OSError:
 
158
                # We don't especially care *why* the dir is immortal.
 
159
                raise ImmortalLimbo(self._limbodir)
 
160
            try:
 
161
                if self._deletiondir is not None:
 
162
                    os.rmdir(self._deletiondir)
 
163
            except OSError:
 
164
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
165
        finally:
 
166
            self._tree.unlock()
 
167
            self._tree = None
 
168
 
151
169
    def _assign_id(self):
152
170
        """Produce a new tranform id"""
153
171
        new_id = "new-%s" % self._id_number
163
181
 
164
182
    def adjust_path(self, name, parent, trans_id):
165
183
        """Change the path that is assigned to a transaction id."""
166
 
        if parent is None:
167
 
            raise ValueError("Parent trans-id may not be None")
168
184
        if trans_id == self._new_root:
169
185
            raise CantMoveRoot
 
186
        previous_parent = self._new_parent.get(trans_id)
 
187
        previous_name = self._new_name.get(trans_id)
170
188
        self._new_name[trans_id] = name
171
189
        self._new_parent[trans_id] = parent
 
190
        if (trans_id in self._limbo_files and
 
191
            trans_id not in self._needs_rename):
 
192
            self._rename_in_limbo([trans_id])
 
193
            self._limbo_children[previous_parent].remove(trans_id)
 
194
            del self._limbo_children_names[previous_parent][previous_name]
 
195
 
 
196
    def _rename_in_limbo(self, trans_ids):
 
197
        """Fix limbo names so that the right final path is produced.
 
198
 
 
199
        This means we outsmarted ourselves-- we tried to avoid renaming
 
200
        these files later by creating them with their final names in their
 
201
        final parents.  But now the previous name or parent is no longer
 
202
        suitable, so we have to rename them.
 
203
 
 
204
        Even for trans_ids that have no new contents, we must remove their
 
205
        entries from _limbo_files, because they are now stale.
 
206
        """
 
207
        for trans_id in trans_ids:
 
208
            old_path = self._limbo_files.pop(trans_id)
 
209
            if trans_id not in self._new_contents:
 
210
                continue
 
211
            new_path = self._limbo_name(trans_id)
 
212
            os.rename(old_path, new_path)
172
213
 
173
214
    def adjust_root_path(self, name, parent):
174
215
        """Emulate moving the root by moving all children, instead.
175
 
 
 
216
        
176
217
        We do this by undoing the association of root's transaction id with the
177
218
        current tree.  This allows us to create a new directory with that
178
 
        transaction id.  We unversion the root directory and version the
 
219
        transaction id.  We unversion the root directory and version the 
179
220
        physically new directory, and hope someone versions the tree root
180
221
        later.
181
222
        """
184
225
        # force moving all children of root
185
226
        for child_id in self.iter_tree_children(old_root):
186
227
            if child_id != parent:
187
 
                self.adjust_path(self.final_name(child_id),
 
228
                self.adjust_path(self.final_name(child_id), 
188
229
                                 self.final_parent(child_id), child_id)
189
230
            file_id = self.final_file_id(child_id)
190
231
            if file_id is not None:
191
232
                self.unversion_file(child_id)
192
233
            self.version_file(file_id, child_id)
193
 
 
 
234
        
194
235
        # the physical root needs a new transaction id
195
236
        self._tree_path_ids.pop("")
196
237
        self._tree_id_paths.pop(old_root)
202
243
        self.version_file(old_root_file_id, old_root)
203
244
        self.unversion_file(self._new_root)
204
245
 
205
 
    def fixup_new_roots(self):
206
 
        """Reinterpret requests to change the root directory
207
 
 
208
 
        Instead of creating a root directory, or moving an existing directory,
209
 
        all the attributes and children of the new root are applied to the
210
 
        existing root directory.
211
 
 
212
 
        This means that the old root trans-id becomes obsolete, so it is
213
 
        recommended only to invoke this after the root trans-id has become
214
 
        irrelevant.
215
 
        """
216
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
217
 
                     ROOT_PARENT]
218
 
        if len(new_roots) < 1:
219
 
            return
220
 
        if len(new_roots) != 1:
221
 
            raise ValueError('A tree cannot have two roots!')
222
 
        if self._new_root is None:
223
 
            self._new_root = new_roots[0]
224
 
            return
225
 
        old_new_root = new_roots[0]
226
 
        # TODO: What to do if a old_new_root is present, but self._new_root is
227
 
        #       not listed as being removed? This code explicitly unversions
228
 
        #       the old root and versions it with the new file_id. Though that
229
 
        #       seems like an incomplete delta
230
 
 
231
 
        # unversion the new root's directory.
232
 
        file_id = self.final_file_id(old_new_root)
233
 
        if old_new_root in self._new_id:
234
 
            self.cancel_versioning(old_new_root)
235
 
        else:
236
 
            self.unversion_file(old_new_root)
237
 
        # if, at this stage, root still has an old file_id, zap it so we can
238
 
        # stick a new one in.
239
 
        if (self.tree_file_id(self._new_root) is not None and
240
 
            self._new_root not in self._removed_id):
241
 
            self.unversion_file(self._new_root)
242
 
        self.version_file(file_id, self._new_root)
243
 
 
244
 
        # Now move children of new root into old root directory.
245
 
        # Ensure all children are registered with the transaction, but don't
246
 
        # use directly-- some tree children have new parents
247
 
        list(self.iter_tree_children(old_new_root))
248
 
        # Move all children of new root into old root directory.
249
 
        for child in self.by_parent().get(old_new_root, []):
250
 
            self.adjust_path(self.final_name(child), self._new_root, child)
251
 
 
252
 
        # Ensure old_new_root has no directory.
253
 
        if old_new_root in self._new_contents:
254
 
            self.cancel_creation(old_new_root)
255
 
        else:
256
 
            self.delete_contents(old_new_root)
257
 
 
258
 
        # prevent deletion of root directory.
259
 
        if self._new_root in self._removed_contents:
260
 
            self.cancel_deletion(self._new_root)
261
 
 
262
 
        # destroy path info for old_new_root.
263
 
        del self._new_parent[old_new_root]
264
 
        del self._new_name[old_new_root]
265
 
 
266
246
    def trans_id_tree_file_id(self, inventory_id):
267
247
        """Determine the transaction id of a working tree file.
268
 
 
 
248
        
269
249
        This reflects only files that already exist, not ones that will be
270
250
        added by transactions.
271
251
        """
272
 
        if inventory_id is None:
273
 
            raise ValueError('None is not a valid file id')
274
252
        path = self._tree.id2path(inventory_id)
275
253
        return self.trans_id_tree_path(path)
276
254
 
280
258
        a transaction has been unversioned, it is deliberately still returned.
281
259
        (this will likely lead to an unversioned parent conflict.)
282
260
        """
283
 
        if file_id is None:
284
 
            raise ValueError('None is not a valid file id')
285
261
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
286
262
            return self._r_new_id[file_id]
287
 
        else:
288
 
            try:
289
 
                self._tree.iter_entries_by_dir([file_id]).next()
290
 
            except StopIteration:
291
 
                if file_id in self._non_present_ids:
292
 
                    return self._non_present_ids[file_id]
293
 
                else:
294
 
                    trans_id = self._assign_id()
295
 
                    self._non_present_ids[file_id] = trans_id
296
 
                    return trans_id
297
 
            else:
298
 
                return self.trans_id_tree_file_id(file_id)
 
263
        elif file_id in self._tree.inventory:
 
264
            return self.trans_id_tree_file_id(file_id)
 
265
        elif file_id in self._non_present_ids:
 
266
            return self._non_present_ids[file_id]
 
267
        else:
 
268
            trans_id = self._assign_id()
 
269
            self._non_present_ids[file_id] = trans_id
 
270
            return trans_id
 
271
 
 
272
    def canonical_path(self, path):
 
273
        """Get the canonical tree-relative path"""
 
274
        # don't follow final symlinks
 
275
        abs = self._tree.abspath(path)
 
276
        if abs in self._relpaths:
 
277
            return self._relpaths[abs]
 
278
        dirname, basename = os.path.split(abs)
 
279
        if dirname not in self._realpaths:
 
280
            self._realpaths[dirname] = os.path.realpath(dirname)
 
281
        dirname = self._realpaths[dirname]
 
282
        abs = pathjoin(dirname, basename)
 
283
        if dirname in self._relpaths:
 
284
            relpath = pathjoin(self._relpaths[dirname], basename)
 
285
            relpath = relpath.rstrip('/\\')
 
286
        else:
 
287
            relpath = self._tree.relpath(abs)
 
288
        self._relpaths[abs] = relpath
 
289
        return relpath
299
290
 
300
291
    def trans_id_tree_path(self, path):
301
292
        """Determine (and maybe set) the transaction ID for a tree path."""
312
303
            return ROOT_PARENT
313
304
        return self.trans_id_tree_path(os.path.dirname(path))
314
305
 
 
306
    def create_file(self, contents, trans_id, mode_id=None):
 
307
        """Schedule creation of a new file.
 
308
 
 
309
        See also new_file.
 
310
        
 
311
        Contents is an iterator of strings, all of which will be written
 
312
        to the target destination.
 
313
 
 
314
        New file takes the permissions of any existing file with that id,
 
315
        unless mode_id is specified.
 
316
        """
 
317
        name = self._limbo_name(trans_id)
 
318
        f = open(name, 'wb')
 
319
        try:
 
320
            try:
 
321
                unique_add(self._new_contents, trans_id, 'file')
 
322
            except:
 
323
                # Clean up the file, it never got registered so
 
324
                # TreeTransform.finalize() won't clean it up.
 
325
                f.close()
 
326
                os.unlink(name)
 
327
                raise
 
328
 
 
329
            f.writelines(contents)
 
330
        finally:
 
331
            f.close()
 
332
        self._set_mode(trans_id, mode_id, S_ISREG)
 
333
 
 
334
    def _set_mode(self, trans_id, mode_id, typefunc):
 
335
        """Set the mode of new file contents.
 
336
        The mode_id is the existing file to get the mode from (often the same
 
337
        as trans_id).  The operation is only performed if there's a mode match
 
338
        according to typefunc.
 
339
        """
 
340
        if mode_id is None:
 
341
            mode_id = trans_id
 
342
        try:
 
343
            old_path = self._tree_id_paths[mode_id]
 
344
        except KeyError:
 
345
            return
 
346
        try:
 
347
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
348
        except OSError, e:
 
349
            if e.errno == errno.ENOENT:
 
350
                return
 
351
            else:
 
352
                raise
 
353
        if typefunc(mode):
 
354
            os.chmod(self._limbo_name(trans_id), mode)
 
355
 
 
356
    def create_hardlink(self, path, trans_id):
 
357
        """Schedule creation of a hard link"""
 
358
        name = self._limbo_name(trans_id)
 
359
        try:
 
360
            os.link(path, name)
 
361
        except OSError, e:
 
362
            if e.errno != errno.EPERM:
 
363
                raise
 
364
            raise errors.HardLinkNotSupported(path)
 
365
        try:
 
366
            unique_add(self._new_contents, trans_id, 'file')
 
367
        except:
 
368
            # Clean up the file, it never got registered so
 
369
            # TreeTransform.finalize() won't clean it up.
 
370
            os.unlink(name)
 
371
            raise
 
372
 
 
373
    def create_directory(self, trans_id):
 
374
        """Schedule creation of a new directory.
 
375
        
 
376
        See also new_directory.
 
377
        """
 
378
        os.mkdir(self._limbo_name(trans_id))
 
379
        unique_add(self._new_contents, trans_id, 'directory')
 
380
 
 
381
    def create_symlink(self, target, trans_id):
 
382
        """Schedule creation of a new symbolic link.
 
383
 
 
384
        target is a bytestring.
 
385
        See also new_symlink.
 
386
        """
 
387
        if has_symlinks():
 
388
            os.symlink(target, self._limbo_name(trans_id))
 
389
            unique_add(self._new_contents, trans_id, 'symlink')
 
390
        else:
 
391
            try:
 
392
                path = FinalPaths(self).get_path(trans_id)
 
393
            except KeyError:
 
394
                path = None
 
395
            raise UnableCreateSymlink(path=path)
 
396
 
 
397
    def cancel_creation(self, trans_id):
 
398
        """Cancel the creation of new file contents."""
 
399
        del self._new_contents[trans_id]
 
400
        children = self._limbo_children.get(trans_id)
 
401
        # if this is a limbo directory with children, move them before removing
 
402
        # the directory
 
403
        if children is not None:
 
404
            self._rename_in_limbo(children)
 
405
            del self._limbo_children[trans_id]
 
406
            del self._limbo_children_names[trans_id]
 
407
        delete_any(self._limbo_name(trans_id))
 
408
 
315
409
    def delete_contents(self, trans_id):
316
410
        """Schedule the contents of a path entry for deletion"""
317
 
        # Ensure that the object exists in the WorkingTree, this will raise an
318
 
        # exception if there is a problem
319
411
        self.tree_kind(trans_id)
320
412
        self._removed_contents.add(trans_id)
321
413
 
358
450
        del self._new_id[trans_id]
359
451
        del self._r_new_id[file_id]
360
452
 
361
 
    def new_paths(self, filesystem_only=False):
362
 
        """Determine the paths of all new and changed files.
363
 
 
364
 
        :param filesystem_only: if True, only calculate values for files
365
 
            that require renames or execute bit changes.
 
453
    def new_paths(self):
 
454
        """Determine the paths of all new and changed files"""
 
455
        new_ids = set()
 
456
        fp = FinalPaths(self)
 
457
        for id_set in (self._new_name, self._new_parent, self._new_contents,
 
458
                       self._new_id, self._new_executability):
 
459
            new_ids.update(id_set)
 
460
        new_paths = [(fp.get_path(t), t) for t in new_ids]
 
461
        new_paths.sort()
 
462
        return new_paths
 
463
 
 
464
    def tree_kind(self, trans_id):
 
465
        """Determine the file kind in the working tree.
 
466
 
 
467
        Raises NoSuchFile if the file does not exist
366
468
        """
367
 
        new_ids = set()
368
 
        if filesystem_only:
369
 
            stale_ids = self._needs_rename.difference(self._new_name)
370
 
            stale_ids.difference_update(self._new_parent)
371
 
            stale_ids.difference_update(self._new_contents)
372
 
            stale_ids.difference_update(self._new_id)
373
 
            needs_rename = self._needs_rename.difference(stale_ids)
374
 
            id_sets = (needs_rename, self._new_executability)
375
 
        else:
376
 
            id_sets = (self._new_name, self._new_parent, self._new_contents,
377
 
                       self._new_id, self._new_executability)
378
 
        for id_set in id_sets:
379
 
            new_ids.update(id_set)
380
 
        return sorted(FinalPaths(self).get_paths(new_ids))
381
 
 
382
 
    def _inventory_altered(self):
383
 
        """Get the trans_ids and paths of files needing new inv entries."""
384
 
        new_ids = set()
385
 
        for id_set in [self._new_name, self._new_parent, self._new_id,
386
 
                       self._new_executability]:
387
 
            new_ids.update(id_set)
388
 
        changed_kind = set(self._removed_contents)
389
 
        changed_kind.intersection_update(self._new_contents)
390
 
        changed_kind.difference_update(new_ids)
391
 
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
392
 
                        self.final_kind(t))
393
 
        new_ids.update(changed_kind)
394
 
        return sorted(FinalPaths(self).get_paths(new_ids))
 
469
        path = self._tree_id_paths.get(trans_id)
 
470
        if path is None:
 
471
            raise NoSuchFile(None)
 
472
        try:
 
473
            return file_kind(self._tree.abspath(path))
 
474
        except OSError, e:
 
475
            if e.errno != errno.ENOENT:
 
476
                raise
 
477
            else:
 
478
                raise NoSuchFile(path)
395
479
 
396
480
    def final_kind(self, trans_id):
397
481
        """Determine the final file kind, after any changes applied.
398
 
 
 
482
        
399
483
        Raises NoSuchFile if the file does not exist/has no contents.
400
484
        (It is conceivable that a path would be created without the
401
485
        corresponding contents insertion command)
417
501
        # the file is old; the old id is still valid
418
502
        if self._new_root == trans_id:
419
503
            return self._tree.get_root_id()
420
 
        return self._tree.path2id(path)
 
504
        return self._tree.inventory.path2id(path)
421
505
 
422
506
    def final_file_id(self, trans_id):
423
507
        """Determine the file id after any changes are applied, or None.
424
 
 
 
508
        
425
509
        None indicates that the file will not be versioned after changes are
426
510
        applied.
427
511
        """
466
550
 
467
551
    def by_parent(self):
468
552
        """Return a map of parent: children for known parents.
469
 
 
 
553
        
470
554
        Only new paths and parents of tree files with assigned ids are used.
471
555
        """
472
556
        by_parent = {}
473
557
        items = list(self._new_parent.iteritems())
474
 
        items.extend((t, self.final_parent(t)) for t in
 
558
        items.extend((t, self.final_parent(t)) for t in 
475
559
                      self._tree_id_paths.keys())
476
560
        for trans_id, parent_id in items:
477
561
            if parent_id not in by_parent:
505
589
        conflicts.extend(self._overwrite_conflicts())
506
590
        return conflicts
507
591
 
508
 
    def _check_malformed(self):
509
 
        conflicts = self.find_conflicts()
510
 
        if len(conflicts) != 0:
511
 
            raise MalformedTransform(conflicts=conflicts)
512
 
 
513
592
    def _add_tree_children(self):
514
593
        """Add all the children of all active parents to the known paths.
515
594
 
517
596
        removed.  This is a necessary first step in detecting conflicts.
518
597
        """
519
598
        parents = self.by_parent().keys()
520
 
        parents.extend([t for t in self._removed_contents if
 
599
        parents.extend([t for t in self._removed_contents if 
521
600
                        self.tree_kind(t) == 'directory'])
522
601
        for trans_id in self._removed_id:
523
602
            file_id = self.tree_file_id(trans_id)
531
610
            # ensure that all children are registered with the transaction
532
611
            list(self.iter_tree_children(parent_id))
533
612
 
 
613
    def iter_tree_children(self, parent_id):
 
614
        """Iterate through the entry's tree children, if any"""
 
615
        try:
 
616
            path = self._tree_id_paths[parent_id]
 
617
        except KeyError:
 
618
            return
 
619
        try:
 
620
            children = os.listdir(self._tree.abspath(path))
 
621
        except OSError, e:
 
622
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
 
623
                raise
 
624
            return
 
625
            
 
626
        for child in children:
 
627
            childpath = joinpath(path, child)
 
628
            if self._tree.is_control_filename(childpath):
 
629
                continue
 
630
            yield self.trans_id_tree_path(childpath)
 
631
 
534
632
    def has_named_child(self, by_parent, parent_id, name):
535
633
        try:
536
634
            children = by_parent[parent_id]
590
688
 
591
689
    def _improper_versioning(self):
592
690
        """Cannot version a file with no contents, or a bad type.
593
 
 
 
691
        
594
692
        However, existing entries with no contents are okay.
595
693
        """
596
694
        conflicts = []
606
704
 
607
705
    def _executability_conflicts(self):
608
706
        """Check for bad executability changes.
609
 
 
 
707
        
610
708
        Only versioned files may have their executability set, because
611
709
        1. only versioned entries can have executability under windows
612
710
        2. only files can be executable.  (The execute bit on a directory
711
809
            return True
712
810
        return False
713
811
 
714
 
    def _set_executability(self, path, trans_id):
 
812
    def _limbo_name(self, trans_id):
 
813
        """Generate the limbo name of a file"""
 
814
        limbo_name = self._limbo_files.get(trans_id)
 
815
        if limbo_name is not None:
 
816
            return limbo_name
 
817
        parent = self._new_parent.get(trans_id)
 
818
        # if the parent directory is already in limbo (e.g. when building a
 
819
        # tree), choose a limbo name inside the parent, to reduce further
 
820
        # renames.
 
821
        use_direct_path = False
 
822
        if self._new_contents.get(parent) == 'directory':
 
823
            filename = self._new_name.get(trans_id)
 
824
            if filename is not None:
 
825
                if parent not in self._limbo_children:
 
826
                    self._limbo_children[parent] = set()
 
827
                    self._limbo_children_names[parent] = {}
 
828
                    use_direct_path = True
 
829
                # the direct path can only be used if no other file has
 
830
                # already taken this pathname, i.e. if the name is unused, or
 
831
                # if it is already associated with this trans_id.
 
832
                elif self._case_sensitive_target:
 
833
                    if (self._limbo_children_names[parent].get(filename)
 
834
                        in (trans_id, None)):
 
835
                        use_direct_path = True
 
836
                else:
 
837
                    for l_filename, l_trans_id in\
 
838
                        self._limbo_children_names[parent].iteritems():
 
839
                        if l_trans_id == trans_id:
 
840
                            continue
 
841
                        if l_filename.lower() == filename.lower():
 
842
                            break
 
843
                    else:
 
844
                        use_direct_path = True
 
845
 
 
846
        if use_direct_path:
 
847
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
848
            self._limbo_children[parent].add(trans_id)
 
849
            self._limbo_children_names[parent][filename] = trans_id
 
850
        else:
 
851
            limbo_name = pathjoin(self._limbodir, trans_id)
 
852
            self._needs_rename.add(trans_id)
 
853
        self._limbo_files[trans_id] = limbo_name
 
854
        return limbo_name
 
855
 
 
856
    def _set_executability(self, path, entry, trans_id):
715
857
        """Set the executability of versioned files """
 
858
        new_executability = self._new_executability[trans_id]
 
859
        entry.executable = new_executability
716
860
        if supports_executable():
717
 
            new_executability = self._new_executability[trans_id]
718
861
            abspath = self._tree.abspath(path)
719
862
            current_mode = os.stat(abspath).st_mode
720
863
            if new_executability:
737
880
            self.version_file(file_id, trans_id)
738
881
        return trans_id
739
882
 
740
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
883
    def new_file(self, name, parent_id, contents, file_id=None, 
741
884
                 executable=None):
742
885
        """Convenience method to create files.
743
 
 
 
886
        
744
887
        name is the name of the file to create.
745
888
        parent_id is the transaction id of the parent directory of the file.
746
889
        contents is an iterator of bytestrings, which will be used to produce
766
909
        """
767
910
        trans_id = self._new_entry(name, parent_id, file_id)
768
911
        self.create_directory(trans_id)
769
 
        return trans_id
 
912
        return trans_id 
770
913
 
771
914
    def new_symlink(self, name, parent_id, target, file_id=None):
772
915
        """Convenience method to create symbolic link.
773
 
 
 
916
        
774
917
        name is the name of the symlink to create.
775
918
        parent_id is the transaction id of the parent directory of the symlink.
776
919
        target is a bytestring of the target of the symlink.
815
958
        from_path = self._tree_id_paths.get(from_trans_id)
816
959
        if from_versioned:
817
960
            # get data from working tree if versioned
818
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
961
            from_entry = self._tree.inventory[file_id]
819
962
            from_name = from_entry.name
820
963
            from_parent = from_entry.parent_id
821
964
        else:
922
1065
    def get_preview_tree(self):
923
1066
        """Return a tree representing the result of the transform.
924
1067
 
925
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
926
 
        it.
 
1068
        This tree only supports the subset of Tree functionality required
 
1069
        by show_diff_trees.  It must only be compared to tt._tree.
927
1070
        """
928
1071
        return _PreviewTree(self)
929
1072
 
930
 
    def commit(self, branch, message, merge_parents=None, strict=False):
931
 
        """Commit the result of this TreeTransform to a branch.
932
 
 
933
 
        :param branch: The branch to commit to.
934
 
        :param message: The message to attach to the commit.
935
 
        :param merge_parents: Additional parents specified by pending merges.
936
 
        :return: The revision_id of the revision committed.
937
 
        """
938
 
        self._check_malformed()
939
 
        if strict:
940
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
941
 
            for trans_id in unversioned:
942
 
                if self.final_file_id(trans_id) is None:
943
 
                    raise errors.StrictCommitFailed()
944
 
 
945
 
        revno, last_rev_id = branch.last_revision_info()
946
 
        if last_rev_id == _mod_revision.NULL_REVISION:
947
 
            if merge_parents is not None:
948
 
                raise ValueError('Cannot supply merge parents for first'
949
 
                                 ' commit.')
950
 
            parent_ids = []
951
 
        else:
952
 
            parent_ids = [last_rev_id]
953
 
            if merge_parents is not None:
954
 
                parent_ids.extend(merge_parents)
955
 
        if self._tree.get_revision_id() != last_rev_id:
956
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
957
 
                             self._tree.get_revision_id())
958
 
        builder = branch.get_commit_builder(parent_ids)
959
 
        preview = self.get_preview_tree()
960
 
        list(builder.record_iter_changes(preview, last_rev_id,
961
 
                                         self.iter_changes()))
962
 
        builder.finish_inventory()
963
 
        revision_id = builder.commit(message)
964
 
        branch.set_last_revision_info(revno + 1, revision_id)
965
 
        return revision_id
966
 
 
967
 
    def _text_parent(self, trans_id):
968
 
        file_id = self.tree_file_id(trans_id)
969
 
        try:
970
 
            if file_id is None or self._tree.kind(file_id) != 'file':
971
 
                return None
972
 
        except errors.NoSuchFile:
973
 
            return None
974
 
        return file_id
975
 
 
976
 
    def _get_parents_texts(self, trans_id):
977
 
        """Get texts for compression parents of this file."""
978
 
        file_id = self._text_parent(trans_id)
979
 
        if file_id is None:
980
 
            return ()
981
 
        return (self._tree.get_file_text(file_id),)
982
 
 
983
 
    def _get_parents_lines(self, trans_id):
984
 
        """Get lines for compression parents of this file."""
985
 
        file_id = self._text_parent(trans_id)
986
 
        if file_id is None:
987
 
            return ()
988
 
        return (self._tree.get_file_lines(file_id),)
989
 
 
990
 
    def serialize(self, serializer):
991
 
        """Serialize this TreeTransform.
992
 
 
993
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
994
 
        """
995
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
996
 
                        self._new_name.items())
997
 
        new_executability = dict((k, int(v)) for k, v in
998
 
                                 self._new_executability.items())
999
 
        tree_path_ids = dict((k.encode('utf-8'), v)
1000
 
                             for k, v in self._tree_path_ids.items())
1001
 
        attribs = {
1002
 
            '_id_number': self._id_number,
1003
 
            '_new_name': new_name,
1004
 
            '_new_parent': self._new_parent,
1005
 
            '_new_executability': new_executability,
1006
 
            '_new_id': self._new_id,
1007
 
            '_tree_path_ids': tree_path_ids,
1008
 
            '_removed_id': list(self._removed_id),
1009
 
            '_removed_contents': list(self._removed_contents),
1010
 
            '_non_present_ids': self._non_present_ids,
1011
 
            }
1012
 
        yield serializer.bytes_record(bencode.bencode(attribs),
1013
 
                                      (('attribs',),))
1014
 
        for trans_id, kind in self._new_contents.items():
1015
 
            if kind == 'file':
1016
 
                lines = osutils.chunks_to_lines(
1017
 
                    self._read_file_chunks(trans_id))
1018
 
                parents = self._get_parents_lines(trans_id)
1019
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1020
 
                content = ''.join(mpdiff.to_patch())
1021
 
            if kind == 'directory':
1022
 
                content = ''
1023
 
            if kind == 'symlink':
1024
 
                content = self._read_symlink_target(trans_id)
1025
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
1026
 
 
1027
 
    def deserialize(self, records):
1028
 
        """Deserialize a stored TreeTransform.
1029
 
 
1030
 
        :param records: An iterable of (names, content) tuples, as per
1031
 
            pack.ContainerPushParser.
1032
 
        """
1033
 
        names, content = records.next()
1034
 
        attribs = bencode.bdecode(content)
1035
 
        self._id_number = attribs['_id_number']
1036
 
        self._new_name = dict((k, v.decode('utf-8'))
1037
 
                            for k, v in attribs['_new_name'].items())
1038
 
        self._new_parent = attribs['_new_parent']
1039
 
        self._new_executability = dict((k, bool(v)) for k, v in
1040
 
            attribs['_new_executability'].items())
1041
 
        self._new_id = attribs['_new_id']
1042
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1043
 
        self._tree_path_ids = {}
1044
 
        self._tree_id_paths = {}
1045
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
1046
 
            path = bytepath.decode('utf-8')
1047
 
            self._tree_path_ids[path] = trans_id
1048
 
            self._tree_id_paths[trans_id] = path
1049
 
        self._removed_id = set(attribs['_removed_id'])
1050
 
        self._removed_contents = set(attribs['_removed_contents'])
1051
 
        self._non_present_ids = attribs['_non_present_ids']
1052
 
        for ((trans_id, kind),), content in records:
1053
 
            if kind == 'file':
1054
 
                mpdiff = multiparent.MultiParent.from_patch(content)
1055
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1056
 
                self.create_file(lines, trans_id)
1057
 
            if kind == 'directory':
1058
 
                self.create_directory(trans_id)
1059
 
            if kind == 'symlink':
1060
 
                self.create_symlink(content.decode('utf-8'), trans_id)
1061
 
 
1062
 
 
1063
 
class DiskTreeTransform(TreeTransformBase):
1064
 
    """Tree transform storing its contents on disk."""
1065
 
 
1066
 
    def __init__(self, tree, limbodir, pb=None,
1067
 
                 case_sensitive=True):
1068
 
        """Constructor.
1069
 
        :param tree: The tree that will be transformed, but not necessarily
1070
 
            the output tree.
1071
 
        :param limbodir: A directory where new files can be stored until
1072
 
            they are installed in their proper places
1073
 
        :param pb: ignored
1074
 
        :param case_sensitive: If True, the target of the transform is
1075
 
            case sensitive, not just case preserving.
1076
 
        """
1077
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1078
 
        self._limbodir = limbodir
1079
 
        self._deletiondir = None
1080
 
        # A mapping of transform ids to their limbo filename
1081
 
        self._limbo_files = {}
1082
 
        # A mapping of transform ids to a set of the transform ids of children
1083
 
        # that their limbo directory has
1084
 
        self._limbo_children = {}
1085
 
        # Map transform ids to maps of child filename to child transform id
1086
 
        self._limbo_children_names = {}
1087
 
        # List of transform ids that need to be renamed from limbo into place
1088
 
        self._needs_rename = set()
1089
 
        self._creation_mtime = None
1090
 
 
1091
 
    def finalize(self):
1092
 
        """Release the working tree lock, if held, clean up limbo dir.
1093
 
 
1094
 
        This is required if apply has not been invoked, but can be invoked
1095
 
        even after apply.
1096
 
        """
1097
 
        if self._tree is None:
1098
 
            return
1099
 
        try:
1100
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1101
 
                       self._new_contents.iteritems()]
1102
 
            entries.sort(reverse=True)
1103
 
            for path, trans_id, kind in entries:
1104
 
                delete_any(path)
1105
 
            try:
1106
 
                delete_any(self._limbodir)
1107
 
            except OSError:
1108
 
                # We don't especially care *why* the dir is immortal.
1109
 
                raise ImmortalLimbo(self._limbodir)
1110
 
            try:
1111
 
                if self._deletiondir is not None:
1112
 
                    delete_any(self._deletiondir)
1113
 
            except OSError:
1114
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1115
 
        finally:
1116
 
            TreeTransformBase.finalize(self)
1117
 
 
1118
 
    def _limbo_name(self, trans_id):
1119
 
        """Generate the limbo name of a file"""
1120
 
        limbo_name = self._limbo_files.get(trans_id)
1121
 
        if limbo_name is None:
1122
 
            limbo_name = self._generate_limbo_path(trans_id)
1123
 
            self._limbo_files[trans_id] = limbo_name
1124
 
        return limbo_name
1125
 
 
1126
 
    def _generate_limbo_path(self, trans_id):
1127
 
        """Generate a limbo path using the trans_id as the relative path.
1128
 
 
1129
 
        This is suitable as a fallback, and when the transform should not be
1130
 
        sensitive to the path encoding of the limbo directory.
1131
 
        """
1132
 
        self._needs_rename.add(trans_id)
1133
 
        return pathjoin(self._limbodir, trans_id)
1134
 
 
1135
 
    def adjust_path(self, name, parent, trans_id):
1136
 
        previous_parent = self._new_parent.get(trans_id)
1137
 
        previous_name = self._new_name.get(trans_id)
1138
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1139
 
        if (trans_id in self._limbo_files and
1140
 
            trans_id not in self._needs_rename):
1141
 
            self._rename_in_limbo([trans_id])
1142
 
            if previous_parent != parent:
1143
 
                self._limbo_children[previous_parent].remove(trans_id)
1144
 
            if previous_parent != parent or previous_name != name:
1145
 
                del self._limbo_children_names[previous_parent][previous_name]
1146
 
 
1147
 
    def _rename_in_limbo(self, trans_ids):
1148
 
        """Fix limbo names so that the right final path is produced.
1149
 
 
1150
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1151
 
        these files later by creating them with their final names in their
1152
 
        final parents.  But now the previous name or parent is no longer
1153
 
        suitable, so we have to rename them.
1154
 
 
1155
 
        Even for trans_ids that have no new contents, we must remove their
1156
 
        entries from _limbo_files, because they are now stale.
1157
 
        """
1158
 
        for trans_id in trans_ids:
1159
 
            old_path = self._limbo_files.pop(trans_id)
1160
 
            if trans_id not in self._new_contents:
1161
 
                continue
1162
 
            new_path = self._limbo_name(trans_id)
1163
 
            osutils.rename(old_path, new_path)
1164
 
            for descendant in self._limbo_descendants(trans_id):
1165
 
                desc_path = self._limbo_files[descendant]
1166
 
                desc_path = new_path + desc_path[len(old_path):]
1167
 
                self._limbo_files[descendant] = desc_path
1168
 
 
1169
 
    def _limbo_descendants(self, trans_id):
1170
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1171
 
        descendants = set(self._limbo_children.get(trans_id, []))
1172
 
        for descendant in list(descendants):
1173
 
            descendants.update(self._limbo_descendants(descendant))
1174
 
        return descendants
1175
 
 
1176
 
    def create_file(self, contents, trans_id, mode_id=None):
1177
 
        """Schedule creation of a new file.
1178
 
 
1179
 
        See also new_file.
1180
 
 
1181
 
        Contents is an iterator of strings, all of which will be written
1182
 
        to the target destination.
1183
 
 
1184
 
        New file takes the permissions of any existing file with that id,
1185
 
        unless mode_id is specified.
1186
 
        """
1187
 
        name = self._limbo_name(trans_id)
1188
 
        f = open(name, 'wb')
1189
 
        try:
1190
 
            try:
1191
 
                unique_add(self._new_contents, trans_id, 'file')
1192
 
            except:
1193
 
                # Clean up the file, it never got registered so
1194
 
                # TreeTransform.finalize() won't clean it up.
1195
 
                f.close()
1196
 
                os.unlink(name)
1197
 
                raise
1198
 
 
1199
 
            f.writelines(contents)
1200
 
        finally:
1201
 
            f.close()
1202
 
        self._set_mtime(name)
1203
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1204
 
 
1205
 
    def _read_file_chunks(self, trans_id):
1206
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1207
 
        try:
1208
 
            return cur_file.readlines()
1209
 
        finally:
1210
 
            cur_file.close()
1211
 
 
1212
 
    def _read_symlink_target(self, trans_id):
1213
 
        return os.readlink(self._limbo_name(trans_id))
1214
 
 
1215
 
    def _set_mtime(self, path):
1216
 
        """All files that are created get the same mtime.
1217
 
 
1218
 
        This time is set by the first object to be created.
1219
 
        """
1220
 
        if self._creation_mtime is None:
1221
 
            self._creation_mtime = time.time()
1222
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1223
 
 
1224
 
    def create_hardlink(self, path, trans_id):
1225
 
        """Schedule creation of a hard link"""
1226
 
        name = self._limbo_name(trans_id)
1227
 
        try:
1228
 
            os.link(path, name)
1229
 
        except OSError, e:
1230
 
            if e.errno != errno.EPERM:
1231
 
                raise
1232
 
            raise errors.HardLinkNotSupported(path)
1233
 
        try:
1234
 
            unique_add(self._new_contents, trans_id, 'file')
1235
 
        except:
1236
 
            # Clean up the file, it never got registered so
1237
 
            # TreeTransform.finalize() won't clean it up.
1238
 
            os.unlink(name)
1239
 
            raise
1240
 
 
1241
 
    def create_directory(self, trans_id):
1242
 
        """Schedule creation of a new directory.
1243
 
 
1244
 
        See also new_directory.
1245
 
        """
1246
 
        os.mkdir(self._limbo_name(trans_id))
1247
 
        unique_add(self._new_contents, trans_id, 'directory')
1248
 
 
1249
 
    def create_symlink(self, target, trans_id):
1250
 
        """Schedule creation of a new symbolic link.
1251
 
 
1252
 
        target is a bytestring.
1253
 
        See also new_symlink.
1254
 
        """
1255
 
        if has_symlinks():
1256
 
            os.symlink(target, self._limbo_name(trans_id))
1257
 
            unique_add(self._new_contents, trans_id, 'symlink')
1258
 
        else:
1259
 
            try:
1260
 
                path = FinalPaths(self).get_path(trans_id)
1261
 
            except KeyError:
1262
 
                path = None
1263
 
            raise UnableCreateSymlink(path=path)
1264
 
 
1265
 
    def cancel_creation(self, trans_id):
1266
 
        """Cancel the creation of new file contents."""
1267
 
        del self._new_contents[trans_id]
1268
 
        children = self._limbo_children.get(trans_id)
1269
 
        # if this is a limbo directory with children, move them before removing
1270
 
        # the directory
1271
 
        if children is not None:
1272
 
            self._rename_in_limbo(children)
1273
 
            del self._limbo_children[trans_id]
1274
 
            del self._limbo_children_names[trans_id]
1275
 
        delete_any(self._limbo_name(trans_id))
1276
 
 
1277
 
 
1278
 
class TreeTransform(DiskTreeTransform):
 
1073
 
 
1074
class TreeTransform(TreeTransformBase):
1279
1075
    """Represent a tree transformation.
1280
1076
 
1281
1077
    This object is designed to support incremental generation of the transform,
1340
1136
    FileMover does not delete files until it is sure that a rollback will not
1341
1137
    happen.
1342
1138
    """
1343
 
    def __init__(self, tree, pb=None):
 
1139
    def __init__(self, tree, pb=DummyProgress()):
1344
1140
        """Note: a tree_write lock is taken on the tree.
1345
1141
 
1346
1142
        Use TreeTransform.finalize() to release the lock (can be omitted if
1349
1145
        tree.lock_tree_write()
1350
1146
 
1351
1147
        try:
 
1148
            control_files = tree._control_files
1352
1149
            limbodir = urlutils.local_path_from_url(
1353
 
                tree._transport.abspath('limbo'))
 
1150
                control_files.controlfilename('limbo'))
1354
1151
            try:
1355
1152
                os.mkdir(limbodir)
1356
1153
            except OSError, e:
1357
1154
                if e.errno == errno.EEXIST:
1358
1155
                    raise ExistingLimbo(limbodir)
1359
1156
            deletiondir = urlutils.local_path_from_url(
1360
 
                tree._transport.abspath('pending-deletion'))
 
1157
                control_files.controlfilename('pending-deletion'))
1361
1158
            try:
1362
1159
                os.mkdir(deletiondir)
1363
1160
            except OSError, e:
1367
1164
            tree.unlock()
1368
1165
            raise
1369
1166
 
1370
 
        # Cache of realpath results, to speed up canonical_path
1371
 
        self._realpaths = {}
1372
 
        # Cache of relpath results, to speed up canonical_path
1373
 
        self._relpaths = {}
1374
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1167
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1375
1168
                                   tree.case_sensitive)
1376
1169
        self._deletiondir = deletiondir
1377
1170
 
1378
 
    def canonical_path(self, path):
1379
 
        """Get the canonical tree-relative path"""
1380
 
        # don't follow final symlinks
1381
 
        abs = self._tree.abspath(path)
1382
 
        if abs in self._relpaths:
1383
 
            return self._relpaths[abs]
1384
 
        dirname, basename = os.path.split(abs)
1385
 
        if dirname not in self._realpaths:
1386
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1387
 
        dirname = self._realpaths[dirname]
1388
 
        abs = pathjoin(dirname, basename)
1389
 
        if dirname in self._relpaths:
1390
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1391
 
            relpath = relpath.rstrip('/\\')
1392
 
        else:
1393
 
            relpath = self._tree.relpath(abs)
1394
 
        self._relpaths[abs] = relpath
1395
 
        return relpath
1396
 
 
1397
 
    def tree_kind(self, trans_id):
1398
 
        """Determine the file kind in the working tree.
1399
 
 
1400
 
        Raises NoSuchFile if the file does not exist
1401
 
        """
1402
 
        path = self._tree_id_paths.get(trans_id)
1403
 
        if path is None:
1404
 
            raise NoSuchFile(None)
1405
 
        try:
1406
 
            return file_kind(self._tree.abspath(path))
1407
 
        except OSError, e:
1408
 
            if e.errno != errno.ENOENT:
1409
 
                raise
1410
 
            else:
1411
 
                raise NoSuchFile(path)
1412
 
 
1413
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1414
 
        """Set the mode of new file contents.
1415
 
        The mode_id is the existing file to get the mode from (often the same
1416
 
        as trans_id).  The operation is only performed if there's a mode match
1417
 
        according to typefunc.
1418
 
        """
1419
 
        if mode_id is None:
1420
 
            mode_id = trans_id
1421
 
        try:
1422
 
            old_path = self._tree_id_paths[mode_id]
1423
 
        except KeyError:
1424
 
            return
1425
 
        try:
1426
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1427
 
        except OSError, e:
1428
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1429
 
                # Either old_path doesn't exist, or the parent of the
1430
 
                # target is not a directory (but will be one eventually)
1431
 
                # Either way, we know it doesn't exist *right now*
1432
 
                # See also bug #248448
1433
 
                return
1434
 
            else:
1435
 
                raise
1436
 
        if typefunc(mode):
1437
 
            os.chmod(self._limbo_name(trans_id), mode)
1438
 
 
1439
 
    def iter_tree_children(self, parent_id):
1440
 
        """Iterate through the entry's tree children, if any"""
1441
 
        try:
1442
 
            path = self._tree_id_paths[parent_id]
1443
 
        except KeyError:
1444
 
            return
1445
 
        try:
1446
 
            children = os.listdir(self._tree.abspath(path))
1447
 
        except OSError, e:
1448
 
            if not (osutils._is_error_enotdir(e)
1449
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1450
 
                raise
1451
 
            return
1452
 
 
1453
 
        for child in children:
1454
 
            childpath = joinpath(path, child)
1455
 
            if self._tree.is_control_filename(childpath):
1456
 
                continue
1457
 
            yield self.trans_id_tree_path(childpath)
1458
 
 
1459
 
    def _generate_limbo_path(self, trans_id):
1460
 
        """Generate a limbo path using the final path if possible.
1461
 
 
1462
 
        This optimizes the performance of applying the tree transform by
1463
 
        avoiding renames.  These renames can be avoided only when the parent
1464
 
        directory is already scheduled for creation.
1465
 
 
1466
 
        If the final path cannot be used, falls back to using the trans_id as
1467
 
        the relpath.
1468
 
        """
1469
 
        parent = self._new_parent.get(trans_id)
1470
 
        # if the parent directory is already in limbo (e.g. when building a
1471
 
        # tree), choose a limbo name inside the parent, to reduce further
1472
 
        # renames.
1473
 
        use_direct_path = False
1474
 
        if self._new_contents.get(parent) == 'directory':
1475
 
            filename = self._new_name.get(trans_id)
1476
 
            if filename is not None:
1477
 
                if parent not in self._limbo_children:
1478
 
                    self._limbo_children[parent] = set()
1479
 
                    self._limbo_children_names[parent] = {}
1480
 
                    use_direct_path = True
1481
 
                # the direct path can only be used if no other file has
1482
 
                # already taken this pathname, i.e. if the name is unused, or
1483
 
                # if it is already associated with this trans_id.
1484
 
                elif self._case_sensitive_target:
1485
 
                    if (self._limbo_children_names[parent].get(filename)
1486
 
                        in (trans_id, None)):
1487
 
                        use_direct_path = True
1488
 
                else:
1489
 
                    for l_filename, l_trans_id in\
1490
 
                        self._limbo_children_names[parent].iteritems():
1491
 
                        if l_trans_id == trans_id:
1492
 
                            continue
1493
 
                        if l_filename.lower() == filename.lower():
1494
 
                            break
1495
 
                    else:
1496
 
                        use_direct_path = True
1497
 
 
1498
 
        if not use_direct_path:
1499
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1500
 
 
1501
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1502
 
        self._limbo_children[parent].add(trans_id)
1503
 
        self._limbo_children_names[parent][filename] = trans_id
1504
 
        return limbo_name
1505
 
 
1506
 
 
1507
 
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1171
    def apply(self, no_conflicts=False, _mover=None):
1508
1172
        """Apply all changes to the inventory and filesystem.
1509
1173
 
1510
1174
        If filesystem or inventory conflicts are present, MalformedTransform
1514
1178
 
1515
1179
        :param no_conflicts: if True, the caller guarantees there are no
1516
1180
            conflicts, so no check is made.
1517
 
        :param precomputed_delta: An inventory delta to use instead of
1518
 
            calculating one.
1519
1181
        :param _mover: Supply an alternate FileMover, for testing
1520
1182
        """
1521
1183
        if not no_conflicts:
1522
 
            self._check_malformed()
 
1184
            conflicts = self.find_conflicts()
 
1185
            if len(conflicts) != 0:
 
1186
                raise MalformedTransform(conflicts=conflicts)
 
1187
        inventory_delta = []
1523
1188
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
1189
        try:
1525
 
            if precomputed_delta is None:
1526
 
                child_pb.update('Apply phase', 0, 2)
1527
 
                inventory_delta = self._generate_inventory_delta()
1528
 
                offset = 1
1529
 
            else:
1530
 
                inventory_delta = precomputed_delta
1531
 
                offset = 0
1532
1190
            if _mover is None:
1533
1191
                mover = _FileMover()
1534
1192
            else:
1535
1193
                mover = _mover
1536
1194
            try:
1537
 
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
1538
 
                self._apply_removals(mover)
1539
 
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
1540
 
                modified_paths = self._apply_insertions(mover)
 
1195
                child_pb.update('Apply phase', 0, 2)
 
1196
                self._apply_removals(inventory_delta, mover)
 
1197
                child_pb.update('Apply phase', 1, 2)
 
1198
                modified_paths = self._apply_insertions(inventory_delta, mover)
1541
1199
            except:
1542
1200
                mover.rollback()
1543
1201
                raise
1550
1208
        self.finalize()
1551
1209
        return _TransformResults(modified_paths, self.rename_count)
1552
1210
 
1553
 
    def _generate_inventory_delta(self):
1554
 
        """Generate an inventory delta for the current transform."""
1555
 
        inventory_delta = []
1556
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1557
 
        new_paths = self._inventory_altered()
1558
 
        total_entries = len(new_paths) + len(self._removed_id)
1559
 
        try:
1560
 
            for num, trans_id in enumerate(self._removed_id):
1561
 
                if (num % 10) == 0:
1562
 
                    child_pb.update('removing file', num, total_entries)
1563
 
                if trans_id == self._new_root:
1564
 
                    file_id = self._tree.get_root_id()
1565
 
                else:
1566
 
                    file_id = self.tree_file_id(trans_id)
1567
 
                # File-id isn't really being deleted, just moved
1568
 
                if file_id in self._r_new_id:
1569
 
                    continue
1570
 
                path = self._tree_id_paths[trans_id]
1571
 
                inventory_delta.append((path, None, file_id, None))
1572
 
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1573
 
                                     new_paths)
1574
 
            entries = self._tree.iter_entries_by_dir(
1575
 
                new_path_file_ids.values())
1576
 
            old_paths = dict((e.file_id, p) for p, e in entries)
1577
 
            final_kinds = {}
1578
 
            for num, (path, trans_id) in enumerate(new_paths):
1579
 
                if (num % 10) == 0:
1580
 
                    child_pb.update('adding file',
1581
 
                                    num + len(self._removed_id), total_entries)
1582
 
                file_id = new_path_file_ids[trans_id]
1583
 
                if file_id is None:
1584
 
                    continue
1585
 
                needs_entry = False
1586
 
                try:
1587
 
                    kind = self.final_kind(trans_id)
1588
 
                except NoSuchFile:
1589
 
                    kind = self._tree.stored_kind(file_id)
1590
 
                parent_trans_id = self.final_parent(trans_id)
1591
 
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1592
 
                if parent_file_id is None:
1593
 
                    parent_file_id = self.final_file_id(parent_trans_id)
1594
 
                if trans_id in self._new_reference_revision:
1595
 
                    new_entry = inventory.TreeReference(
1596
 
                        file_id,
1597
 
                        self._new_name[trans_id],
1598
 
                        self.final_file_id(self._new_parent[trans_id]),
1599
 
                        None, self._new_reference_revision[trans_id])
1600
 
                else:
1601
 
                    new_entry = inventory.make_entry(kind,
1602
 
                        self.final_name(trans_id),
1603
 
                        parent_file_id, file_id)
1604
 
                old_path = old_paths.get(new_entry.file_id)
1605
 
                new_executability = self._new_executability.get(trans_id)
1606
 
                if new_executability is not None:
1607
 
                    new_entry.executable = new_executability
1608
 
                inventory_delta.append(
1609
 
                    (old_path, path, new_entry.file_id, new_entry))
1610
 
        finally:
1611
 
            child_pb.finished()
1612
 
        return inventory_delta
1613
 
 
1614
 
    def _apply_removals(self, mover):
 
1211
    def _apply_removals(self, inventory_delta, mover):
1615
1212
        """Perform tree operations that remove directory/inventory names.
1616
1213
 
1617
1214
        That is, delete files that are to be deleted, and put any files that
1618
1215
        need renaming into limbo.  This must be done in strict child-to-parent
1619
1216
        order.
1620
 
 
1621
 
        If inventory_delta is None, no inventory delta generation is performed.
1622
1217
        """
1623
1218
        tree_paths = list(self._tree_path_ids.iteritems())
1624
1219
        tree_paths.sort(reverse=True)
1629
1224
                child_pb.update('removing file', num, len(tree_paths))
1630
1225
                full_path = self._tree.abspath(path)
1631
1226
                if trans_id in self._removed_contents:
1632
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1633
 
                    mover.pre_delete(full_path, delete_path)
1634
 
                elif (trans_id in self._new_name
1635
 
                      or trans_id in self._new_parent):
 
1227
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1228
                                     trans_id))
 
1229
                elif trans_id in self._new_name or trans_id in \
 
1230
                    self._new_parent:
1636
1231
                    try:
1637
1232
                        mover.rename(full_path, self._limbo_name(trans_id))
1638
1233
                    except OSError, e:
1640
1235
                            raise
1641
1236
                    else:
1642
1237
                        self.rename_count += 1
 
1238
                if trans_id in self._removed_id:
 
1239
                    if trans_id == self._new_root:
 
1240
                        file_id = self._tree.get_root_id()
 
1241
                    else:
 
1242
                        file_id = self.tree_file_id(trans_id)
 
1243
                    # File-id isn't really being deleted, just moved
 
1244
                    if file_id in self._r_new_id:
 
1245
                        continue
 
1246
                    inventory_delta.append((path, None, file_id, None))
1643
1247
        finally:
1644
1248
            child_pb.finished()
1645
1249
 
1646
 
    def _apply_insertions(self, mover):
 
1250
    def _apply_insertions(self, inventory_delta, mover):
1647
1251
        """Perform tree operations that insert directory/inventory names.
1648
1252
 
1649
1253
        That is, create any files that need to be created, and restore from
1650
1254
        limbo any files that needed renaming.  This must be done in strict
1651
1255
        parent-to-child order.
1652
 
 
1653
 
        If inventory_delta is None, no inventory delta is calculated, and
1654
 
        no list of modified paths is returned.
1655
1256
        """
1656
 
        new_paths = self.new_paths(filesystem_only=True)
 
1257
        new_paths = self.new_paths()
1657
1258
        modified_paths = []
1658
 
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1659
 
                                 new_paths)
1660
1259
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1260
        completed_new = []
1661
1261
        try:
1662
1262
            for num, (path, trans_id) in enumerate(new_paths):
1663
 
                if (num % 10) == 0:
1664
 
                    child_pb.update('adding file', num, len(new_paths))
1665
 
                full_path = self._tree.abspath(path)
1666
 
                if trans_id in self._needs_rename:
1667
 
                    try:
1668
 
                        mover.rename(self._limbo_name(trans_id), full_path)
1669
 
                    except OSError, e:
1670
 
                        # We may be renaming a dangling inventory id
1671
 
                        if e.errno != errno.ENOENT:
1672
 
                            raise
1673
 
                    else:
1674
 
                        self.rename_count += 1
1675
 
                if (trans_id in self._new_contents or
1676
 
                    self.path_changed(trans_id)):
 
1263
                new_entry = None
 
1264
                child_pb.update('adding file', num, len(new_paths))
 
1265
                if trans_id in self._new_contents or \
 
1266
                    self.path_changed(trans_id):
 
1267
                    full_path = self._tree.abspath(path)
 
1268
                    if trans_id in self._needs_rename:
 
1269
                        try:
 
1270
                            mover.rename(self._limbo_name(trans_id), full_path)
 
1271
                        except OSError, e:
 
1272
                            # We may be renaming a dangling inventory id
 
1273
                            if e.errno != errno.ENOENT:
 
1274
                                raise
 
1275
                        else:
 
1276
                            self.rename_count += 1
1677
1277
                    if trans_id in self._new_contents:
1678
1278
                        modified_paths.append(full_path)
 
1279
                        completed_new.append(trans_id)
 
1280
                file_id = self.final_file_id(trans_id)
 
1281
                if file_id is not None and (trans_id in self._new_id or
 
1282
                    trans_id in self._new_name or trans_id in self._new_parent
 
1283
                    or trans_id in self._new_executability):
 
1284
                    try:
 
1285
                        kind = self.final_kind(trans_id)
 
1286
                    except NoSuchFile:
 
1287
                        kind = self._tree.stored_kind(file_id)
 
1288
                    if trans_id in self._new_reference_revision:
 
1289
                        new_entry = inventory.TreeReference(
 
1290
                            self.final_file_id(trans_id),
 
1291
                            self._new_name[trans_id],
 
1292
                            self.final_file_id(self._new_parent[trans_id]),
 
1293
                            None, self._new_reference_revision[trans_id])
 
1294
                    else:
 
1295
                        new_entry = inventory.make_entry(kind,
 
1296
                            self.final_name(trans_id),
 
1297
                            self.final_file_id(self.final_parent(trans_id)),
 
1298
                            self.final_file_id(trans_id))
 
1299
                    try:
 
1300
                        old_path = self._tree.id2path(new_entry.file_id)
 
1301
                    except errors.NoSuchId:
 
1302
                        old_path = None
 
1303
                    inventory_delta.append((old_path, path, new_entry.file_id,
 
1304
                                            new_entry))
 
1305
 
1679
1306
                if trans_id in self._new_executability:
1680
 
                    self._set_executability(path, trans_id)
 
1307
                    self._set_executability(path, new_entry, trans_id)
1681
1308
        finally:
1682
1309
            child_pb.finished()
1683
 
        self._new_contents.clear()
 
1310
        for trans_id in completed_new:
 
1311
            del self._new_contents[trans_id]
1684
1312
        return modified_paths
1685
1313
 
1686
1314
 
1687
 
class TransformPreview(DiskTreeTransform):
 
1315
class TransformPreview(TreeTransformBase):
1688
1316
    """A TreeTransform for generating preview trees.
1689
1317
 
1690
1318
    Unlike TreeTransform, this version works when the input tree is a
1692
1320
    unversioned files in the input tree.
1693
1321
    """
1694
1322
 
1695
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1323
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1696
1324
        tree.lock_read()
1697
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1698
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1325
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1326
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1699
1327
 
1700
1328
    def canonical_path(self, path):
1701
1329
        return path
1723
1351
        except KeyError:
1724
1352
            return
1725
1353
        file_id = self.tree_file_id(parent_id)
1726
 
        if file_id is None:
1727
 
            return
1728
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1729
 
        children = getattr(entry, 'children', {})
1730
 
        for child in children:
 
1354
        for child in self._tree.inventory[file_id].children.iterkeys():
1731
1355
            childpath = joinpath(path, child)
1732
1356
            yield self.trans_id_tree_path(childpath)
1733
1357
 
1738
1362
    def __init__(self, transform):
1739
1363
        self._transform = transform
1740
1364
        self._final_paths = FinalPaths(transform)
1741
 
        self.__by_parent = None
1742
 
        self._parent_ids = []
1743
 
        self._all_children_cache = {}
1744
 
        self._path2trans_id_cache = {}
1745
 
        self._final_name_cache = {}
1746
 
        self._iter_changes_cache = dict((c[0], c) for c in
1747
 
                                        self._transform.iter_changes())
 
1365
 
 
1366
    def _changes(self, file_id):
 
1367
        for changes in self._transform.iter_changes():
 
1368
            if changes[0] == file_id:
 
1369
                return changes
1748
1370
 
1749
1371
    def _content_change(self, file_id):
1750
1372
        """Return True if the content of this file changed"""
1751
 
        changes = self._iter_changes_cache.get(file_id)
 
1373
        changes = self._changes(file_id)
1752
1374
        # changes[2] is true if the file content changed.  See
1753
1375
        # InterTree.iter_changes.
1754
1376
        return (changes is not None and changes[2])
1755
1377
 
1756
 
    def _get_repository(self):
1757
 
        repo = getattr(self._transform._tree, '_repository', None)
1758
 
        if repo is None:
1759
 
            repo = self._transform._tree.branch.repository
1760
 
        return repo
1761
 
 
1762
 
    def _iter_parent_trees(self):
1763
 
        for revision_id in self.get_parent_ids():
1764
 
            try:
1765
 
                yield self.revision_tree(revision_id)
1766
 
            except errors.NoSuchRevisionInTree:
1767
 
                yield self._get_repository().revision_tree(revision_id)
1768
 
 
1769
1378
    def _get_file_revision(self, file_id, vf, tree_revision):
1770
 
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1771
 
                       self._iter_parent_trees()]
1772
 
        vf.add_lines((file_id, tree_revision), parent_keys,
1773
 
                     self.get_file(file_id).readlines())
1774
 
        repo = self._get_repository()
1775
 
        base_vf = repo.texts
1776
 
        if base_vf not in vf.fallback_versionedfiles:
1777
 
            vf.fallback_versionedfiles.append(base_vf)
1778
 
        return tree_revision
 
1379
        return self._transform._tree._get_file_revision(file_id, vf,
 
1380
                                                        tree_revision)
1779
1381
 
1780
1382
    def _stat_limbo_file(self, file_id):
1781
1383
        trans_id = self._transform.trans_id_file_id(file_id)
1782
1384
        name = self._transform._limbo_name(trans_id)
1783
1385
        return os.lstat(name)
1784
1386
 
1785
 
    @property
1786
 
    def _by_parent(self):
1787
 
        if self.__by_parent is None:
1788
 
            self.__by_parent = self._transform.by_parent()
1789
 
        return self.__by_parent
1790
 
 
1791
 
    def _comparison_data(self, entry, path):
1792
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1793
 
        if kind == 'missing':
1794
 
            kind = None
1795
 
            executable = False
1796
 
        else:
1797
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
1798
 
            executable = self.is_executable(file_id, path)
1799
 
        return kind, executable, None
1800
 
 
1801
 
    def is_locked(self):
1802
 
        return False
1803
 
 
1804
1387
    def lock_read(self):
1805
1388
        # Perhaps in theory, this should lock the TreeTransform?
1806
 
        return self
 
1389
        pass
1807
1390
 
1808
1391
    def unlock(self):
1809
1392
        pass
1817
1400
        return self._transform.final_file_id(self._transform.root)
1818
1401
 
1819
1402
    def all_file_ids(self):
1820
 
        tree_ids = set(self._transform._tree.all_file_ids())
1821
 
        tree_ids.difference_update(self._transform.tree_file_id(t)
1822
 
                                   for t in self._transform._removed_id)
1823
 
        tree_ids.update(self._transform._new_id.values())
1824
 
        return tree_ids
 
1403
        return self._transform._tree.all_file_ids()
1825
1404
 
1826
1405
    def __iter__(self):
1827
1406
        return iter(self.all_file_ids())
1828
1407
 
1829
 
    def _has_id(self, file_id, fallback_check):
1830
 
        if file_id in self._transform._r_new_id:
1831
 
            return True
1832
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1833
 
            trans_id in self._transform._removed_id]):
1834
 
            return False
1835
 
        else:
1836
 
            return fallback_check(file_id)
1837
 
 
1838
 
    def has_id(self, file_id):
1839
 
        return self._has_id(file_id, self._transform._tree.has_id)
1840
 
 
1841
 
    def has_or_had_id(self, file_id):
1842
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
1843
 
 
1844
 
    def _path2trans_id(self, path):
1845
 
        # We must not use None here, because that is a valid value to store.
1846
 
        trans_id = self._path2trans_id_cache.get(path, object)
1847
 
        if trans_id is not object:
1848
 
            return trans_id
1849
 
        segments = splitpath(path)
1850
 
        cur_parent = self._transform.root
1851
 
        for cur_segment in segments:
1852
 
            for child in self._all_children(cur_parent):
1853
 
                final_name = self._final_name_cache.get(child)
1854
 
                if final_name is None:
1855
 
                    final_name = self._transform.final_name(child)
1856
 
                    self._final_name_cache[child] = final_name
1857
 
                if final_name == cur_segment:
1858
 
                    cur_parent = child
1859
 
                    break
1860
 
            else:
1861
 
                self._path2trans_id_cache[path] = None
1862
 
                return None
1863
 
        self._path2trans_id_cache[path] = cur_parent
1864
 
        return cur_parent
 
1408
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1409
        """See Tree.paths2ids"""
 
1410
        to_find = set(specific_files)
 
1411
        result = set()
 
1412
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1413
             executable) in self._transform.iter_changes():
 
1414
            if paths[1] in to_find:
 
1415
                result.append(file_id)
 
1416
                to_find.remove(paths[1])
 
1417
        result.update(self._transform._tree.paths2ids(to_find,
 
1418
                      trees=[], require_versioned=require_versioned))
 
1419
        return result
1865
1420
 
1866
1421
    def path2id(self, path):
1867
 
        return self._transform.final_file_id(self._path2trans_id(path))
 
1422
        return self._transform._tree.path2id(path)
1868
1423
 
1869
1424
    def id2path(self, file_id):
1870
1425
        trans_id = self._transform.trans_id_file_id(file_id)
1873
1428
        except NoFinalPath:
1874
1429
            raise errors.NoSuchId(self, file_id)
1875
1430
 
1876
 
    def _all_children(self, trans_id):
1877
 
        children = self._all_children_cache.get(trans_id)
1878
 
        if children is not None:
1879
 
            return children
1880
 
        children = set(self._transform.iter_tree_children(trans_id))
1881
 
        # children in the _new_parent set are provided by _by_parent.
1882
 
        children.difference_update(self._transform._new_parent.keys())
1883
 
        children.update(self._by_parent.get(trans_id, []))
1884
 
        self._all_children_cache[trans_id] = children
1885
 
        return children
1886
 
 
1887
 
    def iter_children(self, file_id):
1888
 
        trans_id = self._transform.trans_id_file_id(file_id)
1889
 
        for child_trans_id in self._all_children(trans_id):
1890
 
            yield self._transform.final_file_id(child_trans_id)
1891
 
 
1892
 
    def extras(self):
1893
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
1894
 
                              in self._transform._tree.extras())
1895
 
        possible_extras.update(self._transform._new_contents)
1896
 
        possible_extras.update(self._transform._removed_id)
1897
 
        for trans_id in possible_extras:
1898
 
            if self._transform.final_file_id(trans_id) is None:
1899
 
                yield self._final_paths._determine_path(trans_id)
1900
 
 
1901
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1902
 
        yield_parents=False):
1903
 
        for trans_id, parent_file_id in ordered_entries:
1904
 
            file_id = self._transform.final_file_id(trans_id)
1905
 
            if file_id is None:
1906
 
                continue
1907
 
            if (specific_file_ids is not None
1908
 
                and file_id not in specific_file_ids):
1909
 
                continue
1910
 
            try:
1911
 
                kind = self._transform.final_kind(trans_id)
1912
 
            except NoSuchFile:
1913
 
                kind = self._transform._tree.stored_kind(file_id)
1914
 
            new_entry = inventory.make_entry(
1915
 
                kind,
1916
 
                self._transform.final_name(trans_id),
1917
 
                parent_file_id, file_id)
1918
 
            yield new_entry, trans_id
1919
 
 
1920
 
    def _list_files_by_dir(self):
1921
 
        todo = [ROOT_PARENT]
1922
 
        ordered_ids = []
1923
 
        while len(todo) > 0:
1924
 
            parent = todo.pop()
1925
 
            parent_file_id = self._transform.final_file_id(parent)
1926
 
            children = list(self._all_children(parent))
1927
 
            paths = dict(zip(children, self._final_paths.get_paths(children)))
1928
 
            children.sort(key=paths.get)
1929
 
            todo.extend(reversed(children))
1930
 
            for trans_id in children:
1931
 
                ordered_ids.append((trans_id, parent_file_id))
1932
 
        return ordered_ids
1933
 
 
1934
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1935
 
        # This may not be a maximally efficient implementation, but it is
1936
 
        # reasonably straightforward.  An implementation that grafts the
1937
 
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1938
 
        # might be more efficient, but requires tricky inferences about stack
1939
 
        # position.
1940
 
        ordered_ids = self._list_files_by_dir()
1941
 
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1942
 
            specific_file_ids, yield_parents=yield_parents):
1943
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1944
 
 
1945
 
    def _iter_entries_for_dir(self, dir_path):
1946
 
        """Return path, entry for items in a directory without recursing down."""
1947
 
        dir_file_id = self.path2id(dir_path)
1948
 
        ordered_ids = []
1949
 
        for file_id in self.iter_children(dir_file_id):
1950
 
            trans_id = self._transform.trans_id_file_id(file_id)
1951
 
            ordered_ids.append((trans_id, file_id))
1952
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1953
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1954
 
 
1955
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1956
 
        """See WorkingTree.list_files."""
1957
 
        # XXX This should behave like WorkingTree.list_files, but is really
1958
 
        # more like RevisionTree.list_files.
1959
 
        if recursive:
1960
 
            prefix = None
1961
 
            if from_dir:
1962
 
                prefix = from_dir + '/'
1963
 
            entries = self.iter_entries_by_dir()
1964
 
            for path, entry in entries:
1965
 
                if entry.name == '' and not include_root:
1966
 
                    continue
1967
 
                if prefix:
1968
 
                    if not path.startswith(prefix):
1969
 
                        continue
1970
 
                    path = path[len(prefix):]
1971
 
                yield path, 'V', entry.kind, entry.file_id, entry
1972
 
        else:
1973
 
            if from_dir is None and include_root is True:
1974
 
                root_entry = inventory.make_entry('directory', '',
1975
 
                    ROOT_PARENT, self.get_root_id())
1976
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1977
 
            entries = self._iter_entries_for_dir(from_dir or '')
1978
 
            for path, entry in entries:
1979
 
                yield path, 'V', entry.kind, entry.file_id, entry
 
1431
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1432
        return self._transform._tree.iter_entries_by_dir(specific_file_ids)
1980
1433
 
1981
1434
    def kind(self, file_id):
1982
1435
        trans_id = self._transform.trans_id_file_id(file_id)
1983
1436
        return self._transform.final_kind(trans_id)
1984
1437
 
1985
1438
    def stored_kind(self, file_id):
1986
 
        trans_id = self._transform.trans_id_file_id(file_id)
1987
 
        try:
1988
 
            return self._transform._new_contents[trans_id]
1989
 
        except KeyError:
1990
 
            return self._transform._tree.stored_kind(file_id)
 
1439
        return self._transform._tree.stored_kind(file_id)
1991
1440
 
1992
1441
    def get_file_mtime(self, file_id, path=None):
1993
1442
        """See Tree.get_file_mtime"""
1994
1443
        if not self._content_change(file_id):
1995
 
            return self._transform._tree.get_file_mtime(file_id)
 
1444
            return self._transform._tree.get_file_mtime(file_id, path)
1996
1445
        return self._stat_limbo_file(file_id).st_mtime
1997
1446
 
1998
 
    def _file_size(self, entry, stat_value):
1999
 
        return self.get_file_size(entry.file_id)
2000
 
 
2001
1447
    def get_file_size(self, file_id):
2002
1448
        """See Tree.get_file_size"""
2003
1449
        if self.kind(file_id) == 'file':
2006
1452
            return None
2007
1453
 
2008
1454
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2009
 
        trans_id = self._transform.trans_id_file_id(file_id)
2010
 
        kind = self._transform._new_contents.get(trans_id)
2011
 
        if kind is None:
2012
 
            return self._transform._tree.get_file_sha1(file_id)
2013
 
        if kind == 'file':
2014
 
            fileobj = self.get_file(file_id)
2015
 
            try:
2016
 
                return sha_file(fileobj)
2017
 
            finally:
2018
 
                fileobj.close()
 
1455
        return self._transform._tree.get_file_sha1(file_id)
2019
1456
 
2020
1457
    def is_executable(self, file_id, path=None):
2021
 
        if file_id is None:
2022
 
            return False
2023
 
        trans_id = self._transform.trans_id_file_id(file_id)
2024
 
        try:
2025
 
            return self._transform._new_executability[trans_id]
2026
 
        except KeyError:
2027
 
            try:
2028
 
                return self._transform._tree.is_executable(file_id, path)
2029
 
            except OSError, e:
2030
 
                if e.errno == errno.ENOENT:
2031
 
                    return False
2032
 
                raise
2033
 
            except errors.NoSuchId:
2034
 
                return False
 
1458
        return self._transform._tree.is_executable(file_id, path)
2035
1459
 
2036
1460
    def path_content_summary(self, path):
2037
 
        trans_id = self._path2trans_id(path)
2038
 
        tt = self._transform
2039
 
        tree_path = tt._tree_id_paths.get(trans_id)
2040
 
        kind = tt._new_contents.get(trans_id)
2041
 
        if kind is None:
2042
 
            if tree_path is None or trans_id in tt._removed_contents:
2043
 
                return 'missing', None, None, None
2044
 
            summary = tt._tree.path_content_summary(tree_path)
2045
 
            kind, size, executable, link_or_sha1 = summary
2046
 
        else:
2047
 
            link_or_sha1 = None
2048
 
            limbo_name = tt._limbo_name(trans_id)
2049
 
            if trans_id in tt._new_reference_revision:
2050
 
                kind = 'tree-reference'
2051
 
            if kind == 'file':
2052
 
                statval = os.lstat(limbo_name)
2053
 
                size = statval.st_size
2054
 
                if not supports_executable():
2055
 
                    executable = False
2056
 
                else:
2057
 
                    executable = statval.st_mode & S_IEXEC
2058
 
            else:
2059
 
                size = None
2060
 
                executable = None
2061
 
            if kind == 'symlink':
2062
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2063
 
        executable = tt._new_executability.get(trans_id, executable)
2064
 
        return kind, size, executable, link_or_sha1
 
1461
        return self._transform._tree.path_content_summary(path)
2065
1462
 
2066
1463
    def iter_changes(self, from_tree, include_unchanged=False,
2067
1464
                      specific_files=None, pb=None, extra_trees=None,
2068
1465
                      require_versioned=True, want_unversioned=False):
2069
1466
        """See InterTree.iter_changes.
2070
1467
 
2071
 
        This has a fast path that is only used when the from_tree matches
2072
 
        the transform tree, and no fancy options are supplied.
 
1468
        This implementation does not support include_unchanged, specific_files,
 
1469
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1470
        ignored.
2073
1471
        """
2074
 
        if (from_tree is not self._transform._tree or include_unchanged or
2075
 
            specific_files or want_unversioned):
2076
 
            return tree.InterTree(from_tree, self).iter_changes(
2077
 
                include_unchanged=include_unchanged,
2078
 
                specific_files=specific_files,
2079
 
                pb=pb,
2080
 
                extra_trees=extra_trees,
2081
 
                require_versioned=require_versioned,
2082
 
                want_unversioned=want_unversioned)
 
1472
        if from_tree is not self._transform._tree:
 
1473
            raise ValueError('from_tree must be transform source tree.')
 
1474
        if include_unchanged:
 
1475
            raise ValueError('include_unchanged is not supported')
 
1476
        if specific_files is not None:
 
1477
            raise ValueError('specific_files is not supported')
2083
1478
        if want_unversioned:
2084
1479
            raise ValueError('want_unversioned is not supported')
2085
1480
        return self._transform.iter_changes()
2092
1487
        name = self._transform._limbo_name(trans_id)
2093
1488
        return open(name, 'rb')
2094
1489
 
2095
 
    def get_file_with_stat(self, file_id, path=None):
2096
 
        return self.get_file(file_id, path), None
 
1490
    def get_file_text(self, file_id):
 
1491
        text_file = self.get_file(file_id)
 
1492
        try:
 
1493
            return text_file.read()
 
1494
        finally:
 
1495
            text_file.close()
2097
1496
 
2098
1497
    def annotate_iter(self, file_id,
2099
1498
                      default_revision=_mod_revision.CURRENT_REVISION):
2100
 
        changes = self._iter_changes_cache.get(file_id)
2101
 
        if changes is None:
2102
 
            get_old = True
2103
 
        else:
2104
 
            changed_content, versioned, kind = (changes[2], changes[3],
2105
 
                                                changes[6])
2106
 
            if kind[1] is None:
2107
 
                return None
2108
 
            get_old = (kind[0] == 'file' and versioned[0])
2109
 
        if get_old:
2110
 
            old_annotation = self._transform._tree.annotate_iter(file_id,
2111
 
                default_revision=default_revision)
2112
 
        else:
2113
 
            old_annotation = []
2114
 
        if changes is None:
2115
 
            return old_annotation
2116
 
        if not changed_content:
2117
 
            return old_annotation
2118
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2119
 
        #       doing, however it fails slightly because it doesn't know what
2120
 
        #       the *other* revision_id is, so it doesn't know how to give the
2121
 
        #       other as the origin for some lines, they all get
2122
 
        #       'default_revision'
2123
 
        #       It would be nice to be able to use the new Annotator based
2124
 
        #       approach, as well.
2125
 
        return annotate.reannotate([old_annotation],
2126
 
                                   self.get_file(file_id).readlines(),
2127
 
                                   default_revision)
 
1499
        return self._transform._tree.annotate_iter(file_id,
 
1500
            default_revision=default_revision)
2128
1501
 
2129
1502
    def get_symlink_target(self, file_id):
2130
1503
        """See Tree.get_symlink_target"""
2132
1505
            return self._transform._tree.get_symlink_target(file_id)
2133
1506
        trans_id = self._transform.trans_id_file_id(file_id)
2134
1507
        name = self._transform._limbo_name(trans_id)
2135
 
        return osutils.readlink(name)
2136
 
 
2137
 
    def walkdirs(self, prefix=''):
2138
 
        pending = [self._transform.root]
2139
 
        while len(pending) > 0:
2140
 
            parent_id = pending.pop()
2141
 
            children = []
2142
 
            subdirs = []
2143
 
            prefix = prefix.rstrip('/')
2144
 
            parent_path = self._final_paths.get_path(parent_id)
2145
 
            parent_file_id = self._transform.final_file_id(parent_id)
2146
 
            for child_id in self._all_children(parent_id):
2147
 
                path_from_root = self._final_paths.get_path(child_id)
2148
 
                basename = self._transform.final_name(child_id)
2149
 
                file_id = self._transform.final_file_id(child_id)
2150
 
                try:
2151
 
                    kind = self._transform.final_kind(child_id)
2152
 
                    versioned_kind = kind
2153
 
                except NoSuchFile:
2154
 
                    kind = 'unknown'
2155
 
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2156
 
                if versioned_kind == 'directory':
2157
 
                    subdirs.append(child_id)
2158
 
                children.append((path_from_root, basename, kind, None,
2159
 
                                 file_id, versioned_kind))
2160
 
            children.sort()
2161
 
            if parent_path.startswith(prefix):
2162
 
                yield (parent_path, parent_file_id), children
2163
 
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2164
 
                                  reverse=True))
 
1508
        return os.readlink(name)
 
1509
 
 
1510
    def list_files(self, include_root=False):
 
1511
        return self._transform._tree.list_files(include_root)
 
1512
 
 
1513
    def walkdirs(self, prefix=""):
 
1514
        return self._transform._tree.walkdirs(prefix)
2165
1515
 
2166
1516
    def get_parent_ids(self):
2167
 
        return self._parent_ids
2168
 
 
2169
 
    def set_parent_ids(self, parent_ids):
2170
 
        self._parent_ids = parent_ids
 
1517
        return self._transform._tree.get_parent_ids()
2171
1518
 
2172
1519
    def get_revision_tree(self, revision_id):
2173
1520
        return self._transform._tree.get_revision_tree(revision_id)
2193
1540
        self.transform = transform
2194
1541
 
2195
1542
    def _determine_path(self, trans_id):
2196
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1543
        if trans_id == self.transform.root:
2197
1544
            return ""
2198
1545
        name = self.transform.final_name(trans_id)
2199
1546
        parent_id = self.transform.final_parent(trans_id)
2208
1555
            self._known_paths[trans_id] = self._determine_path(trans_id)
2209
1556
        return self._known_paths[trans_id]
2210
1557
 
2211
 
    def get_paths(self, trans_ids):
2212
 
        return [(self.get_path(t), t) for t in trans_ids]
2213
 
 
2214
 
 
2215
1558
 
2216
1559
def topology_sorted_ids(tree):
2217
1560
    """Determine the topological order of the ids in a tree"""
2220
1563
    return file_ids
2221
1564
 
2222
1565
 
2223
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2224
 
               delta_from_tree=False):
 
1566
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
2225
1567
    """Create working tree for a branch, using a TreeTransform.
2226
 
 
 
1568
    
2227
1569
    This function should be used on empty trees, having a tree root at most.
2228
1570
    (see merge and revert functionality for working with existing trees)
2229
1571
 
2230
1572
    Existing files are handled like so:
2231
 
 
 
1573
    
2232
1574
    - Existing bzrdirs take precedence over creating new items.  They are
2233
1575
      created as '%s.diverted' % name.
2234
1576
    - Otherwise, if the content on disk matches the content we are building,
2243
1585
    :param hardlink: If true, hard-link files to accelerator_tree, where
2244
1586
        possible.  accelerator_tree must implement abspath, i.e. be a
2245
1587
        working tree.
2246
 
    :param delta_from_tree: If true, build_tree may use the input Tree to
2247
 
        generate the inventory delta.
2248
1588
    """
2249
1589
    wt.lock_tree_write()
2250
1590
    try:
2253
1593
            if accelerator_tree is not None:
2254
1594
                accelerator_tree.lock_read()
2255
1595
            try:
2256
 
                return _build_tree(tree, wt, accelerator_tree, hardlink,
2257
 
                                   delta_from_tree)
 
1596
                return _build_tree(tree, wt, accelerator_tree, hardlink)
2258
1597
            finally:
2259
1598
                if accelerator_tree is not None:
2260
1599
                    accelerator_tree.unlock()
2264
1603
        wt.unlock()
2265
1604
 
2266
1605
 
2267
 
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1606
def _build_tree(tree, wt, accelerator_tree, hardlink):
2268
1607
    """See build_tree."""
2269
1608
    for num, _unused in enumerate(wt.all_file_ids()):
2270
1609
        if num > 0:  # more than just a root
2271
1610
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2272
 
    existing_files = set()
2273
 
    for dir, files in wt.walkdirs():
2274
 
        existing_files.update(f[0] for f in files)
2275
1611
    file_trans_id = {}
2276
1612
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2277
1613
    pp = ProgressPhase("Build phase", 2, top_pb)
2296
1632
        try:
2297
1633
            deferred_contents = []
2298
1634
            num = 0
2299
 
            total = len(tree.inventory)
2300
 
            if delta_from_tree:
2301
 
                precomputed_delta = []
2302
 
            else:
2303
 
                precomputed_delta = None
2304
1635
            for num, (tree_path, entry) in \
2305
1636
                enumerate(tree.inventory.iter_entries_by_dir()):
2306
 
                pb.update("Building tree", num - len(deferred_contents), total)
 
1637
                pb.update("Building tree", num - len(deferred_contents),
 
1638
                          len(tree.inventory))
2307
1639
                if entry.parent_id is None:
2308
1640
                    continue
2309
1641
                reparent = False
2310
1642
                file_id = entry.file_id
2311
 
                if delta_from_tree:
2312
 
                    precomputed_delta.append((None, tree_path, file_id, entry))
2313
 
                if tree_path in existing_files:
2314
 
                    target_path = wt.abspath(tree_path)
 
1643
                target_path = wt.abspath(tree_path)
 
1644
                try:
2315
1645
                    kind = file_kind(target_path)
 
1646
                except NoSuchFile:
 
1647
                    pass
 
1648
                else:
2316
1649
                    if kind == "directory":
2317
1650
                        try:
2318
1651
                            bzrdir.BzrDir.open(target_path)
2326
1659
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2327
1660
                        if kind == 'directory':
2328
1661
                            reparent = True
 
1662
                if entry.parent_id not in file_trans_id:
 
1663
                    raise AssertionError(
 
1664
                        'entry %s parent id %r is not in file_trans_id %r'
 
1665
                        % (entry, entry.parent_id, file_trans_id))
2329
1666
                parent_id = file_trans_id[entry.parent_id]
2330
1667
                if entry.kind == 'file':
2331
1668
                    # We *almost* replicate new_by_entry, so that we can defer
2332
1669
                    # getting the file text, and get them all at once.
2333
1670
                    trans_id = tt.create_path(entry.name, parent_id)
2334
1671
                    file_trans_id[file_id] = trans_id
2335
 
                    tt.version_file(file_id, trans_id)
2336
 
                    executable = tree.is_executable(file_id, tree_path)
2337
 
                    if executable:
 
1672
                    tt.version_file(entry.file_id, trans_id)
 
1673
                    executable = tree.is_executable(entry.file_id, tree_path)
 
1674
                    if executable is not None:
2338
1675
                        tt.set_executability(executable, trans_id)
2339
 
                    trans_data = (trans_id, tree_path)
2340
 
                    deferred_contents.append((file_id, trans_data))
 
1676
                    deferred_contents.append((entry.file_id, trans_id))
2341
1677
                else:
2342
1678
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2343
1679
                                                          tree)
2354
1690
        divert_trans = set(file_trans_id[f] for f in divert)
2355
1691
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2356
1692
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2357
 
        if len(raw_conflicts) > 0:
2358
 
            precomputed_delta = None
2359
1693
        conflicts = cook_conflicts(raw_conflicts, tt)
2360
1694
        for conflict in conflicts:
2361
1695
            warning(conflict)
2363
1697
            wt.add_conflicts(conflicts)
2364
1698
        except errors.UnsupportedOperation:
2365
1699
            pass
2366
 
        result = tt.apply(no_conflicts=True,
2367
 
                          precomputed_delta=precomputed_delta)
 
1700
        result = tt.apply(no_conflicts=True)
2368
1701
    finally:
2369
1702
        tt.finalize()
2370
1703
        top_pb.finished()
2374
1707
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2375
1708
                  hardlink):
2376
1709
    total = len(desired_files) + offset
2377
 
    wt = tt._tree
2378
1710
    if accelerator_tree is None:
2379
1711
        new_desired_files = desired_files
2380
1712
    else:
2381
1713
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2382
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2383
 
                     in iter if not (c or e[0] != e[1])]
2384
 
        if accelerator_tree.supports_content_filtering():
2385
 
            unchanged = [(f, p) for (f, p) in unchanged
2386
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2387
 
        unchanged = dict(unchanged)
 
1714
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1715
                         in iter if not (c or e[0] != e[1]))
2388
1716
        new_desired_files = []
2389
1717
        count = 0
2390
 
        for file_id, (trans_id, tree_path) in desired_files:
 
1718
        for file_id, trans_id in desired_files:
2391
1719
            accelerator_path = unchanged.get(file_id)
2392
1720
            if accelerator_path is None:
2393
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
1721
                new_desired_files.append((file_id, trans_id))
2394
1722
                continue
2395
1723
            pb.update('Adding file contents', count + offset, total)
2396
1724
            if hardlink:
2398
1726
                                   trans_id)
2399
1727
            else:
2400
1728
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2401
 
                if wt.supports_content_filtering():
2402
 
                    filters = wt._content_filter_stack(tree_path)
2403
 
                    contents = filtered_output_bytes(contents, filters,
2404
 
                        ContentFilterContext(tree_path, tree))
2405
1729
                try:
2406
1730
                    tt.create_file(contents, trans_id)
2407
1731
                finally:
2408
 
                    try:
2409
 
                        contents.close()
2410
 
                    except AttributeError:
2411
 
                        # after filtering, contents may no longer be file-like
2412
 
                        pass
 
1732
                    contents.close()
2413
1733
            count += 1
2414
1734
        offset += count
2415
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2416
 
            tree.iter_files_bytes(new_desired_files)):
2417
 
        if wt.supports_content_filtering():
2418
 
            filters = wt._content_filter_stack(tree_path)
2419
 
            contents = filtered_output_bytes(contents, filters,
2420
 
                ContentFilterContext(tree_path, tree))
 
1735
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1736
                                                 new_desired_files)):
2421
1737
        tt.create_file(contents, trans_id)
2422
1738
        pb.update('Adding file contents', count + offset, total)
2423
1739
 
2483
1799
    if kind == 'file':
2484
1800
        contents = tree.get_file(entry.file_id).readlines()
2485
1801
        executable = tree.is_executable(entry.file_id)
2486
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
1802
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2487
1803
                           executable)
2488
1804
    elif kind in ('directory', 'tree-reference'):
2489
1805
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2490
1806
        if kind == 'tree-reference':
2491
1807
            tt.set_tree_reference(entry.reference_revision, trans_id)
2492
 
        return trans_id
 
1808
        return trans_id 
2493
1809
    elif kind == 'symlink':
2494
1810
        target = tree.get_symlink_target(entry.file_id)
2495
1811
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2497
1813
        raise errors.BadFileKindError(name, kind)
2498
1814
 
2499
1815
 
2500
 
@deprecated_function(deprecated_in((1, 9, 0)))
2501
1816
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2502
 
    """Create new file contents according to an inventory entry.
2503
 
 
2504
 
    DEPRECATED.  Use create_from_tree instead.
2505
 
    """
 
1817
    """Create new file contents according to an inventory entry."""
2506
1818
    if entry.kind == "file":
2507
1819
        if lines is None:
2508
1820
            lines = tree.get_file(entry.file_id).readlines()
2513
1825
        tt.create_directory(trans_id)
2514
1826
 
2515
1827
 
2516
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2517
 
    filter_tree_path=None):
2518
 
    """Create new file contents according to tree contents.
2519
 
    
2520
 
    :param filter_tree_path: the tree path to use to lookup
2521
 
      content filters to apply to the bytes output in the working tree.
2522
 
      This only applies if the working tree supports content filtering.
2523
 
    """
2524
 
    kind = tree.kind(file_id)
2525
 
    if kind == 'directory':
2526
 
        tt.create_directory(trans_id)
2527
 
    elif kind == "file":
2528
 
        if bytes is None:
2529
 
            tree_file = tree.get_file(file_id)
2530
 
            try:
2531
 
                bytes = tree_file.readlines()
2532
 
            finally:
2533
 
                tree_file.close()
2534
 
        wt = tt._tree
2535
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2536
 
            filters = wt._content_filter_stack(filter_tree_path)
2537
 
            bytes = filtered_output_bytes(bytes, filters,
2538
 
                ContentFilterContext(filter_tree_path, tree))
2539
 
        tt.create_file(bytes, trans_id)
2540
 
    elif kind == "symlink":
2541
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2542
 
    else:
2543
 
        raise AssertionError('Unknown kind %r' % kind)
2544
 
 
2545
 
 
2546
1828
def create_entry_executability(tt, entry, trans_id):
2547
1829
    """Set the executability of a trans_id according to an inventory entry"""
2548
1830
    if entry.kind == "file":
2585
1867
        if entry.kind != working_kind:
2586
1868
            contents_mod, meta_mod = True, False
2587
1869
        else:
2588
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
1870
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2589
1871
                                       working_tree)
2590
1872
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2591
1873
            cur_entry._forget_tree_state()
2593
1875
 
2594
1876
 
2595
1877
def revert(working_tree, target_tree, filenames, backups=False,
2596
 
           pb=None, change_reporter=None):
 
1878
           pb=DummyProgress(), change_reporter=None):
2597
1879
    """Revert a working tree's contents to those of a target tree."""
2598
1880
    target_tree.lock_read()
2599
 
    pb = ui.ui_factory.nested_progress_bar()
2600
1881
    tt = TreeTransform(working_tree, pb)
2601
1882
    try:
2602
1883
        pp = ProgressPhase("Revert phase", 3, pb)
2603
 
        conflicts, merge_modified = _prepare_revert_transform(
2604
 
            working_tree, target_tree, tt, filenames, backups, pp)
 
1884
        pp.next_phase()
 
1885
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1886
        try:
 
1887
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
1888
                                          child_pb, filenames, backups)
 
1889
        finally:
 
1890
            child_pb.finished()
 
1891
        pp.next_phase()
 
1892
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1893
        try:
 
1894
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
1895
                lambda t, c: conflict_pass(t, c, target_tree))
 
1896
        finally:
 
1897
            child_pb.finished()
 
1898
        conflicts = cook_conflicts(raw_conflicts, tt)
2605
1899
        if change_reporter:
2606
1900
            change_reporter = delta._ChangeReporter(
2607
1901
                unversioned_filter=working_tree.is_ignored)
2618
1912
    return conflicts
2619
1913
 
2620
1914
 
2621
 
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2622
 
                              backups, pp, basis_tree=None,
2623
 
                              merge_modified=None):
2624
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2625
 
    try:
2626
 
        if merge_modified is None:
2627
 
            merge_modified = working_tree.merge_modified()
2628
 
        merge_modified = _alter_files(working_tree, target_tree, tt,
2629
 
                                      child_pb, filenames, backups,
2630
 
                                      merge_modified, basis_tree)
2631
 
    finally:
2632
 
        child_pb.finished()
2633
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2634
 
    try:
2635
 
        raw_conflicts = resolve_conflicts(tt, child_pb,
2636
 
            lambda t, c: conflict_pass(t, c, target_tree))
2637
 
    finally:
2638
 
        child_pb.finished()
2639
 
    conflicts = cook_conflicts(raw_conflicts, tt)
2640
 
    return conflicts, merge_modified
2641
 
 
2642
 
 
2643
1915
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2644
 
                 backups, merge_modified, basis_tree=None):
2645
 
    if basis_tree is not None:
2646
 
        basis_tree.lock_read()
 
1916
                 backups):
 
1917
    merge_modified = working_tree.merge_modified()
2647
1918
    change_list = target_tree.iter_changes(working_tree,
2648
1919
        specific_files=specific_files, pb=pb)
2649
 
    if target_tree.get_root_id() is None:
 
1920
    if target_tree.inventory.root is None:
2650
1921
        skip_root = True
2651
1922
    else:
2652
1923
        skip_root = False
 
1924
    basis_tree = None
2653
1925
    try:
2654
1926
        deferred_files = []
2655
1927
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2691
1963
                        # contents
2692
1964
                        mode_id = trans_id
2693
1965
                        trans_id = new_trans_id
2694
 
                if kind[1] in ('directory', 'tree-reference'):
 
1966
                if kind[1] == 'directory':
2695
1967
                    tt.create_directory(trans_id)
2696
 
                    if kind[1] == 'tree-reference':
2697
 
                        revision = target_tree.get_reference_revision(file_id,
2698
 
                                                                      path[1])
2699
 
                        tt.set_tree_reference(revision, trans_id)
2700
1968
                elif kind[1] == 'symlink':
2701
1969
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2702
1970
                                      trans_id)
2722
1990
                tt.version_file(file_id, trans_id)
2723
1991
            if versioned == (True, False):
2724
1992
                tt.unversion_file(trans_id)
2725
 
            if (name[1] is not None and
 
1993
            if (name[1] is not None and 
2726
1994
                (name[0] != name[1] or parent[0] != parent[1])):
2727
 
                if name[1] == '' and parent[1] is None:
2728
 
                    parent_trans = ROOT_PARENT
2729
 
                else:
2730
 
                    parent_trans = tt.trans_id_file_id(parent[1])
2731
 
                if parent[0] is None and versioned[0]:
2732
 
                    tt.adjust_root_path(name[1], parent_trans)
2733
 
                else:
2734
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
 
1995
                tt.adjust_path(
 
1996
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
2735
1997
            if executable[0] != executable[1] and kind[1] == "file":
2736
1998
                tt.set_executability(executable[1], trans_id)
2737
 
        if working_tree.supports_content_filtering():
2738
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2739
 
                target_tree.iter_files_bytes(deferred_files)):
2740
 
                file_id = deferred_files[index][0]
2741
 
                # We're reverting a tree to the target tree so using the
2742
 
                # target tree to find the file path seems the best choice
2743
 
                # here IMO - Ian C 27/Oct/2009
2744
 
                filter_tree_path = target_tree.id2path(file_id)
2745
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2746
 
                bytes = filtered_output_bytes(bytes, filters,
2747
 
                    ContentFilterContext(filter_tree_path, working_tree))
2748
 
                tt.create_file(bytes, trans_id, mode_id)
2749
 
        else:
2750
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2751
 
                deferred_files):
2752
 
                tt.create_file(bytes, trans_id, mode_id)
2753
 
        tt.fixup_new_roots()
 
1999
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2000
            deferred_files):
 
2001
            tt.create_file(bytes, trans_id, mode_id)
2754
2002
    finally:
2755
2003
        if basis_tree is not None:
2756
2004
            basis_tree.unlock()
2757
2005
    return merge_modified
2758
2006
 
2759
2007
 
2760
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2008
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2761
2009
    """Make many conflict-resolution attempts, but die if they fail"""
2762
2010
    if pass_func is None:
2763
2011
        pass_func = conflict_pass
2764
2012
    new_conflicts = set()
2765
 
    pb = ui.ui_factory.nested_progress_bar()
2766
2013
    try:
2767
2014
        for n in range(10):
2768
2015
            pb.update('Resolution pass', n+1, 10)
2772
2019
            new_conflicts.update(pass_func(tt, conflicts))
2773
2020
        raise MalformedTransform(conflicts=conflicts)
2774
2021
    finally:
2775
 
        pb.finished()
 
2022
        pb.clear()
2776
2023
 
2777
2024
 
2778
2025
def conflict_pass(tt, conflicts, path_tree=None):
2797
2044
                existing_file, new_file = conflict[1], conflict[2]
2798
2045
            new_name = tt.final_name(existing_file)+'.moved'
2799
2046
            tt.adjust_path(new_name, final_parent, existing_file)
2800
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2047
            new_conflicts.add((c_type, 'Moved existing file to', 
2801
2048
                               existing_file, new_file))
2802
2049
        elif c_type == 'parent loop':
2803
2050
            # break the loop by undoing one of the ops that caused the loop
2807
2054
            new_conflicts.add((c_type, 'Cancelled move', cur,
2808
2055
                               tt.final_parent(cur),))
2809
2056
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2810
 
 
 
2057
            
2811
2058
        elif c_type == 'missing parent':
2812
2059
            trans_id = conflict[1]
2813
2060
            try:
2814
2061
                tt.cancel_deletion(trans_id)
2815
 
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2062
                new_conflicts.add(('deleting parent', 'Not deleting', 
2816
2063
                                   trans_id))
2817
2064
            except KeyError:
2818
2065
                create = True
2827
2074
                        # special-case the other tree root (move its
2828
2075
                        # children to current root)
2829
2076
                        if entry.parent_id is None:
2830
 
                            create = False
 
2077
                            create=False
2831
2078
                            moved = _reparent_transform_children(
2832
2079
                                tt, trans_id, tt.root)
2833
2080
                            for child in moved:
2860
2107
            if parent_file_id is not None:
2861
2108
                tt.unversion_file(parent_id)
2862
2109
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
2863
 
        elif c_type == 'versioning no contents':
2864
 
            tt.cancel_versioning(conflict[1])
2865
2110
    return new_conflicts
2866
2111
 
2867
2112
 
2883
2128
        if len(conflict) == 3:
2884
2129
            yield Conflict.factory(c_type, action=action, path=modified_path,
2885
2130
                                     file_id=modified_id)
2886
 
 
 
2131
             
2887
2132
        else:
2888
2133
            conflicting_path = fp.get_path(conflict[3])
2889
2134
            conflicting_id = tt.final_file_id(conflict[3])
2890
2135
            yield Conflict.factory(c_type, action=action, path=modified_path,
2891
 
                                   file_id=modified_id,
 
2136
                                   file_id=modified_id, 
2892
2137
                                   conflict_path=conflicting_path,
2893
2138
                                   conflict_file_id=conflicting_id)
2894
2139
 
2901
2146
        self.pending_deletions = []
2902
2147
 
2903
2148
    def rename(self, from_, to):
2904
 
        """Rename a file from one path to another."""
 
2149
        """Rename a file from one path to another.  Functions like os.rename"""
2905
2150
        try:
2906
 
            osutils.rename(from_, to)
 
2151
            os.rename(from_, to)
2907
2152
        except OSError, e:
2908
2153
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2909
2154
                raise errors.FileExists(to, str(e))
2923
2168
    def rollback(self):
2924
2169
        """Reverse all renames that have been performed"""
2925
2170
        for from_, to in reversed(self.past_renames):
2926
 
            osutils.rename(to, from_)
 
2171
            os.rename(to, from_)
2927
2172
        # after rollback, don't reuse _FileMover
2928
2173
        past_renames = None
2929
2174
        pending_deletions = None