/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-23 19:18:42 UTC
  • mfrom: (3723.1.1 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080923191842-0hfq8zykwwm1oo9k
(jam) Merge bzr 1.7-final into bzr.dev

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
19
from stat import S_ISREG, S_IEXEC
20
 
import time
21
20
 
22
21
from bzrlib.lazy_import import lazy_import
23
22
lazy_import(globals(), """
24
23
from bzrlib import (
25
24
    annotate,
26
 
    bencode,
27
25
    bzrdir,
28
 
    commit,
29
26
    delta,
30
27
    errors,
31
28
    inventory,
32
 
    multiparent,
33
29
    osutils,
34
30
    revision as _mod_revision,
35
 
    ui,
36
31
    )
37
32
""")
38
33
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
39
 
                           ReusingTransform, CantMoveRoot,
 
34
                           ReusingTransform, NotVersionedError, CantMoveRoot,
40
35
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
41
36
                           UnableCreateSymlink)
42
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
43
37
from bzrlib.inventory import InventoryEntry
44
38
from bzrlib.osutils import (
45
39
    delete_any,
47
41
    has_symlinks,
48
42
    lexists,
49
43
    pathjoin,
50
 
    sha_file,
51
44
    splitpath,
52
45
    supports_executable,
53
46
)
54
 
from bzrlib.progress import ProgressPhase
 
47
from bzrlib.progress import DummyProgress, ProgressPhase
55
48
from bzrlib.symbol_versioning import (
56
49
        deprecated_function,
57
 
        deprecated_in,
58
50
        )
59
51
from bzrlib.trace import mutter, warning
60
52
from bzrlib import tree
79
71
 
80
72
 
81
73
class TreeTransformBase(object):
82
 
    """The base class for TreeTransform and its kin."""
 
74
    """The base class for TreeTransform and TreeTransformBase"""
83
75
 
