← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Robert Collins
  • Date: 2008-08-14 06:54:35 UTC
  • mto: This revision was merged to the branch mainline in revision 3629.
  • Revision ID: robertc@robertcollins.net-20080814065435-73xgy9r6xtqmvzux
Review feedback.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
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
30
    osutils,
43
31
    revision as _mod_revision,
44
 
    ui,
45
 
    urlutils,
46
32
    )
47
 
from bzrlib.i18n import gettext
48
33
""")
49
 
from bzrlib.errors import (DuplicateKey, MalformedTransform,
50
 
                           ReusingTransform, CantMoveRoot,
51
 
                           ImmortalLimbo, NoFinalPath,
 
34
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
 
35
                           ReusingTransform, NotVersionedError, CantMoveRoot,
 
36
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
52
37
                           UnableCreateSymlink)
53
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
54
 
from bzrlib.mutabletree import MutableTree
 
38
from bzrlib.inventory import InventoryEntry
55
39
from bzrlib.osutils import (
56
40
    delete_any,
57
41
    file_kind,
58
42
    has_symlinks,
 
43
    lexists,
59
44
    pathjoin,
60
 
    sha_file,
61
45
    splitpath,
62
 
    )
63
 
from bzrlib.progress import ProgressPhase
 
46
    supports_executable,
 
47
)
 
48
from bzrlib.progress import DummyProgress, ProgressPhase
64
49
from bzrlib.symbol_versioning import (
65
 
    deprecated_function,
66
 
    deprecated_in,
67
 
    deprecated_method,
68
 
    )
 
50
        deprecated_function,
 
51
        )
 
52
from bzrlib.trace import mutter, warning
 
53
from bzrlib import tree
 
54
import bzrlib.ui
 
55
import bzrlib.urlutils as urlutils
69
56
 
70
57
 
71
58
ROOT_PARENT = "root-parent"
72
59
 
 
60
 
73
61
def unique_add(map, key, value):
74
62
    if key in map:
75
63
        raise DuplicateKey(key=key)
76
64
    map[key] = value
77
65
 
78
66
 
79
 
 
80
67
class _TransformResults(object):
81
68
    def __init__(self, modified_paths, rename_count):
82
69
        object.__init__(self)
85
72
 
86
73
 
87
74
class TreeTransformBase(object):
88
 
    """The base class for TreeTransform and its kin."""
 
75
    """The base class for TreeTransform and TreeTransformBase"""
89
76
 
90
 
    def __init__(self, tree, pb=None,
 
77
    def __init__(self, tree, limbodir, pb=DummyProgress(),
91
78
                 case_sensitive=True):
92
79
        """Constructor.
93
80
 
94
81
        :param tree: The tree that will be transformed, but not necessarily
95
82
            the output tree.
96
 
        :param pb: ignored
 
83
        :param limbodir: A directory where new files can be stored until
 
84
            they are installed in their proper places
 
85
        :param pb: A ProgressBar indicating how much progress is being made
97
86
        :param case_sensitive: If True, the target of the transform is
98
87
            case sensitive, not just case preserving.
99
88
        """
100
89
        object.__init__(self)
101
90
        self._tree = tree
 
91
        self._limbodir = limbodir
 
92
        self._deletiondir = None
102
93
        self._id_number = 0
103
94
        # mapping of trans_id -> new basename
104
95
        self._new_name = {}
106
97
        self._new_parent = {}
107
98
        # mapping of trans_id with new contents -> new file_kind
108
99
        self._new_contents = {}
109
 
        # mapping of trans_id => (sha1 of content, stat_value)
110
 
        self._observed_sha1s = {}
 
100
        # A mapping of transform ids to their limbo filename
 
101
        self._limbo_files = {}
 
102
        # A mapping of transform ids to a set of the transform ids of children
 
103
        # that their limbo directory has
 
104
        self._limbo_children = {}
 
105
        # Map transform ids to maps of child filename to child transform id
 
106
        self._limbo_children_names = {}
 
107
        # List of transform ids that need to be renamed from limbo into place
 
108
        self._needs_rename = set()
111
109
        # Set of trans_ids whose contents will be removed
112
110
        self._removed_contents = set()
113
111
        # Mapping of trans_id -> new execute-bit value
120
118
        self._non_present_ids = {}
121
119
        # Mapping of new file_id -> trans_id
122
120
        self._r_new_id = {}
123
 
        # Set of trans_ids that will be removed
 
121
        # Set of file_ids that will be removed
124
122
        self._removed_id = set()
125
123
        # Mapping of path in old tree -> trans_id
126
124
        self._tree_path_ids = {}
127
125
        # Mapping trans_id -> path in old tree
128
126
        self._tree_id_paths = {}
 
127
        # Cache of realpath results, to speed up canonical_path
 
128
        self._realpaths = {}
 
129
        # Cache of relpath results, to speed up canonical_path
 
130
        self._relpaths = {}
129
131
        # 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
 
132
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
133
        # Indictor of whether the transform has been applied
136
134
        self._done = False
137
135
        # A progress bar
138
136
        self._pb = pb
141
139
        # A counter of how many files have been renamed
142
140
        self.rename_count = 0
143
141
 
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
142
    def __get_root(self):
166
143
        return self._new_root
167
144
 
168
145
    root = property(__get_root)
169
146
 
 
147
    def finalize(self):
 
148
        """Release the working tree lock, if held, clean up limbo dir.
 
149
 
 
150
        This is required if apply has not been invoked, but can be invoked
 
151
        even after apply.
 
152
        """
 
153
        if self._tree is None:
 
154
            return
 
155
        try:
 
156
            entries = [(self._limbo_name(t), t, k) for t, k in
 
157
                       self._new_contents.iteritems()]
 
158
            entries.sort(reverse=True)
 
159
            for path, trans_id, kind in entries:
 
160
                if kind == "directory":
 
161
                    os.rmdir(path)
 
162
                else:
 
163
                    os.unlink(path)
 
164
            try:
 
165
                os.rmdir(self._limbodir)
 
166
            except OSError:
 
167
                # We don't especially care *why* the dir is immortal.
 
168
                raise ImmortalLimbo(self._limbodir)
 
169
            try:
 
170
                if self._deletiondir is not None:
 
171
                    os.rmdir(self._deletiondir)
 
172
            except OSError:
 
173
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
174
        finally:
 
175
            self._tree.unlock()
 
176
            self._tree = None
 
177
 
170
178
    def _assign_id(self):
171
179
        """Produce a new tranform id"""
172
180
        new_id = "new-%s" % self._id_number
182
190
 
183
191
    def adjust_path(self, name, parent, trans_id):
184
192
        """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
193
        if trans_id == self._new_root:
188
194
            raise CantMoveRoot
 
195
        previous_parent = self._new_parent.get(trans_id)
 
196
        previous_name = self._new_name.get(trans_id)
189
197
        self._new_name[trans_id] = name
190
198
        self._new_parent[trans_id] = parent
 
199
        if (trans_id in self._limbo_files and
 
200
            trans_id not in self._needs_rename):
 
201
            self._rename_in_limbo([trans_id])
 
202
            self._limbo_children[previous_parent].remove(trans_id)
 
203
            del self._limbo_children_names[previous_parent][previous_name]
 
204
 
 
205
    def _rename_in_limbo(self, trans_ids):
 
206
        """Fix limbo names so that the right final path is produced.
 
207
 
 
208
        This means we outsmarted ourselves-- we tried to avoid renaming
 
209
        these files later by creating them with their final names in their
 
210
        final parents.  But now the previous name or parent is no longer
 
211
        suitable, so we have to rename them.
 
212
 
 
213
        Even for trans_ids that have no new contents, we must remove their
 
214
        entries from _limbo_files, because they are now stale.
 
215
        """
 
216
        for trans_id in trans_ids:
 
217
            old_path = self._limbo_files.pop(trans_id)
 
218
            if trans_id not in self._new_contents:
 
219
                continue
 
220
            new_path = self._limbo_name(trans_id)
 
221
            os.rename(old_path, new_path)
191
222
 
192
223
    def adjust_root_path(self, name, parent):
193
224
        """Emulate moving the root by moving all children, instead.
194
 
 
 
225
        
195
226
        We do this by undoing the association of root's transaction id with the
196
227
        current tree.  This allows us to create a new directory with that
197
 
        transaction id.  We unversion the root directory and version the
 
228
        transaction id.  We unversion the root directory and version the 
198
229
        physically new directory, and hope someone versions the tree root
199
230
        later.
200
231
        """
203
234
        # force moving all children of root
204
235
        for child_id in self.iter_tree_children(old_root):
205
236
            if child_id != parent:
206
 
                self.adjust_path(self.final_name(child_id),
 
237
                self.adjust_path(self.final_name(child_id), 
207
238
                                 self.final_parent(child_id), child_id)
208
239
            file_id = self.final_file_id(child_id)
209
240
            if file_id is not None:
210
241
                self.unversion_file(child_id)
211
242
            self.version_file(file_id, child_id)
212
 
 
 
243
        
213
244
        # the physical root needs a new transaction id
214
245
        self._tree_path_ids.pop("")
215
246
        self._tree_id_paths.pop(old_root)
221
252
        self.version_file(old_root_file_id, old_root)
222
253
        self.unversion_file(self._new_root)
223
254
 
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
255
    def trans_id_tree_file_id(self, inventory_id):
286
256
        """Determine the transaction id of a working tree file.
287
 
 
 
257
        
288
258
        This reflects only files that already exist, not ones that will be
289
259
        added by transactions.
290
260
        """
291
 
        if inventory_id is None:
292
 
            raise ValueError('None is not a valid file id')
293
261
        path = self._tree.id2path(inventory_id)
294
262
        return self.trans_id_tree_path(path)
295
263
 
299
267
        a transaction has been unversioned, it is deliberately still returned.
300
268
        (this will likely lead to an unversioned parent conflict.)
301
269
        """
302
 
        if file_id is None:
303
 
            raise ValueError('None is not a valid file id')
304
270
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
305
271
            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)
 
272
        elif file_id in self._tree.inventory:
 
273
            return self.trans_id_tree_file_id(file_id)
 
274
        elif file_id in self._non_present_ids:
 
275
            return self._non_present_ids[file_id]
 
276
        else:
 
277
            trans_id = self._assign_id()
 
278
            self._non_present_ids[file_id] = trans_id
 
279
            return trans_id
 
280
 
 
281
    def canonical_path(self, path):
 
282
        """Get the canonical tree-relative path"""
 
283
        # don't follow final symlinks
 
284
        abs = self._tree.abspath(path)
 
285
        if abs in self._relpaths:
 
286
            return self._relpaths[abs]
 
287
        dirname, basename = os.path.split(abs)
 
288
        if dirname not in self._realpaths:
 
289
            self._realpaths[dirname] = os.path.realpath(dirname)
 
290
        dirname = self._realpaths[dirname]
 
291
        abs = pathjoin(dirname, basename)
 
292
        if dirname in self._relpaths:
 
293
            relpath = pathjoin(self._relpaths[dirname], basename)
 
294
            relpath = relpath.rstrip('/\\')
 
295
        else:
 
296
            relpath = self._tree.relpath(abs)
 
297
        self._relpaths[abs] = relpath
 
298
        return relpath
318
299
 
319
300
    def trans_id_tree_path(self, path):
320
301
        """Determine (and maybe set) the transaction ID for a tree path."""
331
312
            return ROOT_PARENT
332
313
        return self.trans_id_tree_path(os.path.dirname(path))
333
314
 
 
315
    def create_file(self, contents, trans_id, mode_id=None):
 
316
        """Schedule creation of a new file.
 
317
 
 
318
        See also new_file.
 
319
        
 
320
        Contents is an iterator of strings, all of which will be written
 
321
        to the target destination.
 
322
 
 
323
        New file takes the permissions of any existing file with that id,
 
324
        unless mode_id is specified.
 
325
        """
 
326
        name = self._limbo_name(trans_id)
 
327
        f = open(name, 'wb')
 
328
        try:
 
329
            try:
 
330
                unique_add(self._new_contents, trans_id, 'file')
 
331
            except:
 
332
                # Clean up the file, it never got registered so
 
333
                # TreeTransform.finalize() won't clean it up.
 
334
                f.close()
 
335
                os.unlink(name)
 
336
                raise
 
337
 
 
338
            f.writelines(contents)
 
339
        finally:
 
340
            f.close()
 
341
        self._set_mode(trans_id, mode_id, S_ISREG)
 
342
 
 
343
    def _set_mode(self, trans_id, mode_id, typefunc):
 
344
        """Set the mode of new file contents.
 
345
        The mode_id is the existing file to get the mode from (often the same
 
346
        as trans_id).  The operation is only performed if there's a mode match
 
347
        according to typefunc.
 
348
        """
 
349
        if mode_id is None:
 
350
            mode_id = trans_id
 
351
        try:
 
352
            old_path = self._tree_id_paths[mode_id]
 
353
        except KeyError:
 
354
            return
 
355
        try:
 
356
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
357
        except OSError, e:
 
358
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
359
                # Either old_path doesn't exist, or the parent of the
 
360
                # target is not a directory (but will be one eventually)
 
361
                # Either way, we know it doesn't exist *right now*
 
362
                # See also bug #248448
 
363
                return
 
364
            else:
 
365
                raise
 
366
        if typefunc(mode):
 
367
            os.chmod(self._limbo_name(trans_id), mode)
 
368
 
 
369
    def create_hardlink(self, path, trans_id):
 
370
        """Schedule creation of a hard link"""
 
371
        name = self._limbo_name(trans_id)
 
372
        try:
 
373
            os.link(path, name)
 
374
        except OSError, e:
 
375
            if e.errno != errno.EPERM:
 
376
                raise
 
377
            raise errors.HardLinkNotSupported(path)
 
378
        try:
 
379
            unique_add(self._new_contents, trans_id, 'file')
 
380
        except:
 
381
            # Clean up the file, it never got registered so
 
382
            # TreeTransform.finalize() won't clean it up.
 
383
            os.unlink(name)
 
384
            raise
 
385
 
 
386
    def create_directory(self, trans_id):
 
387
        """Schedule creation of a new directory.
 
388
        
 
389
        See also new_directory.
 
390
        """
 
391
        os.mkdir(self._limbo_name(trans_id))
 
392
        unique_add(self._new_contents, trans_id, 'directory')
 
393
 
 
394
    def create_symlink(self, target, trans_id):
 
395
        """Schedule creation of a new symbolic link.
 
396
 
 
397
        target is a bytestring.
 
398
        See also new_symlink.
 
399
        """
 
400
        if has_symlinks():
 
401
            os.symlink(target, self._limbo_name(trans_id))
 
402
            unique_add(self._new_contents, trans_id, 'symlink')
 
403
        else:
 
404
            try:
 
405
                path = FinalPaths(self).get_path(trans_id)
 
406
            except KeyError:
 
407
                path = None
 
408
            raise UnableCreateSymlink(path=path)
 
409
 
 
410
    def cancel_creation(self, trans_id):
 
411
        """Cancel the creation of new file contents."""
 
412
        del self._new_contents[trans_id]
 
413
        children = self._limbo_children.get(trans_id)
 
414
        # if this is a limbo directory with children, move them before removing
 
415
        # the directory
 
416
        if children is not None:
 
417
            self._rename_in_limbo(children)
 
418
            del self._limbo_children[trans_id]
 
419
            del self._limbo_children_names[trans_id]
 
420
        delete_any(self._limbo_name(trans_id))
 
421
 
334
422
    def delete_contents(self, trans_id):
335
423
        """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)
 
424
        self.tree_kind(trans_id)
 
425
        self._removed_contents.add(trans_id)
339
426
 
340
427
    def cancel_deletion(self, trans_id):
341
428
        """Cancel a scheduled deletion"""
398
485
        return sorted(FinalPaths(self).get_paths(new_ids))
399
486
 
400
487
    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.
413
 
        """
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,
 
488
        """Get the trans_ids and paths of files needing new inv entries."""
 
489
        new_ids = set()
 
490
        for id_set in [self._new_name, self._new_parent, self._new_id,
419
491
                       self._new_executability]:
420
 
            changed_ids.update(id_set)
421
 
        # removing implies a kind change
 
492
            new_ids.update(id_set)
422
493
        changed_kind = set(self._removed_contents)
423
 
        # so does adding
424
494
        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))
 
495
        changed_kind.difference_update(new_ids)
 
496
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
497
                        self.final_kind(t))
 
498
        new_ids.update(changed_kind)
 
499
        return sorted(FinalPaths(self).get_paths(new_ids))
 
500
 
 
501
    def tree_kind(self, trans_id):
 
502
        """Determine the file kind in the working tree.
 
503
 
 
504
        Raises NoSuchFile if the file does not exist
 
505
        """
 
506
        path = self._tree_id_paths.get(trans_id)
 
507
        if path is None:
 
508
            raise NoSuchFile(None)
 
509
        try:
 
510
            return file_kind(self._tree.abspath(path))
 
511
        except OSError, e:
 
512
            if e.errno != errno.ENOENT:
 
513
                raise
 
514
            else:
 
515
                raise NoSuchFile(path)
439
516
 
440
517
    def final_kind(self, trans_id):
441
518
        """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)
 
519
        
 
520
        Raises NoSuchFile if the file does not exist/has no contents.
 
521
        (It is conceivable that a path would be created without the
 
522
        corresponding contents insertion command)
446
523
        """
447
524
        if trans_id in self._new_contents:
448
525
            return self._new_contents[trans_id]
449
526
        elif trans_id in self._removed_contents:
450
 
            return None
 
527
            raise NoSuchFile(None)
451
528
        else:
452
529
            return self.tree_kind(trans_id)
453
530
 
461
538
        # the file is old; the old id is still valid
462
539
        if self._new_root == trans_id:
463
540
            return self._tree.get_root_id()
464
 
        return self._tree.path2id(path)
 
541
        return self._tree.inventory.path2id(path)
465
542
 
466
543
    def final_file_id(self, trans_id):
467
544
        """Determine the file id after any changes are applied, or None.
468
 
 
 
545
        
469
546
        None indicates that the file will not be versioned after changes are
470
547
        applied.
471
548
        """
510
587
 
511
588
    def by_parent(self):
512
589
        """Return a map of parent: children for known parents.
513
 
 
 
590
        
514
591
        Only new paths and parents of tree files with assigned ids are used.
