~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Alexander Belchenko
  • Date: 2008-02-07 07:53:19 UTC
  • mto: This revision was merged to the branch mainline in revision 3231.
  • Revision ID: bialix@ukr.net-20080207075319-d9jj7as8i5ztiff7
some cleanup in package_mf.py; mention about load_from_zip() deprecation in NEWS.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
from __future__ import absolute_import
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
17
import os
20
18
import errno
21
 
from stat import S_ISREG, S_IEXEC
22
 
import time
 
19
from stat import S_ISREG
 
20
import tempfile
23
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
24
24
from bzrlib import (
25
 
    config as _mod_config,
 
25
    bzrdir,
 
26
    delta,
26
27
    errors,
27
 
    lazy_import,
28
 
    registry,
29
 
    trace,
30
 
    tree,
31
 
    )
32
 
lazy_import.lazy_import(globals(), """
33
 
from bzrlib import (
34
 
    annotate,
35
 
    bencode,
36
 
    controldir,
37
 
    commit,
38
 
    conflicts,
39
 
    delta,
40
 
    inventory,
41
 
    multiparent,
42
 
    osutils,
43
 
    revision as _mod_revision,
44
 
    ui,
45
 
    urlutils,
46
 
    )
47
 
from bzrlib.i18n import gettext
 
28
    inventory
 
29
    )
48
30
""")
49
 
from bzrlib.errors import (DuplicateKey, MalformedTransform,
50
 
                           ReusingTransform, CantMoveRoot,
51
 
                           ImmortalLimbo, NoFinalPath,
 
31
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
 
32
                           ReusingTransform, NotVersionedError, CantMoveRoot,
 
33
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
52
34
                           UnableCreateSymlink)
53
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
54
 
from bzrlib.mutabletree import MutableTree
55
 
from bzrlib.osutils import (
56
 
    delete_any,
57
 
    file_kind,
58
 
    has_symlinks,
59
 
    pathjoin,
60
 
    sha_file,
61
 
    splitpath,
62
 
    )
63
 
from bzrlib.progress import ProgressPhase
 
35
from bzrlib.inventory import InventoryEntry
 
36
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
 
37
                            delete_any, has_symlinks)
 
38
from bzrlib.progress import DummyProgress, ProgressPhase
64
39
from bzrlib.symbol_versioning import (
65
 
    deprecated_function,
66
 
    deprecated_in,
67
 
    deprecated_method,
68
 
    )
 
40
        deprecated_function,
 
41
        zero_fifteen,
 
42
        zero_ninety,
 
43
        )
 
44
from bzrlib.trace import mutter, warning
 
45
from bzrlib import tree
 
46
import bzrlib.ui
 
47
import bzrlib.urlutils as urlutils
69
48
 
70
49
 
71
50
ROOT_PARENT = "root-parent"
72
51
 
 
52
 
73
53
def unique_add(map, key, value):
74
54
    if key in map:
75
55
        raise DuplicateKey(key=key)
76
56
    map[key] = value
77
57
 
78
58
 
79
 
 
80
59
class _TransformResults(object):
81
60
    def __init__(self, modified_paths, rename_count):
82
61
        object.__init__(self)
85
64
 
86
65
 
87
66
class TreeTransformBase(object):
88
 
    """The base class for TreeTransform and its kin."""
 
67
    """The base class for TreeTransform and TreeTransformBase"""
89
68
 
90
 
    def __init__(self, tree, pb=None,
 
69
    def __init__(self, tree, limbodir, pb=DummyProgress(),
91
70
                 case_sensitive=True):
92
71
        """Constructor.
93
72
 
94
73
        :param tree: The tree that will be transformed, but not necessarily
95
74
            the output tree.
96
 
        :param pb: ignored
 
75
        :param limbodir: A directory where new files can be stored until
 
76
            they are installed in their proper places
 
77
        :param pb: A ProgressBar indicating how much progress is being made
97
78
        :param case_sensitive: If True, the target of the transform is
98
79
            case sensitive, not just case preserving.
99
80
        """
100
81
        object.__init__(self)
101
82
        self._tree = tree
 
83
        self._limbodir = limbodir
 
84
        self._deletiondir = None
102
85
        self._id_number = 0
103
86
        # mapping of trans_id -> new basename
104
87
        self._new_name = {}
106
89
        self._new_parent = {}
107
90
        # mapping of trans_id with new contents -> new file_kind
108
91
        self._new_contents = {}
109
 
        # mapping of trans_id => (sha1 of content, stat_value)
110
 
        self._observed_sha1s = {}
 
92
        # A mapping of transform ids to their limbo filename
 
93
        self._limbo_files = {}
 
94
        # A mapping of transform ids to a set of the transform ids of children
 
95
        # that their limbo directory has
 
96
        self._limbo_children = {}
 
97
        # Map transform ids to maps of child filename to child transform id
 
98
        self._limbo_children_names = {}
 
99
        # List of transform ids that need to be renamed from limbo into place
 
100
        self._needs_rename = set()
111
101
        # Set of trans_ids whose contents will be removed
112
102
        self._removed_contents = set()
113
103
        # Mapping of trans_id -> new execute-bit value
120
110
        self._non_present_ids = {}
121
111
        # Mapping of new file_id -> trans_id
122
112
        self._r_new_id = {}
123
 
        # Set of trans_ids that will be removed
 
113
        # Set of file_ids that will be removed
124
114
        self._removed_id = set()
125
115
        # Mapping of path in old tree -> trans_id
126
116
        self._tree_path_ids = {}
127
117
        # Mapping trans_id -> path in old tree
128
118
        self._tree_id_paths = {}
 
119
        # Cache of realpath results, to speed up canonical_path
 
120
        self._realpaths = {}
 
121
        # Cache of relpath results, to speed up canonical_path
 
122
        self._relpaths = {}
129
123
        # 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
 
124
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
125
        # Indictor of whether the transform has been applied
136
126
        self._done = False
137
127
        # A progress bar
138
128
        self._pb = pb
141
131
        # A counter of how many files have been renamed
142
132
        self.rename_count = 0
143
133
 
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
134
    def __get_root(self):
166
135
        return self._new_root
167
136
 
168
137
    root = property(__get_root)
169
138
 
 
139
    def finalize(self):
 
140
        """Release the working tree lock, if held, clean up limbo dir.
 
141
 
 
142
        This is required if apply has not been invoked, but can be invoked
 
143
        even after apply.
 
144
        """
 
145
        if self._tree is None:
 
146
            return
 
147
        try:
 
148
            entries = [(self._limbo_name(t), t, k) for t, k in
 
149
                       self._new_contents.iteritems()]
 
150
            entries.sort(reverse=True)
 
151
            for path, trans_id, kind in entries:
 
152
                if kind == "directory":
 
153
                    os.rmdir(path)
 
154
                else:
 
155
                    os.unlink(path)
 
156
            try:
 
157
                os.rmdir(self._limbodir)
 
158
            except OSError:
 
159
                # We don't especially care *why* the dir is immortal.
 
160
                raise ImmortalLimbo(self._limbodir)
 
161
            try:
 
162
                if self._deletiondir is not None:
 
163
                    os.rmdir(self._deletiondir)
 
164
            except OSError:
 
165
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
166
        finally:
 
167
            self._tree.unlock()
 
168
            self._tree = None
 
169
 
170
170
    def _assign_id(self):
171
171
        """Produce a new tranform id"""
172
172
        new_id = "new-%s" % self._id_number
182
182
 
183
183
    def adjust_path(self, name, parent, trans_id):
184
184
        """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
185
        if trans_id == self._new_root:
188
186
            raise CantMoveRoot
 
187
        previous_parent = self._new_parent.get(trans_id)
 
188
        previous_name = self._new_name.get(trans_id)
189
189
        self._new_name[trans_id] = name
190
190
        self._new_parent[trans_id] = parent
 
191
        if (trans_id in self._limbo_files and
 
192
            trans_id not in self._needs_rename):
 
193
            self._rename_in_limbo([trans_id])
 
194
            self._limbo_children[previous_parent].remove(trans_id)
 
195
            del self._limbo_children_names[previous_parent][previous_name]
 
196
 
 
197
    def _rename_in_limbo(self, trans_ids):
 
198
        """Fix limbo names so that the right final path is produced.
 
199
 
 
200
        This means we outsmarted ourselves-- we tried to avoid renaming
 
201
        these files later by creating them with their final names in their
 
202
        final parents.  But now the previous name or parent is no longer
 
203
        suitable, so we have to rename them.
 
204
 
 
205
        Even for trans_ids that have no new contents, we must remove their
 
206
        entries from _limbo_files, because they are now stale.
 
207
        """
 
208
        for trans_id in trans_ids:
 
209
            old_path = self._limbo_files.pop(trans_id)
 
210
            if trans_id not in self._new_contents:
 
211
                continue
 
212
            new_path = self._limbo_name(trans_id)
 
213
            os.rename(old_path, new_path)
191
214
 
192
215
    def adjust_root_path(self, name, parent):
193
216
        """Emulate moving the root by moving all children, instead.
194
 
 
 
217
        
195
218
        We do this by undoing the association of root's transaction id with the
196
219
        current tree.  This allows us to create a new directory with that
197
 
        transaction id.  We unversion the root directory and version the
 
220
        transaction id.  We unversion the root directory and version the 
198
221
        physically new directory, and hope someone versions the tree root
199
222
        later.
200
223
        """
203
226
        # force moving all children of root
204
227
        for child_id in self.iter_tree_children(old_root):
205
228
            if child_id != parent:
206
 
                self.adjust_path(self.final_name(child_id),
 
229
                self.adjust_path(self.final_name(child_id), 
207
230
                                 self.final_parent(child_id), child_id)
208
231
            file_id = self.final_file_id(child_id)
209
232
            if file_id is not None:
210
233
                self.unversion_file(child_id)
211
234
            self.version_file(file_id, child_id)
212
 
 
 
235
        
213
236
        # the physical root needs a new transaction id
214
237
        self._tree_path_ids.pop("")
215
238
        self._tree_id_paths.pop(old_root)
221
244
        self.version_file(old_root_file_id, old_root)
222
245
        self.unversion_file(self._new_root)
223
246
 
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
247
    def trans_id_tree_file_id(self, inventory_id):
286
248
        """Determine the transaction id of a working tree file.
287
 
 
 
249
        
288
250
        This reflects only files that already exist, not ones that will be
289
251
        added by transactions.
290
252
        """
291
 
        if inventory_id is None:
292
 
            raise ValueError('None is not a valid file id')
293
 
        path = self._tree.id2path(inventory_id)
 
253
        path = self._tree.inventory.id2path(inventory_id)
294
254
        return self.trans_id_tree_path(path)
295
255
 
296
256
    def trans_id_file_id(self, file_id):
299
259
        a transaction has been unversioned, it is deliberately still returned.
300
260
        (this will likely lead to an unversioned parent conflict.)
301
261
        """
302
 
        if file_id is None:
303
 
            raise ValueError('None is not a valid file id')
304
262
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
305
263
            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)
 
264
        elif file_id in self._tree.inventory:
 
265
            return self.trans_id_tree_file_id(file_id)
 
266
        elif file_id in self._non_present_ids:
 
267
            return self._non_present_ids[file_id]
 
268
        else:
 
269
            trans_id = self._assign_id()
 
270
            self._non_present_ids[file_id] = trans_id
 
271
            return trans_id
 
272
 
 
273
    def canonical_path(self, path):
 
274
        """Get the canonical tree-relative path"""
 
275
        # don't follow final symlinks
 
276
        abs = self._tree.abspath(path)
 
277
        if abs in self._relpaths:
 
278
            return self._relpaths[abs]
 
279
        dirname, basename = os.path.split(abs)
 
280
        if dirname not in self._realpaths:
 
281
            self._realpaths[dirname] = os.path.realpath(dirname)
 
282
        dirname = self._realpaths[dirname]
 
283
        abs = pathjoin(dirname, basename)
 
284
        if dirname in self._relpaths:
 
285
            relpath = pathjoin(self._relpaths[dirname], basename)
 