84
 
    def __init__(self, tree, pb=None,
 
76
    def __init__(self, tree, limbodir, pb=DummyProgress(),
85
77
                 case_sensitive=True):
86
78
        """Constructor.
87
79
 
88
80
        :param tree: The tree that will be transformed, but not necessarily
89
81
            the output tree.
90
 
        :param pb: ignored
 
82
        :param limbodir: A directory where new files can be stored until
 
83
            they are installed in their proper places
 
84
        :param pb: A ProgressBar indicating how much progress is being made
91
85
        :param case_sensitive: If True, the target of the transform is
92
86
            case sensitive, not just case preserving.
93
87
        """
94
88
        object.__init__(self)
95
89
        self._tree = tree
 
90
        self._limbodir = limbodir
 
91
        self._deletiondir = None
96
92
        self._id_number = 0
97
93
        # mapping of trans_id -> new basename
98
94
        self._new_name = {}
100
96
        self._new_parent = {}
101
97
        # mapping of trans_id with new contents -> new file_kind
102
98
        self._new_contents = {}
 
99
        # A mapping of transform ids to their limbo filename
 
100
        self._limbo_files = {}
 
101
        # A mapping of transform ids to a set of the transform ids of children
 
102
        # that their limbo directory has
 
103
        self._limbo_children = {}
 
104
        # Map transform ids to maps of child filename to child transform id
 
105
        self._limbo_children_names = {}
 
106
        # List of transform ids that need to be renamed from limbo into place
 
107
        self._needs_rename = set()
103
108
        # Set of trans_ids whose contents will be removed
104
109
        self._removed_contents = set()
105
110
        # Mapping of trans_id -> new execute-bit value
112
117
        self._non_present_ids = {}
113
118
        # Mapping of new file_id -> trans_id
114
119
        self._r_new_id = {}
115
 
        # Set of trans_ids that will be removed
 
120
        # Set of file_ids that will be removed
116
121
        self._removed_id = set()
117
122
        # Mapping of path in old tree -> trans_id
118
123
        self._tree_path_ids = {}
119
124
        # Mapping trans_id -> path in old tree
120
125
        self._tree_id_paths = {}
 
126
        # Cache of realpath results, to speed up canonical_path
 
127
        self._realpaths = {}
 
128
        # Cache of relpath results, to speed up canonical_path
 
129
        self._relpaths = {}
121
130
        # The trans_id that will be used as the tree root
122
131
        root_id = tree.get_root_id()
123
132
        if root_id is not None:
133
142
        # A counter of how many files have been renamed
134
143
        self.rename_count = 0
135
144
 
136
 
    def finalize(self):
137
 
        """Release the working tree lock, if held.
138
 
 
139
 
        This is required if apply has not been invoked, but can be invoked
140
 
        even after apply.
141
 
        """
142
 
        if self._tree is None:
143
 
            return
144
 
        self._tree.unlock()
145
 
        self._tree = None
146
 
 
147
145
    def __get_root(self):
148
146
        return self._new_root
149
147
 
150
148
    root = property(__get_root)
151
149
 
 
150
    def finalize(self):
 
151
        """Release the working tree lock, if held, clean up limbo dir.
 
152
 
 
153
        This is required if apply has not been invoked, but can be invoked
 
154
        even after apply.
 
155
        """
 
156
        if self._tree is None:
 
157
            return
 
158
        try:
 
159
            entries = [(self._limbo_name(t), t, k) for t, k in
 
160
                       self._new_contents.iteritems()]
 
161
            entries.sort(reverse=True)
 
162
            for path, trans_id, kind in entries:
 
163
                if kind == "directory":
 
164
                    os.rmdir(path)
 
165
                else:
 
166
                    os.unlink(path)
 
167
            try:
 
168
                os.rmdir(self._limbodir)
 
169
            except OSError:
 
170
                # We don't especially care *why* the dir is immortal.
 
171
                raise ImmortalLimbo(self._limbodir)
 
172
            try:
 
173
                if self._deletiondir is not None:
 
174
                    os.rmdir(self._deletiondir)
 
175
            except OSError:
 
176
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
177
        finally:
 
178
            self._tree.unlock()
 
179
            self._tree = None
 
180
 
152
181
    def _assign_id(self):
153
182
        """Produce a new tranform id"""
154
183
        new_id = "new-%s" % self._id_number
164
193
 
165
194
    def adjust_path(self, name, parent, trans_id):
166
195
        """Change the path that is assigned to a transaction id."""
167
 
        if parent is None:
168
 
            raise ValueError("Parent trans-id may not be None")
169
196
        if trans_id == self._new_root:
170
197
            raise CantMoveRoot
 
198
        previous_parent = self._new_parent.get(trans_id)
 
199
        previous_name = self._new_name.get(trans_id)
171
200
        self._new_name[trans_id] = name
172
201
        self._new_parent[trans_id] = parent
 
202
        if parent == ROOT_PARENT:
 
203
            if self._new_root is not None:
 
204
                raise ValueError("Cannot have multiple roots.")
 
205
            self._new_root = trans_id
 
206
        if (trans_id in self._limbo_files and
 
207
            trans_id not in self._needs_rename):
 
208
            self._rename_in_limbo([trans_id])
 
209
            self._limbo_children[previous_parent].remove(trans_id)
 
210
            del self._limbo_children_names[previous_parent][previous_name]
 
211
 
 
212
    def _rename_in_limbo(self, trans_ids):
 
213
        """Fix limbo names so that the right final path is produced.
 
214
 
 
215
        This means we outsmarted ourselves-- we tried to avoid renaming
 
216
        these files later by creating them with their final names in their
 
217
        final parents.  But now the previous name or parent is no longer
 
218
        suitable, so we have to rename them.
 
219
 
 
220
        Even for trans_ids that have no new contents, we must remove their
 
221
        entries from _limbo_files, because they are now stale.
 
222
        """
 
223
        for trans_id in trans_ids:
 
224
            old_path = self._limbo_files.pop(trans_id)
 
225
            if trans_id not in self._new_contents:
 
226
                continue
 
227
            new_path = self._limbo_name(trans_id)
 
228
            os.rename(old_path, new_path)
173
229
 
174
230
    def adjust_root_path(self, name, parent):
175
231
        """Emulate moving the root by moving all children, instead.
176
 
 
 
232
        
177
233
        We do this by undoing the association of root's transaction id with the
178
234
        current tree.  This allows us to create a new directory with that
179
 
        transaction id.  We unversion the root directory and version the
 
235
        transaction id.  We unversion the root directory and version the 
180
236
        physically new directory, and hope someone versions the tree root
181
237
        later.
182
238
        """
185
241
        # force moving all children of root
186
242
        for child_id in self.iter_tree_children(old_root):
187
243
            if child_id != parent:
188
 
                self.adjust_path(self.final_name(child_id),
 
244
                self.adjust_path(self.final_name(child_id), 
189
245
                                 self.final_parent(child_id), child_id)
190
246
            file_id = self.final_file_id(child_id)
191
247
            if file_id is not None:
192
248
                self.unversion_file(child_id)
193
249
            self.version_file(file_id, child_id)
194
 
 
 
250
        
195
251
        # the physical root needs a new transaction id
196
252
        self._tree_path_ids.pop("")
197
253
        self._tree_id_paths.pop(old_root)
203
259
        self.version_file(old_root_file_id, old_root)
204
260
        self.unversion_file(self._new_root)
205
261
 
206
 
    def fixup_new_roots(self):
207
 
        """Reinterpret requests to change the root directory
208
 
 
209
 
        Instead of creating a root directory, or moving an existing directory,
210
 
        all the attributes and children of the new root are applied to the
211
 
        existing root directory.
212
 
 
213
 
        This means that the old root trans-id becomes obsolete, so it is
214
 
        recommended only to invoke this after the root trans-id has become
215
 
        irrelevant.
216
 
        """
217
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
218
 
                     ROOT_PARENT]
219
 
        if len(new_roots) < 1:
220
 
            return
221
 
        if len(new_roots) != 1:
222
 
            raise ValueError('A tree cannot have two roots!')
223
 
        if self._new_root is None:
224
 
            self._new_root = new_roots[0]
225
 
            return
226
 
        old_new_root = new_roots[0]
227
 
        # TODO: What to do if a old_new_root is present, but self._new_root is
228
 
        #       not listed as being removed? This code explicitly unversions
229
 
        #       the old root and versions it with the new file_id. Though that
230
 
        #       seems like an incomplete delta
231
 
 
232
 
        # unversion the new root's directory.
233
 
        file_id = self.final_file_id(old_new_root)
234
 
        if old_new_root in self._new_id:
235
 
            self.cancel_versioning(old_new_root)
236
 
        else:
237
 
            self.unversion_file(old_new_root)
238
 
        # if, at this stage, root still has an old file_id, zap it so we can
239
 
        # stick a new one in.
240
 
        if (self.tree_file_id(self._new_root) is not None and
241
 
            self._new_root not in self._removed_id):
242
 
            self.unversion_file(self._new_root)
243
 
        self.version_file(file_id, self._new_root)
244
 
 
245
 
        # Now move children of new root into old root directory.
246
 
        # Ensure all children are registered with the transaction, but don't
247
 
        # use directly-- some tree children have new parents
248
 
        list(self.iter_tree_children(old_new_root))
249
 
        # Move all children of new root into old root directory.
250
 
        for child in self.by_parent().get(old_new_root, []):
251
 
            self.adjust_path(self.final_name(child), self._new_root, child)
252
 
 
253
 
        # Ensure old_new_root has no directory.
254
 
        if old_new_root in self._new_contents:
255
 
            self.cancel_creation(old_new_root)
256
 
        else:
257
 
            self.delete_contents(old_new_root)
258
 
 
259
 
        # prevent deletion of root directory.
260
 
        if self._new_root in self._removed_contents:
261
 
            self.cancel_deletion(self._new_root)
262
 
 
263
 
        # destroy path info for old_new_root.
264
 
        del self._new_parent[old_new_root]
265
 
        del self._new_name[old_new_root]
266
 
 
267
262
    def trans_id_tree_file_id(self, inventory_id):
268
263
        """Determine the transaction id of a working tree file.
269
 
 
 
264
        
270
265
        This reflects only files that already exist, not ones that will be
271
266
        added by transactions.
272
267
        """
285
280
            raise ValueError('None is not a valid file id')
286
281
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
287
282
            return self._r_new_id[file_id]
288
 
        else:
289
 
            try:
290
 
                self._tree.iter_entries_by_dir([file_id]).next()
291
 
            except StopIteration:
292
 
                if file_id in self._non_present_ids:
293
 
                    return self._non_present_ids[file_id]
294
 
                else:
295
 
                    trans_id = self._assign_id()
296
 
                    self._non_present_ids[file_id] = trans_id
297
 
                    return trans_id
298
 
            else:
299
 
                return self.trans_id_tree_file_id(file_id)
 
283
        elif file_id in self._tree.inventory:
 
284
            return self.trans_id_tree_file_id(file_id)
 
285
        elif file_id in self._non_present_ids:
 
286
            return self._non_present_ids[file_id]
 
287
        else:
 
288
            trans_id = self._assign_id()
 
289
            self._non_present_ids[file_id] = trans_id
 
290
            return trans_id
 
291
 
 
292
    def canonical_path(self, path):
 
293
        """Get the canonical tree-relative path"""
 
294
        # don't follow final symlinks
 
295
        abs = self._tree.abspath(path)
 
296
        if abs in self._relpaths:
 
297
            return self._relpaths[abs]
 
298
        dirname, basename = os.path.split(abs)
 
299
        if dirname not in self._realpaths:
 
300
            self._realpaths[dirname] = os.path.realpath(dirname)
 
301
        dirname = self._realpaths[dirname]
 
302
        abs = pathjoin(dirname, basename)
 
303
        if dirname in self._relpaths:
 
304
            relpath = pathjoin(self._relpaths[dirname], basename)
 
305
            relpath = relpath.rstrip('/\\')
 
306
        else:
 
307
            relpath = self._tree.relpath(abs)
 
308
        self._relpaths[abs] = relpath
 
309
        return relpath
300
310
 
301
311
    def trans_id_tree_path(self, path):
302
312
        """Determine (and maybe set) the transaction ID for a tree path."""
313
323
            return ROOT_PARENT
314
324
        return self.trans_id_tree_path(os.path.dirname(path))
315
325
 
 
326
    def create_file(self, contents, trans_id, mode_id=None):
 
327
        """Schedule creation of a new file.
 
328
 
 
329
        See also new_file.
 
330
        
 
331
        Contents is an iterator of strings, all of which will be written
 
332
        to the target destination.
 
333
 
 
334
        New file takes the permissions of any existing file with that id,
 
335
        unless mode_id is specified.
 
336
        """
 
337
        name = self._limbo_name(trans_id)
 
338
        f = open(name, 'wb')
 
339
        try:
 
340
            try:
 
341
                unique_add(self._new_contents, trans_id, 'file')
 
342
            except:
 
343
                # Clean up the file, it never got registered so
 
344
                # TreeTransform.finalize() won't clean it up.
 
345
                f.close()
 
346
                os.unlink(name)
 
347
                raise
 
348
 
 
349
            f.writelines(contents)
 
350
        finally:
 
351
            f.close()
 
352
        self._set_mode(trans_id, mode_id, S_ISREG)
 
353
 
 
354
    def _set_mode(self, trans_id, mode_id, typefunc):
 
355
        """Set the mode of new file contents.
 
356
        The mode_id is the existing file to get the mode from (often the same
 
357
        as trans_id).  The operation is only performed if there's a mode match
 
358
        according to typefunc.
 
359
        """
 
360
        if mode_id is None:
 
361
            mode_id = trans_id
 
362
        try:
 
363
            old_path = self._tree_id_paths[mode_id]
 
364
        except KeyError:
 
365
            return
 
366
        try:
 
367
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
368
        except OSError, e:
 
369
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
370
                # Either old_path doesn't exist, or the parent of the
 
371
                # target is not a directory (but will be one eventually)
 
372
                # Either way, we know it doesn't exist *right now*
 
373
                # See also bug #248448
 
374
                return
 
375
            else:
 
376
                raise
 
377
        if typefunc(mode):
 
378
            os.chmod(self._limbo_name(trans_id), mode)
 
379
 
 
380
    def create_hardlink(self, path, trans_id):
 
381
        """Schedule creation of a hard link"""
 
382
        name = self._limbo_name(trans_id)
 
383
        try:
 
384
            os.link(path, name)
 
385
        except OSError, e:
 
386
            if e.errno != errno.EPERM:
 
387
                raise
 
388
            raise errors.HardLinkNotSupported(path)
 
389
        try:
 
390
            unique_add(self._new_contents, trans_id, 'file')
 
391
        except:
 
392
            # Clean up the file, it never got registered so
 
393
            # TreeTransform.finalize() won't clean it up.
 
394
            os.unlink(name)
 
395
            raise
 
396
 
 
397
    def create_directory(self, trans_id):
 
398
        """Schedule creation of a new directory.
 
399
        
 
400
        See also new_directory.
 
401
        """
 
402
        os.mkdir(self._limbo_name(trans_id))
 
403
        unique_add(self._new_contents, trans_id, 'directory')
 
404
 
 
405
    def create_symlink(self, target, trans_id):
 
406
        """Schedule creation of a new symbolic link.
 
407
 
 
408
        target is a bytestring.
 
409
        See also new_symlink.
 
410
        """
 
411
        if has_symlinks():
 
412
            os.symlink(target, self._limbo_name(trans_id))
 
413
            unique_add(self._new_contents, trans_id, 'symlink')
 
414
        else:
 
415
            try:
 
416
                path = FinalPaths(self).get_path(trans_id)
 
417
            except KeyError:
 
418
                path = None
 
419
            raise UnableCreateSymlink(path=path)
 
420
 
 
421
    def cancel_creation(self, trans_id):
 
422
        """Cancel the creation of new file contents."""
 
423
        del self._new_contents[trans_id]
 
424
        children = self._limbo_children.get(trans_id)
 
425
        # if this is a limbo directory with children, move them before removing
 
426
        # the directory
 
427
        if children is not None:
 
428
            self._rename_in_limbo(children)
 
429
            del self._limbo_children[trans_id]
 
430
            del self._limbo_children_names[trans_id]
 
431
        delete_any(self._limbo_name(trans_id))
 
432
 
316
433
    def delete_contents(self, trans_id):
317
434
        """Schedule the contents of a path entry for deletion"""
318
 
        # Ensure that the object exists in the WorkingTree, this will raise an
319
 
        # exception if there is a problem
320
435
        self.tree_kind(trans_id)
321
436
        self._removed_contents.add(trans_id)
322
437
 
394
509
        new_ids.update(changed_kind)
395
510
        return sorted(FinalPaths(self).get_paths(new_ids))
396
511
 
 
512
    def tree_kind(self, trans_id):
 
513
        """Determine the file kind in the working tree.
 
514
 
 
515
        Raises NoSuchFile if the file does not exist
 
516
        """
 
517
        path = self._tree_id_paths.get(trans_id)
 
518
        if path is None:
 
519
            raise NoSuchFile(None)
 
520
        try:
 
521
            return file_kind(self._tree.abspath(path))
 
522
        except OSError, e:
 
523
            if e.errno != errno.ENOENT:
 
524
                raise
 
525
            else:
 
526
                raise NoSuchFile(path)
 
527
 
397
528
    def final_kind(self, trans_id):
398
529
        """Determine the final file kind, after any changes applied.
399
 
 
 
530
        
400
531
        Raises NoSuchFile if the file does not exist/has no contents.
401
532
        (It is conceivable that a path would be created without the
402
533
        corresponding contents insertion command)
418
549
        # the file is old; the old id is still valid
419
550
        if self._new_root == trans_id:
420
551
            return self._tree.get_root_id()
421
 
        return self._tree.path2id(path)
 
552
        return self._tree.inventory.path2id(path)
422
553
 
423
554
    def final_file_id(self, trans_id):
424
555
        """Determine the file id after any changes are applied, or None.
425
 
 
 
556
        
426
557
        None indicates that the file will not be versioned after changes are
427
558
        applied.
428
559
        """
467
598
 
468
599
    def by_parent(self):
469
600
        """Return a map of parent: children for known parents.
470
 
 
 
601
        
471
602
        Only new paths and parents of tree files with assigned ids are used.
472
603
        """
473
604
        by_parent = {}
474
605
        items = list(self._new_parent.iteritems())
475
 
        items.extend((t, self.final_parent(t)) for t in
 
606
        items.extend((t, self.final_parent(t)) for t in 
476
607
                      self._tree_id_paths.keys())
477
608
        for trans_id, parent_id in items:
478
609
            if parent_id not in by_parent:
506
637
        conflicts.extend(self._overwrite_conflicts())
507
638
        return conflicts
508
639
 
509
 
    def _check_malformed(self):
510
 
        conflicts = self.find_conflicts()
511
 
        if len(conflicts) != 0:
512
 
            raise MalformedTransform(conflicts=conflicts)
513
 
 
514
640
    def _add_tree_children(self):
515
641
        """Add all the children of all active parents to the known paths.
516
642
 
518
644
        removed.  This is a necessary first step in detecting conflicts.
519
645
        """
520
646
        parents = self.by_parent().keys()
521
 
        parents.extend([t for t in self._removed_contents if
 
647
        parents.extend([t for t in self._removed_contents if 
522
648
                        self.tree_kind(t) == 'directory'])
523
649
        for trans_id in self._removed_id:
524
650
            file_id = self.tree_file_id(trans_id)
532
658
            # ensure that all children are registered with the transaction
533
659
            list(self.iter_tree_children(parent_id))
534
660
 
 
661
    def iter_tree_children(self, parent_id):
 
662
        """Iterate through the entry's tree children, if any"""
 
663
        try:
 
664
            path = self._tree_id_paths[parent_id]
 
665
        except KeyError:
 
666
            return
 
667
        try:
 
668
            children = os.listdir(self._tree.abspath(path))
 
669
        except OSError, e:
 
670
            if not (osutils._is_error_enotdir(e)
 
671
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
672
                raise
 
673
            return
 
674
 
 
675
        for child in children:
 
676
            childpath = joinpath(path, child)
 
677
            if self._tree.is_control_filename(childpath):
 
678
                continue
 
679
            yield self.trans_id_tree_path(childpath)
 
680
 
535
681
    def has_named_child(self, by_parent, parent_id, name):
536
682
        try:
537
683
            children = by_parent[parent_id]
591
737
 
592
738
    def _improper_versioning(self):
593
739
        """Cannot version a file with no contents, or a bad type.
594
 
 
 
740
        
595
741
        However, existing entries with no contents are okay.
596
742
        """
597
743
        conflicts = []
607
753
 
608
754
    def _executability_conflicts(self):
609
755
        """Check for bad executability changes.
610
 
 
 
756
        
611
757
        Only versioned files may have their executability set, because
612
758
        1. only versioned entries can have executability under windows
613
759
        2. only files can be executable.  (The execute bit on a directory
712
858
            return True
713
859
        return False
714
860
 
 
861
    def _limbo_name(self, trans_id):
 
862
        """Generate the limbo name of a file"""
 
863
        limbo_name = self._limbo_files.get(trans_id)
 
864
        if limbo_name is not None:
 
865
            return limbo_name
 
866
        parent = self._new_parent.get(trans_id)
 
867
        # if the parent directory is already in limbo (e.g. when building a
 
868
        # tree), choose a limbo name inside the parent, to reduce further
 
869
        # renames.
 
870
        use_direct_path = False
 
871
        if self._new_contents.get(parent) == 'directory':
 
872
            filename = self._new_name.get(trans_id)
 
873
            if filename is not None:
 
874
                if parent not in self._limbo_children:
 
875
                    self._limbo_children[parent] = set()
 
876
                    self._limbo_children_names[parent] = {}
 
877
                    use_direct_path = True
 
878
                # the direct path can only be used if no other file has
 
879
                # already taken this pathname, i.e. if the name is unused, or
 
880
                # if it is already associated with this trans_id.
 
881
                elif self._case_sensitive_target:
 
882
                    if (self._limbo_children_names[parent].get(filename)
 
883
                        in (trans_id, None)):
 
884
                        use_direct_path = True
 
885
                else:
 
886
                    for l_filename, l_trans_id in\
 
887
                        self._limbo_children_names[parent].iteritems():
 
888
                        if l_trans_id == trans_id:
 
889
                            continue
 
890
                        if l_filename.lower() == filename.lower():
 
891
                            break
 
892
                    else:
 
893
                        use_direct_path = True
 
894
 
 
895
        if use_direct_path:
 
896
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
897
            self._limbo_children[parent].add(trans_id)
 
898
            self._limbo_children_names[parent][filename] = trans_id
 
899
        else:
 
900
            limbo_name = pathjoin(self._limbodir, trans_id)
 
901
            self._needs_rename.add(trans_id)
 
902
        self._limbo_files[trans_id] = limbo_name
 
903
        return limbo_name
 
904
 
715
905
    def _set_executability(self, path, trans_id):
716
906
        """Set the executability of versioned files """
717
907
        if supports_executable():
738
928
            self.version_file(file_id, trans_id)
739
929
        return trans_id
740
930
 
741
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
931
    def new_file(self, name, parent_id, contents, file_id=None, 
742
932
                 executable=None):
743
933
        """Convenience method to create files.
744
 
 
 
934
        
745
935
        name is the name of the file to create.
746
936
        parent_id is the transaction id of the parent directory of the file.
747
937
        contents is an iterator of bytestrings, which will be used to produce
767
957
        """
768
958
        trans_id = self._new_entry(name, parent_id, file_id)
769
959
        self.create_directory(trans_id)
770
 
        return trans_id
 
960
        return trans_id 
771
961
 
772
962
    def new_symlink(self, name, parent_id, target, file_id=None):
773
963
        """Convenience method to create symbolic link.
774
 
 
 
964
        
775
965
        name is the name of the symlink to create.
776
966
        parent_id is the transaction id of the parent directory of the symlink.
777
967
        target is a bytestring of the target of the symlink.
816
1006
        from_path = self._tree_id_paths.get(from_trans_id)
817
1007
        if from_versioned:
818
1008
            # get data from working tree if versioned
819
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1009
            from_entry = self._tree.inventory[file_id]
820
1010
            from_name = from_entry.name
821
1011
            from_parent = from_entry.parent_id
822
1012
        else:
923
1113
    def get_preview_tree(self):
924
1114
        """Return a tree representing the result of the transform.
925
1115
 
926
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
927
 
        it.
 
1116
        This tree only supports the subset of Tree functionality required
 
1117
        by show_diff_trees.  It must only be compared to tt._tree.
928
1118
        """
929
1119
        return _PreviewTree(self)
930
1120
 
931
 
    def commit(self, branch, message, merge_parents=None, strict=False,
932
 
               timestamp=None, timezone=None, committer=None, authors=None,
933
 
               revprops=None, revision_id=None):
934
 
        """Commit the result of this TreeTransform to a branch.
935
 
 
936
 
        :param branch: The branch to commit to.
937
 
        :param message: The message to attach to the commit.
938
 
        :param merge_parents: Additional parent revision-ids specified by
939
 
            pending merges.
940
 
        :param strict: If True, abort the commit if there are unversioned
941
 
            files.
942
 
        :param timestamp: if not None, seconds-since-epoch for the time and
943
 
            date.  (May be a float.)
944
 
        :param timezone: Optional timezone for timestamp, as an offset in
945
 
            seconds.
946
 
        :param committer: Optional committer in email-id format.
947
 
            (e.g. "J Random Hacker <jrandom@example.com>")
948
 
        :param authors: Optional list of authors in email-id format.
949
 
        :param revprops: Optional dictionary of revision properties.
950
 
        :param revision_id: Optional revision id.  (Specifying a revision-id
951
 
            may reduce performance for some non-native formats.)
952
 
        :return: The revision_id of the revision committed.
953
 
        """
954
 
        self._check_malformed()
955
 
        if strict:
956
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
957
 
            for trans_id in unversioned:
958
 
                if self.final_file_id(trans_id) is None:
959
 
                    raise errors.StrictCommitFailed()
960
 
 
961
 
        revno, last_rev_id = branch.last_revision_info()
962
 
        if last_rev_id == _mod_revision.NULL_REVISION:
963
 
            if merge_parents is not None:
964
 
                raise ValueError('Cannot supply merge parents for first'
965
 
                                 ' commit.')
966
 
            parent_ids = []
967
 
        else:
968
 
            parent_ids = [last_rev_id]
969
 
            if merge_parents is not None:
970
 
                parent_ids.extend(merge_parents)
971
 
        if self._tree.get_revision_id() != last_rev_id:
972
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
973
 
                             self._tree.get_revision_id())
974
 
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
975
 
        builder = branch.get_commit_builder(parent_ids,
976
 
                                            timestamp=timestamp,
977
 
                                            timezone=timezone,
978
 
                                            committer=committer,
979
 
                                            revprops=revprops,
980
 
                                            revision_id=revision_id)
981
 
        preview = self.get_preview_tree()
982
 
        list(builder.record_iter_changes(preview, last_rev_id,
983
 
                                         self.iter_changes()))
984
 
        builder.finish_inventory()
985
 
        revision_id = builder.commit(message)
986
 
        branch.set_last_revision_info(revno + 1, revision_id)
987
 
        return revision_id
988
 
 
989
 
    def _text_parent(self, trans_id):
990
 
        file_id = self.tree_file_id(trans_id)
991
 
        try:
992
 
            if file_id is None or self._tree.kind(file_id) != 'file':
993
 
                return None
994
 
        except errors.NoSuchFile:
995
 
            return None
996
 
        return file_id
997
 
 
998
 
    def _get_parents_texts(self, trans_id):
999
 
        """Get texts for compression parents of this file."""
1000
 
        file_id = self._text_parent(trans_id)
1001
 
        if file_id is None:
1002
 
            return ()
1003
 
        return (self._tree.get_file_text(file_id),)
1004
 
 
1005
 
    def _get_parents_lines(self, trans_id):
1006
 
        """Get lines for compression parents of this file."""
1007
 
        file_id = self._text_parent(trans_id)
1008
 
        if file_id is None:
1009
 
            return ()
1010
 
        return (self._tree.get_file_lines(file_id),)
1011
 
 
1012
 
    def serialize(self, serializer):
1013
 
        """Serialize this TreeTransform.
1014
 
 
1015
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
1016
 
        """
1017
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
1018
 
                        self._new_name.items())