515
592
        """
516
593
        by_parent = {}
517
594
        items = list(self._new_parent.iteritems())
518
 
        items.extend((t, self.final_parent(t)) for t in
 
595
        items.extend((t, self.final_parent(t)) for t in 
519
596
                      self._tree_id_paths.keys())
520
597
        for trans_id, parent_id in items:
521
598
            if parent_id not in by_parent:
549
626
        conflicts.extend(self._overwrite_conflicts())
550
627
        return conflicts
551
628
 
552
 
    def _check_malformed(self):
553
 
        conflicts = self.find_conflicts()
554
 
        if len(conflicts) != 0:
555
 
            raise MalformedTransform(conflicts=conflicts)
556
 
 
557
629
    def _add_tree_children(self):
558
630
        """Add all the children of all active parents to the known paths.
559
631
 
561
633
        removed.  This is a necessary first step in detecting conflicts.
562
634
        """
563
635
        parents = self.by_parent().keys()
564
 
        parents.extend([t for t in self._removed_contents if
 
636
        parents.extend([t for t in self._removed_contents if 
565
637
                        self.tree_kind(t) == 'directory'])
566
638
        for trans_id in self._removed_id:
567
639
            file_id = self.tree_file_id(trans_id)
568
640
            if file_id is not None:
569
 
                if self._tree.stored_kind(file_id) == 'directory':
 
641
                if self._tree.inventory[file_id].kind == 'directory':
570
642
                    parents.append(trans_id)
571
643
            elif self.tree_kind(trans_id) == 'directory':
572
644
                parents.append(trans_id)
575
647
            # ensure that all children are registered with the transaction
576
648
            list(self.iter_tree_children(parent_id))
577
649
 
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:
 
650
    def iter_tree_children(self, parent_id):
 
651
        """Iterate through the entry's tree children, if any"""
 
652
        try:
 
653
            path = self._tree_id_paths[parent_id]
 
654
        except KeyError:
 
655
            return
 
656
        try:
 
657
            children = os.listdir(self._tree.abspath(path))
 
658
        except OSError, e:
 
659
            if not (osutils._is_error_enotdir(e)
 
660
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
661
                raise
 
662
            return
 
663
 
 
664
        for child in children:
 
665
            childpath = joinpath(path, child)
 
666
            if self._tree.is_control_filename(childpath):
 
667
                continue
 
668
            yield self.trans_id_tree_path(childpath)
 
669
 
 
670
    def has_named_child(self, by_parent, parent_id, name):
 
671
        try:
 
672
            children = by_parent[parent_id]
 
673
        except KeyError:
 
674
            children = []
 
675
        for child in children:
592
676
            if self.final_name(child) == name:
593
677
                return True
594
 
        parent_path = self._tree_id_paths.get(parent_id, None)
595
 
        if parent_path is None:
596
 
            # No parent... no children
 
678
        try:
 
679
            path = self._tree_id_paths[parent_id]
 
680
        except KeyError:
597
681
            return False
598
 
        child_path = joinpath(parent_path, name)
599
 
        child_id = self._tree_path_ids.get(child_path, None)
 
682
        childpath = joinpath(path, name)
 
683
        child_id = self._tree_path_ids.get(childpath)
600
684
        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))
 
685
            return lexists(self._tree.abspath(childpath))
603
686
        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))
 
687
            if self.final_parent(child_id) != parent_id:
 
688
                return False
 
689
            if child_id in self._removed_contents:
 
690
                # XXX What about dangling file-ids?
 
691
                return False
 
692
            else:
 
693
                return True
620
694
 
621
695
    def _parent_loops(self):
622
696
        """No entry should be its own ancestor"""
624
698
        for trans_id in self._new_parent:
625
699
            seen = set()
626
700
            parent_id = trans_id
627
 
            while parent_id != ROOT_PARENT:
 
701
            while parent_id is not ROOT_PARENT:
628
702
                seen.add(parent_id)
629
703
                try:
630
704
                    parent_id = self.final_parent(parent_id)
640
714
        """If parent directories are versioned, children must be versioned."""
641
715
        conflicts = []
642
716
        for parent_id, children in by_parent.iteritems():
643
 
            if parent_id == ROOT_PARENT:
 
717
            if parent_id is ROOT_PARENT:
644
718
                continue
645
719
            if self.final_file_id(parent_id) is not None:
646
720
                continue
652
726
 
653
727
    def _improper_versioning(self):
654
728
        """Cannot version a file with no contents, or a bad type.
655
 
 
 
729
        
656
730
        However, existing entries with no contents are okay.
657
731
        """
658
732
        conflicts = []
659
733
        for trans_id in self._new_id.iterkeys():
660
 
            kind = self.final_kind(trans_id)
661
 
            if kind is None:
 
734
            try:
 
735
                kind = self.final_kind(trans_id)
 
736
            except NoSuchFile:
662
737
                conflicts.append(('versioning no contents', trans_id))
663
738
                continue
664
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
739
            if not InventoryEntry.versionable_kind(kind):
665
740
                conflicts.append(('versioning bad kind', trans_id, kind))
666
741
        return conflicts
667
742
 
668
743
    def _executability_conflicts(self):
669
744
        """Check for bad executability changes.
670
 
 
 
745
        
671
746
        Only versioned files may have their executability set, because
672
747
        1. only versioned entries can have executability under windows
673
748
        2. only files can be executable.  (The execute bit on a directory
678
753
            if self.final_file_id(trans_id) is None:
679
754
                conflicts.append(('unversioned executability', trans_id))
680
755
            else:
681
 
                if self.final_kind(trans_id) != "file":
 
756
                try:
 
757
                    non_file = self.final_kind(trans_id) != "file"
 
758
                except NoSuchFile:
 
759
                    non_file = True
 
760
                if non_file is True:
682
761
                    conflicts.append(('non-file executability', trans_id))
683
762
        return conflicts
684
763
 
686
765
        """Check for overwrites (not permitted on Win32)"""
687
766
        conflicts = []
688
767
        for trans_id in self._new_contents:
689
 
            if self.tree_kind(trans_id) is None:
 
768
            try:
 
769
                self.tree_kind(trans_id)
 
770
            except NoSuchFile:
690
771
                continue
691
772
            if trans_id not in self._removed_contents:
692
773
                conflicts.append(('overwrite', trans_id,
699
780
        if (self._new_name, self._new_parent) == ({}, {}):
700
781
            return conflicts
701
782
        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))
 
783
            name_ids = [(self.final_name(t), t) for t in children]
 
784
            if not self._case_sensitive_target:
 
785
                name_ids = [(n.lower(), t) for n, t in name_ids]
710
786
            name_ids.sort()
711
787
            last_name = None
712
788
            last_trans_id = None
713
789
            for name, trans_id in name_ids:
714
 
                kind = self.final_kind(trans_id)
 
790
                try:
 
791
                    kind = self.final_kind(trans_id)
 
792
                except NoSuchFile:
 
793
                    kind = None
715
794
                file_id = self.final_file_id(trans_id)
716
795
                if kind is None and file_id is None:
717
796
                    continue
736
815
        return conflicts
737
816
 
738
817
    def _parent_type_conflicts(self, by_parent):
739
 
        """Children must have a directory parent"""
 
818
        """parents must have directory 'contents'."""
740
819
        conflicts = []
741
820
        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)
 
821
            if parent_id is ROOT_PARENT:
 
822
                continue
 
823
            if not self._any_contents(children):
 
824
                continue
 
825
            for child in children:
 
826
                try:
 
827
                    self.final_kind(child)
 
828
                except NoSuchFile:
 
829
                    continue
 
830
            try:
 
831
                kind = self.final_kind(parent_id)
 
832
            except NoSuchFile:
 
833
                kind = None
754
834
            if kind is None:
755
 
                # The directory will be deleted
756
835
                conflicts.append(('missing parent', parent_id))
757
836
            elif kind != "directory":
758
 
                # Meh, we need a *directory* to put something in it
759
837
                conflicts.append(('non-directory parent', parent_id))
760
838
        return conflicts
761
839
 
 
840
    def _any_contents(self, trans_ids):
 
841
        """Return true if any of the trans_ids, will have contents."""
 
842
        for trans_id in trans_ids:
 
843
            try:
 
844
                kind = self.final_kind(trans_id)
 
845
            except NoSuchFile:
 
846
                continue
 
847
            return True
 
848
        return False
 
849
 
 
850
    def _limbo_name(self, trans_id):
 
851
        """Generate the limbo name of a file"""
 
852
        limbo_name = self._limbo_files.get(trans_id)
 
853
        if limbo_name is not None:
 
854
            return limbo_name
 
855
        parent = self._new_parent.get(trans_id)
 
856
        # if the parent directory is already in limbo (e.g. when building a
 
857
        # tree), choose a limbo name inside the parent, to reduce further
 
858
        # renames.
 
859
        use_direct_path = False
 
860
        if self._new_contents.get(parent) == 'directory':
 
861
            filename = self._new_name.get(trans_id)
 
862
            if filename is not None:
 
863
                if parent not in self._limbo_children:
 
864
                    self._limbo_children[parent] = set()
 
865
                    self._limbo_children_names[parent] = {}
 
866
                    use_direct_path = True
 
867
                # the direct path can only be used if no other file has
 
868
                # already taken this pathname, i.e. if the name is unused, or
 
869
                # if it is already associated with this trans_id.
 
870
                elif self._case_sensitive_target:
 
871
                    if (self._limbo_children_names[parent].get(filename)
 
872
                        in (trans_id, None)):
 
873
                        use_direct_path = True
 
874
                else:
 
875
                    for l_filename, l_trans_id in\
 
876
                        self._limbo_children_names[parent].iteritems():
 
877
                        if l_trans_id == trans_id:
 
878
                            continue
 
879
                        if l_filename.lower() == filename.lower():
 
880
                            break
 
881
                    else:
 
882
                        use_direct_path = True
 
883
 
 
884
        if use_direct_path:
 
885
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
886
            self._limbo_children[parent].add(trans_id)
 
887
            self._limbo_children_names[parent][filename] = trans_id
 
888
        else:
 
889
            limbo_name = pathjoin(self._limbodir, trans_id)
 
890
            self._needs_rename.add(trans_id)
 
891
        self._limbo_files[trans_id] = limbo_name
 
892
        return limbo_name
 
893
 
762
894
    def _set_executability(self, path, trans_id):
763
895
        """Set the executability of versioned files """
764
 
        if self._tree._supports_executable():
 
896
        if supports_executable():
765
897
            new_executability = self._new_executability[trans_id]
766
898
            abspath = self._tree.abspath(path)
767
899
            current_mode = os.stat(abspath).st_mode
776
908
                    to_mode |= 0010 & ~umask
777
909
            else:
778
910
                to_mode = current_mode & ~0111
779
 
            osutils.chmod_if_possible(abspath, to_mode)
 
911
            os.chmod(abspath, to_mode)
780
912
 
781
913
    def _new_entry(self, name, parent_id, file_id):
782
914
        """Helper function to create a new filesystem entry."""
785
917
            self.version_file(file_id, trans_id)
786
918
        return trans_id
787
919
 
788
 
    def new_file(self, name, parent_id, contents, file_id=None,
789
 
                 executable=None, sha1=None):
 
920
    def new_file(self, name, parent_id, contents, file_id=None, 
 
921
                 executable=None):
790
922
        """Convenience method to create files.
