← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Martin Albisetti
  • Date: 2008-05-06 00:21:18 UTC
  • mto: (3431.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 3432.
  • Revision ID: argentina@gmail.com-20080506002118-7w9ywklw4khddf3g
Added spanish index

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
28
    inventory,
32
 
    multiparent,
33
 
    osutils,
34
29
    revision as _mod_revision,
35
 
    ui,
36
30
    )
37
31
""")
38
32
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
39
 
                           ReusingTransform, CantMoveRoot,
 
33
                           ReusingTransform, NotVersionedError, CantMoveRoot,
40
34
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
41
35
                           UnableCreateSymlink)
42
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
43
36
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
 
37
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
 
38
                            delete_any, has_symlinks)
 
39
from bzrlib.progress import DummyProgress, ProgressPhase
55
40
from bzrlib.symbol_versioning import (
56
41
        deprecated_function,
57
 
        deprecated_in,
 
42
        zero_fifteen,
 
43
        zero_ninety,
58
44
        )
59
45
from bzrlib.trace import mutter, warning
60
46
from bzrlib import tree
79
65
 
80
66
 
81
67
class TreeTransformBase(object):
82
 
    """The base class for TreeTransform and its kin."""
 
68
    """The base class for TreeTransform and TreeTransformBase"""
83
69
 
84
 
    def __init__(self, tree, pb=None,
 
70
    def __init__(self, tree, limbodir, pb=DummyProgress(),
85
71
                 case_sensitive=True):
86
72
        """Constructor.
87
73
 
88
74
        :param tree: The tree that will be transformed, but not necessarily
89
75
            the output tree.
90
 
        :param pb: ignored
 
76
        :param limbodir: A directory where new files can be stored until
 
77
            they are installed in their proper places
 
78
        :param pb: A ProgressBar indicating how much progress is being made
91
79
        :param case_sensitive: If True, the target of the transform is
92
80
            case sensitive, not just case preserving.
93
81
        """
94
82
        object.__init__(self)
95
83
        self._tree = tree
 
84
        self._limbodir = limbodir
 
85
        self._deletiondir = None
96
86
        self._id_number = 0
97
87
        # mapping of trans_id -> new basename
98
88
        self._new_name = {}
100
90
        self._new_parent = {}
101
91
        # mapping of trans_id with new contents -> new file_kind
102
92
        self._new_contents = {}
 
93
        # A mapping of transform ids to their limbo filename
 
94
        self._limbo_files = {}
 
95
        # A mapping of transform ids to a set of the transform ids of children
 
96
        # that their limbo directory has
 
97
        self._limbo_children = {}
 
98
        # Map transform ids to maps of child filename to child transform id
 
99
        self._limbo_children_names = {}
 
100
        # List of transform ids that need to be renamed from limbo into place
 
101
        self._needs_rename = set()
103
102
        # Set of trans_ids whose contents will be removed
104
103
        self._removed_contents = set()
105
104
        # Mapping of trans_id -> new execute-bit value
112
111
        self._non_present_ids = {}
113
112
        # Mapping of new file_id -> trans_id
114
113
        self._r_new_id = {}
115
 
        # Set of trans_ids that will be removed
 
114
        # Set of file_ids that will be removed
116
115
        self._removed_id = set()
117
116
        # Mapping of path in old tree -> trans_id
118
117
        self._tree_path_ids = {}
119
118
        # Mapping trans_id -> path in old tree
120
119
        self._tree_id_paths = {}
 
120
        # Cache of realpath results, to speed up canonical_path
 
121
        self._realpaths = {}
 
122
        # Cache of relpath results, to speed up canonical_path
 
123
        self._relpaths = {}
121
124
        # 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
 
125
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
127
126
        # Indictor of whether the transform has been applied
128
127
        self._done = False
129
128
        # A progress bar
133
132
        # A counter of how many files have been renamed
134
133
        self.rename_count = 0
135
134
 
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
135
    def __get_root(self):
148
136
        return self._new_root
149
137
 
150
138
    root = property(__get_root)
151
139
 
 
140
    def finalize(self):
 
141
        """Release the working tree lock, if held, clean up limbo dir.
 
142
 
 
143
        This is required if apply has not been invoked, but can be invoked
 
144
        even after apply.
 
145
        """
 
146
        if self._tree is None:
 
147
            return
 
148
        try:
 
149
            entries = [(self._limbo_name(t), t, k) for t, k in
 
150
                       self._new_contents.iteritems()]
 
151
            entries.sort(reverse=True)
 
152
            for path, trans_id, kind in entries:
 
153
                if kind == "directory":
 
154
                    os.rmdir(path)
 
155
                else:
 
156
                    os.unlink(path)
 
157
            try:
 
158
                os.rmdir(self._limbodir)
 
159
            except OSError:
 
160
                # We don't especially care *why* the dir is immortal.
 
161
                raise ImmortalLimbo(self._limbodir)
 
162
            try:
 
163
                if self._deletiondir is not None:
 
164
                    os.rmdir(self._deletiondir)
 
165
            except OSError:
 
166
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
167
        finally:
 
168
            self._tree.unlock()
 
169
            self._tree = None
 
170
 
152
171
    def _assign_id(self):
153
172
        """Produce a new tranform id"""
154
173
        new_id = "new-%s" % self._id_number
164
183
 
165
184
    def adjust_path(self, name, parent, trans_id):
166
185
        """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
186
        if trans_id == self._new_root:
170
187
            raise CantMoveRoot
 
188
        previous_parent = self._new_parent.get(trans_id)
 
189
        previous_name = self._new_name.get(trans_id)
171
190
        self._new_name[trans_id] = name
172
191
        self._new_parent[trans_id] = parent
 
192
        if (trans_id in self._limbo_files and
 
193
            trans_id not in self._needs_rename):
 
194
            self._rename_in_limbo([trans_id])
 
195
            self._limbo_children[previous_parent].remove(trans_id)
 
196
            del self._limbo_children_names[previous_parent][previous_name]
 
197
 
 
198
    def _rename_in_limbo(self, trans_ids):
 
199
        """Fix limbo names so that the right final path is produced.
 
200
 
 
201
        This means we outsmarted ourselves-- we tried to avoid renaming
 
202
        these files later by creating them with their final names in their
 
203
        final parents.  But now the previous name or parent is no longer
 
204
        suitable, so we have to rename them.
 
205
 
 
206
        Even for trans_ids that have no new contents, we must remove their
 
207
        entries from _limbo_files, because they are now stale.
 
208
        """
 
209
        for trans_id in trans_ids:
 
210
            old_path = self._limbo_files.pop(trans_id)
 
211
            if trans_id not in self._new_contents:
 
212
                continue
 
213
            new_path = self._limbo_name(trans_id)
 
214
            os.rename(old_path, new_path)
173
215
 
174
216
    def adjust_root_path(self, name, parent):
175
217
        """Emulate moving the root by moving all children, instead.
176
 
 
 
218
        
177
219
        We do this by undoing the association of root's transaction id with the
178
220
        current tree.  This allows us to create a new directory with that
179
 
        transaction id.  We unversion the root directory and version the
 
221
        transaction id.  We unversion the root directory and version the 
180
222
        physically new directory, and hope someone versions the tree root
181
223
        later.
182
224
        """
185
227
        # force moving all children of root
186
228
        for child_id in self.iter_tree_children(old_root):
187
229
            if child_id != parent:
188
 
                self.adjust_path(self.final_name(child_id),
 
230
                self.adjust_path(self.final_name(child_id), 
189
231
                                 self.final_parent(child_id), child_id)
190
232
            file_id = self.final_file_id(child_id)
191
233
            if file_id is not None:
192
234
                self.unversion_file(child_id)
193
235
            self.version_file(file_id, child_id)
194
 
 
 
236
        
195
237
        # the physical root needs a new transaction id
196
238
        self._tree_path_ids.pop("")
197
239
        self._tree_id_paths.pop(old_root)
203
245
        self.version_file(old_root_file_id, old_root)
204
246
        self.unversion_file(self._new_root)
205
247
 
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
248
    def trans_id_tree_file_id(self, inventory_id):
268
249
        """Determine the transaction id of a working tree file.
269
 
 
 
250
        
270
251
        This reflects only files that already exist, not ones that will be
271
252
        added by transactions.
272
253
        """
273
 
        if inventory_id is None:
274
 
            raise ValueError('None is not a valid file id')
275
254
        path = self._tree.id2path(inventory_id)
276
255
        return self.trans_id_tree_path(path)
277
256
 
281
260
        a transaction has been unversioned, it is deliberately still returned.
282
261
        (this will likely lead to an unversioned parent conflict.)
283
262
        """
284
 
        if file_id is None:
285
 
            raise ValueError('None is not a valid file id')
286
263
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
287
264
            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)
 
265
        elif file_id in self._tree.inventory:
 
266
            return self.trans_id_tree_file_id(file_id)
 
267
        elif file_id in self._non_present_ids:
 
268
            return self._non_present_ids[file_id]
 
269
        else:
 
270
            trans_id = self._assign_id()
 
271
            self._non_present_ids[file_id] = trans_id
 
272
            return trans_id
 
273
 
 
274
    def canonical_path(self, path):
 
275
        """Get the canonical tree-relative path"""
 
276
        # don't follow final symlinks
 
277
        abs = self._tree.abspath(path)
 
278
        if abs in self._relpaths:
 
279
            return self._relpaths[abs]
 
280
        dirname, basename = os.path.split(abs)
 
281
        if dirname not in self._realpaths:
 
282
            self._realpaths[dirname] = os.path.realpath(dirname)
 
283
        dirname = self._realpaths[dirname]
 
284
        abs = pathjoin(dirname, basename)
 
285
        if dirname in self._relpaths:
 
286
            relpath = pathjoin(self._relpaths[dirname], basename)
 
287
            relpath = relpath.rstrip('/\\')
 
288
        else:
 
289
            relpath = self._tree.relpath(abs)
 
290
        self._relpaths[abs] = relpath
 
291
        return relpath
300
292
 
301
293
    def trans_id_tree_path(self, path):
302
294
        """Determine (and maybe set) the transaction ID for a tree path."""
313
305
            return ROOT_PARENT
314
306
        return self.trans_id_tree_path(os.path.dirname(path))
315
307
 
 
308
    def create_file(self, contents, trans_id, mode_id=None):
 
309
        """Schedule creation of a new file.
 
310
 
 
311
        See also new_file.
 
312
        
 
313
        Contents is an iterator of strings, all of which will be written
 
314
        to the target destination.
 
315
 
 
316
        New file takes the permissions of any existing file with that id,
 
317
        unless mode_id is specified.
 
318
        """
 
319
        name = self._limbo_name(trans_id)
 
320
        f = open(name, 'wb')
 
321
        try:
 
322
            try:
 
323
                unique_add(self._new_contents, trans_id, 'file')
 
324
            except:
 
325
                # Clean up the file, it never got registered so
 
326
                # TreeTransform.finalize() won't clean it up.
 
327
                f.close()
 
328
                os.unlink(name)
 
329
                raise
 
330
 
 
331
            f.writelines(contents)
 
332
        finally:
 
333
            f.close()
 
334
        self._set_mode(trans_id, mode_id, S_ISREG)
 
335
 
 
336
    def _set_mode(self, trans_id, mode_id, typefunc):
 
337
        """Set the mode of new file contents.
 
338
        The mode_id is the existing file to get the mode from (often the same
 
339
        as trans_id).  The operation is only performed if there's a mode match
 
340
        according to typefunc.
 
341
        """
 
342
        if mode_id is None:
 
343
            mode_id = trans_id
 
344
        try:
 
345
            old_path = self._tree_id_paths[mode_id]
 
346
        except KeyError:
 
347
            return
 
348
        try:
 
349
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
350
        except OSError, e:
 
351
            if e.errno == errno.ENOENT:
 
352
                return
 
353
            else:
 
354
                raise
 
355
        if typefunc(mode):
 
356
            os.chmod(self._limbo_name(trans_id), mode)
 
357
 
 
358
    def create_hardlink(self, path, trans_id):
 
359
        """Schedule creation of a hard link"""
 
360
        name = self._limbo_name(trans_id)
 
361
        try:
 
362
            os.link(path, name)
 
363
        except OSError, e:
 
364
            if e.errno != errno.EPERM:
 
365
                raise
 
366
            raise errors.HardLinkNotSupported(path)
 
367
        try:
 
368
            unique_add(self._new_contents, trans_id, 'file')
 
369
        except:
 
370
            # Clean up the file, it never got registered so
 
371
            # TreeTransform.finalize() won't clean it up.
 
372
            os.unlink(name)
 
373
            raise
 
374
 
 
375
    def create_directory(self, trans_id):
 
376
        """Schedule creation of a new directory.
 
377
        
 
378
        See also new_directory.
 
379
        """
 
380
        os.mkdir(self._limbo_name(trans_id))
 
381
        unique_add(self._new_contents, trans_id, 'directory')
 
382
 
 
383
    def create_symlink(self, target, trans_id):
 
384
        """Schedule creation of a new symbolic link.
 
385
 
 
386
        target is a bytestring.
 
387
        See also new_symlink.
 
388
        """
 
389
        if has_symlinks():
 
390
            os.symlink(target, self._limbo_name(trans_id))
 
391
            unique_add(self._new_contents, trans_id, 'symlink')
 
392
        else:
 
393
            try:
 
394
                path = FinalPaths(self).get_path(trans_id)
 
395
            except KeyError:
 
396
                path = None
 
397
            raise UnableCreateSymlink(path=path)
 
398
 
 
399
    def cancel_creation(self, trans_id):
 
400
        """Cancel the creation of new file contents."""
 
401
        del self._new_contents[trans_id]
 
402
        children = self._limbo_children.get(trans_id)
 
403
        # if this is a limbo directory with children, move them before removing
 
404
        # the directory
 
405
        if children is not None:
 
406
            self._rename_in_limbo(children)
 
407
            del self._limbo_children[trans_id]
 
408
            del self._limbo_children_names[trans_id]
 
409
        delete_any(self._limbo_name(trans_id))
 
410
 
316
411
    def delete_contents(self, trans_id):
317
412
        """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
413
        self.tree_kind(trans_id)
321
414
        self._removed_contents.add(trans_id)
322
415
 
348
441
 
349
442
    def version_file(self, file_id, trans_id):
350
443
        """Schedule a file to become versioned."""
351
 
        if file_id is None:
352
 
            raise ValueError()
 
444
        assert file_id is not None
353
445
        unique_add(self._new_id, trans_id, file_id)
354
446
        unique_add(self._r_new_id, file_id, trans_id)
355
447
 
359
451
        del self._new_id[trans_id]
360
452
        del self._r_new_id[file_id]
361
453
 
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.
 
454
    def new_paths(self):
 
455
        """Determine the paths of all new and changed files"""
 
456
        new_ids = set()
 
457
        fp = FinalPaths(self)
 
458
        for id_set in (self._new_name, self._new_parent, self._new_contents,
 
459
                       self._new_id, self._new_executability):
 
460
            new_ids.update(id_set)
 
461
        new_paths = [(fp.get_path(t), t) for t in new_ids]
 
462
        new_paths.sort()
 
463
        return new_paths
 
464
 
 
465
    def tree_kind(self, trans_id):
 
466
        """Determine the file kind in the working tree.
 
467
 
 
468
        Raises NoSuchFile if the file does not exist
367
469
        """
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))
 
470
        path = self._tree_id_paths.get(trans_id)
 
471
        if path is None:
 
472
            raise NoSuchFile(None)
 
473
        try:
 
474
            return file_kind(self._tree.abspath(path))
 
475
        except OSError, e:
 
476
            if e.errno != errno.ENOENT:
 
477
                raise
 
478
            else:
 
479
                raise NoSuchFile(path)
396
480
 
397
481
    def final_kind(self, trans_id):
398
482
        """Determine the final file kind, after any changes applied.
399
 
 
 
483
        
400
484
        Raises NoSuchFile if the file does not exist/has no contents.
401
485
        (It is conceivable that a path would be created without the
402
486
        corresponding contents insertion command)
418
502
        # the file is old; the old id is still valid
419
503
        if self._new_root == trans_id:
420
504
            return self._tree.get_root_id()
421
 
        return self._tree.path2id(path)
 
505
        return self._tree.inventory.path2id(path)
422
506
 
423
507
    def final_file_id(self, trans_id):
424
508
        """Determine the file id after any changes are applied, or None.