1019
 
        new_executability = dict((k, int(v)) for k, v in
1020
 
                                 self._new_executability.items())
1021
 
        tree_path_ids = dict((k.encode('utf-8'), v)
1022
 
                             for k, v in self._tree_path_ids.items())
1023
 
        attribs = {
1024
 
            '_id_number': self._id_number,
1025
 
            '_new_name': new_name,
1026
 
            '_new_parent': self._new_parent,
1027
 
            '_new_executability': new_executability,
1028
 
            '_new_id': self._new_id,
1029
 
            '_tree_path_ids': tree_path_ids,
1030
 
            '_removed_id': list(self._removed_id),
1031
 
            '_removed_contents': list(self._removed_contents),
1032
 
            '_non_present_ids': self._non_present_ids,
1033
 
            }
1034
 
        yield serializer.bytes_record(bencode.bencode(attribs),
1035
 
                                      (('attribs',),))
1036
 
        for trans_id, kind in self._new_contents.items():
1037
 
            if kind == 'file':
1038
 
                lines = osutils.chunks_to_lines(
1039
 
                    self._read_file_chunks(trans_id))
1040
 
                parents = self._get_parents_lines(trans_id)
1041
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1042
 
                content = ''.join(mpdiff.to_patch())
1043
 
            if kind == 'directory':