791
 
 
 
923
        
792
924
        name is the name of the file to create.
793
925
        parent_id is the transaction id of the parent directory of the file.
794
926
        contents is an iterator of bytestrings, which will be used to produce
799
931
        trans_id = self._new_entry(name, parent_id, file_id)
800
932
        # TODO: rather than scheduling a set_executable call,
801
933
        # have create_file create the file with the right mode.
802
 
        self.create_file(contents, trans_id, sha1=sha1)
 
934
        self.create_file(contents, trans_id)
803
935
        if executable is not None:
804
936
            self.set_executability(executable, trans_id)
805
937
        return trans_id
814
946
        """
815
947
        trans_id = self._new_entry(name, parent_id, file_id)
816
948
        self.create_directory(trans_id)
817
 
        return trans_id
 
949
        return trans_id 
818
950
 
819
951
    def new_symlink(self, name, parent_id, target, file_id=None):
820
952
        """Convenience method to create symbolic link.
821
 
 
 
953
        
822
954
        name is the name of the symlink to create.
823
955
        parent_id is the transaction id of the parent directory of the symlink.
824
956
        target is a bytestring of the target of the symlink.
828
960
        self.create_symlink(target, trans_id)
829
961
        return trans_id
830
962
 
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
963
    def _affected_ids(self):
874
964
        """Return the set of transform ids affected by the transform"""
875
965
        trans_ids = set(self._removed_id)
905
995
        from_path = self._tree_id_paths.get(from_trans_id)
906
996
        if from_versioned:
907
997
            # get data from working tree if versioned
908
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
998
            from_entry = self._tree.inventory[file_id]
909
999
            from_name = from_entry.name
910
1000
            from_parent = from_entry.parent_id
911
1001
        else:
934
1024
        Return a (name, parent, kind, executable) tuple
935
1025
        """
936
1026
        to_name = self.final_name(to_trans_id)
937
 
        to_kind = self.final_kind(to_trans_id)
 
1027
        try:
 
1028
            to_kind = self.final_kind(to_trans_id)
 
1029
        except NoSuchFile:
 
1030
            to_kind = None
938
1031
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
939
1032
        if to_trans_id in self._new_executability:
940
1033
            to_executable = self._new_executability[to_trans_id]
1009
1102
    def get_preview_tree(self):
1010
1103
        """Return a tree representing the result of the transform.
1011
1104
 
1012
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
1013
 
        it.
 
1105
        This tree only supports the subset of Tree functionality required
 
1106
        by show_diff_trees.  It must only be compared to tt._tree.
1014
1107
        """
1015
1108
        return _PreviewTree(self)
1016
1109
 
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):
 
1110
 
 
1111
class TreeTransform(TreeTransformBase):
1481
1112
    """Represent a tree transformation.
1482
1113
 
1483
1114
    This object is designed to support incremental generation of the transform,
1542
1173
    FileMover does not delete files until it is sure that a rollback will not
1543
1174
    happen.
1544
1175
    """
1545
 
    def __init__(self, tree, pb=None):
 
1176
    def __init__(self, tree, pb=DummyProgress()):
1546
1177
        """Note: a tree_write lock is taken on the tree.
1547
1178
 
1548
1179
        Use TreeTransform.finalize() to release the lock (can be omitted if
1553
1184
        try:
1554
1185
            limbodir = urlutils.local_path_from_url(
1555
1186
                tree._transport.abspath('limbo'))
1556
 
            osutils.ensure_empty_directory_exists(
1557
 
                limbodir,
1558
 
                errors.ExistingLimbo)
 
1187
            try:
 
1188
                os.mkdir(limbodir)
 
1189
            except OSError, e:
 
1190
                if e.errno == errno.EEXIST:
 
1191
                    raise ExistingLimbo(limbodir)
1559
1192
            deletiondir = urlutils.local_path_from_url(
1560
1193
                tree._transport.abspath('pending-deletion'))
1561
 
            osutils.ensure_empty_directory_exists(
1562
 
                deletiondir,
1563
 
                errors.ExistingPendingDeletion)
 
1194
            try:
 
1195
                os.mkdir(deletiondir)
 
1196
            except OSError, e:
 
1197
                if e.errno == errno.EEXIST:
 
1198
                    raise errors.ExistingPendingDeletion(deletiondir)
1564
1199
        except:
1565
1200
            tree.unlock()
1566
1201
            raise
1567
1202
 
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,
 
1203
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1573
1204
                                   tree.case_sensitive)
1574
1205
        self._deletiondir = deletiondir
1575
1206
 
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
1207
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1703
1208
        """Apply all changes to the inventory and filesystem.
1704
1209
 
1713
1218
            calculating one.
1714
1219
        :param _mover: Supply an alternate FileMover, for testing
1715
1220
        """
1716
 
        for hook in MutableTree.hooks['pre_transform']:
1717
 
            hook(self._tree, self)
1718
1221
        if not no_conflicts:
1719
 
            self._check_malformed()
1720
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1222
            conflicts = self.find_conflicts()
 
1223
            if len(conflicts) != 0:
 
1224
                raise MalformedTransform(conflicts=conflicts)
 
1225
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1721
1226
        try:
1722
1227
            if precomputed_delta is None:
1723
 
                child_pb.update(gettext('Apply phase'), 0, 2)
 
1228
                child_pb.update('Apply phase', 0, 2)
1724
1229
                inventory_delta = self._generate_inventory_delta()
1725
1230
                offset = 1
1726
1231
            else:
1731
1236
            else:
1732
1237
                mover = _mover
1733
1238
            try:
1734
 
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
 
1239
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
1735
1240
                self._apply_removals(mover)
1736
 
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
 
1241
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
1737
1242
                modified_paths = self._apply_insertions(mover)
1738
1243
            except:
1739
1244
                mover.rollback()
1742
1247
                mover.apply_deletions()
1743
1248
        finally:
1744
1249
            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
1250
        self._tree.apply_inventory_delta(inventory_delta)
1748
 
        self._apply_observed_sha1s()
1749
1251
        self._done = True
1750
1252
        self.finalize()
1751
1253
        return _TransformResults(modified_paths, self.rename_count)
1753
1255
    def _generate_inventory_delta(self):
1754
1256
        """Generate an inventory delta for the current transform."""
1755
1257
        inventory_delta = []
1756
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1258
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1757
1259
        new_paths = self._inventory_altered()
1758
1260
        total_entries = len(new_paths) + len(self._removed_id)
1759
1261
        try:
1760
1262
            for num, trans_id in enumerate(self._removed_id):
1761
1263
                if (num % 10) == 0:
1762
 
                    child_pb.update(gettext('removing file'), num, total_entries)
 
1264
                    child_pb.update('removing file', num, total_entries)
1763
1265
                if trans_id == self._new_root:
1764
1266
                    file_id = self._tree.get_root_id()
1765
1267
                else:
1777
1279
            final_kinds = {}
1778
1280
            for num, (path, trans_id) in enumerate(new_paths):
1779
1281
                if (num % 10) == 0:
1780
 
                    child_pb.update(gettext('adding file'),
 
1282
                    child_pb.update('adding file',
1781
1283
                                    num + len(self._removed_id), total_entries)
1782
1284
                file_id = new_path_file_ids[trans_id]
1783
1285
                if file_id is None:
1784
1286
                    continue
1785
1287
                needs_entry = False
1786
 
                kind = self.final_kind(trans_id)
1787
 
                if kind is None:
 
1288
                try:
 
1289
                    kind = self.final_kind(trans_id)
 
1290
                except NoSuchFile:
1788
1291
                    kind = self._tree.stored_kind(file_id)
1789
1292
                parent_trans_id = self.final_parent(trans_id)
1790
1293
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1821
1324
        """
1822
1325
        tree_paths = list(self._tree_path_ids.iteritems())
1823
1326
        tree_paths.sort(reverse=True)
1824
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1327
        kind_changes = set()
 
1328
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1825
1329
        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))
 
1330
            for num, data in enumerate(tree_paths):
 
1331
                path, trans_id = data
 
1332
                child_pb.update('removing file', num, len(tree_paths))
1831
1333
                full_path = self._tree.abspath(path)
1832
1334
                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):
 
1335
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1336
                                     trans_id))
 
1337
                elif trans_id in self._new_name or trans_id in \
 
1338
                    self._new_parent:
1837
1339
                    try:
1838
1340
                        mover.rename(full_path, self._limbo_name(trans_id))
1839
 
                    except errors.TransformRenameFailed, e:
 
1341
                    except OSError, e:
1840
1342
                        if e.errno != errno.ENOENT:
1841
1343
                            raise
1842
1344
                    else:
1843
1345
                        self.rename_count += 1
1844
1346
        finally:
1845
1347
            child_pb.finished()
 
1348
        return kind_changes
1846
1349
 
1847
1350
    def _apply_insertions(self, mover):
1848
1351
        """Perform tree operations that insert directory/inventory names.
1853
1356
 
1854
1357
        If inventory_delta is None, no inventory delta is calculated, and
1855
1358
        no list of modified paths is returned.
 
1359
 
 
1360
        kind_changes is a set of trans ids where the entry has changed
 
1361
        kind, and so an inventory delta entry should be created for them.
1856
1362
        """
1857
1363
        new_paths = self.new_paths(filesystem_only=True)
1858
1364
        modified_paths = []
1859
1365
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1860
1366
                                 new_paths)
1861
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1367
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1862
1368
        try:
1863
1369
            for num, (path, trans_id) in enumerate(new_paths):
1864
1370
                if (num % 10) == 0:
1865
 
                    child_pb.update(gettext('adding file'), num, len(new_paths))
 
1371
                    child_pb.update('adding file', num, len(new_paths))
1866
1372
                full_path = self._tree.abspath(path)
1867
1373
                if trans_id in self._needs_rename:
1868
1374
                    try:
1869
1375
                        mover.rename(self._limbo_name(trans_id), full_path)
1870
 
                    except errors.TransformRenameFailed, e:
 
1376
                    except OSError, e:
1871
1377
                        # We may be renaming a dangling inventory id
1872
1378
                        if e.errno != errno.ENOENT:
1873
1379
                            raise
1874
1380
                    else:
1875
1381
                        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
1382
                if (trans_id in self._new_contents or
1880
1383
                    self.path_changed(trans_id)):
1881
1384
                    if trans_id in self._new_contents:
1882
1385
                        modified_paths.append(full_path)
1883
1386
                if trans_id in self._new_executability:
1884
1387
                    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)
1889
1388
        finally:
1890
1389
            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
1390
        self._new_contents.clear()
1897
1391
        return modified_paths
1898
1392
 
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):
 
1393
 
 
1394
class TransformPreview(TreeTransformBase):
1924
1395
    """A TreeTransform for generating preview trees.
1925
1396
 
1926
1397
    Unlike TreeTransform, this version works when the input tree is a
1928
1399
    unversioned files in the input tree.
1929
1400
    """
1930
1401
 
1931
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1402
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1932
1403
        tree.lock_read()
1933
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1934
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1404
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1405
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1935
1406
 
1936
1407
    def canonical_path(self, path):
1937
1408
        return path
1939
1410
    def tree_kind(self, trans_id):
1940
1411
        path = self._tree_id_paths.get(trans_id)
1941
1412
        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
 
1413
            raise NoSuchFile(None)
 
1414
        file_id = self._tree.path2id(path)
 
1415
        return self._tree.kind(file_id)
1947
1416
 
1948
1417
    def _set_mode(self, trans_id, mode_id, typefunc):
1949
1418
        """Set the mode of new file contents.
1963
1432
        file_id = self.tree_file_id(parent_id)
1964
1433
        if file_id is None:
1965
1434
            return
1966
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1967
 
        children = getattr(entry, 'children', {})
 
1435
        children = getattr(self._tree.inventory[file_id], 'children', {})
1968
1436
        for child in children:
1969
1437
            childpath = joinpath(path, child)
1970
1438
            yield self.trans_id_tree_path(childpath)
1971
1439
 
1972
 
    def new_orphan(self, trans_id, parent_id):
1973
 
        raise NotImplementedError(self.new_orphan)
1974
 
 
1975
 
 
1976
 
class _PreviewTree(tree.InventoryTree):
 
1440
 
 
1441
class _PreviewTree(tree.Tree):
1977
1442
    """Partial implementation of Tree to support show_diff_trees"""
1978
1443
 
1979
1444
    def __init__(self, transform):
1981
1446
        self._final_paths = FinalPaths(transform)
1982
1447
        self.__by_parent = None
1983
1448
        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())
 
1449
 
 
1450
    def _changes(self, file_id):
 
1451
        for changes in self._transform.iter_changes():
 
1452
            if changes[0] == file_id:
 
1453
                return changes
1989
1454
 
1990
1455
    def _content_change(self, file_id):
1991
1456
        """Return True if the content of this file changed"""
1992
 
        changes = self._iter_changes_cache.get(file_id)
 
1457
        changes = self._changes(file_id)
1993
1458
        # changes[2] is true if the file content changed.  See
1994
1459
        # InterTree.iter_changes.
1995
1460
        return (changes is not None and changes[2])
2008
1473
                yield self._get_repository().revision_tree(revision_id)
2009
1474
 
2010
1475
    def _get_file_revision(self, file_id, vf, tree_revision):
2011
 
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
1476
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
2012
1477
                       self._iter_parent_trees()]
2013
1478
        vf.add_lines((file_id, tree_revision), parent_keys,
2014
 
                     self.get_file_lines(file_id))
 
1479
                     self.get_file(file_id).readlines())
2015
1480
        repo = self._get_repository()
2016
1481
        base_vf = repo.texts
2017
1482
        if base_vf not in vf.fallback_versionedfiles:
2018
1483
            vf.fallback_versionedfiles.append(base_vf)
2019
1484
        return tree_revision
2020
1485
 
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)
 
1486
    def _stat_limbo_file(self, file_id):
 
1487
        trans_id = self._transform.trans_id_file_id(file_id)
2024
1488
        name = self._transform._limbo_name(trans_id)
2025
1489
        return os.lstat(name)
2026
1490
 
2030
1494
            self.__by_parent = self._transform.by_parent()
2031
1495
        return self.__by_parent
2032
1496
 
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
1497
    def lock_read(self):
2047
1498
        # Perhaps in theory, this should lock the TreeTransform?
2048
 
        return self
 
1499
        pass
2049
1500
 
2050
1501
    def unlock(self):
2051
1502
        pass
2052
1503
 
2053
1504
    @property
2054
 
    @deprecated_method(deprecated_in((2, 5, 0)))
2055
1505
    def inventory(self):
2056
1506
        """This Tree does not use inventory as its backing data."""
2057
1507
        raise NotImplementedError(_PreviewTree.inventory)
2058
1508
 
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
1509
    def get_root_id(self):
2065
1510
        return self._transform.final_file_id(self._transform.root)
2066
1511
 
2074
1519
    def __iter__(self):
2075
1520
        return iter(self.all_file_ids())
2076
1521
 
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)
 
1522
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1523
        """See Tree.paths2ids"""
 
1524
        to_find = set(specific_files)
 
1525
        result = set()
 
1526
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1527
             executable) in self._transform.iter_changes():
 
1528
            if paths[1] in to_find:
 
1529
                result.append(file_id)
 
1530
                to_find.remove(paths[1])
 
1531
        result.update(self._transform._tree.paths2ids(to_find,
 
1532
                      trees=[], require_versioned=require_versioned))
 
1533
        return result
2091
1534
 
2092
1535
    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
1536
        segments = splitpath(path)
2098
1537
        cur_parent = self._transform.root
2099
1538
        for cur_segment in segments:
2100
1539
            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:
 
1540
                if self._transform.final_name(child) == cur_segment:
2106
1541
                    cur_parent = child
2107
1542
                    break
2108
1543
            else:
2109
 
                self._path2trans_id_cache[path] = None
2110
1544
                return None
2111
 
        self._path2trans_id_cache[path] = cur_parent
2112
1545
        return cur_parent
2113
1546
 
2114
1547
    def path2id(self, path):
2115
 
        if isinstance(path, list):
2116
 
            if path == []:
2117
 
                path = [""]
2118
 
            path = osutils.pathjoin(*path)
2119
1548
        return self._transform.final_file_id(self._path2trans_id(path))
2120
1549
 
2121
1550
    def id2path(self, file_id):
2126
1555
            raise errors.NoSuchId(self, file_id)
2127
1556
 
2128
1557
    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
1558
        children = set(self._transform.iter_tree_children(trans_id))
2133
1559
        # children in the _new_parent set are provided by _by_parent.