286
            relpath = relpath.rstrip('/\\')
 
287
        else:
 
288
            relpath = self._tree.relpath(abs)
 
289
        self._relpaths[abs] = relpath
 
290
        return relpath
318
291
 
319
292
    def trans_id_tree_path(self, path):
320
293
        """Determine (and maybe set) the transaction ID for a tree path."""
331
304
            return ROOT_PARENT
332
305
        return self.trans_id_tree_path(os.path.dirname(path))
333
306
 
 
307
    def create_file(self, contents, trans_id, mode_id=None):
 
308
        """Schedule creation of a new file.
 
309
 
 
310
        See also new_file.
 
311
        
 
312
        Contents is an iterator of strings, all of which will be written
 
313
        to the target destination.
 
314
 
 
315
        New file takes the permissions of any existing file with that id,
 
316
        unless mode_id is specified.
 
317
        """
 
318
        name = self._limbo_name(trans_id)
 
319
        f = open(name, 'wb')
 
320
        try:
 
321
            try:
 
322
                unique_add(self._new_contents, trans_id, 'file')
 
323
            except:
 
324
                # Clean up the file, it never got registered so
 
325
                # TreeTransform.finalize() won't clean it up.
 
326
                f.close()
 
327
                os.unlink(name)
 
328
                raise
 
329
 
 
330
            f.writelines(contents)
 
331
        finally:
 
332
            f.close()
 
333
        self._set_mode(trans_id, mode_id, S_ISREG)
 
334
 
 
335
    def _set_mode(self, trans_id, mode_id, typefunc):
 
336
        """Set the mode of new file contents.
 
337
        The mode_id is the existing file to get the mode from (often the same
 
338
        as trans_id).  The operation is only performed if there's a mode match
 
339
        according to typefunc.
 
340
        """
 
341
        if mode_id is None:
 
342
            mode_id = trans_id
 
343
        try:
 
344
            old_path = self._tree_id_paths[mode_id]
 
345
        except KeyError:
 
346
            return
 
347
        try:
 
348
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
349
        except OSError, e:
 
350
            if e.errno == errno.ENOENT:
 
351
                return
 
352
            else:
 
353
                raise
 
354
        if typefunc(mode):
 
355
            os.chmod(self._limbo_name(trans_id), mode)
 
356
 
 
357
    def create_directory(self, trans_id):
 
358
        """Schedule creation of a new directory.
 
359
        
 
360
        See also new_directory.
 
361
        """
 
362
        os.mkdir(self._limbo_name(trans_id))
 
363
        unique_add(self._new_contents, trans_id, 'directory')
 
364
 
 
365
    def create_symlink(self, target, trans_id):
 
366
        """Schedule creation of a new symbolic link.
 
367
 
 
368
        target is a bytestring.
 
369
        See also new_symlink.
 
370
        """
 
371
        if has_symlinks():
 
372
            os.symlink(target, self._limbo_name(trans_id))
 
373
            unique_add(self._new_contents, trans_id, 'symlink')
 
374
        else:
 
375
            try:
 
376
                path = FinalPaths(self).get_path(trans_id)
 
377
            except KeyError:
 
378
                path = None
 
379
            raise UnableCreateSymlink(path=path)
 
380
 
 
381
    def cancel_creation(self, trans_id):
 
382
        """Cancel the creation of new file contents."""
 
383
        del self._new_contents[trans_id]
 
384
        children = self._limbo_children.get(trans_id)
 
385
        # if this is a limbo directory with children, move them before removing
 
386
        # the directory
 
387
        if children is not None:
 
388
            self._rename_in_limbo(children)
 
389
            del self._limbo_children[trans_id]
 
390
            del self._limbo_children_names[trans_id]
 
391
        delete_any(self._limbo_name(trans_id))
 
392
 
334
393
    def delete_contents(self, trans_id):
335
394
        """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)
 
395
        self.tree_kind(trans_id)
 
396
        self._removed_contents.add(trans_id)
339
397
 
340
398
    def cancel_deletion(self, trans_id):
341
399
        """Cancel a scheduled deletion"""
365
423
 
366
424
    def version_file(self, file_id, trans_id):
367
425
        """Schedule a file to become versioned."""
368
 
        if file_id is None:
369
 
            raise ValueError()
 
426
        assert file_id is not None
370
427
        unique_add(self._new_id, trans_id, file_id)
371
428
        unique_add(self._r_new_id, file_id, trans_id)
372
429
 
376
433
        del self._new_id[trans_id]
377
434
        del self._r_new_id[file_id]
378
435
 
379
 
    def new_paths(self, filesystem_only=False):
380
 
        """Determine the paths of all new and changed files.
381
 
 
382
 
        :param filesystem_only: if True, only calculate values for files
383
 
            that require renames or execute bit changes.
384
 
        """
 
436
    def new_paths(self):
 
437
        """Determine the paths of all new and changed files"""
385
438
        new_ids = set()
386
 
        if filesystem_only:
387
 
            stale_ids = self._needs_rename.difference(self._new_name)
388
 
            stale_ids.difference_update(self._new_parent)
389
 
            stale_ids.difference_update(self._new_contents)
390
 
            stale_ids.difference_update(self._new_id)
391
 
            needs_rename = self._needs_rename.difference(stale_ids)
392
 
            id_sets = (needs_rename, self._new_executability)
393
 
        else:
394
 
            id_sets = (self._new_name, self._new_parent, self._new_contents,
395
 
                       self._new_id, self._new_executability)
396
 
        for id_set in id_sets:
 
439
        fp = FinalPaths(self)
 
440
        for id_set in (self._new_name, self._new_parent, self._new_contents,
 
441
                       self._new_id, self._new_executability):
397
442
            new_ids.update(id_set)
398
 
        return sorted(FinalPaths(self).get_paths(new_ids))
399
 
 
400
 
    def _inventory_altered(self):
401
 
        """Determine which trans_ids need new Inventory entries.
402
 
 
403
 
        An new entry is needed when anything that would be reflected by an
404
 
        inventory entry changes, including file name, file_id, parent file_id,
405
 
        file kind, and the execute bit.
406
 
 
407
 
        Some care is taken to return entries with real changes, not cases
408
 
        where the value is deleted and then restored to its original value,
409
 
        but some actually unchanged values may be returned.
410
 
 
411
 
        :returns: A list of (path, trans_id) for all items requiring an
412
 
            inventory change. Ordered by path.
 
443
        new_paths = [(fp.get_path(t), t) for t in new_ids]
 
444
        new_paths.sort()
 
445
        return new_paths
 
446
 
 
447
    def tree_kind(self, trans_id):
 
448
        """Determine the file kind in the working tree.
 
449
 
 
450
        Raises NoSuchFile if the file does not exist
413
451
        """
414
 
        changed_ids = set()
415
 
        # Find entries whose file_ids are new (or changed).
416
 
        new_file_id = set(t for t in self._new_id
417
 
                          if self._new_id[t] != self.tree_file_id(t))
418
 
        for id_set in [self._new_name, self._new_parent, new_file_id,
419
 
                       self._new_executability]:
420
 
            changed_ids.update(id_set)
421
 
        # removing implies a kind change
422
 
        changed_kind = set(self._removed_contents)
423
 
        # so does adding
424
 
        changed_kind.intersection_update(self._new_contents)
425
 
        # Ignore entries that are already known to have changed.
426
 
        changed_kind.difference_update(changed_ids)
427
 
        #  to keep only the truly changed ones
428
 
        changed_kind = (t for t in changed_kind
429
 
                        if self.tree_kind(t) != self.final_kind(t))
430
 
        # all kind changes will alter the inventory
431
 
        changed_ids.update(changed_kind)
432
 
        # To find entries with changed parent_ids, find parents which existed,
433
 
        # but changed file_id.
434
 
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
435
 
        # Now add all their children to the set.
436
 
        for parent_trans_id in new_file_id:
437
 
            changed_ids.update(self.iter_tree_children(parent_trans_id))
438
 
        return sorted(FinalPaths(self).get_paths(changed_ids))
 
452
        path = self._tree_id_paths.get(trans_id)
 
453
        if path is None:
 
454
            raise NoSuchFile(None)
 
455
        try:
 
456
            return file_kind(self._tree.abspath(path))
 
457
        except OSError, e:
 
458
            if e.errno != errno.ENOENT:
 
459
                raise
 
460
            else:
 
461
                raise NoSuchFile(path)
439
462
 
440
463
    def final_kind(self, trans_id):
441
464
        """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)
 
465
        
 
466
        Raises NoSuchFile if the file does not exist/has no contents.
 
467
        (It is conceivable that a path would be created without the
 
468
        corresponding contents insertion command)
446
469
        """
447
470
        if trans_id in self._new_contents:
448
471
            return self._new_contents[trans_id]
449
472
        elif trans_id in self._removed_contents:
450
 
            return None
 
473
            raise NoSuchFile(None)
451
474
        else:
452
475
            return self.tree_kind(trans_id)
453
476
 
461
484
        # the file is old; the old id is still valid
462
485
        if self._new_root == trans_id:
463
486
            return self._tree.get_root_id()
464
 
        return self._tree.path2id(path)
 
487
        return self._tree.inventory.path2id(path)
465
488
 
466
489
    def final_file_id(self, trans_id):
467
490
        """Determine the file id after any changes are applied, or None.
468
 
 
 
491
        
469
492
        None indicates that the file will not be versioned after changes are
470
493
        applied.
471
494
        """
472
495
        try:
 
496
            # there is a new id for this file
 
497
            assert self._new_id[trans_id] is not None
473
498
            return self._new_id[trans_id]
474
499
        except KeyError:
475
500
            if trans_id in self._removed_id:
510
535
 
511
536
    def by_parent(self):
512
537
        """Return a map of parent: children for known parents.
513
 
 
 
538
        
514
539
        Only new paths and parents of tree files with assigned ids are used.
515
540
        """
516
541
        by_parent = {}
517
542
        items = list(self._new_parent.iteritems())
518
 
        items.extend((t, self.final_parent(t)) for t in
 
543
        items.extend((t, self.final_parent(t)) for t in 
519
544
                      self._tree_id_paths.keys())
520
545
        for trans_id, parent_id in items:
521
546
            if parent_id not in by_parent:
549
574
        conflicts.extend(self._overwrite_conflicts())
550
575
        return conflicts
551
576
 
552
 
    def _check_malformed(self):
553
 
        conflicts = self.find_conflicts()
554
 
        if len(conflicts) != 0:
555
 
            raise MalformedTransform(conflicts=conflicts)
556
 
 
557
577
    def _add_tree_children(self):
558
578
        """Add all the children of all active parents to the known paths.
559
579
 
561
581
        removed.  This is a necessary first step in detecting conflicts.
562
582
        """
563
583
        parents = self.by_parent().keys()
564
 
        parents.extend([t for t in self._removed_contents if
 
584
        parents.extend([t for t in self._removed_contents if 
565
585
                        self.tree_kind(t) == 'directory'])
566
586
        for trans_id in self._removed_id:
567
587
            file_id = self.tree_file_id(trans_id)
568
588
            if file_id is not None:
569
 
                if self._tree.stored_kind(file_id) == 'directory':
 
589
                if self._tree.inventory[file_id].kind == 'directory':
570
590
                    parents.append(trans_id)
571
591
            elif self.tree_kind(trans_id) == 'directory':
572
592
                parents.append(trans_id)
575
595
            # ensure that all children are registered with the transaction
576
596
            list(self.iter_tree_children(parent_id))
577
597
 
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:
 
598
    def iter_tree_children(self, parent_id):
 
599
        """Iterate through the entry's tree children, if any"""
 
600
        try:
 
601
            path = self._tree_id_paths[parent_id]
 
602
        except KeyError:
 
603
            return
 
604
        try:
 
605
            children = os.listdir(self._tree.abspath(path))
 
606
        except OSError, e:
 
607
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
 
608
                raise
 
609
            return
 
610
            
 
611
        for child in children:
 
612
            childpath = joinpath(path, child)
 
613
            if self._tree.is_control_filename(childpath):
 
614
                continue
 
615
            yield self.trans_id_tree_path(childpath)
 
616
 
 
617
    def has_named_child(self, by_parent, parent_id, name):
 
618
        try:
 
619
            children = by_parent[parent_id]
 
620
        except KeyError:
 
621
            children = []
 
622
        for child in children:
592
623
            if self.final_name(child) == name:
593
624
                return True
594
 
        parent_path = self._tree_id_paths.get(parent_id, None)
595
 
        if parent_path is None:
596
 
            # No parent... no children
 
625
        try:
 
626
            path = self._tree_id_paths[parent_id]
 
627
        except KeyError:
597
628
            return False
598
 
        child_path = joinpath(parent_path, name)
599
 
        child_id = self._tree_path_ids.get(child_path, None)
 
629
        childpath = joinpath(path, name)
 
630
        child_id = self._tree_path_ids.get(childpath)
600
631
        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))
 
632
            return lexists(self._tree.abspath(childpath))
603
633
        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))
 