1044
 
                content = ''
1045
 
            if kind == 'symlink':
1046
 
                content = self._read_symlink_target(trans_id)
1047
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
1048
 
 
1049
 
    def deserialize(self, records):
1050
 
        """Deserialize a stored TreeTransform.
1051
 
 
1052
 
        :param records: An iterable of (names, content) tuples, as per
1053
 
            pack.ContainerPushParser.
1054
 
        """
1055
 
        names, content = records.next()
1056
 
        attribs = bencode.bdecode(content)
1057
 
        self._id_number = attribs['_id_number']
1058
 
        self._new_name = dict((k, v.decode('utf-8'))
1059
 
                            for k, v in attribs['_new_name'].items())
1060
 
        self._new_parent = attribs['_new_parent']
1061
 
        self._new_executability = dict((k, bool(v)) for k, v in
1062
 
            attribs['_new_executability'].items())
1063
 
        self._new_id = attribs['_new_id']
1064
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1065
 
        self._tree_path_ids = {}
1066
 
        self._tree_id_paths = {}
1067
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
1068
 
            path = bytepath.decode('utf-8')
1069
 
            self._tree_path_ids[path] = trans_id
1070
 
            self._tree_id_paths[trans_id] = path
1071
 
        self._removed_id = set(attribs['_removed_id'])
1072
 
        self._removed_contents = set(attribs['_removed_contents'])
1073
 
        self._non_present_ids = attribs['_non_present_ids']
1074
 
        for ((trans_id, kind),), content in records:
1075
 
            if kind == 'file':
1076
 
                mpdiff = multiparent.MultiParent.from_patch(content)
1077
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1078
 
                self.create_file(lines, trans_id)
1079
 
            if kind == 'directory':
1080
 
                self.create_directory(trans_id)
1081
 
            if kind == 'symlink':
1082
 
                self.create_symlink(content.decode('utf-8'), trans_id)
1083
 
 
1084
 
 
1085
 
class DiskTreeTransform(TreeTransformBase):
1086
 
    """Tree transform storing its contents on disk."""
1087
 
 
1088
 
    def __init__(self, tree, limbodir, pb=None,
1089
 
                 case_sensitive=True):
1090
 
        """Constructor.
1091
 
        :param tree: The tree that will be transformed, but not necessarily
1092
 
            the output tree.
1093
 
        :param limbodir: A directory where new files can be stored until
1094
 
            they are installed in their proper places
1095
 
        :param pb: ignored
1096
 
        :param case_sensitive: If True, the target of the transform is
1097
 
            case sensitive, not just case preserving.
1098
 
        """
1099
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1100
 
        self._limbodir = limbodir
1101
 
        self._deletiondir = None
1102
 
        # A mapping of transform ids to their limbo filename
1103
 
        self._limbo_files = {}
1104
 
        # A mapping of transform ids to a set of the transform ids of children
1105
 
        # that their limbo directory has
1106
 
        self._limbo_children = {}
1107
 
        # Map transform ids to maps of child filename to child transform id
1108
 
        self._limbo_children_names = {}
1109
 
        # List of transform ids that need to be renamed from limbo into place
1110
 
        self._needs_rename = set()
1111
 
        self._creation_mtime = None
1112
 
 
1113
 
    def finalize(self):
1114
 
        """Release the working tree lock, if held, clean up limbo dir.
1115
 
 
1116
 
        This is required if apply has not been invoked, but can be invoked
1117
 
        even after apply.
1118
 
        """
1119
 
        if self._tree is None:
1120
 
            return
1121
 
        try:
1122
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1123
 
                       self._new_contents.iteritems()]
1124
 
            entries.sort(reverse=True)
1125
 
            for path, trans_id, kind in entries:
1126
 
                delete_any(path)
1127
 
            try:
1128
 
                delete_any(self._limbodir)
1129
 
            except OSError:
1130
 
                # We don't especially care *why* the dir is immortal.
1131
 
                raise ImmortalLimbo(self._limbodir)
1132
 
            try:
1133
 
                if self._deletiondir is not None:
1134
 
                    delete_any(self._deletiondir)
1135
 
            except OSError:
1136
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1137
 
        finally:
1138
 
            TreeTransformBase.finalize(self)
1139
 
 
1140
 
    def _limbo_name(self, trans_id):
1141
 
        """Generate the limbo name of a file"""
1142
 
        limbo_name = self._limbo_files.get(trans_id)
1143
 
        if limbo_name is None:
1144
 
            limbo_name = self._generate_limbo_path(trans_id)
1145
 
            self._limbo_files[trans_id] = limbo_name
1146
 
        return limbo_name
1147
 
 
1148
 
    def _generate_limbo_path(self, trans_id):
1149
 
        """Generate a limbo path using the trans_id as the relative path.
1150
 
 
1151
 
        This is suitable as a fallback, and when the transform should not be
1152
 
        sensitive to the path encoding of the limbo directory.
1153
 
        """
1154
 
        self._needs_rename.add(trans_id)
1155
 
        return pathjoin(self._limbodir, trans_id)
1156
 
 
1157
 
    def adjust_path(self, name, parent, trans_id):
1158
 
        previous_parent = self._new_parent.get(trans_id)
1159
 
        previous_name = self._new_name.get(trans_id)
1160
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1161
 
        if (trans_id in self._limbo_files and
1162
 
            trans_id not in self._needs_rename):
1163
 
            self._rename_in_limbo([trans_id])
1164
 
            if previous_parent != parent:
1165
 
                self._limbo_children[previous_parent].remove(trans_id)
1166
 
            if previous_parent != parent or previous_name != name:
1167
 
                del self._limbo_children_names[previous_parent][previous_name]
1168
 
 
1169
 
    def _rename_in_limbo(self, trans_ids):
1170
 
        """Fix limbo names so that the right final path is produced.
1171
 
 
1172
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1173
 
        these files later by creating them with their final names in their
1174
 
        final parents.  But now the previous name or parent is no longer
1175
 
        suitable, so we have to rename them.
1176
 
 
1177
 
        Even for trans_ids that have no new contents, we must remove their
1178
 
        entries from _limbo_files, because they are now stale.
1179
 
        """
1180
 
        for trans_id in trans_ids:
1181
 
            old_path = self._limbo_files.pop(trans_id)
1182
 
            if trans_id not in self._new_contents:
1183
 
                continue
1184
 
            new_path = self._limbo_name(trans_id)
1185
 
            osutils.rename(old_path, new_path)
1186
 
            for descendant in self._limbo_descendants(trans_id):
1187
 
                desc_path = self._limbo_files[descendant]
1188
 
                desc_path = new_path + desc_path[len(old_path):]
1189
 
                self._limbo_files[descendant] = desc_path
