← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 14:01:20 UTC
  • mfrom: (3280.2.5 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080316140120-i3yq8yr1l66m11h7
Start 1.4 development

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