634
            if self.final_parent(child_id) != parent_id:
 
635
                return False
 
636
            if child_id in self._removed_contents:
 
637
                # XXX What about dangling file-ids?
 
638
                return False
 
639
            else:
 
640
                return True
620
641
 
621
642
    def _parent_loops(self):
622
643
        """No entry should be its own ancestor"""
624
645
        for trans_id in self._new_parent:
625
646
            seen = set()
626
647
            parent_id = trans_id
627
 
            while parent_id != ROOT_PARENT:
 
648
            while parent_id is not ROOT_PARENT:
628
649
                seen.add(parent_id)
629
650
                try:
630
651
                    parent_id = self.final_parent(parent_id)
640
661
        """If parent directories are versioned, children must be versioned."""
641
662
        conflicts = []
642
663
        for parent_id, children in by_parent.iteritems():
643
 
            if parent_id == ROOT_PARENT:
 
664
            if parent_id is ROOT_PARENT:
644
665
                continue
645
666
            if self.final_file_id(parent_id) is not None:
646
667
                continue
652
673
 
653
674
    def _improper_versioning(self):
654
675
        """Cannot version a file with no contents, or a bad type.
655
 
 
 
676
        
656
677
        However, existing entries with no contents are okay.
657
678
        """
658
679
        conflicts = []
659
680
        for trans_id in self._new_id.iterkeys():
660
 
            kind = self.final_kind(trans_id)
661
 
            if kind is None:
 
681
            try:
 
682
                kind = self.final_kind(trans_id)
 
683
            except NoSuchFile:
662
684
                conflicts.append(('versioning no contents', trans_id))
663
685
                continue
664
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
686
            if not InventoryEntry.versionable_kind(kind):
665
687
                conflicts.append(('versioning bad kind', trans_id, kind))
666
688
        return conflicts
667
689
 
668
690
    def _executability_conflicts(self):
669
691
        """Check for bad executability changes.
670
 
 
 
692
        
671
693
        Only versioned files may have their executability set, because
672
694
        1. only versioned entries can have executability under windows
673
695
        2. only files can be executable.  (The execute bit on a directory
678
700
            if self.final_file_id(trans_id) is None:
679
701
                conflicts.append(('unversioned executability', trans_id))
680
702
            else:
681
 
                if self.final_kind(trans_id) != "file":
 
703
                try:
 
704
                    non_file = self.final_kind(trans_id) != "file"
 
705
                except NoSuchFile:
 
706
                    non_file = True
 
707
                if non_file is True:
682
708
                    conflicts.append(('non-file executability', trans_id))
683
709
        return conflicts
684
710
 
686
712
        """Check for overwrites (not permitted on Win32)"""
687
713
        conflicts = []
688
714
        for trans_id in self._new_contents:
689
 
            if self.tree_kind(trans_id) is None:
 
715
            try:
 
716
                self.tree_kind(trans_id)
 
717
            except NoSuchFile:
690
718
                continue
691
719
            if trans_id not in self._removed_contents:
692
720
                conflicts.append(('overwrite', trans_id,
699
727
        if (self._new_name, self._new_parent) == ({}, {}):
700
728
            return conflicts
701
729
        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))
 
730
            name_ids = [(self.final_name(t), t) for t in children]
 
731
            if not self._case_sensitive_target:
 
732
                name_ids = [(n.lower(), t) for n, t in name_ids]
710
733
            name_ids.sort()
711
734
            last_name = None
712
735
            last_trans_id = None
713
736
            for name, trans_id in name_ids:
714
 
                kind = self.final_kind(trans_id)
 
737
                try:
 
738
                    kind = self.final_kind(trans_id)
 
739
                except NoSuchFile:
 
740
                    kind = None
715
741
                file_id = self.final_file_id(trans_id)
716
742
                if kind is None and file_id is None:
717
743
                    continue
727
753
        conflicts = []
728
754
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
729
755
                                self._removed_id))
730
 
        all_ids = self._tree.all_file_ids()
731
 
        active_tree_ids = all_ids.difference(removed_tree_ids)
 
756
        active_tree_ids = set((f for f in self._tree.inventory if
 
757
                               f not in removed_tree_ids))
732
758
        for trans_id, file_id in self._new_id.iteritems():
733
759
            if file_id in active_tree_ids:
734
760
                old_trans_id = self.trans_id_tree_file_id(file_id)
736
762
        return conflicts
737
763
 
738
764
    def _parent_type_conflicts(self, by_parent):
739
 
        """Children must have a directory parent"""
 
765
        """parents must have directory 'contents'."""
740
766
        conflicts = []
741
767
        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)
 
768
            if parent_id is ROOT_PARENT:
 
769
                continue
 
770
            if not self._any_contents(children):
 
771
                continue
 
772
            for child in children:
 
773
                try:
 
774
                    self.final_kind(child)
 
775
                except NoSuchFile:
 
776
                    continue
 
777
            try:
 
778
                kind = self.final_kind(parent_id)
 
779
            except NoSuchFile:
 
780
                kind = None
754
781
            if kind is None:
755
 
                # The directory will be deleted
756
782
                conflicts.append(('missing parent', parent_id))
757
783
            elif kind != "directory":
758
 
                # Meh, we need a *directory* to put something in it
759
784
                conflicts.append(('non-directory parent', parent_id))
760
785
        return conflicts
761
786
 
762
 
    def _set_executability(self, path, trans_id):
 
787
    def _any_contents(self, trans_ids):
 
788
        """Return true if any of the trans_ids, will have contents."""
 
789
        for trans_id in trans_ids:
 
790
            try:
 
791
                kind = self.final_kind(trans_id)
 
792
            except NoSuchFile:
 
793
                continue
 
794
            return True
 
795
        return False
 
796
 
 
797
    def _limbo_name(self, trans_id):
 
798
        """Generate the limbo name of a file"""
 
799
        limbo_name = self._limbo_files.get(trans_id)
 
800
        if limbo_name is not None:
 
801
            return limbo_name
 
802
        parent = self._new_parent.get(trans_id)
 
803
        # if the parent directory is already in limbo (e.g. when building a
 
804
        # tree), choose a limbo name inside the parent, to reduce further
 
805
        # renames.
 
806
        use_direct_path = False
 
807
        if self._new_contents.get(parent) == 'directory':
 
808
            filename = self._new_name.get(trans_id)
 
809
            if filename is not None:
 
810
                if parent not in self._limbo_children:
 
811
                    self._limbo_children[parent] = set()
 
812
                    self._limbo_children_names[parent] = {}
 
813
                    use_direct_path = True
 
814
                # the direct path can only be used if no other file has
 
815
                # already taken this pathname, i.e. if the name is unused, or
 
816
                # if it is already associated with this trans_id.
 
817
                elif self._case_sensitive_target:
 
818
                    if (self._limbo_children_names[parent].get(filename)
 
819
                        in (trans_id, None)):
 
820
                        use_direct_path = True
 
821
                else:
 
822
                    for l_filename, l_trans_id in\
 
823
                        self._limbo_children_names[parent].iteritems():
 
824
                        if l_trans_id == trans_id:
 
825
                            continue
 
826
                        if l_filename.lower() == filename.lower():
 
827
                            break
 
828
                    else:
 
829
                        use_direct_path = True
 
830
 
 
831
        if use_direct_path:
 
832
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
833
            self._limbo_children[parent].add(trans_id)
 
834
            self._limbo_children_names[parent][filename] = trans_id
 
835
        else:
 
836
            limbo_name = pathjoin(self._limbodir, trans_id)
 
837
            self._needs_rename.add(trans_id)
 
838
        self._limbo_files[trans_id] = limbo_name
 
839
        return limbo_name
 
840
 
 
841
    def _set_executability(self, path, entry, trans_id):
763
842
        """Set the executability of versioned files """
764
 
        if self._tree._supports_executable():
765
 
            new_executability = self._new_executability[trans_id]
 
843
        new_executability = self._new_executability[trans_id]
 
844
        entry.executable = new_executability
 
845
        if supports_executable():
766
846
            abspath = self._tree.abspath(path)
767
847
            current_mode = os.stat(abspath).st_mode
768
848
            if new_executability:
776
856
                    to_mode |= 0010 & ~umask
777
857
            else:
778
858
                to_mode = current_mode & ~0111
779
 
            osutils.chmod_if_possible(abspath, to_mode)
 
859
            os.chmod(abspath, to_mode)
780
860
 
781
861
    def _new_entry(self, name, parent_id, file_id):
782
862
        """Helper function to create a new filesystem entry."""
785
865
            self.version_file(file_id, trans_id)
786
866
        return trans_id
787
867
 
788
 
    def new_file(self, name, parent_id, contents, file_id=None,
789
 
                 executable=None, sha1=None):
 
868
    def new_file(self, name, parent_id, contents, file_id=None, 
 
869
                 executable=None):
790
870
        """Convenience method to create files.
791
 
 
 
871
        
792
872
        name is the name of the file to create.
793
873
        parent_id is the transaction id of the parent directory of the file.
794
874
        contents is an iterator of bytestrings, which will be used to produce
799
879
        trans_id = self._new_entry(name, parent_id, file_id)
800
880
        # TODO: rather than scheduling a set_executable call,
801
881
        # have create_file create the file with the right mode.
802
 
        self.create_file(contents, trans_id, sha1=sha1)
 
882
        self.create_file(contents, trans_id)
803
883
        if executable is not None:
804
884
            self.set_executability(executable, trans_id)
805
885
        return trans_id
814
894
        """
815
895
        trans_id = self._new_entry(name, parent_id, file_id)
816
896
        self.create_directory(trans_id)
817
 
        return trans_id
 
897
        return trans_id 
818
898
 
819
899
    def new_symlink(self, name, parent_id, target, file_id=None):
820
900
        """Convenience method to create symbolic link.
821
 
 
 
901
        
822
902
        name is the name of the symlink to create.
823
903
        parent_id is the transaction id of the parent directory of the symlink.
824
904
        target is a bytestring of the target of the symlink.
828
908
        self.create_symlink(target, trans_id)
829
909
        return trans_id
830
910
 
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
911
    def _affected_ids(self):
874
912
        """Return the set of transform ids affected by the transform"""
875
913
        trans_ids = set(self._removed_id)
905
943
        from_path = self._tree_id_paths.get(from_trans_id)
906
944
        if from_versioned:
907
945
            # get data from working tree if versioned
908
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
946
            from_entry = self._tree.inventory[file_id]
909
947
            from_name = from_entry.name
910
948
            from_parent = from_entry.parent_id
911
949
        else:
934
972
        Return a (name, parent, kind, executable) tuple
935
973
        """
936
974
        to_name = self.final_name(to_trans_id)
937
 
        to_kind = self.final_kind(to_trans_id)
 
975
        try:
 
976
            to_kind = self.final_kind(to_trans_id)
 
977
        except NoSuchFile:
 
978
            to_kind = None
938
979
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
939
980
        if to_trans_id in self._new_executability:
940
981
            to_executable = self._new_executability[to_trans_id]
944
985
            to_executable = False
945
986
        return to_name, to_parent, to_kind, to_executable
946
987
 
947
 
    def iter_changes(self):
948
 
        """Produce output in the same format as Tree.iter_changes.
 
