/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Ian Clatworthy
  • Date: 2008-03-27 07:51:10 UTC
  • mto: (3311.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3312.
  • Revision ID: ian.clatworthy@canonical.com-20080327075110-afgd7x03ybju06ez
Reduce evangelism in the User Guide

Show diffs side-by-side

added added

removed removed

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