425
 
 
 
509
        
426
510
        None indicates that the file will not be versioned after changes are
427
511
        applied.
428
512
        """
429
513
        try:
 
514
            # there is a new id for this file
 
515
            assert self._new_id[trans_id] is not None
430
516
            return self._new_id[trans_id]
431
517
        except KeyError:
432
518
            if trans_id in self._removed_id:
467
553
 
468
554
    def by_parent(self):
469
555
        """Return a map of parent: children for known parents.
470
 
 
 
556
        
471
557
        Only new paths and parents of tree files with assigned ids are used.
472
558
        """
473
559
        by_parent = {}
474
560
        items = list(self._new_parent.iteritems())
475
 
        items.extend((t, self.final_parent(t)) for t in
 
561
        items.extend((t, self.final_parent(t)) for t in 
476
562
                      self._tree_id_paths.keys())
477
563
        for trans_id, parent_id in items:
478
564
            if parent_id not in by_parent:
506
592
        conflicts.extend(self._overwrite_conflicts())
507
593
        return conflicts
508
594
 
509
 
    def _check_malformed(self):
510
 
        conflicts = self.find_conflicts()
511
 
        if len(conflicts) != 0:
512
 
            raise MalformedTransform(conflicts=conflicts)
513
 
 
514
595
    def _add_tree_children(self):
515
596
        """Add all the children of all active parents to the known paths.
516
597
 
518
599
        removed.  This is a necessary first step in detecting conflicts.
519
600
        """
520
601
        parents = self.by_parent().keys()
521
 
        parents.extend([t for t in self._removed_contents if
 
602
        parents.extend([t for t in self._removed_contents if 
522
603
                        self.tree_kind(t) == 'directory'])
523
604
        for trans_id in self._removed_id:
524
605
            file_id = self.tree_file_id(trans_id)
532
613
            # ensure that all children are registered with the transaction
533
614
            list(self.iter_tree_children(parent_id))
534
615
 
 
616
    def iter_tree_children(self, parent_id):
 
617
        """Iterate through the entry's tree children, if any"""
 
618
        try:
 
619
            path = self._tree_id_paths[parent_id]
 
620
        except KeyError:
 
621
            return
 
622
        try:
 
623
            children = os.listdir(self._tree.abspath(path))
 
624
        except OSError, e:
 
625
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
 
626
                raise
 
627
            return
 
628
            
 
629
        for child in children:
 
630
            childpath = joinpath(path, child)
 
631
            if self._tree.is_control_filename(childpath):
 
632
                continue
 
633
            yield self.trans_id_tree_path(childpath)
 
634
 
535
635
    def has_named_child(self, by_parent, parent_id, name):
536
636
        try:
537
637
            children = by_parent[parent_id]
591
691
 
592
692
    def _improper_versioning(self):
593
693
        """Cannot version a file with no contents, or a bad type.
594
 
 
 
694
        
595
695
        However, existing entries with no contents are okay.
596
696
        """
597
697
        conflicts = []
607
707
 
608
708
    def _executability_conflicts(self):
609
709
        """Check for bad executability changes.
610
 
 
 
710
        
611
711
        Only versioned files may have their executability set, because
612
712
        1. only versioned entries can have executability under windows
613
713
        2. only files can be executable.  (The execute bit on a directory
712
812
            return True
713
813
        return False
714
814
 
715
 
    def _set_executability(self, path, trans_id):
 
815
    def _limbo_name(self, trans_id):
 
816
        """Generate the limbo name of a file"""
 
817
        limbo_name = self._limbo_files.get(trans_id)
 
818
        if limbo_name is not None:
 
819
            return limbo_name
 
820
        parent = self._new_parent.get(trans_id)
 
821
        # if the parent directory is already in limbo (e.g. when building a
 
822
        # tree), choose a limbo name inside the parent, to reduce further
 
823
        # renames.
 
824
        use_direct_path = False
 
825
        if self._new_contents.get(parent) == 'directory':
 
826
            filename = self._new_name.get(trans_id)
 
827
            if filename is not None:
 
828
                if parent not in self._limbo_children:
 
829
                    self._limbo_children[parent] = set()
 
830
                    self._limbo_children_names[parent] = {}
 
831
                    use_direct_path = True
 
832
                # the direct path can only be used if no other file has
 
833
                # already taken this pathname, i.e. if the name is unused, or
 
834
                # if it is already associated with this trans_id.
 
835
                elif self._case_sensitive_target:
 
836
                    if (self._limbo_children_names[parent].get(filename)
 
837
                        in (trans_id, None)):
 
838
                        use_direct_path = True
 
839
                else:
 
840
                    for l_filename, l_trans_id in\
 
841
                        self._limbo_children_names[parent].iteritems():
 
842
                        if l_trans_id == trans_id:
 
843
                            continue
 
844
                        if l_filename.lower() == filename.lower():
 
845
                            break
 
846
                    else:
 
847
                        use_direct_path = True
 
848
 
 
849
        if use_direct_path:
 
850
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
851
            self._limbo_children[parent].add(trans_id)
 
852
            self._limbo_children_names[parent][filename] = trans_id
 
853
        else:
 
854
            limbo_name = pathjoin(self._limbodir, trans_id)
 
855
            self._needs_rename.add(trans_id)
 
856
        self._limbo_files[trans_id] = limbo_name
 
857
        return limbo_name
 
858
 
 
859
    def _set_executability(self, path, entry, trans_id):
716
860
        """Set the executability of versioned files """
 
861
        new_executability = self._new_executability[trans_id]
 
862
        entry.executable = new_executability
717
863
        if supports_executable():
718
 
            new_executability = self._new_executability[trans_id]
719
864
            abspath = self._tree.abspath(path)
720
865
            current_mode = os.stat(abspath).st_mode
721
866
            if new_executability:
738
883
            self.version_file(file_id, trans_id)
739
884
        return trans_id
740
885
 
741
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
886
    def new_file(self, name, parent_id, contents, file_id=None, 
742
887
                 executable=None):
743
888
        """Convenience method to create files.
744
 
 
 
889
        
745
890
        name is the name of the file to create.
746
891
        parent_id is the transaction id of the parent directory of the file.
747
892
        contents is an iterator of bytestrings, which will be used to produce
767
912
        """
768
913
        trans_id = self._new_entry(name, parent_id, file_id)
769
914
        self.create_directory(trans_id)
770
 
        return trans_id
 
915
        return trans_id 
771
916
 
772
917
    def new_symlink(self, name, parent_id, target, file_id=None):
773
918
        """Convenience method to create symbolic link.
774
 
 
 
919
        
775
920
        name is the name of the symlink to create.
776
921
        parent_id is the transaction id of the parent directory of the symlink.
777
922
        target is a bytestring of the target of the symlink.
816
961
        from_path = self._tree_id_paths.get(from_trans_id)
817
962
        if from_versioned:
818
963
            # get data from working tree if versioned
819
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
964
            from_entry = self._tree.inventory[file_id]
820
965
            from_name = from_entry.name
821
966
            from_parent = from_entry.parent_id
822
967
        else:
923
1068
    def get_preview_tree(self):
924
1069
        """Return a tree representing the result of the transform.
925
1070
 
926
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
927
 
        it.
 
1071
        This tree only supports the subset of Tree functionality required
 
1072
        by show_diff_trees.  It must only be compared to tt._tree.
928
1073
        """
929
1074
        return _PreviewTree(self)
930
1075
 
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):
 
1076
 
 
1077
class TreeTransform(TreeTransformBase):
1301
1078
    """Represent a tree transformation.
1302
1079
 
1303
1080
    This object is designed to support incremental generation of the transform,
1362
1139
    FileMover does not delete files until it is sure that a rollback will not
1363
1140
    happen.
1364
1141
    """
1365
 
    def __init__(self, tree, pb=None):
 
1142
    def __init__(self, tree, pb=DummyProgress()):