988
    def _iter_changes(self):
 
989
        """Produce output in the same format as Tree._iter_changes.
949
990
 
950
991
        Will produce nonsensical results if invoked while inventory/filesystem
951
992
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
1009
1050
    def get_preview_tree(self):
1010
1051
        """Return a tree representing the result of the transform.
1011
1052
 
1012
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
1013
 
        it.
 
1053
        This tree only supports the subset of Tree functionality required
 
1054
        by show_diff_trees.  It must only be compared to tt._tree.
1014
1055
        """
1015
1056
        return _PreviewTree(self)
1016
1057
 
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):
 
1058
 
 
1059
class TreeTransform(TreeTransformBase):
1481
1060
    """Represent a tree transformation.
1482
1061
 
1483
1062
    This object is designed to support incremental generation of the transform,
1542
1121
    FileMover does not delete files until it is sure that a rollback will not
1543
1122
    happen.
1544
1123
    """
1545
 
    def __init__(self, tree, pb=None):
 
1124
    def __init__(self, tree, pb=DummyProgress()):
1546
1125
        """Note: a tree_write lock is taken on the tree.
1547
1126
 
1548
1127
        Use TreeTransform.finalize() to release the lock (can be omitted if
1551
1130
        tree.lock_tree_write()
1552
1131
 
1553
1132
        try:
 
1133
            control_files = tree._control_files
1554
1134
            limbodir = urlutils.local_path_from_url(
1555
 
                tree._transport.abspath('limbo'))
1556
 
            osutils.ensure_empty_directory_exists(
1557
 
                limbodir,
1558
 
                errors.ExistingLimbo)
 
1135
                control_files.controlfilename('limbo'))
 
1136
            try:
 
1137
                os.mkdir(limbodir)
 
1138
            except OSError, e:
 
1139
                if e.errno == errno.EEXIST:
 
1140
                    raise ExistingLimbo(limbodir)
1559
1141
            deletiondir = urlutils.local_path_from_url(
1560
 
                tree._transport.abspath('pending-deletion'))
1561
 
            osutils.ensure_empty_directory_exists(
1562
 
                deletiondir,
1563
 
                errors.ExistingPendingDeletion)
 
1142
                control_files.controlfilename('pending-deletion'))
 
1143
            try:
 
1144
                os.mkdir(deletiondir)
 
1145
            except OSError, e:
 
1146
                if e.errno == errno.EEXIST:
 
1147
                    raise errors.ExistingPendingDeletion(deletiondir)
1564
1148
        except:
1565
1149
            tree.unlock()
1566
1150
            raise
1567
1151
 
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,
 
1152
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1573
1153
                                   tree.case_sensitive)
1574
1154
        self._deletiondir = deletiondir
1575
1155
 
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
 
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1156
    def apply(self, no_conflicts=False, _mover=None):
1703
1157
        """Apply all changes to the inventory and filesystem.
1704
1158
 
1705
1159
        If filesystem or inventory conflicts are present, MalformedTransform
1709
1163
 
1710
1164
        :param no_conflicts: if True, the caller guarantees there are no
1711
1165
            conflicts, so no check is made.
1712
 
        :param precomputed_delta: An inventory delta to use instead of
1713
 
            calculating one.
1714
1166
        :param _mover: Supply an alternate FileMover, for testing
1715
1167
        """
1716
 
        for hook in MutableTree.hooks['pre_transform']:
1717
 
            hook(self._tree, self)
1718
1168
        if not no_conflicts:
1719
 
            self._check_malformed()
1720
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1169
            conflicts = self.find_conflicts()
 
1170
            if len(conflicts) != 0:
 
1171
                raise MalformedTransform(conflicts=conflicts)
 
1172
        inv = self._tree.inventory
 
1173
        inventory_delta = []
 
1174
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1721
1175
        try:
1722
 
            if precomputed_delta is None:
1723
 
                child_pb.update(gettext('Apply phase'), 0, 2)
1724
 
                inventory_delta = self._generate_inventory_delta()
1725
 
                offset = 1
1726
 
            else:
1727
 
                inventory_delta = precomputed_delta
1728
 
                offset = 0
1729
1176
            if _mover is None:
1730
1177
                mover = _FileMover()
1731
1178
            else:
1732
1179
                mover = _mover
1733
1180
            try:
1734
 
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1735
 
                self._apply_removals(mover)
1736
 
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1737
 
                modified_paths = self._apply_insertions(mover)
 
1181
                child_pb.update('Apply phase', 0, 2)
 
1182
                self._apply_removals(inv, inventory_delta, mover)
 
1183
                child_pb.update('Apply phase', 1, 2)
 
1184
                modified_paths = self._apply_insertions(inv, inventory_delta,
 
1185
                                                        mover)
1738
1186
            except:
1739
1187
                mover.rollback()
1740
1188
                raise
1742
1190
                mover.apply_deletions()
1743
1191
        finally:
1744
1192
            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
1193
        self._tree.apply_inventory_delta(inventory_delta)
1748
 
        self._apply_observed_sha1s()
1749
1194
        self._done = True
1750
1195
        self.finalize()
1751
1196
        return _TransformResults(modified_paths, self.rename_count)
1752
1197
 
1753
 
    def _generate_inventory_delta(self):
1754
 
        """Generate an inventory delta for the current transform."""
1755
 
        inventory_delta = []
1756
 
        child_pb = ui.ui_factory.nested_progress_bar()
1757
 
        new_paths = self._inventory_altered()
1758
 
        total_entries = len(new_paths) + len(self._removed_id)
1759
 
        try:
1760
 
            for num, trans_id in enumerate(self._removed_id):
1761
 
                if (num % 10) == 0:
1762
 
                    child_pb.update(gettext('removing file'), num, total_entries)
1763
 
                if trans_id == self._new_root:
1764
 
                    file_id = self._tree.get_root_id()
1765
 
                else:
1766
 
                    file_id = self.tree_file_id(trans_id)
1767
 
                # File-id isn't really being deleted, just moved
1768
 
                if file_id in self._r_new_id:
1769
 
                    continue
1770
 
                path = self._tree_id_paths[trans_id]
1771
 
                inventory_delta.append((path, None, file_id, None))
1772
 
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1773
 
                                     new_paths)
1774
 
            entries = self._tree.iter_entries_by_dir(
1775
 
                new_path_file_ids.values())
1776
 
            old_paths = dict((e.file_id, p) for p, e in entries)
1777
 
            final_kinds = {}
1778
 
            for num, (path, trans_id) in enumerate(new_paths):
1779
 
                if (num % 10) == 0:
1780
 
                    child_pb.update(gettext('adding file'),
1781
 
                                    num + len(self._removed_id), total_entries)
1782
 
                file_id = new_path_file_ids[trans_id]
1783
 
                if file_id is None:
1784
 
                    continue
1785
 
                needs_entry = False
1786
 
                kind = self.final_kind(trans_id)
1787
 
                if kind is None:
1788
 
                    kind = self._tree.stored_kind(file_id)
1789
 
                parent_trans_id = self.final_parent(trans_id)
1790
 
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1791
 
                if parent_file_id is None:
1792
 
                    parent_file_id = self.final_file_id(parent_trans_id)
1793
 
                if trans_id in self._new_reference_revision:
1794
 
                    new_entry = inventory.TreeReference(
1795
 
                        file_id,
1796
 
                        self._new_name[trans_id],
1797
 
                        self.final_file_id(self._new_parent[trans_id]),
1798
 
                        None, self._new_reference_revision[trans_id])
1799
 
                else:
1800
 
                    new_entry = inventory.make_entry(kind,
1801
 
                        self.final_name(trans_id),
1802
 
                        parent_file_id, file_id)
1803
 
                old_path = old_paths.get(new_entry.file_id)
1804
 
                new_executability = self._new_executability.get(trans_id)
1805
 
                if new_executability is not None:
1806
 
                    new_entry.executable = new_executability
1807
 
                inventory_delta.append(
1808
 
                    (old_path, path, new_entry.file_id, new_entry))
1809
 
        finally:
1810
 
            child_pb.finished()
1811
 
        return inventory_delta
1812
 
 
1813
 
    def _apply_removals(self, mover):
 
1198
    def _apply_removals(self, inv, inventory_delta, mover):
1814
1199
        """Perform tree operations that remove directory/inventory names.
1815
1200
 
1816
1201
        That is, delete files that are to be deleted, and put any files that
1817
1202
        need renaming into limbo.  This must be done in strict child-to-parent
1818
1203
        order.
1819
 
 
1820
 
        If inventory_delta is None, no inventory delta generation is performed.
1821
1204
        """
1822
1205
        tree_paths = list(self._tree_path_ids.iteritems())
1823
1206
        tree_paths.sort(reverse=True)
1824
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1207
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1825
1208
        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))
 
1209
            for num, data in enumerate(tree_paths):
 
1210
                path, trans_id = data
 
1211
                child_pb.update('removing file', num, len(tree_paths))
1831
1212
                full_path = self._tree.abspath(path)
1832
1213
                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):
 
1214
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1215
                                     trans_id))
 
1216
                elif trans_id in self._new_name or trans_id in \
 
1217
                    self._new_parent:
1837
1218
                    try:
1838
1219
                        mover.rename(full_path, self._limbo_name(trans_id))
1839
 
                    except errors.TransformRenameFailed, e:
 
1220
                    except OSError, e:
1840
1221
                        if e.errno != errno.ENOENT:
1841
1222
                            raise
1842
1223
                    else:
1843
1224
                        self.rename_count += 1
 
1225
                if trans_id in self._removed_id:
 
1226
                    if trans_id == self._new_root:
 
1227
                        file_id = self._tree.get_root_id()
 
1228
                    else:
 
1229
                        file_id = self.tree_file_id(trans_id)
 
1230
                    if file_id is not None:
 
1231
                        inventory_delta.append((path, None, file_id, None))
1844
1232
        finally:
1845
1233
            child_pb.finished()
1846
1234
 
1847
 
    def _apply_insertions(self, mover):
 
1235
    def _apply_insertions(self, inv, inventory_delta, mover):
1848
1236
        """Perform tree operations that insert directory/inventory names.
1849
1237
 
1850
1238
        That is, create any files that need to be created, and restore from
1851
1239
        limbo any files that needed renaming.  This must be done in strict
1852
1240
        parent-to-child order.
1853
 
 
1854
 
        If inventory_delta is None, no inventory delta is calculated, and
1855
 
        no list of modified paths is returned.
1856
1241
        """
1857
 
        new_paths = self.new_paths(filesystem_only=True)
 
1242
        new_paths = self.new_paths()
1858
1243
        modified_paths = []
1859
 
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1860
 
                                 new_paths)
1861
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1244
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1245
        completed_new = []
1862
1246
        try:
1863
1247
            for num, (path, trans_id) in enumerate(new_paths):
1864
 
                if (num % 10) == 0:
1865
 
                    child_pb.update(gettext('adding file'), num, len(new_paths))
1866
 
                full_path = self._tree.abspath(path)
1867
 
                if trans_id in self._needs_rename:
1868
 
                    try:
1869
 
                        mover.rename(self._limbo_name(trans_id), full_path)
1870
 
                    except errors.TransformRenameFailed, e:
1871
 
                        # We may be renaming a dangling inventory id
1872
 
                        if e.errno != errno.ENOENT:
1873
 
                            raise
1874
 
                    else:
1875
 
                        self.rename_count += 1
1876
 
                    # TODO: if trans_id in self._observed_sha1s, we should
1877
 
                    #       re-stat the final target, since ctime will be
1878
 
                    #       updated by the change.
1879
 
                if (trans_id in self._new_contents or
1880
 
                    self.path_changed(trans_id)):
 
1248
                new_entry = None
 
1249
                child_pb.update('adding file', num, len(new_paths))
 
1250
                try:
 
1251
                    kind = self._new_contents[trans_id]
 
1252
                except KeyError:
 
1253
                    kind = contents = None
 
1254
                if trans_id in self._new_contents or \
 
1255
                    self.path_changed(trans_id):
 