1190
 
 
1191
 
    def _limbo_descendants(self, trans_id):
1192
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1193
 
        descendants = set(self._limbo_children.get(trans_id, []))
1194
 
        for descendant in list(descendants):
1195
 
            descendants.update(self._limbo_descendants(descendant))
1196
 
        return descendants
1197
 
 
1198
 
    def create_file(self, contents, trans_id, mode_id=None):
1199
 
        """Schedule creation of a new file.
1200
 
 
1201
 
        See also new_file.
1202
 
 
1203
 
        Contents is an iterator of strings, all of which will be written
1204
 
        to the target destination.
1205
 
 
1206
 
        New file takes the permissions of any existing file with that id,
1207
 
        unless mode_id is specified.
1208
 
        """
1209
 
        name = self._limbo_name(trans_id)
1210
 
        f = open(name, 'wb')
1211
 
        try:
1212
 
            try:
1213
 
                unique_add(self._new_contents, trans_id, 'file')
1214
 
            except:
1215
 
                # Clean up the file, it never got registered so
1216
 
                # TreeTransform.finalize() won't clean it up.
1217
 
                f.close()
1218
 
                os.unlink(name)
1219
 
                raise
1220
 
 
1221
 
            f.writelines(contents)
1222
 
        finally:
1223
 
            f.close()
1224
 
        self._set_mtime(name)
1225
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1226
 
 
1227
 
    def _read_file_chunks(self, trans_id):
1228
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1229
 
        try:
1230
 
            return cur_file.readlines()
1231
 
        finally:
1232
 
            cur_file.close()
1233
 
 
1234
 
    def _read_symlink_target(self, trans_id):
1235
 
        return os.readlink(self._limbo_name(trans_id))
1236
 
 
1237
 
    def _set_mtime(self, path):
1238
 
        """All files that are created get the same mtime.
1239
 
 
1240
 
        This time is set by the first object to be created.
1241
 
        """
1242
 
        if self._creation_mtime is None:
1243
 
            self._creation_mtime = time.time()
1244
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1245
 
 
1246
 
    def create_hardlink(self, path, trans_id):
1247
 
        """Schedule creation of a hard link"""
1248
 
        name = self._limbo_name(trans_id)
1249
 
        try:
1250
 
            os.link(path, name)
1251
 
        except OSError, e:
1252
 
            if e.errno != errno.EPERM:
1253
 
                raise
1254
 
            raise errors.HardLinkNotSupported(path)
1255
 
        try:
1256
 
            unique_add(self._new_contents, trans_id, 'file')
1257
 
        except:
1258
 
            # Clean up the file, it never got registered so
1259
 
            # TreeTransform.finalize() won't clean it up.
1260
 
            os.unlink(name)
1261
 
            raise
1262
 
 
1263
 
    def create_directory(self, trans_id):
1264
 
        """Schedule creation of a new directory.
1265
 
 
1266
 
        See also new_directory.
1267
 
        """
1268
 
        os.mkdir(self._limbo_name(trans_id))
1269
 
        unique_add(self._new_contents, trans_id, 'directory')
1270
 
 
1271
 
    def create_symlink(self, target, trans_id):
1272
 
        """Schedule creation of a new symbolic link.
1273
 
 
1274
 
        target is a bytestring.
1275
 
        See also new_symlink.
1276
 
        """
1277
 
        if has_symlinks():
1278
 
            os.symlink(target, self._limbo_name(trans_id))
1279
 
            unique_add(self._new_contents, trans_id, 'symlink')
1280
 
        else:
1281
 
            try:
1282
 
                path = FinalPaths(self).get_path(trans_id)
1283
 
            except KeyError:
1284
 
                path = None
1285
 
            raise UnableCreateSymlink(path=path)
1286
 
 
1287
 
    def cancel_creation(self, trans_id):
1288
 
        """Cancel the creation of new file contents."""
1289
 
        del self._new_contents[trans_id]
1290
 
        children = self._limbo_children.get(trans_id)
1291
 
        # if this is a limbo directory with children, move them before removing
1292
 
        # the directory
1293
 
        if children is not None:
1294
 
            self._rename_in_limbo(children)
1295
 
            del self._limbo_children[trans_id]
1296
 
            del self._limbo_children_names[trans_id]
1297
 
        delete_any(self._limbo_name(trans_id))
1298
 
 
1299
 
 
1300
 
class TreeTransform(DiskTreeTransform):
 
1121
 
 
1122
class TreeTransform(TreeTransformBase):
1301
1123
    """Represent a tree transformation.
1302
1124
 
1303
1125
    This object is designed to support incremental generation of the transform,
1362
1184
    FileMover does not delete files until it is sure that a rollback will not
1363
1185
    happen.
1364
1186
    """
1365
 
    def __init__(self, tree, pb=None):
 
1187
    def __init__(self, tree, pb=DummyProgress()):
1366
1188
        """Note: a tree_write lock is taken on the tree.
1367
1189
 
1368
1190
        Use TreeTransform.finalize() to release the lock (can be omitted if
1389
1211
            tree.unlock()
1390
1212
            raise
1391
1213
 
1392
 
        # Cache of realpath results, to speed up canonical_path
1393
 
        self._realpaths = {}
1394
 
        # Cache of relpath results, to speed up canonical_path
1395
 
        self._relpaths = {}
1396
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1214
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1397
1215
                                   tree.case_sensitive)
1398
1216
        self._deletiondir = deletiondir
1399
1217
 
1400
 
    def canonical_path(self, path):
1401
 
        """Get the canonical tree-relative path"""
1402
 
        # don't follow final symlinks
1403
 
        abs = self._tree.abspath(path)
1404
 
        if abs in self._relpaths:
1405
 
            return self._relpaths[abs]
1406
 
        dirname, basename = os.path.split(abs)
1407
 
        if dirname not in self._realpaths:
1408
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1409
 
        dirname = self._realpaths[dirname]
1410
 
        abs = pathjoin(dirname, basename)
1411
 
        if dirname in self._relpaths:
1412
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1413
 
            relpath = relpath.rstrip('/\\')
1414
 
        else:
1415
 
            relpath = self._tree.relpath(abs)
1416
 
        self._relpaths[abs] = relpath
1417
 
        return relpath
1418
 
 
1419
 
    def tree_kind(self, trans_id):
1420
 
        """Determine the file kind in the working tree.
1421
 
 
1422
 
        Raises NoSuchFile if the file does not exist
1423
 
        """
1424
 
        path = self._tree_id_paths.get(trans_id)
1425
 
        if path is None:
1426
 
            raise NoSuchFile(None)
1427
 
        try:
1428
 
            return file_kind(self._tree.abspath(path))
1429
 
        except OSError, e:
1430
 
            if e.errno != errno.ENOENT:
1431
 
                raise
1432
 
            else:
1433
 
                raise NoSuchFile(path)
1434
 
 
1435
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1436
 
        """Set the mode of new file contents.
1437
 
        The mode_id is the existing file to get the mode from (often the same
1438
 
        as trans_id).  The operation is only performed if there's a mode match
1439
 
        according to typefunc.
1440
 
        """
1441
 
        if mode_id is None:
1442
 
            mode_id = trans_id
1443
 
        try:
1444
 
            old_path = self._tree_id_paths[mode_id]
1445
 
        except KeyError:
1446
 
            return
1447
 
        try:
1448
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1449
 
        except OSError, e:
1450
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1451
 
                # Either old_path doesn't exist, or the parent of the
1452
 
                # target is not a directory (but will be one eventually)
1453
 
                # Either way, we know it doesn't exist *right now*
1454
 
                # See also bug #248448
1455
 
                return
1456
 
            else:
1457
 
                raise
1458
 
        if typefunc(mode):
1459
 
            os.chmod(self._limbo_name(trans_id), mode)
1460
 
 
1461
 
    def iter_tree_children(self, parent_id):
1462
 
        """Iterate through the entry's tree children, if any"""
1463
 
        try:
1464
 
            path = self._tree_id_paths[parent_id]
1465
 
        except KeyError:
1466
 
            return
1467
 
        try:
1468
 
            children = os.listdir(self._tree.abspath(path))
1469
 
        except OSError, e:
1470
 
            if not (osutils._is_error_enotdir(e)
1471
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1472
 
                raise
1473
 
            return
1474
 
 
1475
 
        for child in children:
1476
 
            childpath = joinpath(path, child)
1477
 
            if self._tree.is_control_filename(childpath):
1478
 
                continue
1479
 
            yield self.trans_id_tree_path(childpath)
1480
 
 
1481
 
    def _generate_limbo_path(self, trans_id):
1482
 
        """Generate a limbo path using the final path if possible.
1483
 
 
1484
 
        This optimizes the performance of applying the tree transform by
1485
 
        avoiding renames.  These renames can be avoided only when the parent
1486
 
        directory is already scheduled for creation.
1487
 
 
1488
 
        If the final path cannot be used, falls back to using the trans_id as
1489
 
        the relpath.
1490
 
        """
1491
 
        parent = self._new_parent.get(trans_id)
1492
 
        # if the parent directory is already in limbo (e.g. when building a
1493
 
        # tree), choose a limbo name inside the parent, to reduce further
1494
 
        # renames.
1495
 
        use_direct_path = False
1496
 
        if self._new_contents.get(parent) == 'directory':
1497
 
            filename = self._new_name.get(trans_id)
1498
 
            if filename is not None:
1499
 
                if parent not in self._limbo_children:
1500
 
                    self._limbo_children[parent] = set()
1501
 
                    self._limbo_children_names[parent] = {}
1502
 
                    use_direct_path = True
1503
 
                # the direct path can only be used if no other file has
1504
 
                # already taken this pathname, i.e. if the name is unused, or
1505
 
                # if it is already associated with this trans_id.
1506
 
                elif self._case_sensitive_target:
1507
 
                    if (self._limbo_children_names[parent].get(filename)
1508
 
                        in (trans_id, None)):
1509
 
                        use_direct_path = True
1510
 
                else:
1511
 
                    for l_filename, l_trans_id in\
1512
 
                        self._limbo_children_names[parent].iteritems():
1513
 
                        if l_trans_id == trans_id:
1514
 
                            continue
1515
 
                        if l_filename.lower() == filename.lower():
1516
 
                            break
1517
 
                    else:
1518
 
                        use_direct_path = True
1519
 
 
1520
 
        if not use_direct_path:
1521
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1522
 
 
1523
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1524
 
        self._limbo_children[parent].add(trans_id)
1525
 
        self._limbo_children_names[parent][filename] = trans_id
1526
 
        return limbo_name
1527
 
 
1528
 
 
1529
1218
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1530
1219
        """Apply all changes to the inventory and filesystem.
1531
1220
 
1541
1230
        :param _mover: Supply an alternate FileMover, for testing
1542
1231
        """
1543
1232
        if not no_conflicts:
1544
 
            self._check_malformed()
 
1233
            conflicts = self.find_conflicts()
 
1234
            if len(conflicts) != 0:
 
1235
                raise MalformedTransform(conflicts=conflicts)
1545
1236
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1546
1237
        try:
1547
1238
            if precomputed_delta is None:
1651
1342
                child_pb.update('removing file', num, len(tree_paths))
1652
1343
                full_path = self._tree.abspath(path)
1653
1344
                if trans_id in self._removed_contents:
1654
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1655
 
                    mover.pre_delete(full_path, delete_path)
1656
 
                elif (trans_id in self._new_name
1657
 
                      or trans_id in self._new_parent):
 
1345
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1346
                                     trans_id))
 
1347
                elif trans_id in self._new_name or trans_id in \
 
1348
                    self._new_parent:
1658
1349
                    try:
1659
1350
                        mover.rename(full_path, self._limbo_name(trans_id))
1660
1351
                    except OSError, e:
1706
1397
        return modified_paths
1707
1398
 
1708
1399
 
1709
 
class TransformPreview(DiskTreeTransform):
 
1400
class TransformPreview(TreeTransformBase):
1710
1401
    """A TreeTransform for generating preview trees.
1711
1402
 
1712
1403
    Unlike TreeTransform, this version works when the input tree is a
1714
1405
    unversioned files in the input tree.
1715
1406
    """
1716
1407
 
1717
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1408
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1718
1409
        tree.lock_read()
1719
1410
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1720
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1411
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1721
1412
 
1722
1413
    def canonical_path(self, path):
1723
1414
        return path
1747
1438
        file_id = self.tree_file_id(parent_id)
1748
1439
        if file_id is None:
1749
1440
            return
1750
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1751
 
        children = getattr(entry, 'children', {})
 
1441
        children = getattr(self._tree.inventory[file_id], 'children', {})
1752
1442
        for child in children:
1753
1443
            childpath = joinpath(path, child)
1754
1444
            yield self.trans_id_tree_path(childpath)
1762
1452
        self._final_paths = FinalPaths(transform)
1763
1453
        self.__by_parent = None
1764
1454
        self._parent_ids = []
1765
 
        self._all_children_cache = {}
1766
 
        self._path2trans_id_cache = {}
1767
 
        self._final_name_cache = {}
1768
 
        self._iter_changes_cache = dict((c[0], c) for c in
1769
 
                                        self._transform.iter_changes())
 
1455
 
 
1456
    def _changes(self, file_id):
 
1457
        for changes in self._transform.iter_changes():
 
1458
            if changes[0] == file_id:
 
1459
                return changes
1770
1460
 
1771
1461
    def _content_change(self, file_id):
1772
1462
        """Return True if the content of this file changed"""
1773
 
        changes = self._iter_changes_cache.get(file_id)
 
1463
        changes = self._changes(file_id)
1774
1464
        # changes[2] is true if the file content changed.  See
1775
1465
        # InterTree.iter_changes.
1776
1466
        return (changes is not None and changes[2])
1820
1510
            executable = self.is_executable(file_id, path)
1821
1511
        return kind, executable, None
1822
1512
 
1823
 
    def is_locked(self):
1824
 
        return False
1825
 
 
1826
1513
    def lock_read(self):
1827
1514
        # Perhaps in theory, this should lock the TreeTransform?
1828
 
        return self
 
1515
        pass
1829
1516
 
1830
1517
    def unlock(self):
1831
1518
        pass
1848
1535
    def __iter__(self):
1849
1536
        return iter(self.all_file_ids())
1850
1537
 
1851
 
    def _has_id(self, file_id, fallback_check):
 
1538
    def has_id(self, file_id):
1852
1539
        if file_id in self._transform._r_new_id:
1853
1540
            return True
1854
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1855
 
            trans_id in self._transform._removed_id]):
 
1541
        elif file_id in self._transform._removed_id:
1856
1542
            return False
1857
1543
        else:
1858
 
            return fallback_check(file_id)
1859
 
 
1860
 
    def has_id(self, file_id):
1861
 
        return self._has_id(file_id, self._transform._tree.has_id)
1862
 
 
1863
 
    def has_or_had_id(self, file_id):
1864
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
1544
            return self._transform._tree.has_id(file_id)
1865
1545
 
1866
1546
    def _path2trans_id(self, path):
1867
 
        # We must not use None here, because that is a valid value to store.
1868
 
        trans_id = self._path2trans_id_cache.get(path, object)
1869
 
        if trans_id is not object:
1870
 
            return trans_id
1871
1547
        segments = splitpath(path)
1872
1548
        cur_parent = self._transform.root
1873
1549
        for cur_segment in segments:
1874
1550
            for child in self._all_children(cur_parent):
1875
 
                final_name = self._final_name_cache.get(child)
1876
 
                if final_name is None:
1877
 
                    final_name = self._transform.final_name(child)
1878
 
                    self._final_name_cache[child] = final_name
1879
 
                if final_name == cur_segment:
 
1551
                if self._transform.final_name(child) == cur_segment:
1880
1552
                    cur_parent = child
1881
1553
                    break
1882
1554
            else:
1883
 
                self._path2trans_id_cache[path] = None
1884
1555
                return None
1885
 
        self._path2trans_id_cache[path] = cur_parent
1886
1556
        return cur_parent
1887
1557
 
1888
1558
    def path2id(self, path):
1896
1566
            raise errors.NoSuchId(self, file_id)
1897
1567
 
1898
1568
    def _all_children(self, trans_id):
1899
 
        children = self._all_children_cache.get(trans_id)
1900
 
        if children is not None:
1901
 
            return children
1902
1569
        children = set(self._transform.iter_tree_children(trans_id))
1903
1570
        # children in the _new_parent set are provided by _by_parent.
1904
1571
        children.difference_update(self._transform._new_parent.keys())
1905
1572
        children.update(self._by_parent.get(trans_id, []))
1906
 
        self._all_children_cache[trans_id] = children
1907
1573
        return children
1908
1574
 
1909
1575
    def iter_children(self, file_id):
1920
1586
            if self._transform.final_file_id(trans_id) is None:
1921
1587
                yield self._final_paths._determine_path(trans_id)
1922
1588
 
1923
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1924
 
        yield_parents=False):
 
1589
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
1925
1590
        for trans_id, parent_file_id in ordered_entries:
1926
1591
            file_id = self._transform.final_file_id(trans_id)
1927
1592
            if file_id is None:
1953
1618
                ordered_ids.append((trans_id, parent_file_id))
1954
1619
        return ordered_ids
1955
1620
 
1956
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
1621
    def iter_entries_by_dir(self, specific_file_ids=None):
1957
1622
        # This may not be a maximally efficient implementation, but it is
1958
1623
        # reasonably straightforward.  An implementation that grafts the
1959
1624
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1961
1626
        # position.
1962
1627
        ordered_ids = self._list_files_by_dir()
1963
1628
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1964
 
            specific_file_ids, yield_parents=yield_parents):
1965
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1966
 
 
1967
 
    def _iter_entries_for_dir(self, dir_path):
1968
 
        """Return path, entry for items in a directory without recursing down."""
1969
 
        dir_file_id = self.path2id(dir_path)
1970
 
        ordered_ids = []
1971
 
        for file_id in self.iter_children(dir_file_id):
1972
 
            trans_id = self._transform.trans_id_file_id(file_id)
1973
 
            ordered_ids.append((trans_id, file_id))
1974
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1975
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1976
 
 
1977
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1978
 
        """See WorkingTree.list_files."""
 
1629
                                                      specific_file_ids):
 
1630
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1631
 
 
1632
    def list_files(self, include_root=False):
 
1633
        """See Tree.list_files."""
1979
1634
        # XXX This should behave like WorkingTree.list_files, but is really
1980
1635
        # more like RevisionTree.list_files.
1981
 
        if recursive:
1982
 
            prefix = None
1983
 
            if from_dir:
1984
 
                prefix = from_dir + '/'
1985
 
            entries = self.iter_entries_by_dir()
1986
 
            for path, entry in entries:
1987
 
                if entry.name == '' and not include_root:
1988
 
                    continue
1989
 
                if prefix:
1990
 
                    if not path.startswith(prefix):
1991
 
                        continue
1992
 
                    path = path[len(prefix):]
1993
 
                yield path, 'V', entry.kind, entry.file_id, entry
1994
 
        else:
1995
 
            if from_dir is None and include_root is True:
1996
 
                root_entry = inventory.make_entry('directory', '',
1997
 
                    ROOT_PARENT, self.get_root_id())