1366
1143
        """Note: a tree_write lock is taken on the tree.
1367
1144
 
1368
1145
        Use TreeTransform.finalize() to release the lock (can be omitted if
1371
1148
        tree.lock_tree_write()
1372
1149
 
1373
1150
        try:
 
1151
            control_files = tree._control_files
1374
1152
            limbodir = urlutils.local_path_from_url(
1375
 
                tree._transport.abspath('limbo'))
 
1153
                control_files.controlfilename('limbo'))
1376
1154
            try:
1377
1155
                os.mkdir(limbodir)
1378
1156
            except OSError, e:
1379
1157
                if e.errno == errno.EEXIST:
1380
1158
                    raise ExistingLimbo(limbodir)
1381
1159
            deletiondir = urlutils.local_path_from_url(
1382
 
                tree._transport.abspath('pending-deletion'))
 
1160
                control_files.controlfilename('pending-deletion'))
1383
1161
            try:
1384
1162
                os.mkdir(deletiondir)
1385
1163
            except OSError, e:
1389
1167
            tree.unlock()
1390
1168
            raise
1391
1169
 
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,
 
1170
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1397
1171
                                   tree.case_sensitive)
1398
1172
        self._deletiondir = deletiondir
1399
1173
 
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):
 
1174
    def apply(self, no_conflicts=False, _mover=None):
1530
1175
        """Apply all changes to the inventory and filesystem.
1531
1176
 
1532
1177
        If filesystem or inventory conflicts are present, MalformedTransform
1536
1181
 
1537
1182
        :param no_conflicts: if True, the caller guarantees there are no
1538
1183
            conflicts, so no check is made.
1539
 
        :param precomputed_delta: An inventory delta to use instead of
1540
 
            calculating one.
1541
1184
        :param _mover: Supply an alternate FileMover, for testing
1542
1185
        """
1543
1186
        if not no_conflicts:
1544
 
            self._check_malformed()
 
1187
            conflicts = self.find_conflicts()
 
1188
            if len(conflicts) != 0:
 
1189
                raise MalformedTransform(conflicts=conflicts)
 
1190
        inventory_delta = []
1545
1191
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1546
1192
        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
1193
            if _mover is None:
1555
1194
                mover = _FileMover()
1556
1195
            else:
1557
1196
                mover = _mover
1558
1197
            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)
 
1198
                child_pb.update('Apply phase', 0, 2)
 
1199
                self._apply_removals(inventory_delta, mover)
 
1200
                child_pb.update('Apply phase', 1, 2)
 
1201
                modified_paths = self._apply_insertions(inventory_delta, mover)
1563
1202
            except:
1564
1203
                mover.rollback()
1565
1204
                raise
1572
1211
        self.finalize()
1573
1212
        return _TransformResults(modified_paths, self.rename_count)
1574
1213
 
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):
 
1214
    def _apply_removals(self, inventory_delta, mover):
1637
1215
        """Perform tree operations that remove directory/inventory names.
1638
1216
 
1639
1217
        That is, delete files that are to be deleted, and put any files that
1640
1218
        need renaming into limbo.  This must be done in strict child-to-parent
1641
1219
        order.
1642
 
 
1643
 
        If inventory_delta is None, no inventory delta generation is performed.
1644
1220
        """
1645
1221
        tree_paths = list(self._tree_path_ids.iteritems())
1646
1222
        tree_paths.sort(reverse=True)
1651
1227
                child_pb.update('removing file', num, len(tree_paths))
1652
1228
                full_path = self._tree.abspath(path)
1653
1229
                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):
 
1230
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1231
                                     trans_id))
 
1232
                elif trans_id in self._new_name or trans_id in \
 
1233
                    self._new_parent:
1658
1234
                    try:
1659
1235
                        mover.rename(full_path, self._limbo_name(trans_id))
1660
 
                    except errors.TransformRenameFailed, e:
 
1236
                    except OSError, e:
1661
1237
                        if e.errno != errno.ENOENT:
1662
1238
                            raise
1663
1239
                    else:
1664
1240
                        self.rename_count += 1
 
1241
                if trans_id in self._removed_id:
 
1242
                    if trans_id == self._new_root:
 
1243
                        file_id = self._tree.get_root_id()
 
1244
                    else:
 
1245
                        file_id = self.tree_file_id(trans_id)
 
1246
                    assert file_id is not None
 
1247
                    # File-id isn't really being deleted, just moved
 
1248
                    if file_id in self._r_new_id:
 
1249
                        continue
 
1250
                    inventory_delta.append((path, None, file_id, None))
1665
1251
        finally:
1666
1252
            child_pb.finished()
1667
1253
 
1668
 
    def _apply_insertions(self, mover):
 
1254
    def _apply_insertions(self, inventory_delta, mover):
1669
1255
        """Perform tree operations that insert directory/inventory names.
1670
1256
 
1671
1257
        That is, create any files that need to be created, and restore from
1672
1258
        limbo any files that needed renaming.  This must be done in strict
1673
1259
        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
1260
        """
1678
 
        new_paths = self.new_paths(filesystem_only=True)
 
1261
        new_paths = self.new_paths()
1679
1262
        modified_paths = []
1680
 
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1681
 
                                 new_paths)
1682
1263
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1264
        completed_new = []
1683
1265
        try:
1684
1266
            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 errors.TransformRenameFailed, 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)):
 
1267
                new_entry = None
 
1268
                child_pb.update('adding file', num, len(new_paths))
 
1269
                if trans_id in self._new_contents or \
 
1270
                    self.path_changed(trans_id):
 
1271
                    full_path = self._tree.abspath(path)
 
1272
                    if trans_id in self._needs_rename:
 
1273
                        try:
 
1274
                            mover.rename(self._limbo_name(trans_id), full_path)
 
1275
                        except OSError, e:
 
1276
                            # We may be renaming a dangling inventory id
 
1277
                            if e.errno != errno.ENOENT:
 
1278
                                raise
 
1279
                        else:
 
1280
                            self.rename_count += 1
1699
1281
                    if trans_id in self._new_contents:
1700
1282
                        modified_paths.append(full_path)
 
1283
                        completed_new.append(trans_id)
 
1284
                file_id = self.final_file_id(trans_id)
 
1285
                if file_id is not None and (trans_id in self._new_id or
 
1286
                    trans_id in self._new_name or trans_id in self._new_parent
 
1287
                    or trans_id in self._new_executability):
 
1288
                    try:
 
1289
                        kind = self.final_kind(trans_id)
 
1290
                    except NoSuchFile:
 
1291
                        kind = self._tree.stored_kind(file_id)
 
1292
                    if trans_id in self._new_reference_revision:
 
1293
                        new_entry = inventory.TreeReference(
 
1294
                            self.final_file_id(trans_id),
 
1295
                            self._new_name[trans_id],
 
1296
                            self.final_file_id(self._new_parent[trans_id]),
 
1297
                            None, self._new_reference_revision[trans_id])
 
1298
                    else:
 
1299
                        new_entry = inventory.make_entry(kind,
 
1300
                            self.final_name(trans_id),
 
1301
                            self.final_file_id(self.final_parent(trans_id)),
 
1302
                            self.final_file_id(trans_id))
 
1303
                    try:
 
1304
                        old_path = self._tree.id2path(new_entry.file_id)
 
1305
                    except errors.NoSuchId:
 
1306
                        old_path = None
 
1307
                    inventory_delta.append((old_path, path, new_entry.file_id,
 
1308
                                            new_entry))
 
1309
 
1701
1310
                if trans_id in self._new_executability:
1702
 
                    self._set_executability(path, trans_id)
 
1311
                    self._set_executability(path, new_entry, trans_id)
1703
1312
        finally:
1704
1313
            child_pb.finished()
1705
 
        self._new_contents.clear()
 
1314
        for trans_id in completed_new:
 
1315
            del self._new_contents[trans_id]
1706
1316
        return modified_paths
1707
1317
 
1708
1318
 
1709
 
class TransformPreview(DiskTreeTransform):
 
1319
class TransformPreview(TreeTransformBase):
1710
1320
    """A TreeTransform for generating preview trees.
1711
1321
 
1712
1322
    Unlike TreeTransform, this version works when the input tree is a
1714
1324
    unversioned files in the input tree.