1256
                    full_path = self._tree.abspath(path)
 
1257
                    if trans_id in self._needs_rename:
 
1258
                        try:
 
1259
                            mover.rename(self._limbo_name(trans_id), full_path)
 
1260
                        except OSError, e:
 
1261
                            # We may be renaming a dangling inventory id
 
1262
                            if e.errno != errno.ENOENT:
 
1263
                                raise
 
1264
                        else:
 
1265
                            self.rename_count += 1
1881
1266
                    if trans_id in self._new_contents:
1882
1267
                        modified_paths.append(full_path)
 
1268
                        completed_new.append(trans_id)
 
1269
 
 
1270
                if trans_id in self._new_id:
 
1271
                    if kind is None:
 
1272
                        kind = file_kind(self._tree.abspath(path))
 
1273
                    if trans_id in self._new_reference_revision:
 
1274
                        new_entry = inventory.TreeReference(
 
1275
                            self._new_id[trans_id],
 
1276
                            self._new_name[trans_id],
 
1277
                            self.final_file_id(self._new_parent[trans_id]),
 
1278
                            None, self._new_reference_revision[trans_id])
 
1279
                    else:
 
1280
                        new_entry = inventory.make_entry(kind,
 
1281
                            self.final_name(trans_id),
 
1282
                            self.final_file_id(self.final_parent(trans_id)),
 
1283
                            self._new_id[trans_id])
 
1284
                else:
 
1285
                    if trans_id in self._new_name or trans_id in\
 
1286
                        self._new_parent or\
 
1287
                        trans_id in self._new_executability:
 
1288
                        file_id = self.final_file_id(trans_id)
 
1289
                        if file_id is not None:
 
1290
                            entry = inv[file_id]
 
1291
                            new_entry = entry.copy()
 
1292
 
 
1293
                    if trans_id in self._new_name or trans_id in\
 
1294
                        self._new_parent:
 
1295
                            if new_entry is not None:
 
1296
                                new_entry.name = self.final_name(trans_id)
 
1297
                                parent = self.final_parent(trans_id)
 
1298
                                parent_id = self.final_file_id(parent)
 
1299
                                new_entry.parent_id = parent_id
 
1300
 
1883
1301
                if trans_id in self._new_executability:
1884
 
                    self._set_executability(path, trans_id)
1885
 
                if trans_id in self._observed_sha1s:
1886
 
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
1887
 
                    st = osutils.lstat(full_path)
1888
 
                    self._observed_sha1s[trans_id] = (o_sha1, st)
 
1302
                    self._set_executability(path, new_entry, trans_id)
 
1303
                if new_entry is not None:
 
1304
                    if new_entry.file_id in inv:
 
1305
                        old_path = inv.id2path(new_entry.file_id)
 
1306
                    else:
 
1307
                        old_path = None
 
1308
                    inventory_delta.append((old_path, path,
 
1309
                                            new_entry.file_id,
 
1310
                                            new_entry))
1889
1311
        finally:
1890
1312
            child_pb.finished()
1891
 
        for path, trans_id in new_paths:
1892
 
            # new_paths includes stuff like workingtree conflicts. Only the
1893
 
            # stuff in new_contents actually comes from limbo.
1894
 
            if trans_id in self._limbo_files:
1895
 
                del self._limbo_files[trans_id]
1896
 
        self._new_contents.clear()
 
1313
        for trans_id in completed_new:
 
1314
            del self._new_contents[trans_id]
1897
1315
        return modified_paths
1898
1316
 
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):
 
1317
 
 
1318
class TransformPreview(TreeTransformBase):
1924
1319
    """A TreeTransform for generating preview trees.
1925
1320
 
1926
1321
    Unlike TreeTransform, this version works when the input tree is a
1928
1323
    unversioned files in the input tree.
1929
1324
    """
1930
1325
 
1931
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1326
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1932
1327
        tree.lock_read()
1933
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1934
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1328
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1329
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1935
1330
 
1936
1331
    def canonical_path(self, path):
1937
1332
        return path
1939
1334
    def tree_kind(self, trans_id):
1940
1335
        path = self._tree_id_paths.get(trans_id)
1941
1336
        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
 
1337
            raise NoSuchFile(None)
 
1338
        file_id = self._tree.path2id(path)
 
1339
        return self._tree.kind(file_id)
1947
1340
 
1948
1341
    def _set_mode(self, trans_id, mode_id, typefunc):
1949
1342
        """Set the mode of new file contents.
1961
1354
        except KeyError:
1962
1355
            return
1963
1356
        file_id = self.tree_file_id(parent_id)
1964
 
        if file_id is None:
1965
 
            return
1966
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1967
 
        children = getattr(entry, 'children', {})
1968
 
        for child in children:
 
1357
        for child in self._tree.inventory[file_id].children.iterkeys():
1969
1358
            childpath = joinpath(path, child)
1970
1359
            yield self.trans_id_tree_path(childpath)
1971
1360
 
1972
 
    def new_orphan(self, trans_id, parent_id):
1973
 
        raise NotImplementedError(self.new_orphan)
1974
 
 
1975
 
 
1976
 
class _PreviewTree(tree.InventoryTree):
 
1361
 
 
1362
class _PreviewTree(object):
1977
1363
    """Partial implementation of Tree to support show_diff_trees"""
1978
1364
 
1979
1365
    def __init__(self, transform):
1980
1366
        self._transform = transform
1981
 
        self._final_paths = FinalPaths(transform)
1982
 
        self.__by_parent = None
1983
 
        self._parent_ids = []
1984
 
        self._all_children_cache = {}
1985
 
        self._path2trans_id_cache = {}
1986
 
        self._final_name_cache = {}
1987
 
        self._iter_changes_cache = dict((c[0], c) for c in
1988
 
                                        self._transform.iter_changes())
1989
 
 
1990
 
    def _content_change(self, file_id):
1991
 
        """Return True if the content of this file changed"""
1992
 
        changes = self._iter_changes_cache.get(file_id)
1993
 
        # changes[2] is true if the file content changed.  See
1994
 
        # InterTree.iter_changes.
1995
 
        return (changes is not None and changes[2])
1996
 
 
1997
 
    def _get_repository(self):
1998
 
        repo = getattr(self._transform._tree, '_repository', None)
1999
 
        if repo is None:
2000
 
            repo = self._transform._tree.branch.repository
2001
 
        return repo
2002
 
 
2003
 
    def _iter_parent_trees(self):
2004
 
        for revision_id in self.get_parent_ids():
2005
 
            try:
2006
 
                yield self.revision_tree(revision_id)
2007
 
            except errors.NoSuchRevisionInTree:
2008
 
                yield self._get_repository().revision_tree(revision_id)
2009
 
 
2010
 
    def _get_file_revision(self, file_id, vf, tree_revision):
2011
 
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2012
 
                       self._iter_parent_trees()]
2013
 
        vf.add_lines((file_id, tree_revision), parent_keys,
2014
 
                     self.get_file_lines(file_id))
2015
 
        repo = self._get_repository()
2016
 
        base_vf = repo.texts
2017
 
        if base_vf not in vf.fallback_versionedfiles:
2018
 
            vf.fallback_versionedfiles.append(base_vf)
2019
 
        return tree_revision
2020
 
 
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)
2024
 
        name = self._transform._limbo_name(trans_id)
2025
 
        return os.lstat(name)
2026
 
 
2027
 
    @property
2028
 
    def _by_parent(self):
2029
 
        if self.__by_parent is None:
2030
 
            self.__by_parent = self._transform.by_parent()
2031
 
        return self.__by_parent
2032
 
 
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
1367
 
2046
1368
    def lock_read(self):
2047
1369
        # Perhaps in theory, this should lock the TreeTransform?
2048
 
        return self
 
1370
        pass
2049
1371
 
2050
1372
    def unlock(self):
2051
1373
        pass
2052
1374
 
2053
 
    @property
2054
 
    @deprecated_method(deprecated_in((2, 5, 0)))
2055
 
    def inventory(self):
2056
 
        """This Tree does not use inventory as its backing data."""
2057
 
        raise NotImplementedError(_PreviewTree.inventory)
2058
 
 
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
 
    def get_root_id(self):
2065
 
        return self._transform.final_file_id(self._transform.root)
2066
 
 
2067
 
    def all_file_ids(self):
2068
 
        tree_ids = set(self._transform._tree.all_file_ids())
2069
 
        tree_ids.difference_update(self._transform.tree_file_id(t)
2070
 
                                   for t in self._transform._removed_id)
2071
 
        tree_ids.update(self._transform._new_id.values())
2072
 
        return tree_ids
2073
 
 
2074
 
    def __iter__(self):
2075
 
        return iter(self.all_file_ids())
2076
 
 
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)
2091
 
 
2092
 
    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
 
        segments = splitpath(path)
2098
 
        cur_parent = self._transform.root
2099
 
        for cur_segment in segments:
2100
 
            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:
2106
 
                    cur_parent = child
2107
 
                    break
2108
 
            else:
2109
 
                self._path2trans_id_cache[path] = None
2110
 
                return None
2111
 
        self._path2trans_id_cache[path] = cur_parent
2112
 
        return cur_parent
2113
 
 
2114
 
    def path2id(self, path):
2115
 
        if isinstance(path, list):
2116
 
            if path == []:
2117
 
                path = [""]
2118
 
            path = osutils.pathjoin(*path)
2119
 
        return self._transform.final_file_id(self._path2trans_id(path))
2120
 
 
2121
 
    def id2path(self, file_id):
2122
 
        trans_id = self._transform.trans_id_file_id(file_id)
2123
 
        try:
2124
 
            return self._final_paths._determine_path(trans_id)
2125
 
        except NoFinalPath:
2126
 
            raise errors.NoSuchId(self, file_id)
2127
 
 
2128
 
    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
 
        children = set(self._transform.iter_tree_children(trans_id))
2133
 
        # children in the _new_parent set are provided by _by_parent.
2134
 
        children.difference_update(self._transform._new_parent.keys())
2135
 
        children.update(self._by_parent.get(trans_id, []))
2136
 
        self._all_children_cache[trans_id] = children
2137
 
        return children
2138
 
 
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):
2155
 
        for trans_id, parent_file_id in ordered_entries:
2156
 
            file_id = self._transform.final_file_id(trans_id)
2157
 
            if file_id is None:
2158
 
                continue
2159
 
            if (specific_file_ids is not None
2160
 
                and file_id not in specific_file_ids):
2161
 
                continue
2162
 
            kind = self._transform.final_kind(trans_id)
2163
 
            if kind is None:
2164
 
                kind = self._transform._tree.stored_kind(file_id)
2165
 
            new_entry = inventory.make_entry(
2166
 
                kind,
2167
 
                self._transform.final_name(trans_id),
2168
 
                parent_file_id, file_id)
2169
 
            yield new_entry, trans_id
2170
 
 
2171
 
    def _list_files_by_dir(self):
2172
 
        todo = [ROOT_PARENT]
2173
 
        ordered_ids = []
2174
 
        while len(todo) > 0:
2175
 
            parent = todo.pop()
2176
 
            parent_file_id = self._transform.final_file_id(parent)
2177
 
            children = list(self._all_children(parent))
2178
 
            paths = dict(zip(children, self._final_paths.get_paths(children)))
2179
 
            children.sort(key=paths.get)
2180
 
            todo.extend(reversed(children))
2181
 
            for trans_id in children:
2182
 
                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
 
        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
 
1375
    def _iter_changes(self, from_tree, include_unchanged=False,
 
1376
                      specific_files=None, pb=None, extra_trees=None,
 
1377
                      require_versioned=True, want_unversioned=False):
 
1378
        """See InterTree._iter_changes.
 
1379
 
 
1380
        This implementation does not support include_unchanged, specific_files,
 
1381
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1382
        ignored.
 