1998
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1999
 
            entries = self._iter_entries_for_dir(from_dir or '')
2000
 
            for path, entry in entries:
2001
 
                yield path, 'V', entry.kind, entry.file_id, entry
 
1636
        for path, entry in self.iter_entries_by_dir():
 
1637
            if entry.name == '' and not include_root:
 
1638
                continue
 
1639
            yield path, 'V', entry.kind, entry.file_id, entry
2002
1640
 
2003
1641
    def kind(self, file_id):
2004
1642
        trans_id = self._transform.trans_id_file_id(file_id)
2014
1652
    def get_file_mtime(self, file_id, path=None):
2015
1653
        """See Tree.get_file_mtime"""
2016
1654
        if not self._content_change(file_id):
2017
 
            return self._transform._tree.get_file_mtime(file_id)
 
1655
            return self._transform._tree.get_file_mtime(file_id, path)
2018
1656
        return self._stat_limbo_file(file_id).st_mtime
2019
1657
 
2020
1658
    def _file_size(self, entry, stat_value):
2028
1666
            return None
2029
1667
 
2030
1668
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2031
 
        trans_id = self._transform.trans_id_file_id(file_id)
2032
 
        kind = self._transform._new_contents.get(trans_id)
2033
 
        if kind is None:
2034
 
            return self._transform._tree.get_file_sha1(file_id)
2035
 
        if kind == 'file':
2036
 
            fileobj = self.get_file(file_id)
2037
 
            try:
2038
 
                return sha_file(fileobj)
2039
 
            finally:
2040
 
                fileobj.close()
 
1669
        return self._transform._tree.get_file_sha1(file_id)
2041
1670
 
2042
1671
    def is_executable(self, file_id, path=None):
2043
1672
        if file_id is None:
2046
1675
        try:
2047
1676
            return self._transform._new_executability[trans_id]
2048
1677
        except KeyError:
2049
 
            try:
2050
 
                return self._transform._tree.is_executable(file_id, path)
2051
 
            except OSError, e:
2052
 
                if e.errno == errno.ENOENT:
2053
 
                    return False
2054
 
                raise
2055
 
            except errors.NoSuchId:
2056
 
                return False
 
1678
            return self._transform._tree.is_executable(file_id, path)
2057
1679
 
2058
1680
    def path_content_summary(self, path):
2059
1681
        trans_id = self._path2trans_id(path)
2074
1696
                statval = os.lstat(limbo_name)
2075
1697
                size = statval.st_size
2076
1698
                if not supports_executable():
2077
 
                    executable = False
 
1699
                    executable = None
2078
1700
                else:
2079
1701
                    executable = statval.st_mode & S_IEXEC
2080
1702
            else:
2081
1703
                size = None
2082
1704
                executable = None
2083
1705
            if kind == 'symlink':
2084
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2085
 
        executable = tt._new_executability.get(trans_id, executable)
 
1706
                link_or_sha1 = os.readlink(limbo_name)
 
1707
        if supports_executable():
 
1708
            executable = tt._new_executability.get(trans_id, executable)
2086
1709
        return kind, size, executable, link_or_sha1
2087
1710
 
2088
1711
    def iter_changes(self, from_tree, include_unchanged=False,
2090
1713
                      require_versioned=True, want_unversioned=False):
2091
1714
        """See InterTree.iter_changes.
2092
1715
 
2093
 
        This has a fast path that is only used when the from_tree matches
2094
 
        the transform tree, and no fancy options are supplied.
 
1716
        This implementation does not support include_unchanged, specific_files,
 
1717
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1718
        ignored.
2095
1719
        """
2096
 
        if (from_tree is not self._transform._tree or include_unchanged or
2097
 
            specific_files or want_unversioned):
 
1720
        if from_tree is not self._transform._tree:
2098
1721
            return tree.InterTree(from_tree, self).iter_changes(
2099
1722
                include_unchanged=include_unchanged,
2100
1723
                specific_files=specific_files,
2102
1725
                extra_trees=extra_trees,
2103
1726
                require_versioned=require_versioned,
2104
1727
                want_unversioned=want_unversioned)
 
1728
        if include_unchanged:
 
1729
            raise ValueError('include_unchanged is not supported')
 
1730
        if specific_files is not None:
 
1731
            raise ValueError('specific_files is not supported')
2105
1732
        if want_unversioned:
2106
1733
            raise ValueError('want_unversioned is not supported')
2107
1734
        return self._transform.iter_changes()
2114
1741
        name = self._transform._limbo_name(trans_id)
2115
1742
        return open(name, 'rb')
2116
1743
 
2117
 
    def get_file_with_stat(self, file_id, path=None):
2118
 
        return self.get_file(file_id, path), None
 
1744
    def get_file_text(self, file_id):
 
1745
        text_file = self.get_file(file_id)
 
1746
        try:
 
1747
            return text_file.read()
 
1748
        finally:
 
1749
            text_file.close()
2119
1750
 
2120
1751
    def annotate_iter(self, file_id,
2121
1752
                      default_revision=_mod_revision.CURRENT_REVISION):
2122
 
        changes = self._iter_changes_cache.get(file_id)
 
1753
        changes = self._changes(file_id)
2123
1754
        if changes is None:
2124
1755
            get_old = True
2125
1756
        else:
2137
1768
            return old_annotation
2138
1769
        if not changed_content:
2139
1770
            return old_annotation
2140
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2141
 
        #       doing, however it fails slightly because it doesn't know what
2142
 
        #       the *other* revision_id is, so it doesn't know how to give the
2143
 
        #       other as the origin for some lines, they all get
2144
 
        #       'default_revision'
2145
 
        #       It would be nice to be able to use the new Annotator based
2146
 
        #       approach, as well.
2147
1771
        return annotate.reannotate([old_annotation],
2148
1772
                                   self.get_file(file_id).readlines(),
2149
1773
                                   default_revision)
2154
1778
            return self._transform._tree.get_symlink_target(file_id)
2155
1779
        trans_id = self._transform.trans_id_file_id(file_id)
2156
1780
        name = self._transform._limbo_name(trans_id)
2157
 
        return osutils.readlink(name)
 
1781
        return os.readlink(name)
2158
1782
 
2159
1783
    def walkdirs(self, prefix=''):
2160
1784
        pending = [self._transform.root]
2215
1839
        self.transform = transform
2216
1840
 
2217
1841
    def _determine_path(self, trans_id):
2218
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1842
        if trans_id == self.transform.root:
2219
1843
            return ""
2220
1844
        name = self.transform.final_name(trans_id)
2221
1845
        parent_id = self.transform.final_parent(trans_id)
2245
1869
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2246
1870
               delta_from_tree=False):
2247
1871
    """Create working tree for a branch, using a TreeTransform.
2248
 
 
 
1872
    
2249
1873
    This function should be used on empty trees, having a tree root at most.
2250
1874
    (see merge and revert functionality for working with existing trees)
2251
1875
 
2252
1876
    Existing files are handled like so:
2253
 
 
 
1877
    
2254
1878
    - Existing bzrdirs take precedence over creating new items.  They are
2255
1879
      created as '%s.diverted' % name.
2256
1880
    - Otherwise, if the content on disk matches the content we are building,
2358
1982
                    executable = tree.is_executable(file_id, tree_path)
2359
1983
                    if executable:
2360
1984
                        tt.set_executability(executable, trans_id)
2361
 
                    trans_data = (trans_id, tree_path)
2362
 
                    deferred_contents.append((file_id, trans_data))
 
1985
                    deferred_contents.append((file_id, trans_id))
2363
1986
                else:
2364
1987
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2365
1988
                                                          tree)
2396
2019
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2397
2020
                  hardlink):
2398
2021
    total = len(desired_files) + offset
2399
 
    wt = tt._tree
2400
2022
    if accelerator_tree is None:
2401
2023
        new_desired_files = desired_files
2402
2024
    else:
2403
2025
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2404
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2405
 
                     in iter if not (c or e[0] != e[1])]
2406
 
        if accelerator_tree.supports_content_filtering():
2407
 
            unchanged = [(f, p) for (f, p) in unchanged
2408
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2409
 
        unchanged = dict(unchanged)
 
2026
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
2027
                         in iter if not (c or e[0] != e[1]))
2410
2028
        new_desired_files = []
2411
2029
        count = 0
2412
 
        for file_id, (trans_id, tree_path) in desired_files:
 
2030
        for file_id, trans_id in desired_files:
2413
2031
            accelerator_path = unchanged.get(file_id)
2414
2032
            if accelerator_path is None:
2415
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
2033
                new_desired_files.append((file_id, trans_id))
2416
2034
                continue
2417
2035
            pb.update('Adding file contents', count + offset, total)
2418
2036
            if hardlink:
2420
2038
                                   trans_id)
2421
2039
            else:
2422
2040
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2423
 
                if wt.supports_content_filtering():
2424
 
                    filters = wt._content_filter_stack(tree_path)
2425
 
                    contents = filtered_output_bytes(contents, filters,
2426
 
                        ContentFilterContext(tree_path, tree))
2427
2041
                try:
2428
2042
                    tt.create_file(contents, trans_id)
2429
2043
                finally:
2430
 
                    try:
2431
 
                        contents.close()
2432
 
                    except AttributeError:
2433
 
                        # after filtering, contents may no longer be file-like
2434
 
                        pass
 
2044
                    contents.close()
2435
2045
            count += 1
2436
2046
        offset += count
2437
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2438
 
            tree.iter_files_bytes(new_desired_files)):
2439
 
        if wt.supports_content_filtering():
2440
 
            filters = wt._content_filter_stack(tree_path)
2441
 
            contents = filtered_output_bytes(contents, filters,
2442
 
                ContentFilterContext(tree_path, tree))
 
2047
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
2048
                                                 new_desired_files)):
2443
2049
        tt.create_file(contents, trans_id)
2444
2050
        pb.update('Adding file contents', count + offset, total)
2445
2051
 
2505
2111
    if kind == 'file':
2506
2112
        contents = tree.get_file(entry.file_id).readlines()
2507
2113
        executable = tree.is_executable(entry.file_id)
2508
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
2114
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2509
2115
                           executable)
2510
2116
    elif kind in ('directory', 'tree-reference'):
2511
2117
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2512
2118
        if kind == 'tree-reference':
2513
2119
            tt.set_tree_reference(entry.reference_revision, trans_id)
2514
 
        return trans_id
 
2120
        return trans_id 
2515
2121
    elif kind == 'symlink':
2516
2122
        target = tree.get_symlink_target(entry.file_id)
2517
2123
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2519
2125
        raise errors.BadFileKindError(name, kind)
2520
2126
 
2521
2127
 
2522
 
@deprecated_function(deprecated_in((1, 9, 0)))
2523
2128
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2524
 
    """Create new file contents according to an inventory entry.