1715
1325
    """
1716
1326
 
1717
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1327
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1718
1328
        tree.lock_read()
1719
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1720
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1329
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1330
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1721
1331
 
1722
1332
    def canonical_path(self, path):
1723
1333
        return path
1745
1355
        except KeyError:
1746
1356
            return
1747
1357
        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:
 
1358
        for child in self._tree.inventory[file_id].children.iterkeys():
1753
1359
            childpath = joinpath(path, child)
1754
1360
            yield self.trans_id_tree_path(childpath)
1755
1361
 
1760
1366
    def __init__(self, transform):
1761
1367
        self._transform = transform
1762
1368
        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())
 
1369
 
 
1370
    def _changes(self, file_id):
 
1371
        for changes in self._transform.iter_changes():
 
1372
            if changes[0] == file_id:
 
1373
                return changes
1770
1374
 
1771
1375
    def _content_change(self, file_id):
1772
1376
        """Return True if the content of this file changed"""
1773
 
        changes = self._iter_changes_cache.get(file_id)
 
1377
        changes = self._changes(file_id)
1774
1378
        # changes[2] is true if the file content changed.  See
1775
1379
        # InterTree.iter_changes.
1776
1380
        return (changes is not None and changes[2])
1777
1381
 
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
1382
    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_lines(file_id))
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
 
1383
        return self._transform._tree._get_file_revision(file_id, vf,
 
1384
                                                        tree_revision)
1801
1385
 
1802
1386
    def _stat_limbo_file(self, file_id):
1803
1387
        trans_id = self._transform.trans_id_file_id(file_id)
1804
1388
        name = self._transform._limbo_name(trans_id)
1805
1389
        return os.lstat(name)
1806
1390
 
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
 
 
1826
1391
    def lock_read(self):
1827
1392
        # Perhaps in theory, this should lock the TreeTransform?
1828
 
        return self
 
1393
        pass
1829
1394
 
1830
1395
    def unlock(self):
1831
1396
        pass
1839
1404
        return self._transform.final_file_id(self._transform.root)
1840
1405
 
1841
1406
    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
 
1407
        return self._transform._tree.all_file_ids()
1847
1408
 
1848
1409
    def __iter__(self):
1849
1410
        return iter(self.all_file_ids())
1850
1411
 
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
 
1412
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1413
        """See Tree.paths2ids"""
 
1414
        to_find = set(specific_files)
 
1415
        result = set()
 
1416
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1417
             executable) in self._transform.iter_changes():
 
1418
            if paths[1] in to_find:
 
1419
                result.append(file_id)
 
1420
                to_find.remove(paths[1])
 
1421
        result.update(self._transform._tree.paths2ids(to_find,
 
1422
                      trees=[], require_versioned=require_versioned))
 
1423
        return result
1887
1424
 
1888
1425
    def path2id(self, path):
1889
 
        return self._transform.final_file_id(self._path2trans_id(path))
 
1426
        return self._transform._tree.path2id(path)
1890
1427
 
1891
1428
    def id2path(self, file_id):
1892
1429
        trans_id = self._transform.trans_id_file_id(file_id)
1895
1432
        except NoFinalPath:
1896
1433
            raise errors.NoSuchId(self, file_id)
1897
1434
 
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
 
1435
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1436
        return self._transform._tree.iter_entries_by_dir(specific_file_ids)
2002
1437
 
2003
1438
    def kind(self, file_id):
2004
1439
        trans_id = self._transform.trans_id_file_id(file_id)
2005
1440
        return self._transform.final_kind(trans_id)
2006
1441
 
2007
1442
    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)
 
1443
        return self._transform._tree.stored_kind(file_id)
2013
1444
 
2014
1445
    def get_file_mtime(self, file_id, path=None):
2015
1446
        """See Tree.get_file_mtime"""
2016
1447
        if not self._content_change(file_id):
2017
 
            return self._transform._tree.get_file_mtime(file_id)
 
1448
            return self._transform._tree.get_file_mtime(file_id, path)
2018
1449
        return self._stat_limbo_file(file_id).st_mtime
2019
1450
 
2020
 
    def _file_size(self, entry, stat_value):
2021
 
        return self.get_file_size(entry.file_id)
2022
 
 
2023
1451
    def get_file_size(self, file_id):
2024
1452
        """See Tree.get_file_size"""
2025
1453
        if self.kind(file_id) == 'file':
2028
1456
            return None
2029
1457
 
2030
1458
    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()
 
1459
        return self._transform._tree.get_file_sha1(file_id)
2041
1460
 
2042
1461
    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
 
1462
        return self._transform._tree.is_executable(file_id, path)
2057
1463
 
2058
1464
    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
 
1465
        return self._transform._tree.path_content_summary(path)
2087
1466
 
2088
1467
    def iter_changes(self, from_tree, include_unchanged=False,
2089
1468
                      specific_files=None, pb=None, extra_trees=None,
2090
1469
                      require_versioned=True, want_unversioned=False):
2091
1470
        """See InterTree.iter_changes.
2092
1471
 
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.
 
1472
        This implementation does not support include_unchanged, specific_files,
 
1473
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1474
        ignored.
2095
1475
        """
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)
 
1476
        if from_tree is not self._transform._tree:
 
1477
            raise ValueError('from_tree must be transform source tree.')
 
1478
        if include_unchanged:
 
1479
            raise ValueError('include_unchanged is not supported')
 
1480
        if specific_files is not None:
 
1481
            raise ValueError('specific_files is not supported')
2105
1482
        if want_unversioned:
2106
1483
            raise ValueError('want_unversioned is not supported')
2107
1484
        return self._transform.iter_changes()
2114
1491
        name = self._transform._limbo_name(trans_id)
2115
1492
        return open(name, 'rb')
2116
1493
 
2117
 
    def get_file_with_stat(self, file_id, path=None):
2118
 
        return self.get_file(file_id, path), None
 
1494
    def get_file_text(self, file_id):
 
1495
        text_file = self.get_file(file_id)
 
1496
        try:
 
1497
            return text_file.read()
 
1498
        finally:
 
1499
            text_file.close()
2119
1500
 
2120
1501
    def annotate_iter(self, file_id,
2121
1502
                      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)
 
1503
        return self._transform._tree.annotate_iter(file_id,
 
1504
            default_revision=default_revision)
2150
1505
 
2151
1506
    def get_symlink_target(self, file_id):
2152
1507
        """See Tree.get_symlink_target"""
2154
1509
            return self._transform._tree.get_symlink_target(file_id)
2155
1510
        trans_id = self._transform.trans_id_file_id(file_id)
2156
1511
        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))
 
1512
        return os.readlink(name)
 
1513
 
 
1514
    def list_files(self, include_root=False):
 
1515
        return self._transform._tree.list_files(include_root)
 
1516
 
 
1517
    def walkdirs(self, prefix=""):
 
1518
        return self._transform._tree.walkdirs(prefix)
2187
1519
 
2188
1520
    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
 
1521
        return self._transform._tree.get_parent_ids()
2193
1522
 
2194
1523
    def get_revision_tree(self, revision_id):
2195
1524
        return self._transform._tree.get_revision_tree(revision_id)
2215
1544
        self.transform = transform
2216
1545
 
2217
1546
    def _determine_path(self, trans_id):
2218
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1547
        if trans_id == self.transform.root:
2219
1548
            return ""
2220
1549
        name = self.transform.final_name(trans_id)
2221
1550
        parent_id = self.transform.final_parent(trans_id)
2230
1559
            self._known_paths[trans_id] = self._determine_path(trans_id)
2231
1560
        return self._known_paths[trans_id]
2232
1561
 
2233
 
    def get_paths(self, trans_ids):
2234
 
        return [(self.get_path(t), t) for t in trans_ids]
2235
 
 
2236
 
 
2237
1562
 
2238
1563
def topology_sorted_ids(tree):
2239
1564
    """Determine the topological order of the ids in a tree"""
2242
1567
    return file_ids
2243
1568
 
2244
1569
 
2245
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2246
 
               delta_from_tree=False):
 
1570
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
2247
1571
    """Create working tree for a branch, using a TreeTransform.
2248
 
 
 
1572
    
2249
1573
    This function should be used on empty trees, having a tree root at most.
2250
1574
    (see merge and revert functionality for working with existing trees)
2251
1575
 
2252
1576
    Existing files are handled like so:
2253
 
 
 
1577
    
2254
1578
    - Existing bzrdirs take precedence over creating new items.  They are
2255
1579
      created as '%s.diverted' % name.