1383
        """
 
1384
        if from_tree is not self._transform._tree:
 
1385
            raise ValueError('from_tree must be transform source tree.')
 
1386
        if include_unchanged:
 
1387
            raise ValueError('include_unchanged is not supported')
 
1388
        if specific_files is not None:
 
1389
            raise ValueError('specific_files is not supported')
 
1390
        if want_unversioned:
 
1391
            raise ValueError('want_unversioned is not supported')
 
1392
        return self._transform._iter_changes()
2239
1393
 
2240
1394
    def kind(self, file_id):
2241
1395
        trans_id = self._transform.trans_id_file_id(file_id)
2242
1396
        return self._transform.final_kind(trans_id)
2243
1397
 
2244
 
    def stored_kind(self, file_id):
2245
 
        trans_id = self._transform.trans_id_file_id(file_id)
2246
 
        try:
2247
 
            return self._transform._new_contents[trans_id]
2248
 
        except KeyError:
2249
 
            return self._transform._tree.stored_kind(file_id)
2250
 
 
2251
1398
    def get_file_mtime(self, file_id, path=None):
2252
1399
        """See Tree.get_file_mtime"""
2253
 
        if not self._content_change(file_id):
2254
 
            return self._transform._tree.get_file_mtime(file_id)
2255
 
        return self._stat_limbo_file(file_id).st_mtime
2256
 
 
2257
 
    def _file_size(self, entry, stat_value):
2258
 
        return self.get_file_size(entry.file_id)
2259
 
 
2260
 
    def get_file_size(self, file_id):
2261
 
        """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
 
        if self.kind(file_id) == 'file':
2269
 
            return self._transform._tree.get_file_size(file_id)
2270
 
        else:
2271
 
            return None
2272
 
 
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
 
    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()
2296
 
 
2297
 
    def is_executable(self, file_id, path=None):
2298
 
        if file_id is None:
2299
 
            return False
2300
 
        trans_id = self._transform.trans_id_file_id(file_id)
2301
 
        try:
2302
 
            return self._transform._new_executability[trans_id]
2303
 
        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)
2321
 
 
2322
 
    def path_content_summary(self, path):
2323
 
        trans_id = self._path2trans_id(path)
2324
 
        tt = self._transform
2325
 
        tree_path = tt._tree_id_paths.get(trans_id)
2326
 
        kind = tt._new_contents.get(trans_id)
2327
 
        if kind is None:
2328
 
            if tree_path is None or trans_id in tt._removed_contents:
2329
 
                return 'missing', None, None, None
2330
 
            summary = tt._tree.path_content_summary(tree_path)
2331
 
            kind, size, executable, link_or_sha1 = summary
2332
 
        else:
2333
 
            link_or_sha1 = None
2334
 
            limbo_name = tt._limbo_name(trans_id)
2335
 
            if trans_id in tt._new_reference_revision:
2336
 
                kind = 'tree-reference'
2337
 
            if kind == 'file':
2338
 
                statval = os.lstat(limbo_name)
2339
 
                size = statval.st_size
2340
 
                if not tt._limbo_supports_executable():
2341
 
                    executable = False
2342
 
                else:
2343
 
                    executable = statval.st_mode & S_IEXEC
2344
 
            else:
2345
 
                size = None
2346
 
                executable = None
2347
 
            if kind == 'symlink':
2348
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2349
 
        executable = tt._new_executability.get(trans_id, executable)
2350
 
        return kind, size, executable, link_or_sha1
2351
 
 
2352
 
    def iter_changes(self, from_tree, include_unchanged=False,
2353
 
                      specific_files=None, pb=None, extra_trees=None,
2354
 
                      require_versioned=True, want_unversioned=False):
2355
 
        """See InterTree.iter_changes.
2356
 
 
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.
2359
 
        """
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)
2369
 
        if want_unversioned:
2370
 
            raise ValueError('want_unversioned is not supported')
2371
 
        return self._transform.iter_changes()
2372
 
 
2373
 
    def get_file(self, file_id, path=None):
 
1400
        trans_id = self._transform.trans_id_file_id(file_id)
 
1401
        name = self._transform._limbo_name(trans_id)
 
1402
        return os.stat(name).st_mtime
 
1403
 
 
1404
    def get_file(self, file_id):
2374
1405
        """See Tree.get_file"""
2375
 
        if not self._content_change(file_id):
2376
 
            return self._transform._tree.get_file(file_id, path)
2377
1406
        trans_id = self._transform.trans_id_file_id(file_id)
2378
1407
        name = self._transform._limbo_name(trans_id)
2379
1408
        return open(name, 'rb')
2380
1409
 
2381
 
    def get_file_with_stat(self, file_id, path=None):
2382
 
        return self.get_file(file_id, path), None
2383
 
 
2384
 
    def annotate_iter(self, file_id,
2385
 
                      default_revision=_mod_revision.CURRENT_REVISION):
2386
 
        changes = self._iter_changes_cache.get(file_id)
2387
 
        if changes is None:
2388
 
            get_old = True
2389
 
        else:
2390
 
            changed_content, versioned, kind = (changes[2], changes[3],
2391
 
                                                changes[6])
2392
 
            if kind[1] is None:
2393
 
                return None
2394
 
            get_old = (kind[0] == 'file' and versioned[0])
2395
 
        if get_old:
2396
 
            old_annotation = self._transform._tree.annotate_iter(file_id,
2397
 
                default_revision=default_revision)
2398
 
        else:
2399
 
            old_annotation = []
2400
 
        if changes is None:
2401
 
            return old_annotation
2402
 
        if not changed_content:
2403
 
            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
 
        return annotate.reannotate([old_annotation],
2412
 
                                   self.get_file(file_id).readlines(),
2413
 
                                   default_revision)
2414
 
 
2415
 
    def get_symlink_target(self, file_id, path=None):
2416
 
        """See Tree.get_symlink_target"""
2417
 
        if not self._content_change(file_id):
2418
 
            return self._transform._tree.get_symlink_target(file_id)
2419
 
        trans_id = self._transform.trans_id_file_id(file_id)
2420
 
        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))
2451
 
 
2452
 
    def get_parent_ids(self):
2453
 
        return self._parent_ids
2454
 
 
2455
 
    def set_parent_ids(self, parent_ids):
2456
 
        self._parent_ids = parent_ids
2457
 
 
2458
 
    def get_revision_tree(self, revision_id):
2459
 
        return self._transform._tree.get_revision_tree(revision_id)
 
1410
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1411
        """See Tree.paths2ids"""
 
1412
        return 'not_empty'
2460
1413
 
2461
1414
 
2462
1415
def joinpath(parent, child):
2479
1432
        self.transform = transform
2480
1433
 
2481
1434
    def _determine_path(self, trans_id):
2482
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1435
        if trans_id == self.transform.root:
2483
1436
            return ""
2484
1437
        name = self.transform.final_name(trans_id)
2485
1438
        parent_id = self.transform.final_parent(trans_id)
2494
1447
            self._known_paths[trans_id] = self._determine_path(trans_id)
2495
1448
        return self._known_paths[trans_id]
2496
1449
 
2497
 
    def get_paths(self, trans_ids):
2498
 
        return [(self.get_path(t), t) for t in trans_ids]
2499
 
 
2500
 
 
2501
1450
 
2502
1451
def topology_sorted_ids(tree):
2503
1452
    """Determine the topological order of the ids in a tree"""
2506
1455
    return file_ids
2507
1456
 
2508
1457
 
2509
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2510
 
               delta_from_tree=False):
 
1458
def build_tree(tree, wt, accelerator_tree=None):
2511
1459
    """Create working tree for a branch, using a TreeTransform.
2512
 
 
 
1460
    
2513
1461
    This function should be used on empty trees, having a tree root at most.
2514
1462
    (see merge and revert functionality for working with existing trees)
2515
1463
 
2516
1464
    Existing files are handled like so:
2517
 
 
 
1465
    
2518
1466
    - Existing bzrdirs take precedence over creating new items.  They are
2519
1467
      created as '%s.diverted' % name.
2520
1468
    - Otherwise, if the content on disk matches the content we are building,
2526
1474
    :param accelerator_tree: A tree which can be used for retrieving file
2527
1475
        contents more quickly than tree itself, i.e. a workingtree.  tree
2528
1476
        will be used for cases where accelerator_tree's content is different.
2529
 
    :param hardlink: If true, hard-link files to accelerator_tree, where
2530
 
        possible.  accelerator_tree must implement abspath, i.e. be a
2531
 
        working tree.
2532
 
    :param delta_from_tree: If true, build_tree may use the input Tree to
2533
 
        generate the inventory delta.
2534
1477
    """
2535
1478
    wt.lock_tree_write()
2536
1479
    try:
2539
1482
            if accelerator_tree is not None:
2540
1483
                accelerator_tree.lock_read()
2541
1484
            try:
2542
 
                return _build_tree(tree, wt, accelerator_tree, hardlink,
2543
 
                                   delta_from_tree)
 
1485
                return _build_tree(tree, wt, accelerator_tree)
2544
1486
            finally:
2545
1487
                if accelerator_tree is not None:
2546
1488
                    accelerator_tree.unlock()
2550
1492
        wt.unlock()
2551
1493
 
2552
1494
 
2553
 
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1495
def _build_tree(tree, wt, accelerator_tree):
2554
1496
    """See build_tree."""
2555
 
    for num, _unused in enumerate(wt.all_file_ids()):
2556
 
        if num > 0:  # more than just a root
2557
 
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
1497
    if len(wt.inventory) > 1:  # more than just a root
 
1498
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2558
1499
    file_trans_id = {}
2559
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
1500
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2560
1501
    pp = ProgressPhase("Build phase", 2, top_pb)
2561
 
    if tree.get_root_id() is not None:
 
1502
    if tree.inventory.root is not None:
2562
1503
        # This is kind of a hack: we should be altering the root
2563
1504
        # as part of the regular tree shape diff logic.
2564
1505
        # The conditional test here is to avoid doing an
2575
1516
        pp.next_phase()
2576
1517
        file_trans_id[wt.get_root_id()] = \
2577
1518
            tt.trans_id_tree_file_id(wt.get_root_id())
2578
 
        pb = ui.ui_factory.nested_progress_bar()
 
1519
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2579
1520
        try:
2580
1521
            deferred_contents = []
2581
 
            num = 0
2582
 
            total = len(tree.all_file_ids())
2583
 
            if delta_from_tree:
2584
 
                precomputed_delta = []
2585
 
            else:
2586
 
                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
1522
            for num, (tree_path, entry) in \
2597
 
                enumerate(tree.iter_entries_by_dir()):
2598
 
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
 
1523
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1524
                pb.update("Building tree", num - len(deferred_contents),
 
1525
                          len(tree.inventory))
2599
1526
                if entry.parent_id is None:
2600
1527
                    continue
2601
1528
                reparent = False
2602
1529
                file_id = entry.file_id
2603
 
                if delta_from_tree:
2604
 
                    precomputed_delta.append((None, tree_path, file_id, entry))
2605
 
                if tree_path in existing_files:
2606
 
                    target_path = wt.abspath(tree_path)
 
1530
                target_path = wt.abspath(tree_path)
 
1531
                try:
2607
1532
                    kind = file_kind(target_path)
 
1533
                except NoSuchFile:
 
1534
                    pass
 
1535
                else:
2608
1536
                    if kind == "directory":
2609
1537
                        try:
2610
 
                            controldir.ControlDir.open(target_path)
 
1538
                            bzrdir.BzrDir.open(target_path)
2611
1539
                        except errors.NotBranchError:
2612
1540
                            pass
2613
1541
                        else:
2618
1546
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2619
1547
                        if kind == 'directory':
2620
1548
                            reparent = True
 
1549
                if entry.parent_id not in file_trans_id:
 
1550
                    raise AssertionError(
 
1551
                        'entry %s parent id %r is not in file_trans_id %r'
 
1552
                        % (entry, entry.parent_id, file_trans_id))
2621
1553
                parent_id = file_trans_id[entry.parent_id]
2622
1554
                if entry.kind == 'file':
2623
1555
                    # We *almost* replicate new_by_entry, so that we can defer
2624
1556
                    # getting the file text, and get them all at once.
2625
1557
                    trans_id = tt.create_path(entry.name, parent_id)
2626
1558
                    file_trans_id[file_id] = trans_id
