~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2008-07-07 21:54:04 UTC
  • mto: This revision was merged to the branch mainline in revision 3533.
  • Revision ID: jelmer@samba.org-20080707215404-09t83ot6mv02jr6w
Move functionality to add ignores to the ignore file into a separate function.

Show diffs side-by-side

added added

removed removed

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