2256
1580
    - Otherwise, if the content on disk matches the content we are building,
2265
1589
    :param hardlink: If true, hard-link files to accelerator_tree, where
2266
1590
        possible.  accelerator_tree must implement abspath, i.e. be a
2267
1591
        working tree.
2268
 
    :param delta_from_tree: If true, build_tree may use the input Tree to
2269
 
        generate the inventory delta.
2270
1592
    """
2271
1593
    wt.lock_tree_write()
2272
1594
    try:
2275
1597
            if accelerator_tree is not None:
2276
1598
                accelerator_tree.lock_read()
2277
1599
            try:
2278
 
                return _build_tree(tree, wt, accelerator_tree, hardlink,
2279
 
                                   delta_from_tree)
 
1600
                return _build_tree(tree, wt, accelerator_tree, hardlink)
2280
1601
            finally:
2281
1602
                if accelerator_tree is not None:
2282
1603
                    accelerator_tree.unlock()
2286
1607
        wt.unlock()
2287
1608
 
2288
1609
 
2289
 
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1610
def _build_tree(tree, wt, accelerator_tree, hardlink):
2290
1611
    """See build_tree."""
2291
1612
    for num, _unused in enumerate(wt.all_file_ids()):
2292
1613
        if num > 0:  # more than just a root
2315
1636
        try:
2316
1637
            deferred_contents = []
2317
1638
            num = 0
2318
 
            total = len(tree.inventory)
2319
 
            if delta_from_tree:
2320
 
                precomputed_delta = []
2321
 
            else:
2322
 
                precomputed_delta = None
2323
 
            # Check if tree inventory has content. If so, we populate
2324
 
            # existing_files with the directory content. If there are no
2325
 
            # entries we skip populating existing_files as its not used.
2326
 
            # This improves performance and unncessary work on large
2327
 
            # directory trees. (#501307)
2328
 
            if total > 0:
2329
 
                existing_files = set()
2330
 
                for dir, files in wt.walkdirs():
2331
 
                    existing_files.update(f[0] for f in files)
2332
1639
            for num, (tree_path, entry) in \
2333
1640
                enumerate(tree.inventory.iter_entries_by_dir()):
2334
 
                pb.update("Building tree", num - len(deferred_contents), total)
 
1641
                pb.update("Building tree", num - len(deferred_contents),
 
1642
                          len(tree.inventory))
2335
1643
                if entry.parent_id is None:
2336
1644
                    continue
2337
1645
                reparent = False
2338
1646
                file_id = entry.file_id
2339
 
                if delta_from_tree:
2340
 
                    precomputed_delta.append((None, tree_path, file_id, entry))
2341
 
                if tree_path in existing_files:
2342
 
                    target_path = wt.abspath(tree_path)
 
1647
                target_path = wt.abspath(tree_path)
 
1648
                try:
2343
1649
                    kind = file_kind(target_path)
 
1650
                except NoSuchFile:
 
1651
                    pass
 
1652
                else:
2344
1653
                    if kind == "directory":
2345
1654
                        try:
2346
1655
                            bzrdir.BzrDir.open(target_path)
2354
1663
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2355
1664
                        if kind == 'directory':
2356
1665
                            reparent = True
 
1666
                if entry.parent_id not in file_trans_id:
 
1667
                    raise AssertionError(
 
1668
                        'entry %s parent id %r is not in file_trans_id %r'
 
1669
                        % (entry, entry.parent_id, file_trans_id))
2357
1670
                parent_id = file_trans_id[entry.parent_id]
2358
1671
                if entry.kind == 'file':
2359
1672
                    # We *almost* replicate new_by_entry, so that we can defer
2360
1673
                    # getting the file text, and get them all at once.
2361
1674
                    trans_id = tt.create_path(entry.name, parent_id)
2362
1675
                    file_trans_id[file_id] = trans_id
2363
 
                    tt.version_file(file_id, trans_id)
2364
 
                    executable = tree.is_executable(file_id, tree_path)
2365
 
                    if executable:
 
1676
                    tt.version_file(entry.file_id, trans_id)
 
1677
                    executable = tree.is_executable(entry.file_id, tree_path)
 
1678
                    if executable is not None:
2366
1679
                        tt.set_executability(executable, trans_id)
2367
 
                    trans_data = (trans_id, tree_path)
2368
 
                    deferred_contents.append((file_id, trans_data))
 
1680
                    deferred_contents.append((entry.file_id, trans_id))
2369
1681
                else:
2370
1682
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2371
1683
                                                          tree)
2382
1694
        divert_trans = set(file_trans_id[f] for f in divert)
2383
1695
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2384
1696
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2385
 
        if len(raw_conflicts) > 0:
2386
 
            precomputed_delta = None
2387
1697
        conflicts = cook_conflicts(raw_conflicts, tt)
2388
1698
        for conflict in conflicts:
2389
1699
            warning(conflict)
2391
1701
            wt.add_conflicts(conflicts)
2392
1702
        except errors.UnsupportedOperation:
2393
1703
            pass
2394
 
        result = tt.apply(no_conflicts=True,
2395
 
                          precomputed_delta=precomputed_delta)
 
1704
        result = tt.apply(no_conflicts=True)
2396
1705
    finally:
2397
1706
        tt.finalize()
2398
1707
        top_pb.finished()
2402
1711
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2403
1712
                  hardlink):
2404
1713
    total = len(desired_files) + offset
2405
 
    wt = tt._tree
2406
1714
    if accelerator_tree is None:
2407
1715
        new_desired_files = desired_files
2408
1716
    else:
2409
1717
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2410
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2411
 
                     in iter if not (c or e[0] != e[1])]
2412
 
        if accelerator_tree.supports_content_filtering():
2413
 
            unchanged = [(f, p) for (f, p) in unchanged
2414
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2415
 
        unchanged = dict(unchanged)
 
1718
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1719
                         in iter if not (c or e[0] != e[1]))
2416
1720
        new_desired_files = []
2417
1721
        count = 0
2418
 
        for file_id, (trans_id, tree_path) in desired_files:
 
1722
        for file_id, trans_id in desired_files:
2419
1723
            accelerator_path = unchanged.get(file_id)
2420
1724
            if accelerator_path is None:
2421
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
1725
                new_desired_files.append((file_id, trans_id))
2422
1726
                continue
2423
1727
            pb.update('Adding file contents', count + offset, total)
2424
1728
            if hardlink:
2426
1730
                                   trans_id)
2427
1731
            else:
2428
1732
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2429
 
                if wt.supports_content_filtering():
2430
 
                    filters = wt._content_filter_stack(tree_path)
2431
 
                    contents = filtered_output_bytes(contents, filters,
2432
 
                        ContentFilterContext(tree_path, tree))
2433
1733
                try:
2434
1734
                    tt.create_file(contents, trans_id)
2435
1735
                finally:
2436
 
                    try:
2437
 
                        contents.close()
2438
 
                    except AttributeError:
2439
 
                        # after filtering, contents may no longer be file-like
2440
 
                        pass
 
1736
                    contents.close()
2441
1737
            count += 1
2442
1738
        offset += count
2443
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2444
 
            tree.iter_files_bytes(new_desired_files)):
2445
 
        if wt.supports_content_filtering():
2446
 
            filters = wt._content_filter_stack(tree_path)
2447
 
            contents = filtered_output_bytes(contents, filters,
2448
 
                ContentFilterContext(tree_path, tree))
 
1739
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1740
                                                 new_desired_files)):
2449
1741
        tt.create_file(contents, trans_id)
2450
1742
        pb.update('Adding file contents', count + offset, total)
2451
1743
 
2466
1758
    if entry.kind == "directory":
2467
1759
        return True
2468
1760
    if entry.kind == "file":
2469
 
        f = file(target_path, 'rb')
2470
 
        try:
2471
 
            if tree.get_file_text(file_id) == f.read():
2472
 
                return True
2473
 
        finally:
2474
 
            f.close()
 
1761
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1762
            return True
2475
1763
    elif entry.kind == "symlink":
2476
1764
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2477
1765
            return True
2482
1770
    new_conflicts = set()
2483
1771
    for c_type, conflict in ((c[0], c) for c in conflicts):
2484
1772
        # Anything but a 'duplicate' would indicate programmer error
2485
 
        if c_type != 'duplicate':
2486
 
            raise AssertionError(c_type)
 
1773
        assert c_type == 'duplicate', c_type
2487
1774
        # Now figure out which is new and which is old
2488
1775
        if tt.new_contents(conflict[1]):
2489
1776
            new_file = conflict[1]
2515
1802
    if kind == 'file':
2516
1803
        contents = tree.get_file(entry.file_id).readlines()
2517
1804
        executable = tree.is_executable(entry.file_id)
2518
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
1805
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2519
1806
                           executable)
2520
1807
    elif kind in ('directory', 'tree-reference'):
2521
1808
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2522
1809
        if kind == 'tree-reference':
2523
1810
            tt.set_tree_reference(entry.reference_revision, trans_id)
2524
 
        return trans_id
 
1811
        return trans_id 
2525
1812
    elif kind == 'symlink':
2526
1813
        target = tree.get_symlink_target(entry.file_id)
2527
1814
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2529
1816
        raise errors.BadFileKindError(name, kind)
2530
1817
 
2531
1818
 
2532
 
@deprecated_function(deprecated_in((1, 9, 0)))
2533
1819
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2534
 
    """Create new file contents according to an inventory entry.