2627
 
                    tt.version_file(file_id, trans_id)
2628
 
                    executable = tree.is_executable(file_id, tree_path)
2629
 
                    if executable:
 
1559
                    tt.version_file(entry.file_id, trans_id)
 
1560
                    executable = tree.is_executable(entry.file_id, tree_path)
 
1561
                    if executable is not None:
2630
1562
                        tt.set_executability(executable, trans_id)
2631
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
2632
 
                    deferred_contents.append((file_id, trans_data))
 
1563
                    deferred_contents.append((entry.file_id, trans_id))
2633
1564
                else:
2634
1565
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2635
1566
                                                          tree)
2637
1568
                    new_trans_id = file_trans_id[file_id]
2638
1569
                    old_parent = tt.trans_id_tree_path(tree_path)
2639
1570
                    _reparent_children(tt, old_parent, new_trans_id)
2640
 
            offset = num + 1 - len(deferred_contents)
2641
 
            _create_files(tt, tree, deferred_contents, pb, offset,
2642
 
                          accelerator_tree, hardlink)
 
1571
            for num, (trans_id, bytes) in enumerate(
 
1572
                _iter_files_bytes_accelerated(tree, accelerator_tree,
 
1573
                                              deferred_contents)):
 
1574
                tt.create_file(bytes, trans_id)
 
1575
                pb.update('Adding file contents',
 
1576
                          (num + len(tree.inventory) - len(deferred_contents)),
 
1577
                          len(tree.inventory))
2643
1578
        finally:
2644
1579
            pb.finished()
2645
1580
        pp.next_phase()
2646
1581
        divert_trans = set(file_trans_id[f] for f in divert)
2647
1582
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2648
1583
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2649
 
        if len(raw_conflicts) > 0:
2650
 
            precomputed_delta = None
2651
1584
        conflicts = cook_conflicts(raw_conflicts, tt)
2652
1585
        for conflict in conflicts:
2653
 
            trace.warning(unicode(conflict))
 
1586
            warning(conflict)
2654
1587
        try:
2655
1588
            wt.add_conflicts(conflicts)
2656
1589
        except errors.UnsupportedOperation:
2657
1590
            pass
2658
 
        result = tt.apply(no_conflicts=True,
2659
 
                          precomputed_delta=precomputed_delta)
 
1591
        result = tt.apply(no_conflicts=True)
2660
1592
    finally:
2661
1593
        tt.finalize()
2662
1594
        top_pb.finished()
2663
1595
    return result
2664
1596
 
2665
1597
 
2666
 
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2667
 
                  hardlink):
2668
 
    total = len(desired_files) + offset
2669
 
    wt = tt._tree
 
1598
def _iter_files_bytes_accelerated(tree, accelerator_tree, desired_files):
2670
1599
    if accelerator_tree is None:
2671
1600
        new_desired_files = desired_files
2672
1601
    else:
2673
 
        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)
 
1602
        iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
 
1603
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1604
                         in iter if not c)
2680
1605
        new_desired_files = []
2681
 
        count = 0
2682
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
1606
        for file_id, identifier in desired_files:
2683
1607
            accelerator_path = unchanged.get(file_id)
2684
1608
            if accelerator_path is None:
2685
 
                new_desired_files.append((file_id,
2686
 
                    (trans_id, tree_path, text_sha1)))
 
1609
                new_desired_files.append((file_id, identifier))
2687
1610
                continue
2688
 
            pb.update(gettext('Adding file contents'), count + offset, total)
2689
 
            if hardlink:
2690
 
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2691
 
                                   trans_id)
2692
 
            else:
2693
 
                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
 
                try:
2699
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
2700
 
                finally:
2701
 
                    try:
2702
 
                        contents.close()
2703
 
                    except AttributeError:
2704
 
                        # after filtering, contents may no longer be file-like
2705
 
                        pass
2706
 
            count += 1
2707
 
        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)
 
1611
            contents = accelerator_tree.get_file(file_id, accelerator_path)
 
1612
            try:
 
1613
                want_new = False
 
1614
                contents_bytes = (contents.read(),)
 
1615
            finally:
 
1616
                contents.close()
 
1617
            yield identifier, contents_bytes
 
1618
    for result in tree.iter_files_bytes(new_desired_files):
 
1619
        yield result
2716
1620
 
2717
1621
 
2718
1622
def _reparent_children(tt, old_parent, new_parent):
2719
1623
    for child in tt.iter_tree_children(old_parent):
2720
1624
        tt.adjust_path(tt.final_name(child), new_parent, child)
2721
1625
 
2722
 
 
2723
1626
def _reparent_transform_children(tt, old_parent, new_parent):
2724
1627
    by_parent = tt.by_parent()
2725
1628
    for child in by_parent[old_parent]:
2726
1629
        tt.adjust_path(tt.final_name(child), new_parent, child)
2727
 
    return by_parent[old_parent]
2728
 
 
2729
1630
 
2730
1631
def _content_match(tree, entry, file_id, kind, target_path):
2731
1632
    if entry.kind != kind:
2733
1634
    if entry.kind == "directory":
2734
1635
        return True
2735
1636
    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()
 
1637
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1638
            return True
2742
1639
    elif entry.kind == "symlink":
2743
1640
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2744
1641
            return True
2749
1646
    new_conflicts = set()
2750
1647
    for c_type, conflict in ((c[0], c) for c in conflicts):
2751
1648
        # Anything but a 'duplicate' would indicate programmer error
2752
 
        if c_type != 'duplicate':
2753
 
            raise AssertionError(c_type)
 
1649
        assert c_type == 'duplicate', c_type
2754
1650
        # Now figure out which is new and which is old
2755
1651
        if tt.new_contents(conflict[1]):
2756
1652
            new_file = conflict[1]
2782
1678
    if kind == 'file':
2783
1679
        contents = tree.get_file(entry.file_id).readlines()
2784
1680
        executable = tree.is_executable(entry.file_id)
2785
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
1681
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2786
1682
                           executable)
2787
1683
    elif kind in ('directory', 'tree-reference'):
2788
1684
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2789
1685
        if kind == 'tree-reference':
2790
1686
            tt.set_tree_reference(entry.reference_revision, trans_id)
2791
 
        return trans_id
 
1687
        return trans_id 
2792
1688
    elif kind == 'symlink':
2793
1689
        target = tree.get_symlink_target(entry.file_id)
2794
1690
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2796
1692
        raise errors.BadFileKindError(name, kind)
2797
1693
 
2798
1694
 
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':
 
1695
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
1696
    """Create new file contents according to an inventory entry."""
 
1697
    if entry.kind == "file":
 
1698
        if lines is None:
 
1699
            lines = tree.get_file(entry.file_id).readlines()
 
1700
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
1701
    elif entry.kind == "symlink":
 
1702
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
1703
    elif entry.kind == "directory":
2809
1704
        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
1705
 
2828
1706
 
2829
1707
def create_entry_executability(tt, entry, trans_id):
2832
1710
        tt.set_executability(entry.executable, trans_id)
2833
1711
 
2834
1712
 
 
1713
@deprecated_function(zero_fifteen)
 
1714
def find_interesting(working_tree, target_tree, filenames):
 
1715
    """Find the ids corresponding to specified filenames.
 
1716
    
 
1717
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
 
1718
    """
 
1719
    working_tree.lock_read()
 
1720
    try:
 
1721
        target_tree.lock_read()
 
1722
        try:
 
1723
            return working_tree.paths2ids(filenames, [target_tree])
 
1724
        finally:
 
1725
            target_tree.unlock()
 
1726
    finally:
 
1727
        working_tree.unlock()
 
1728
 
 
1729
 
 
1730
@deprecated_function(zero_ninety)
 
1731
def change_entry(tt, file_id, working_tree, target_tree, 
 
1732
                 trans_id_file_id, backups, trans_id, by_parent):
 
1733
    """Replace a file_id's contents with those from a target tree."""
 
1734
    if file_id is None and target_tree is None:
 
1735
        # skip the logic altogether in the deprecation test
 
1736
        return
 
1737
    e_trans_id = trans_id_file_id(file_id)
 
1738
    entry = target_tree.inventory[file_id]
 
1739
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
 
1740
                                                           working_tree)
 
1741
    if contents_mod:
 
1742
        mode_id = e_trans_id
 
1743
        if has_contents:
 
1744
            if not backups:
 
1745
                tt.delete_contents(e_trans_id)
 
1746
            else:
 
1747
                parent_trans_id = trans_id_file_id(entry.parent_id)
 
1748
                backup_name = get_backup_name(entry, by_parent,
 
1749
                                              parent_trans_id, tt)
 
1750
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
 
1751
                tt.unversion_file(e_trans_id)
 
1752
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
 
1753
                tt.version_file(file_id, e_trans_id)
 
1754
                trans_id[file_id] = e_trans_id
 
1755
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
 
1756
        create_entry_executability(tt, entry, e_trans_id)
 
1757
 
 
1758
    elif meta_mod:
 
1759
        tt.set_executability(entry.executable, e_trans_id)
 
1760
    if tt.final_name(e_trans_id) != entry.name:
 
1761
        adjust_path  = True
 
1762
    else:
 
1763
        parent_id = tt.final_parent(e_trans_id)
 
1764
        parent_file_id = tt.final_file_id(parent_id)
 
1765
        if parent_file_id != entry.parent_id:
 
1766
            adjust_path = True
 
1767
        else:
 
1768
            adjust_path = False
 
1769
    if adjust_path:
 
1770
        parent_trans_id = trans_id_file_id(entry.parent_id)
 
1771
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
 
1772
 
 
1773
 
 
1774
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
1775
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
1776
 
 
1777
 
 
1778
def _get_backup_name(name, by_parent, parent_trans_id, tt):
 
1779
    """Produce a backup-style name that appears to be available"""
 
1780
    def name_gen():
 
1781
        counter = 1
 
1782
        while True:
 
1783
            yield "%s.~%d~" % (name, counter)
 
1784
            counter += 1
 
1785
    for new_name in name_gen():
 
1786
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
1787
            return new_name
 
1788
 
 
1789
 
 
1790
def _entry_changes(file_id, entry, working_tree):
 
1791
    """Determine in which ways the inventory entry has changed.
 
1792
 
 
1793
    Returns booleans: has_contents, content_mod, meta_mod
 
1794
    has_contents means there are currently contents, but they differ
 
1795
    contents_mod means contents need to be modified
 
1796
    meta_mod means the metadata needs to be modified
 
1797
    """
 
1798
    cur_entry = working_tree.inventory[file_id]
 
1799
    try:
 
1800
        working_kind = working_tree.kind(file_id)
 
1801
        has_contents = True
 
1802
    except NoSuchFile:
 
1803
        has_contents = False
 
1804
        contents_mod = True
 
1805
        meta_mod = False
 
1806
    if has_contents is True:
 
1807
        if entry.kind != working_kind:
 
1808
            contents_mod, meta_mod = True, False
 
1809
        else:
 
1810
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
1811
                                       working_tree)
 
1812
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
 
1813
            cur_entry._forget_tree_state()
 
1814
    return has_contents, contents_mod, meta_mod
 
1815
 
 
1816
 
2835
1817
def revert(working_tree, target_tree, filenames, backups=False,
2836
 
           pb=None, change_reporter=None):
 
1818
           pb=DummyProgress(), change_reporter=None):
2837
1819
    """Revert a working tree's contents to those of a target tree."""
2838
1820
    target_tree.lock_read()
2839
 
    pb = ui.ui_factory.nested_progress_bar()
2840
1821
    tt = TreeTransform(working_tree, pb)
2841
1822
    try:
2842
1823
        pp = ProgressPhase("Revert phase", 3, pb)
2843
 
        conflicts, merge_modified = _prepare_revert_transform(
2844
 
            working_tree, target_tree, tt, filenames, backups, pp)
 
1824
        pp.next_phase()
 
1825
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1826
        try:
 
1827
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
1828
                                          child_pb, filenames, backups)
 
1829
        finally:
 
1830
            child_pb.finished()
 
1831
        pp.next_phase()
 
1832
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1833
        try:
 