2525
 
 
2526
 
    DEPRECATED.  Use create_from_tree instead.
2527
 
    """
 
2129
    """Create new file contents according to an inventory entry."""
2528
2130
    if entry.kind == "file":
2529
2131
        if lines is None:
2530
2132
            lines = tree.get_file(entry.file_id).readlines()
2535
2137
        tt.create_directory(trans_id)
2536
2138
 
2537
2139
 
2538
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2539
 
    filter_tree_path=None):
2540
 
    """Create new file contents according to tree contents.
2541
 
    
2542
 
    :param filter_tree_path: the tree path to use to lookup
2543
 
      content filters to apply to the bytes output in the working tree.
2544
 
      This only applies if the working tree supports content filtering.
2545
 
    """
2546
 
    kind = tree.kind(file_id)
2547
 
    if kind == 'directory':
2548
 
        tt.create_directory(trans_id)
2549
 
    elif kind == "file":
2550
 
        if bytes is None:
2551
 
            tree_file = tree.get_file(file_id)
2552
 
            try:
2553
 
                bytes = tree_file.readlines()
2554
 
            finally:
2555
 
                tree_file.close()
2556
 
        wt = tt._tree
2557
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2558
 
            filters = wt._content_filter_stack(filter_tree_path)
2559
 
            bytes = filtered_output_bytes(bytes, filters,
2560
 
                ContentFilterContext(filter_tree_path, tree))
2561
 
        tt.create_file(bytes, trans_id)
2562
 
    elif kind == "symlink":
2563
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2564
 
    else:
2565
 
        raise AssertionError('Unknown kind %r' % kind)
2566
 
 
2567
 
 
2568
2140
def create_entry_executability(tt, entry, trans_id):
2569
2141
    """Set the executability of a trans_id according to an inventory entry"""
2570
2142
    if entry.kind == "file":
2607
2179
        if entry.kind != working_kind:
2608
2180
            contents_mod, meta_mod = True, False
2609
2181
        else:
2610
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
2182
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2611
2183
                                       working_tree)
2612
2184
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2613
2185
            cur_entry._forget_tree_state()
2615
2187
 
2616
2188
 
2617
2189
def revert(working_tree, target_tree, filenames, backups=False,
2618
 
           pb=None, change_reporter=None):
 
2190
           pb=DummyProgress(), change_reporter=None):
2619
2191
    """Revert a working tree's contents to those of a target tree."""
2620
2192
    target_tree.lock_read()
2621
 
    pb = ui.ui_factory.nested_progress_bar()
2622
2193
    tt = TreeTransform(working_tree, pb)
2623
2194
    try:
2624
2195
        pp = ProgressPhase("Revert phase", 3, pb)
2643
2214
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2644
2215
                              backups, pp, basis_tree=None,
2645
2216
                              merge_modified=None):
 
2217
    pp.next_phase()
2646
2218
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2647
2219
    try:
2648
2220
        if merge_modified is None:
2652
2224
                                      merge_modified, basis_tree)
2653
2225
    finally:
2654
2226
        child_pb.finished()
 
2227
    pp.next_phase()
2655
2228
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2656
2229
    try:
2657
2230
        raw_conflicts = resolve_conflicts(tt, child_pb,
2750
2323
                    parent_trans = ROOT_PARENT
2751
2324
                else:
2752
2325
                    parent_trans = tt.trans_id_file_id(parent[1])
2753
 
                if parent[0] is None and versioned[0]:
2754
 
                    tt.adjust_root_path(name[1], parent_trans)
2755
 
                else:
2756
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
 
2326
                tt.adjust_path(name[1], parent_trans, trans_id)
2757
2327
            if executable[0] != executable[1] and kind[1] == "file":
2758
2328
                tt.set_executability(executable[1], trans_id)
2759
 
        if working_tree.supports_content_filtering():
2760
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2761
 
                target_tree.iter_files_bytes(deferred_files)):
2762
 
                file_id = deferred_files[index][0]
2763
 
                # We're reverting a tree to the target tree so using the
2764
 
                # target tree to find the file path seems the best choice
2765
 
                # here IMO - Ian C 27/Oct/2009
2766
 
                filter_tree_path = target_tree.id2path(file_id)
2767
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2768
 
                bytes = filtered_output_bytes(bytes, filters,
2769
 
                    ContentFilterContext(filter_tree_path, working_tree))
2770
 
                tt.create_file(bytes, trans_id, mode_id)
2771
 
        else:
2772
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2773
 
                deferred_files):
2774
 
                tt.create_file(bytes, trans_id, mode_id)
2775
 
        tt.fixup_new_roots()
 
2329
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2330
            deferred_files):
 
2331
            tt.create_file(bytes, trans_id, mode_id)
2776
2332
    finally:
2777
2333
        if basis_tree is not None:
2778
2334
            basis_tree.unlock()
2779
2335
    return merge_modified
2780
2336
 
2781
2337
 
2782
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2338
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2783
2339
    """Make many conflict-resolution attempts, but die if they fail"""
2784
2340
    if pass_func is None:
2785
2341
        pass_func = conflict_pass
2786
2342
    new_conflicts = set()
2787
 
    pb = ui.ui_factory.nested_progress_bar()
2788
2343
    try:
2789
2344
        for n in range(10):
2790
2345
            pb.update('Resolution pass', n+1, 10)
2794
2349
            new_conflicts.update(pass_func(tt, conflicts))
2795
2350
        raise MalformedTransform(conflicts=conflicts)
2796
2351
    finally:
2797
 
        pb.finished()
 
2352
        pb.clear()
2798
2353
 
2799
2354
 
2800
2355
def conflict_pass(tt, conflicts, path_tree=None):
2819
2374
                existing_file, new_file = conflict[1], conflict[2]
2820
2375
            new_name = tt.final_name(existing_file)+'.moved'
2821
2376
            tt.adjust_path(new_name, final_parent, existing_file)
2822
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2377
            new_conflicts.add((c_type, 'Moved existing file to', 
2823
2378
                               existing_file, new_file))
2824
2379
        elif c_type == 'parent loop':
2825
2380
            # break the loop by undoing one of the ops that caused the loop
2829
2384
            new_conflicts.add((c_type, 'Cancelled move', cur,
2830
2385
                               tt.final_parent(cur),))
2831
2386
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2832
 
 
 
2387
            
2833
2388
        elif c_type == 'missing parent':
2834
2389
            trans_id = conflict[1]
2835
2390
            try:
2836
2391
                tt.cancel_deletion(trans_id)
2837
 
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2392
                new_conflicts.add(('deleting parent', 'Not deleting', 
2838
2393
                                   trans_id))
2839
2394
            except KeyError:
2840
2395
                create = True
2849
2404
                        # special-case the other tree root (move its
2850
2405
                        # children to current root)
2851
2406
                        if entry.parent_id is None:
2852
 
                            create = False
 
2407
                            create=False
2853
2408
                            moved = _reparent_transform_children(
2854
2409
                                tt, trans_id, tt.root)
2855
2410
                            for child in moved:
2905
2460
        if len(conflict) == 3:
2906
2461
            yield Conflict.factory(c_type, action=action, path=modified_path,
2907
2462
                                     file_id=modified_id)
2908
 
 
 
2463
             
2909
2464
        else:
2910
2465
            conflicting_path = fp.get_path(conflict[3])
2911
2466
            conflicting_id = tt.final_file_id(conflict[3])
2912
2467
            yield Conflict.factory(c_type, action=action, path=modified_path,
2913
 
                                   file_id=modified_id,
 
2468
                                   file_id=modified_id, 
2914
2469
                                   conflict_path=conflicting_path,
2915
2470
                                   conflict_file_id=conflicting_id)
2916
2471
 
2923
2478
        self.pending_deletions = []
2924
2479
 
2925
2480
    def rename(self, from_, to):
2926
 
        """Rename a file from one path to another."""
 
2481
        """Rename a file from one path to another.  Functions like os.rename"""
2927
2482
        try:
2928
 
            osutils.rename(from_, to)
 
2483
            os.rename(from_, to)
2929
2484
        except OSError, e:
2930
2485
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2931
2486
                raise errors.FileExists(to, str(e))
2945
2500
    def rollback(self):
2946
2501
        """Reverse all renames that have been performed"""
2947
2502
        for from_, to in reversed(self.past_renames):
2948
 
            osutils.rename(to, from_)
 
2503
            os.rename(to, from_)
2949
2504
        # after rollback, don't reuse _FileMover
2950
2505
        past_renames = None
2951
2506
        pending_deletions = None