2134
1560
        children.difference_update(self._transform._new_parent.keys())
2135
1561
        children.update(self._by_parent.get(trans_id, []))
2136
 
        self._all_children_cache[trans_id] = children
2137
1562
        return children
2138
1563
 
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):
 
1564
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
2155
1565
        for trans_id, parent_file_id in ordered_entries:
2156
1566
            file_id = self._transform.final_file_id(trans_id)
2157
1567
            if file_id is None:
2159
1569
            if (specific_file_ids is not None
2160
1570
                and file_id not in specific_file_ids):
2161
1571
                continue
2162
 
            kind = self._transform.final_kind(trans_id)
2163
 
            if kind is None:
 
1572
            try:
 
1573
                kind = self._transform.final_kind(trans_id)
 
1574
            except NoSuchFile:
2164
1575
                kind = self._transform._tree.stored_kind(file_id)
2165
1576
            new_entry = inventory.make_entry(
2166
1577
                kind,
2168
1579
                parent_file_id, file_id)
2169
1580
            yield new_entry, trans_id
2170
1581
 
2171
 
    def _list_files_by_dir(self):
 
1582
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1583
        # This may not be a maximally efficient implementation, but it is
 
1584
        # reasonably straightforward.  An implementation that grafts the
 
1585
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
1586
        # might be more efficient, but requires tricky inferences about stack
 
1587
        # position.
2172
1588
        todo = [ROOT_PARENT]
2173
1589
        ordered_ids = []
2174
1590
        while len(todo) > 0:
2180
1596
            todo.extend(reversed(children))
2181
1597
            for trans_id in children:
2182
1598
                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
1599
        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
 
1600
                                                      specific_file_ids):
 
1601
            yield unicode(self._final_paths.get_path(trans_id)), entry
2239
1602
 
2240
1603
    def kind(self, file_id):
2241
1604
        trans_id = self._transform.trans_id_file_id(file_id)
2251
1614
    def get_file_mtime(self, file_id, path=None):
2252
1615
        """See Tree.get_file_mtime"""
2253
1616
        if not self._content_change(file_id):
2254
 
            return self._transform._tree.get_file_mtime(file_id)
 
1617
            return self._transform._tree.get_file_mtime(file_id, path)
2255
1618
        return self._stat_limbo_file(file_id).st_mtime
2256
1619
 
2257
 
    def _file_size(self, entry, stat_value):
2258
 
        return self.get_file_size(entry.file_id)
2259
 
 
2260
1620
    def get_file_size(self, file_id):
2261
1621
        """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
1622
        if self.kind(file_id) == 'file':
2269
1623
            return self._transform._tree.get_file_size(file_id)
2270
1624
        else:
2271
1625
            return None
2272
1626
 
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
1627
    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()
 
1628
        return self._transform._tree.get_file_sha1(file_id)
2296
1629
 
2297
1630
    def is_executable(self, file_id, path=None):
2298
 
        if file_id is None:
2299
 
            return False
2300
1631
        trans_id = self._transform.trans_id_file_id(file_id)
2301
1632
        try:
2302
1633
            return self._transform._new_executability[trans_id]
2303
1634
        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)
 
1635
            return self._transform._tree.is_executable(file_id, path)
2321
1636
 
2322
1637
    def path_content_summary(self, path):
2323
1638
        trans_id = self._path2trans_id(path)
2337
1652
            if kind == 'file':
2338
1653
                statval = os.lstat(limbo_name)
2339
1654
                size = statval.st_size
2340
 
                if not tt._limbo_supports_executable():
2341
 
                    executable = False
 
1655
                if not supports_executable():
 
1656
                    executable = None
2342
1657
                else:
2343
1658
                    executable = statval.st_mode & S_IEXEC
2344
1659
            else:
2345
1660
                size = None
2346
1661
                executable = None
2347
1662
            if kind == 'symlink':
2348
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2349
 
        executable = tt._new_executability.get(trans_id, executable)
 
1663
                link_or_sha1 = os.readlink(limbo_name)
 
1664
        if supports_executable():
 
1665
            executable = tt._new_executability.get(trans_id, executable)
2350
1666
        return kind, size, executable, link_or_sha1
2351
1667
 
2352
1668
    def iter_changes(self, from_tree, include_unchanged=False,
2354
1670
                      require_versioned=True, want_unversioned=False):
2355
1671
        """See InterTree.iter_changes.
2356
1672
 
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.
 
1673
        This implementation does not support include_unchanged, specific_files,
 
1674
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1675
        ignored.
2359
1676
        """
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)
 
1677
        if from_tree is not self._transform._tree:
 
1678
            raise ValueError('from_tree must be transform source tree.')
 
1679
        if include_unchanged:
 
1680
            raise ValueError('include_unchanged is not supported')
 
1681
        if specific_files is not None:
 
1682
            raise ValueError('specific_files is not supported')
2369
1683
        if want_unversioned:
2370
1684
            raise ValueError('want_unversioned is not supported')
2371
1685
        return self._transform.iter_changes()
2378
1692
        name = self._transform._limbo_name(trans_id)
2379
1693
        return open(name, 'rb')
2380
1694
 
2381
 
    def get_file_with_stat(self, file_id, path=None):
2382
 
        return self.get_file(file_id, path), None
 
1695
    def get_file_text(self, file_id):
 
1696
        text_file = self.get_file(file_id)
 
1697
        try:
 
1698
            return text_file.read()
 
1699
        finally:
 
1700
            text_file.close()
2383
1701
 
2384
1702
    def annotate_iter(self, file_id,
2385
1703
                      default_revision=_mod_revision.CURRENT_REVISION):
2386
 
        changes = self._iter_changes_cache.get(file_id)
 
1704
        changes = self._changes(file_id)
2387
1705
        if changes is None:
2388
1706
            get_old = True
2389
1707
        else:
2401
1719
            return old_annotation
2402
1720
        if not changed_content:
2403
1721
            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
1722
        return annotate.reannotate([old_annotation],
2412
1723
                                   self.get_file(file_id).readlines(),
2413
1724
                                   default_revision)
2414
1725
 
2415
 
    def get_symlink_target(self, file_id, path=None):
 
1726
    def get_symlink_target(self, file_id):
2416
1727
        """See Tree.get_symlink_target"""
2417
1728
        if not self._content_change(file_id):
2418
1729
            return self._transform._tree.get_symlink_target(file_id)
2419
1730
        trans_id = self._transform.trans_id_file_id(file_id)
2420
1731
        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))
 
1732
        return os.readlink(name)
 
1733
 
 
1734
    def list_files(self, include_root=False):
 
1735
        return self._transform._tree.list_files(include_root)
 
1736
 
 
1737
    def walkdirs(self, prefix=""):
 
1738
        return self._transform._tree.walkdirs(prefix)
2451
1739
 
2452
1740
    def get_parent_ids(self):
2453
1741
        return self._parent_ids
2479
1767
        self.transform = transform
2480
1768
 
2481
1769
    def _determine_path(self, trans_id):
2482
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1770
        if trans_id == self.transform.root:
2483
1771
            return ""
2484
1772
        name = self.transform.final_name(trans_id)
2485
1773
        parent_id = self.transform.final_parent(trans_id)
2509
1797
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2510
1798
               delta_from_tree=False):
2511
1799
    """Create working tree for a branch, using a TreeTransform.
2512
 
 
 
1800
    
2513
1801
    This function should be used on empty trees, having a tree root at most.
2514
1802
    (see merge and revert functionality for working with existing trees)
2515
1803
 
2516
1804
    Existing files are handled like so:
2517
 
 
 
1805
    
2518
1806
    - Existing bzrdirs take precedence over creating new items.  They are
2519
1807
      created as '%s.diverted' % name.
2520
1808
    - Otherwise, if the content on disk matches the content we are building,
2555
1843
    for num, _unused in enumerate(wt.all_file_ids()):
2556
1844
        if num > 0:  # more than just a root
2557
1845
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
1846
    existing_files = set()
 
1847
    for dir, files in wt.walkdirs():
 
1848
        existing_files.update(f[0] for f in files)
2558
1849
    file_trans_id = {}
2559
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
1850
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2560
1851
    pp = ProgressPhase("Build phase", 2, top_pb)
2561
 
    if tree.get_root_id() is not None:
 
1852
    if tree.inventory.root is not None:
2562
1853
        # This is kind of a hack: we should be altering the root
2563
1854
        # as part of the regular tree shape diff logic.
2564
1855
        # The conditional test here is to avoid doing an
2575
1866
        pp.next_phase()
2576
1867
        file_trans_id[wt.get_root_id()] = \
2577
1868
            tt.trans_id_tree_file_id(wt.get_root_id())
2578
 
        pb = ui.ui_factory.nested_progress_bar()
 
1869
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2579
1870
        try:
2580
1871
            deferred_contents = []
2581
1872
            num = 0
2582
 
            total = len(tree.all_file_ids())
 
1873
            total = len(tree.inventory)
2583
1874
            if delta_from_tree:
2584
1875
                precomputed_delta = []
2585
1876
            else:
2586
1877
                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
1878
            for num, (tree_path, entry) in \
2597
 
                enumerate(tree.iter_entries_by_dir()):
2598
 
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
 
1879
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1880
                pb.update("Building tree", num - len(deferred_contents), total)
2599
1881
                if entry.parent_id is None:
2600
1882
                    continue
2601
1883
                reparent = False
2607
1889
                    kind = file_kind(target_path)
2608
1890
                    if kind == "directory":
2609
1891
                        try:
2610
 
                            controldir.ControlDir.open(target_path)
 
1892
                            bzrdir.BzrDir.open(target_path)
2611
1893
                        except errors.NotBranchError:
2612
1894
                            pass
2613
1895
                        else:
2628
1910
                    executable = tree.is_executable(file_id, tree_path)
2629
1911
                    if executable:
2630
1912
                        tt.set_executability(executable, trans_id)
2631
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
2632
 
                    deferred_contents.append((file_id, trans_data))
 
1913
                    deferred_contents.append((file_id, trans_id))
2633
1914
                else:
2634
1915
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2635
1916
                                                          tree)
2650
1931
            precomputed_delta = None
2651
1932
        conflicts = cook_conflicts(raw_conflicts, tt)
2652
1933
        for conflict in conflicts:
2653
 
            trace.warning(unicode(conflict))
 
1934
            warning(conflict)
2654
1935
        try:
2655
1936
            wt.add_conflicts(conflicts)
2656
1937
        except errors.UnsupportedOperation:
2666
1947
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2667
1948
                  hardlink):
2668
1949
    total = len(desired_files) + offset
2669
 
    wt = tt._tree
2670
1950
    if accelerator_tree is None:
2671
1951
        new_desired_files = desired_files
2672
1952
    else:
2673
1953
        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)
 
1954
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1955
                         in iter if not (c or e[0] != e[1]))
2680
1956
        new_desired_files = []
2681
1957
        count = 0
2682
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
1958
        for file_id, trans_id in desired_files:
2683
1959
            accelerator_path = unchanged.get(file_id)
2684
1960
            if accelerator_path is None:
2685
 
                new_desired_files.append((file_id,
2686
 
                    (trans_id, tree_path, text_sha1)))
 
1961
                new_desired_files.append((file_id, trans_id))
2687
1962
                continue
2688
 
            pb.update(gettext('Adding file contents'), count + offset, total)
 
1963
            pb.update('Adding file contents', count + offset, total)
2689
1964
            if hardlink:
2690
1965
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2691
1966
                                   trans_id)
2692
1967
            else:
2693
1968
                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
1969
                try:
2699
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
1970
                    tt.create_file(contents, trans_id)
2700
1971
                finally:
2701
 
                    try:
2702
 
                        contents.close()
2703
 
                    except AttributeError:
2704
 
                        # after filtering, contents may no longer be file-like
2705
 
                        pass
 
1972
                    contents.close()
2706
1973
            count += 1
2707
1974
        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)
 
1975
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1976
                                                 new_desired_files)):
 
1977
        tt.create_file(contents, trans_id)
 
1978
        pb.update('Adding file contents', count + offset, total)
2716
1979
 
2717
1980
 
2718
1981
def _reparent_children(tt, old_parent, new_parent):
2719
1982
    for child in tt.iter_tree_children(old_parent):
2720
1983
        tt.adjust_path(tt.final_name(child), new_parent, child)
2721
1984
 
2722
 
 
2723
1985
def _reparent_transform_children(tt, old_parent, new_parent):
2724
1986
    by_parent = tt.by_parent()
2725
1987
    for child in by_parent[old_parent]:
2726
1988
        tt.adjust_path(tt.final_name(child), new_parent, child)
2727
1989
    return by_parent[old_parent]
2728
1990
 
2729
 
 
2730
1991
def _content_match(tree, entry, file_id, kind, target_path):
2731
1992
    if entry.kind != kind:
2732
1993
        return False
2733
1994
    if entry.kind == "directory":
2734
1995
        return True
2735
1996
    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()
 
1997
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1998
            return True
2742
1999
    elif entry.kind == "symlink":
2743
2000
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2744
2001
            return True
2782
2039
    if kind == 'file':
2783
2040
        contents = tree.get_file(entry.file_id).readlines()
2784
2041
        executable = tree.is_executable(entry.file_id)
2785
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
2042
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2786
2043
                           executable)
2787
2044
    elif kind in ('directory', 'tree-reference'):
2788
2045
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2789
2046
        if kind == 'tree-reference':
2790
2047
            tt.set_tree_reference(entry.reference_revision, trans_id)
2791
 
        return trans_id
 
2048
        return trans_id 
2792
2049
    elif kind == 'symlink':
2793
2050
        target = tree.get_symlink_target(entry.file_id)
2794
2051
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2796
2053
        raise errors.BadFileKindError(name, kind)
2797
2054
 
2798
2055
 
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':
 
2056
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
2057
    """Create new file contents according to an inventory entry."""
 
2058
    if entry.kind == "file":
 
2059
        if lines is None:
 
2060
            lines = tree.get_file(entry.file_id).readlines()
 
2061
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
2062
    elif entry.kind == "symlink":
 
2063
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
2064
    elif entry.kind == "directory":
2809
2065
        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
2066
 
2828
2067
 
2829
2068
def create_entry_executability(tt, entry, trans_id):
2832
2071
        tt.set_executability(entry.executable, trans_id)
2833
2072
 
2834
2073
 
 
2074
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
2075
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
2076
 
 
2077
 
 
2078
def _get_backup_name(name, by_parent, parent_trans_id, tt):
 
2079
    """Produce a backup-style name that appears to be available"""
 
2080
    def name_gen():
 
2081
        counter = 1
 
2082
        while True:
 
2083
            yield "%s.~%d~" % (name, counter)
 
2084
            counter += 1
 
2085
    for new_name in name_gen():
 
2086
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
2087
            return new_name
 
2088
 
 
2089
 
 
2090
def _entry_changes(file_id, entry, working_tree):
 
2091
    """Determine in which ways the inventory entry has changed.
 
2092
 
 
2093
    Returns booleans: has_contents, content_mod, meta_mod
 
2094
    has_contents means there are currently contents, but they differ
 
2095
    contents_mod means contents need to be modified
 
2096
    meta_mod means the metadata needs to be modified
 
2097
    """
 
2098
    cur_entry = working_tree.inventory[file_id]
 
2099
    try:
 
2100
        working_kind = working_tree.kind(file_id)
 
2101
        has_contents = True
 
2102
    except NoSuchFile:
 
2103
        has_contents = False
 
2104
        contents_mod = True
 
2105
        meta_mod = False
 
2106
    if has_contents is True:
 
2107
        if entry.kind != working_kind:
 
2108
            contents_mod, meta_mod = True, False
 
2109
        else:
 
2110
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2111
                                       working_tree)
 
2112
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
 
2113
            cur_entry._forget_tree_state()
 
2114
    return has_contents, contents_mod, meta_mod
 
2115
 
 
2116
 
2835
2117
def revert(working_tree, target_tree, filenames, backups=False,
2836
 
           pb=None, change_reporter=None):
 
2118
           pb=DummyProgress(), change_reporter=None):
2837
2119
    """Revert a working tree's contents to those of a target tree."""
2838
2120
    target_tree.lock_read()
2839
 
    pb = ui.ui_factory.nested_progress_bar()
2840
2121
    tt = TreeTransform(working_tree, pb)
2841
2122
    try:
2842
2123
        pp = ProgressPhase("Revert phase", 3, pb)
2843
 
        conflicts, merge_modified = _prepare_revert_transform(
2844
 
            working_tree, target_tree, tt, filenames, backups, pp)
 
2124
        pp.next_phase()
 
2125
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2126
        try:
 
2127
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
2128
                                          child_pb, filenames, backups)
 
2129
        finally:
 
2130
            child_pb.finished()
 
2131
        pp.next_phase()
 
2132
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2133
        try:
 
2134
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
2135
                lambda t, c: conflict_pass(t, c, target_tree))
 
2136
        finally:
 
2137
            child_pb.finished()
 
2138
        conflicts = cook_conflicts(raw_conflicts, tt)
2845
2139
        if change_reporter:
2846
2140
            change_reporter = delta._ChangeReporter(
2847
2141
                unversioned_filter=working_tree.is_ignored)
2848
2142
            delta.report_changes(tt.iter_changes(), change_reporter)
2849
2143
        for conflict in conflicts:
2850
 
            trace.warning(unicode(conflict))
 
2144
            warning(conflict)
2851
2145
        pp.next_phase()
2852
2146
        tt.apply()
2853
2147
        working_tree.set_merge_modified(merge_modified)
2858
2152
    return conflicts
2859
2153
 
2860
2154
 
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
2155
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,
 
2156
                 backups):
 
2157
    merge_modified = working_tree.merge_modified()
 
2158
    change_list = target_tree.iter_changes(working_tree,
2892
2159
        specific_files=specific_files, pb=pb)
2893
 
    if target_tree.get_root_id() is None:
 
2160
    if target_tree.inventory.root is None:
2894
2161
        skip_root = True
2895
2162
    else:
2896
2163
        skip_root = False
 
2164
    basis_tree = None
2897
2165
    try:
2898
2166
        deferred_files = []
2899
2167
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2900
2168
                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:
 
2169
            if skip_root and file_id[0] is not None and parent[0] is None:
2908
2170
                continue
2909
2171
            trans_id = tt.trans_id_file_id(file_id)
2910
2172
            mode_id = None
2911
2173
            if changed_content:
2912
2174
                keep_content = False