1834
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
1835
                lambda t, c: conflict_pass(t, c, target_tree))
 
1836
        finally:
 
1837
            child_pb.finished()
 
1838
        conflicts = cook_conflicts(raw_conflicts, tt)
2845
1839
        if change_reporter:
2846
1840
            change_reporter = delta._ChangeReporter(
2847
1841
                unversioned_filter=working_tree.is_ignored)
2848
 
            delta.report_changes(tt.iter_changes(), change_reporter)
 
1842
            delta.report_changes(tt._iter_changes(), change_reporter)
2849
1843
        for conflict in conflicts:
2850
 
            trace.warning(unicode(conflict))
 
1844
            warning(conflict)
2851
1845
        pp.next_phase()
2852
1846
        tt.apply()
2853
1847
        working_tree.set_merge_modified(merge_modified)
2858
1852
    return conflicts
2859
1853
 
2860
1854
 
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
1855
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,
 
1856
                 backups):
 
1857
    merge_modified = working_tree.merge_modified()
 
1858
    change_list = target_tree._iter_changes(working_tree,
2892
1859
        specific_files=specific_files, pb=pb)
2893
 
    if target_tree.get_root_id() is None:
 
1860
    if target_tree.inventory.root is None:
2894
1861
        skip_root = True
2895
1862
    else:
2896
1863
        skip_root = False
 
1864
    basis_tree = None
2897
1865
    try:
2898
1866
        deferred_files = []
2899
1867
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2900
1868
                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:
 
1869
            if skip_root and file_id[0] is not None and parent[0] is None:
2908
1870
                continue
2909
1871
            trans_id = tt.trans_id_file_id(file_id)
2910
1872
            mode_id = None
2911
1873
            if changed_content:
2912
1874
                keep_content = False
2913
 
                if wt_kind == 'file' and (backups or target_kind is None):
 
1875
                if kind[0] == 'file' and (backups or kind[1] is None):
2914
1876
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2915
1877
                    if merge_modified.get(file_id) != wt_sha1:
2916
1878
                        # acquire the basis tree lazily to prevent the
2919
1881
                        if basis_tree is None:
2920
1882
                            basis_tree = working_tree.basis_tree()
2921
1883
                            basis_tree.lock_read()
2922
 
                        if basis_tree.has_id(file_id):
 
1884
                        if file_id in basis_tree:
2923
1885
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2924
1886
                                keep_content = True
2925
 
                        elif target_kind is None and not target_versioned:
 
1887
                        elif kind[1] is None and not versioned[1]:
2926
1888
                            keep_content = True
2927
 
                if wt_kind is not None:
 
1889
                if kind[0] is not None:
2928
1890
                    if not keep_content:
2929
1891
                        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)
 
1892
                    elif kind[1] is not None:
 
1893
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
1894
                        by_parent = tt.by_parent()
 
1895
                        backup_name = _get_backup_name(name[0], by_parent,
 
1896
                                                       parent_trans_id, tt)
2934
1897
                        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:
 
1898
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
1899
                        if versioned == (True, True):
2937
1900
                            tt.unversion_file(trans_id)
2938
1901
                            tt.version_file(file_id, new_trans_id)
2939
1902
                        # New contents should have the same unix perms as old
2940
1903
                        # contents
2941
1904
                        mode_id = trans_id
2942
1905
                        trans_id = new_trans_id
2943
 
                if target_kind in ('directory', 'tree-reference'):
 
1906
                if kind[1] == 'directory':
2944
1907
                    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':
 
1908
                elif kind[1] == 'symlink':
2950
1909
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2951
1910
                                      trans_id)
2952
 
                elif target_kind == 'file':
 
1911
                elif kind[1] == 'file':
2953
1912
                    deferred_files.append((file_id, (trans_id, mode_id)))
2954
1913
                    if basis_tree is None:
2955
1914
                        basis_tree = working_tree.basis_tree()
2956
1915
                        basis_tree.lock_read()
2957
1916
                    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)):
 
1917
                    if (file_id in basis_tree and new_sha1 ==
 
1918
                        basis_tree.get_file_sha1(file_id)):
2960
1919
                        if file_id in merge_modified:
2961
1920
                            del merge_modified[file_id]
2962
1921
                    else:
2963
1922
                        merge_modified[file_id] = new_sha1
2964
1923
 
2965
1924
                    # 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:
 
1925
                    if keep_content and executable[0] == executable[1]:
 
1926
                        tt.set_executability(executable[1], trans_id)
 
1927
                else:
 
1928
                    assert kind[1] is None
 
1929
            if versioned == (False, True):
2971
1930
                tt.version_file(file_id, trans_id)
2972
 
            if wt_versioned and not target_versioned:
 
1931
            if versioned == (True, False):
2973
1932
                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()
 
1933
            if (name[1] is not None and 
 
1934
                (name[0] != name[1] or parent[0] != parent[1])):
 
1935
                tt.adjust_path(
 
1936
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
1937
            if executable[0] != executable[1] and kind[1] == "file":
 
1938
                tt.set_executability(executable[1], trans_id)
 
1939
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
1940
            deferred_files):
 
1941
            tt.create_file(bytes, trans_id, mode_id)
3003
1942
    finally:
3004
1943
        if basis_tree is not None:
3005
1944
            basis_tree.unlock()
3006
1945
    return merge_modified
3007
1946
 
3008
1947
 
3009
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
1948
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3010
1949
    """Make many conflict-resolution attempts, but die if they fail"""
3011
1950
    if pass_func is None:
3012
1951
        pass_func = conflict_pass
3013
1952
    new_conflicts = set()
3014
 
    pb = ui.ui_factory.nested_progress_bar()
3015
1953
    try:
3016
1954
        for n in range(10):
3017
 
            pb.update(gettext('Resolution pass'), n+1, 10)
 
1955
            pb.update('Resolution pass', n+1, 10)
3018
1956
            conflicts = tt.find_conflicts()
3019
1957
            if len(conflicts) == 0:
3020
1958
                return new_conflicts
3021
1959
            new_conflicts.update(pass_func(tt, conflicts))
3022
1960
        raise MalformedTransform(conflicts=conflicts)
3023
1961
    finally:
3024
 
        pb.finished()
 
1962
        pb.clear()
3025
1963
 
3026
1964
 
3027
1965
def conflict_pass(tt, conflicts, path_tree=None):
3044
1982
                existing_file, new_file = conflict[2], conflict[1]
3045
1983
            else:
3046
1984
                existing_file, new_file = conflict[1], conflict[2]
3047
 
            new_name = tt.final_name(existing_file) + '.moved'
 
1985
            new_name = tt.final_name(existing_file)+'.moved'
3048
1986
            tt.adjust_path(new_name, final_parent, existing_file)
3049
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
1987
            new_conflicts.add((c_type, 'Moved existing file to', 
3050
1988
                               existing_file, new_file))
3051
1989
        elif c_type == 'parent loop':
3052
1990
            # break the loop by undoing one of the ops that caused the loop
3056
1994
            new_conflicts.add((c_type, 'Cancelled move', cur,
3057
1995
                               tt.final_parent(cur),))
3058
1996
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3059
 
 
 
1997
            
3060
1998
        elif c_type == 'missing parent':
3061
1999
            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:
3086
 
                create = True
 
2000
            try:
 
2001
                tt.cancel_deletion(trans_id)
 
2002
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2003
                                   trans_id))
 
2004
            except KeyError:
 
2005
                tt.create_directory(trans_id)
 
2006
                new_conflicts.add((c_type, 'Created directory', trans_id))
3087
2007
                try:
3088
2008
                    tt.final_name(trans_id)
3089
2009
                except NoFinalPath:
3090
2010
                    if path_tree is not None:
3091
2011
                        file_id = tt.final_file_id(trans_id)
3092
 
                        if file_id is None:
3093
 
                            file_id = tt.inactive_file_id(trans_id)
3094
 
                        _, entry = path_tree.iter_entries_by_dir(
3095
 
                            [file_id]).next()
3096
 
                        # special-case the other tree root (move its
3097
 
                        # children to current root)
3098
 
                        if entry.parent_id is None:
3099
 
                            create = False
3100
 
                            moved = _reparent_transform_children(
3101
 
                                tt, trans_id, tt.root)
3102
 
                            for child in moved:
3103
 
                                new_conflicts.add((c_type, 'Moved to root',
3104
 
                                                   child))
3105
 
                        else:
3106
 
                            parent_trans_id = tt.trans_id_file_id(
3107
 
                                entry.parent_id)
3108
 
                            tt.adjust_path(entry.name, parent_trans_id,
3109
 
                                           trans_id)
3110
 
                if create:
3111
 
                    tt.create_directory(trans_id)
3112
 
                    new_conflicts.add((c_type, 'Created directory', trans_id))
 
2012
                        entry = path_tree.inventory[file_id]
 
2013
                        parent_trans_id = tt.trans_id_file_id(entry.parent_id)
 
2014
                        tt.adjust_path(entry.name, parent_trans_id, trans_id)
3113
2015
        elif c_type == 'unversioned parent':
3114
 
            file_id = tt.inactive_file_id(conflict[1])
3115
 
            # 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
3119
 
                    continue
3120
 
            tt.version_file(file_id, conflict[1])
 
2016
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
3121
2017
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3122
2018
        elif c_type == 'non-directory parent':
3123
2019
            parent_id = conflict[1]
3127
2023
            new_parent_id = tt.new_directory(parent_name + '.new',
3128
2024
                parent_parent, parent_file_id)
3129
2025
            _reparent_transform_children(tt, parent_id, new_parent_id)
3130
 
            if parent_file_id is not None:
3131
 
                tt.unversion_file(parent_id)
 
2026
            tt.unversion_file(parent_id)
3132
2027
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
3133
 
        elif c_type == 'versioning no contents':
3134
 
            tt.cancel_versioning(conflict[1])
3135
2028
    return new_conflicts
3136
2029
 
3137
2030
 
3138
2031
def cook_conflicts(raw_conflicts, tt):
3139
2032
    """Generate a list of cooked conflicts, sorted by file path"""
 
2033
    from bzrlib.conflicts import Conflict
3140
2034
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3141
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
2035
    return sorted(conflict_iter, key=Conflict.sort_key)
3142
2036
 
3143
2037
 
3144
2038
def iter_cook_conflicts(raw_conflicts, tt):
 
2039
    from bzrlib.conflicts import Conflict
3145
2040
    fp = FinalPaths(tt)
3146
2041
    for conflict in raw_conflicts:
3147
2042
        c_type = conflict[0]
3149
2044
        modified_path = fp.get_path(conflict[2])
3150
2045
        modified_id = tt.final_file_id(conflict[2])
3151
2046
        if len(conflict) == 3:
3152
 
            yield conflicts.Conflict.factory(
3153
 
                c_type, action=action, path=modified_path, file_id=modified_id)
3154
 
 
 
2047
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2048
                                     file_id=modified_id)
 
2049
             
3155
2050
        else:
3156
2051
            conflicting_path = fp.get_path(conflict[3])
3157
2052
            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)
 
2053
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2054
                                   file_id=modified_id, 
 
2055
                                   conflict_path=conflicting_path,
 
2056
                                   conflict_file_id=conflicting_id)
3163
2057
 
3164
2058
 
3165
2059
class _FileMover(object):
3170
2064
        self.pending_deletions = []
3171
2065
 
3172
2066
    def rename(self, from_, to):
3173
 
        """Rename a file from one path to another."""
 
2067
        """Rename a file from one path to another.  Functions like os.rename"""
3174
2068
        try:
3175
2069
            os.rename(from_, to)
3176
2070
        except OSError, e:
3177
2071
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3178
2072
                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)
 
2073
            raise
3182
2074
        self.past_renames.append((from_, to))
3183
2075
 
3184
2076
    def pre_delete(self, from_, to):
3194
2086
    def rollback(self):
3195
2087
        """Reverse all renames that have been performed"""
3196
2088
        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)
 
2089
            os.rename(to, from_)
3201
2090
        # after rollback, don't reuse _FileMover
3202
2091
        past_renames = None
3203
2092
        pending_deletions = None