2535
 
 
2536
 
    DEPRECATED.  Use create_from_tree instead.
2537
 
    """
 
1820
    """Create new file contents according to an inventory entry."""
2538
1821
    if entry.kind == "file":
2539
1822
        if lines is None:
2540
1823
            lines = tree.get_file(entry.file_id).readlines()
2545
1828
        tt.create_directory(trans_id)
2546
1829
 
2547
1830
 
2548
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2549
 
    filter_tree_path=None):
2550
 
    """Create new file contents according to tree contents.
2551
 
    
2552
 
    :param filter_tree_path: the tree path to use to lookup
2553
 
      content filters to apply to the bytes output in the working tree.
2554
 
      This only applies if the working tree supports content filtering.
2555
 
    """
2556
 
    kind = tree.kind(file_id)
2557
 
    if kind == 'directory':
2558
 
        tt.create_directory(trans_id)
2559
 
    elif kind == "file":
2560
 
        if bytes is None:
2561
 
            tree_file = tree.get_file(file_id)
2562
 
            try:
2563
 
                bytes = tree_file.readlines()
2564
 
            finally:
2565
 
                tree_file.close()
2566
 
        wt = tt._tree
2567
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2568
 
            filters = wt._content_filter_stack(filter_tree_path)
2569
 
            bytes = filtered_output_bytes(bytes, filters,
2570
 
                ContentFilterContext(filter_tree_path, tree))
2571
 
        tt.create_file(bytes, trans_id)
2572
 
    elif kind == "symlink":
2573
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2574
 
    else:
2575
 
        raise AssertionError('Unknown kind %r' % kind)
2576
 
 
2577
 
 
2578
1831
def create_entry_executability(tt, entry, trans_id):
2579
1832
    """Set the executability of a trans_id according to an inventory entry"""
2580
1833
    if entry.kind == "file":
2581
1834
        tt.set_executability(entry.executable, trans_id)
2582
1835
 
2583
1836
 
 
1837
@deprecated_function(zero_fifteen)
 
1838
def find_interesting(working_tree, target_tree, filenames):
 
1839
    """Find the ids corresponding to specified filenames.
 
1840
    
 
1841
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
 
1842
    """
 
1843
    working_tree.lock_read()
 
1844
    try:
 
1845
        target_tree.lock_read()
 
1846
        try:
 
1847
            return working_tree.paths2ids(filenames, [target_tree])
 
1848
        finally:
 
1849
            target_tree.unlock()
 
1850
    finally:
 
1851
        working_tree.unlock()
 
1852
 
 
1853
 
 
1854
@deprecated_function(zero_ninety)
 
1855
def change_entry(tt, file_id, working_tree, target_tree, 
 
1856
                 trans_id_file_id, backups, trans_id, by_parent):
 
1857
    """Replace a file_id's contents with those from a target tree."""
 
1858
    if file_id is None and target_tree is None:
 
1859
        # skip the logic altogether in the deprecation test
 
1860
        return
 
1861
    e_trans_id = trans_id_file_id(file_id)
 
1862
    entry = target_tree.inventory[file_id]
 
1863
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
 
1864
                                                           working_tree)
 
1865
    if contents_mod:
 
1866
        mode_id = e_trans_id
 
1867
        if has_contents:
 
1868
            if not backups:
 
1869
                tt.delete_contents(e_trans_id)
 
1870
            else:
 
1871
                parent_trans_id = trans_id_file_id(entry.parent_id)
 
1872
                backup_name = get_backup_name(entry, by_parent,
 
1873
                                              parent_trans_id, tt)
 
1874
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
 
1875
                tt.unversion_file(e_trans_id)
 
1876
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
 
1877
                tt.version_file(file_id, e_trans_id)
 
1878
                trans_id[file_id] = e_trans_id
 
1879
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
 
1880
        create_entry_executability(tt, entry, e_trans_id)
 
1881
 
 
1882
    elif meta_mod:
 
1883
        tt.set_executability(entry.executable, e_trans_id)
 
1884
    if tt.final_name(e_trans_id) != entry.name:
 
1885
        adjust_path  = True
 
1886
    else:
 
1887
        parent_id = tt.final_parent(e_trans_id)
 
1888
        parent_file_id = tt.final_file_id(parent_id)
 
1889
        if parent_file_id != entry.parent_id:
 
1890
            adjust_path = True
 
1891
        else:
 
1892
            adjust_path = False
 
1893
    if adjust_path:
 
1894
        parent_trans_id = trans_id_file_id(entry.parent_id)
 
1895
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
 
1896
 
 
1897
 
2584
1898
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2585
1899
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2586
1900
 
2617
1931
        if entry.kind != working_kind:
2618
1932
            contents_mod, meta_mod = True, False
2619
1933
        else:
2620
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
1934
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2621
1935
                                       working_tree)
2622
1936
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2623
1937
            cur_entry._forget_tree_state()
2625
1939
 
2626
1940
 
2627
1941
def revert(working_tree, target_tree, filenames, backups=False,
2628
 
           pb=None, change_reporter=None):
 
1942
           pb=DummyProgress(), change_reporter=None):
2629
1943
    """Revert a working tree's contents to those of a target tree."""
2630
1944
    target_tree.lock_read()
2631
 
    pb = ui.ui_factory.nested_progress_bar()
2632
1945
    tt = TreeTransform(working_tree, pb)
2633
1946
    try:
2634
1947
        pp = ProgressPhase("Revert phase", 3, pb)
2635
 
        conflicts, merge_modified = _prepare_revert_transform(
2636
 
            working_tree, target_tree, tt, filenames, backups, pp)
 
1948
        pp.next_phase()
 
1949
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1950
        try:
 
1951
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
1952
                                          child_pb, filenames, backups)
 
1953
        finally:
 
1954
            child_pb.finished()
 
1955
        pp.next_phase()
 
1956
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1957
        try:
 
1958
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
1959
                lambda t, c: conflict_pass(t, c, target_tree))
 
1960
        finally:
 
1961
            child_pb.finished()
 
1962
        conflicts = cook_conflicts(raw_conflicts, tt)
2637
1963
        if change_reporter:
2638
1964
            change_reporter = delta._ChangeReporter(
2639
1965
                unversioned_filter=working_tree.is_ignored)
2650
1976
    return conflicts
2651
1977
 
2652
1978
 
2653
 
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2654
 
                              backups, pp, basis_tree=None,
2655
 
                              merge_modified=None):
2656
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2657
 
    try:
2658
 
        if merge_modified is None:
2659
 
            merge_modified = working_tree.merge_modified()
2660
 
        merge_modified = _alter_files(working_tree, target_tree, tt,
2661
 
                                      child_pb, filenames, backups,
2662
 
                                      merge_modified, basis_tree)
2663
 
    finally:
2664
 
        child_pb.finished()
2665
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2666
 
    try:
2667
 
        raw_conflicts = resolve_conflicts(tt, child_pb,
2668
 
            lambda t, c: conflict_pass(t, c, target_tree))
2669
 
    finally:
2670
 
        child_pb.finished()
2671
 
    conflicts = cook_conflicts(raw_conflicts, tt)