2913
 
                if wt_kind == 'file' and (backups or target_kind is None):
 
2175
                if kind[0] == 'file' and (backups or kind[1] is None):
2914
2176
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2915
2177
                    if merge_modified.get(file_id) != wt_sha1:
2916
2178
                        # acquire the basis tree lazily to prevent the
2919
2181
                        if basis_tree is None:
2920
2182
                            basis_tree = working_tree.basis_tree()
2921
2183
                            basis_tree.lock_read()
2922
 
                        if basis_tree.has_id(file_id):
 
2184
                        if file_id in basis_tree:
2923
2185
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2924
2186
                                keep_content = True
2925
 
                        elif target_kind is None and not target_versioned:
 
2187
                        elif kind[1] is None and not versioned[1]:
2926
2188
                            keep_content = True
2927
 
                if wt_kind is not None:
 
2189
                if kind[0] is not None:
2928
2190
                    if not keep_content:
2929
2191
                        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)
 
2192
                    elif kind[1] is not None:
 
2193
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2194
                        by_parent = tt.by_parent()
 
2195
                        backup_name = _get_backup_name(name[0], by_parent,
 
2196
                                                       parent_trans_id, tt)
2934
2197
                        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:
 
2198
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2199
                        if versioned == (True, True):
2937
2200
                            tt.unversion_file(trans_id)
2938
2201
                            tt.version_file(file_id, new_trans_id)
2939
2202
                        # New contents should have the same unix perms as old
2940
2203
                        # contents
2941
2204
                        mode_id = trans_id
2942
2205
                        trans_id = new_trans_id
2943
 
                if target_kind in ('directory', 'tree-reference'):
 
2206
                if kind[1] == 'directory':
2944
2207
                    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':
 
2208
                elif kind[1] == 'symlink':
2950
2209
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2951
2210
                                      trans_id)
2952
 
                elif target_kind == 'file':
 
2211
                elif kind[1] == 'file':
2953
2212
                    deferred_files.append((file_id, (trans_id, mode_id)))
2954
2213
                    if basis_tree is None:
2955
2214
                        basis_tree = working_tree.basis_tree()
2956
2215
                        basis_tree.lock_read()
2957
2216
                    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)):
 
2217
                    if (file_id in basis_tree and new_sha1 ==
 
2218
                        basis_tree.get_file_sha1(file_id)):
2960
2219
                        if file_id in merge_modified:
2961
2220
                            del merge_modified[file_id]
2962
2221
                    else:
2963
2222
                        merge_modified[file_id] = new_sha1
2964
2223
 
2965
2224
                    # 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:
 
2225
                    if keep_content and executable[0] == executable[1]:
 
2226
                        tt.set_executability(executable[1], trans_id)
 
2227
                elif kind[1] is not None:
 
2228
                    raise AssertionError(kind[1])
 
2229
            if versioned == (False, True):
2971
2230
                tt.version_file(file_id, trans_id)
2972
 
            if wt_versioned and not target_versioned:
 
2231
            if versioned == (True, False):
2973
2232
                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()
 
2233
            if (name[1] is not None and 
 
2234
                (name[0] != name[1] or parent[0] != parent[1])):
 
2235
                tt.adjust_path(
 
2236
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
2237
            if executable[0] != executable[1] and kind[1] == "file":
 
2238
                tt.set_executability(executable[1], trans_id)
 
2239
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2240
            deferred_files):
 
2241
            tt.create_file(bytes, trans_id, mode_id)
3003
2242
    finally:
3004
2243
        if basis_tree is not None:
3005
2244
            basis_tree.unlock()
3006
2245
    return merge_modified
3007
2246
 
3008
2247
 
3009
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2248
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3010
2249
    """Make many conflict-resolution attempts, but die if they fail"""
3011
2250
    if pass_func is None:
3012
2251
        pass_func = conflict_pass
3013
2252
    new_conflicts = set()
3014
 
    pb = ui.ui_factory.nested_progress_bar()
3015
2253
    try:
3016
2254
        for n in range(10):
3017
 
            pb.update(gettext('Resolution pass'), n+1, 10)
 
2255
            pb.update('Resolution pass', n+1, 10)
3018
2256
            conflicts = tt.find_conflicts()
3019
2257
            if len(conflicts) == 0:
3020
2258
                return new_conflicts
3021
2259
            new_conflicts.update(pass_func(tt, conflicts))
3022
2260
        raise MalformedTransform(conflicts=conflicts)
3023
2261
    finally:
3024
 
        pb.finished()
 
2262
        pb.clear()
3025
2263
 
3026
2264
 
3027
2265
def conflict_pass(tt, conflicts, path_tree=None):
3044
2282
                existing_file, new_file = conflict[2], conflict[1]
3045
2283
            else:
3046
2284
                existing_file, new_file = conflict[1], conflict[2]
3047
 
            new_name = tt.final_name(existing_file) + '.moved'
 
2285
            new_name = tt.final_name(existing_file)+'.moved'
3048
2286
            tt.adjust_path(new_name, final_parent, existing_file)
3049
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2287
            new_conflicts.add((c_type, 'Moved existing file to', 
3050
2288
                               existing_file, new_file))
3051
2289
        elif c_type == 'parent loop':
3052
2290
            # break the loop by undoing one of the ops that caused the loop
3056
2294
            new_conflicts.add((c_type, 'Cancelled move', cur,
3057
2295
                               tt.final_parent(cur),))
3058
2296
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3059
 
 
 
2297
            
3060
2298
        elif c_type == 'missing parent':
3061
2299
            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:
 
2300
            try:
 
2301
                tt.cancel_deletion(trans_id)
 
2302
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2303
                                   trans_id))
 
2304
            except KeyError:
3086
2305
                create = True
3087
2306
                try:
3088
2307
                    tt.final_name(trans_id)
3091
2310
                        file_id = tt.final_file_id(trans_id)
3092
2311
                        if file_id is None:
3093
2312
                            file_id = tt.inactive_file_id(trans_id)
3094
 
                        _, entry = path_tree.iter_entries_by_dir(
3095
 
                            [file_id]).next()
 
2313
                        entry = path_tree.inventory[file_id]
3096
2314
                        # special-case the other tree root (move its
3097
2315
                        # children to current root)
3098
2316
                        if entry.parent_id is None:
3099
 
                            create = False
 
2317
                            create=False
3100
2318
                            moved = _reparent_transform_children(
3101
2319
                                tt, trans_id, tt.root)
3102
2320
                            for child in moved:
3113
2331
        elif c_type == 'unversioned parent':
3114
2332
            file_id = tt.inactive_file_id(conflict[1])
3115
2333
            # 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
 
2334
            if path_tree and file_id in path_tree:
 
2335
                if path_tree.inventory[file_id].parent_id is None:
3119
2336
                    continue
3120
2337
            tt.version_file(file_id, conflict[1])
3121
2338
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3130
2347
            if parent_file_id is not None:
3131
2348
                tt.unversion_file(parent_id)
3132
2349
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
3133
 
        elif c_type == 'versioning no contents':
3134
 
            tt.cancel_versioning(conflict[1])
3135
2350
    return new_conflicts
3136
2351
 
3137
2352
 
3138
2353
def cook_conflicts(raw_conflicts, tt):
3139
2354
    """Generate a list of cooked conflicts, sorted by file path"""
 
2355
    from bzrlib.conflicts import Conflict
3140
2356
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3141
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
2357
    return sorted(conflict_iter, key=Conflict.sort_key)
3142
2358
 
3143
2359
 
3144
2360
def iter_cook_conflicts(raw_conflicts, tt):
 
2361
    from bzrlib.conflicts import Conflict
3145
2362
    fp = FinalPaths(tt)
3146
2363
    for conflict in raw_conflicts:
3147
2364
        c_type = conflict[0]
3149
2366
        modified_path = fp.get_path(conflict[2])
3150
2367
        modified_id = tt.final_file_id(conflict[2])
3151
2368
        if len(conflict) == 3:
3152
 
            yield conflicts.Conflict.factory(
3153
 
                c_type, action=action, path=modified_path, file_id=modified_id)
3154
 
 
 
2369
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2370
                                     file_id=modified_id)
 
2371
             
3155
2372
        else:
3156
2373
            conflicting_path = fp.get_path(conflict[3])
3157
2374
            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)
 
2375
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2376
                                   file_id=modified_id, 
 
2377
                                   conflict_path=conflicting_path,
 
2378
                                   conflict_file_id=conflicting_id)
3163
2379
 
3164
2380
 
3165
2381
class _FileMover(object):
3170
2386
        self.pending_deletions = []
3171
2387
 
3172
2388
    def rename(self, from_, to):
3173
 
        """Rename a file from one path to another."""
 
2389
        """Rename a file from one path to another.  Functions like os.rename"""
3174
2390
        try:
3175
2391
            os.rename(from_, to)
3176
2392
        except OSError, e:
3177
2393
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3178
2394
                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)
 
2395
            raise
3182
2396
        self.past_renames.append((from_, to))
3183
2397
 
3184
2398
    def pre_delete(self, from_, to):
3194
2408
    def rollback(self):
3195
2409
        """Reverse all renames that have been performed"""
3196
2410
        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)
 
2411
            os.rename(to, from_)
3201
2412
        # after rollback, don't reuse _FileMover
3202
2413
        past_renames = None
3203
2414
        pending_deletions = None