2672
 
    return conflicts, merge_modified
2673
 
 
2674
 
 
2675
1979
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2676
 
                 backups, merge_modified, basis_tree=None):
2677
 
    if basis_tree is not None:
2678
 
        basis_tree.lock_read()
 
1980
                 backups):
 
1981
    merge_modified = working_tree.merge_modified()
2679
1982
    change_list = target_tree.iter_changes(working_tree,
2680
1983
        specific_files=specific_files, pb=pb)
2681
 
    if target_tree.get_root_id() is None:
 
1984
    if target_tree.inventory.root is None:
2682
1985
        skip_root = True
2683
1986
    else:
2684
1987
        skip_root = False
 
1988
    basis_tree = None
2685
1989
    try:
2686
1990
        deferred_files = []
2687
1991
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2723
2027
                        # contents
2724
2028
                        mode_id = trans_id
2725
2029
                        trans_id = new_trans_id
2726
 
                if kind[1] in ('directory', 'tree-reference'):
 
2030
                if kind[1] == 'directory':
2727
2031
                    tt.create_directory(trans_id)
2728
 
                    if kind[1] == 'tree-reference':
2729
 
                        revision = target_tree.get_reference_revision(file_id,
2730
 
                                                                      path[1])
2731
 
                        tt.set_tree_reference(revision, trans_id)
2732
2032
                elif kind[1] == 'symlink':
2733
2033
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2734
2034
                                      trans_id)
2748
2048
                    # preserve the execute bit when backing up
2749
2049
                    if keep_content and executable[0] == executable[1]:
2750
2050
                        tt.set_executability(executable[1], trans_id)
2751
 
                elif kind[1] is not None:
2752
 
                    raise AssertionError(kind[1])
 
2051
                else:
 
2052
                    assert kind[1] is None
2753
2053
            if versioned == (False, True):
2754
2054
                tt.version_file(file_id, trans_id)
2755
2055
            if versioned == (True, False):
2756
2056
                tt.unversion_file(trans_id)
2757
 
            if (name[1] is not None and
 
2057
            if (name[1] is not None and 
2758
2058
                (name[0] != name[1] or parent[0] != parent[1])):
2759
 
                if name[1] == '' and parent[1] is None:
2760
 
                    parent_trans = ROOT_PARENT
2761
 
                else:
2762
 
                    parent_trans = tt.trans_id_file_id(parent[1])
2763
 
                if parent[0] is None and versioned[0]:
2764
 
                    tt.adjust_root_path(name[1], parent_trans)
2765
 
                else:
2766
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
 
2059
                tt.adjust_path(
 
2060
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
2767
2061
            if executable[0] != executable[1] and kind[1] == "file":
2768
2062
                tt.set_executability(executable[1], trans_id)
2769
 
        if working_tree.supports_content_filtering():
2770
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2771
 
                target_tree.iter_files_bytes(deferred_files)):
2772
 
                file_id = deferred_files[index][0]
2773
 
                # We're reverting a tree to the target tree so using the
2774
 
                # target tree to find the file path seems the best choice
2775
 
                # here IMO - Ian C 27/Oct/2009
2776
 
                filter_tree_path = target_tree.id2path(file_id)
2777
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2778
 
                bytes = filtered_output_bytes(bytes, filters,
2779
 
                    ContentFilterContext(filter_tree_path, working_tree))
2780
 
                tt.create_file(bytes, trans_id, mode_id)
2781
 
        else:
2782
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2783
 
                deferred_files):
2784
 
                tt.create_file(bytes, trans_id, mode_id)
2785
 
        tt.fixup_new_roots()
 
2063
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2064
            deferred_files):
 
2065
            tt.create_file(bytes, trans_id, mode_id)
2786
2066
    finally:
2787
2067
        if basis_tree is not None:
2788
2068
            basis_tree.unlock()
2789
2069
    return merge_modified
2790
2070
 
2791
2071
 
2792
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2072
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2793
2073
    """Make many conflict-resolution attempts, but die if they fail"""
2794
2074
    if pass_func is None:
2795
2075
        pass_func = conflict_pass
2796
2076
    new_conflicts = set()
2797
 
    pb = ui.ui_factory.nested_progress_bar()
2798
2077
    try:
2799
2078
        for n in range(10):
2800
2079
            pb.update('Resolution pass', n+1, 10)
2804
2083
            new_conflicts.update(pass_func(tt, conflicts))
2805
2084
        raise MalformedTransform(conflicts=conflicts)
2806
2085
    finally:
2807
 
        pb.finished()
 
2086
        pb.clear()
2808
2087
 
2809
2088
 
2810
2089
def conflict_pass(tt, conflicts, path_tree=None):
2829
2108
                existing_file, new_file = conflict[1], conflict[2]
2830
2109
            new_name = tt.final_name(existing_file)+'.moved'
2831
2110
            tt.adjust_path(new_name, final_parent, existing_file)
2832
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2111
            new_conflicts.add((c_type, 'Moved existing file to', 
2833
2112
                               existing_file, new_file))
2834
2113
        elif c_type == 'parent loop':
2835
2114
            # break the loop by undoing one of the ops that caused the loop
2839
2118
            new_conflicts.add((c_type, 'Cancelled move', cur,
2840
2119
                               tt.final_parent(cur),))
2841
2120
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2842
 
 
 
2121
            
2843
2122
        elif c_type == 'missing parent':
2844
2123
            trans_id = conflict[1]
2845
2124
            try:
2846
2125
                tt.cancel_deletion(trans_id)
2847
 
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2126
                new_conflicts.add(('deleting parent', 'Not deleting', 
2848
2127
                                   trans_id))
2849
2128
            except KeyError:
2850
2129
                create = True
2859
2138
                        # special-case the other tree root (move its
2860
2139
                        # children to current root)
2861
2140
                        if entry.parent_id is None:
2862
 
                            create = False
 
2141
                            create=False
2863
2142
                            moved = _reparent_transform_children(
2864
2143
                                tt, trans_id, tt.root)
2865
2144
                            for child in moved:
2892
2171
            if parent_file_id is not None:
2893
2172
                tt.unversion_file(parent_id)
2894
2173
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
2895
 
        elif c_type == 'versioning no contents':
2896
 
            tt.cancel_versioning(conflict[1])
2897
2174
    return new_conflicts
2898
2175
 
2899
2176
 
2915
2192
        if len(conflict) == 3:
2916
2193
            yield Conflict.factory(c_type, action=action, path=modified_path,
2917
2194
                                     file_id=modified_id)
2918
 
 
 
2195
             
2919
2196
        else:
2920
2197
            conflicting_path = fp.get_path(conflict[3])
2921
2198
            conflicting_id = tt.final_file_id(conflict[3])
2922
2199
            yield Conflict.factory(c_type, action=action, path=modified_path,
2923
 
                                   file_id=modified_id,
 
2200
                                   file_id=modified_id, 
2924
2201
                                   conflict_path=conflicting_path,
2925
2202
                                   conflict_file_id=conflicting_id)
2926
2203
 
2933
2210
        self.pending_deletions = []
2934
2211
 
2935
2212
    def rename(self, from_, to):
2936
 
        """Rename a file from one path to another."""
 
2213
        """Rename a file from one path to another.  Functions like os.rename"""
2937
2214
        try:
2938
 
            osutils.rename(from_, to)
2939
 
        except (IOError, OSError), e:
 
2215
            os.rename(from_, to)
 
2216
        except OSError, e:
2940
2217
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2941
2218
                raise errors.FileExists(to, str(e))
2942
 
            # normal OSError doesn't include filenames so it's hard to see where
2943
 
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
2944
 
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
 
2219
            raise
2945
2220
        self.past_renames.append((from_, to))
2946
2221
 
2947
2222
    def pre_delete(self, from_, to):
2957
2232
    def rollback(self):
2958
2233
        """Reverse all renames that have been performed"""
2959
2234
        for from_, to in reversed(self.past_renames):
2960
 
            try:
2961
 
                osutils.rename(to, from_)
2962
 
            except (OSError, IOError), e:
2963
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)                
 
2235
            os.rename(to, from_)
2964
2236
        # after rollback, don't reuse _FileMover
2965
2237
        past_renames = None
2966
2238
        pending_deletions = None