/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: 2006-04-13 23:16:57 UTC
  • mfrom: (1662.1.1 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060413231657-bce3d67d3e7a4f2b
(mbp/olaf) push/pull/merge --remember improvements

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2006 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
 
19
from stat import S_ISREG
20
20
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
from bzrlib import (
24
 
    annotate,
25
 
    bencode,
26
 
    bzrdir,
27
 
    delta,
28
 
    errors,
29
 
    inventory,
30
 
    multiparent,
31
 
    osutils,
32
 
    revision as _mod_revision,
33
 
    )
34
 
""")
35
21
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
36
22
                           ReusingTransform, NotVersionedError, CantMoveRoot,
37
 
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
38
 
                           UnableCreateSymlink)
39
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
 
23
                           ExistingLimbo, ImmortalLimbo)
40
24
from bzrlib.inventory import InventoryEntry
41
 
from bzrlib.osutils import (
42
 
    delete_any,
43
 
    file_kind,
44
 
    has_symlinks,
45
 
    lexists,
46
 
    pathjoin,
47
 
    sha_file,
48
 
    splitpath,
49
 
    supports_executable,
50
 
)
 
25
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
 
26
                            delete_any)
51
27
from bzrlib.progress import DummyProgress, ProgressPhase
52
 
from bzrlib.symbol_versioning import (
53
 
        deprecated_function,
54
 
        deprecated_in,
55
 
        )
56
28
from bzrlib.trace import mutter, warning
57
 
from bzrlib import tree
58
 
import bzrlib.ui
59
 
import bzrlib.urlutils as urlutils
 
29
import bzrlib.ui 
60
30
 
61
31
 
62
32
ROOT_PARENT = "root-parent"
69
39
 
70
40
 
71
41
class _TransformResults(object):
72
 
    def __init__(self, modified_paths, rename_count):
 
42
    def __init__(self, modified_paths):
73
43
        object.__init__(self)
74
44
        self.modified_paths = modified_paths
75
 
        self.rename_count = rename_count
76
 
 
77
 
 
78
 
class TreeTransformBase(object):
79
 
    """The base class for TreeTransform and its kin."""
80
 
 
81
 
    def __init__(self, tree, pb=DummyProgress(),
82
 
                 case_sensitive=True):
83
 
        """Constructor.
84
 
 
85
 
        :param tree: The tree that will be transformed, but not necessarily
86
 
            the output tree.
87
 
        :param pb: A ProgressTask indicating how much progress is being made
88
 
        :param case_sensitive: If True, the target of the transform is
89
 
            case sensitive, not just case preserving.
 
45
 
 
46
 
 
47
class TreeTransform(object):
 
48
    """Represent a tree transformation.
 
49
    
 
50
    This object is designed to support incremental generation of the transform,
 
51
    in any order.  
 
52
    
 
53
    It is easy to produce malformed transforms, but they are generally
 
54
    harmless.  Attempting to apply a malformed transform will cause an
 
55
    exception to be raised before any modifications are made to the tree.  
 
56
 
 
57
    Many kinds of malformed transforms can be corrected with the 
 
58
    resolve_conflicts function.  The remaining ones indicate programming error,
 
59
    such as trying to create a file with no path.
 
60
 
 
61
    Two sets of file creation methods are supplied.  Convenience methods are:
 
62
     * new_file
 
63
     * new_directory
 
64
     * new_symlink
 
65
 
 
66
    These are composed of the low-level methods:
 
67
     * create_path
 
68
     * create_file or create_directory or create_symlink
 
69
     * version_file
 
70
     * set_executability
 
71
    """
 
72
    def __init__(self, tree, pb=DummyProgress()):
 
73
        """Note: a write lock is taken on the tree.
 
74
        
 
75
        Use TreeTransform.finalize() to release the lock
90
76
        """
91
77
        object.__init__(self)
92
78
        self._tree = tree
 
79
        self._tree.lock_write()
 
80
        try:
 
81
            control_files = self._tree._control_files
 
82
            self._limbodir = control_files.controlfilename('limbo')
 
83
            try:
 
84
                os.mkdir(self._limbodir)
 
85
            except OSError, e:
 
86
                if e.errno == errno.EEXIST:
 
87
                    raise ExistingLimbo(self._limbodir)
 
88
        except: 
 
89
            self._tree.unlock()
 
90
            raise
 
91
 
93
92
        self._id_number = 0
94
 
        # mapping of trans_id -> new basename
95
93
        self._new_name = {}
96
 
        # mapping of trans_id -> new parent trans_id
97
94
        self._new_parent = {}
98
 
        # mapping of trans_id with new contents -> new file_kind
99
95
        self._new_contents = {}
100
 
        # Set of trans_ids whose contents will be removed
101
96
        self._removed_contents = set()
102
 
        # Mapping of trans_id -> new execute-bit value
103
97
        self._new_executability = {}
104
 
        # Mapping of trans_id -> new tree-reference value
105
 
        self._new_reference_revision = {}
106
 
        # Mapping of trans_id -> new file_id
107
98
        self._new_id = {}
108
 
        # Mapping of old file-id -> trans_id
109
99
        self._non_present_ids = {}
110
 
        # Mapping of new file_id -> trans_id
111
100
        self._r_new_id = {}
112
 
        # Set of trans_ids that will be removed
113
101
        self._removed_id = set()
114
 
        # Mapping of path in old tree -> trans_id
115
102
        self._tree_path_ids = {}
116
 
        # Mapping trans_id -> path in old tree
117
103
        self._tree_id_paths = {}
118
 
        # The trans_id that will be used as the tree root
119
 
        root_id = tree.get_root_id()
120
 
        if root_id is not None:
121
 
            self._new_root = self.trans_id_tree_file_id(root_id)
122
 
        else:
123
 
            self._new_root = None
124
 
        # Indictor of whether the transform has been applied
125
 
        self._done = False
126
 
        # A progress bar
 
104
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
105
        self.__done = False
127
106
        self._pb = pb
128
 
        # Whether the target is case sensitive
129
 
        self._case_sensitive_target = case_sensitive
130
 
        # A counter of how many files have been renamed
131
 
        self.rename_count = 0
132
 
 
133
 
    def finalize(self):
134
 
        """Release the working tree lock, if held.
135
 
 
136
 
        This is required if apply has not been invoked, but can be invoked
137
 
        even after apply.
138
 
        """
139
 
        if self._tree is None:
140
 
            return
141
 
        self._tree.unlock()
142
 
        self._tree = None
143
107
 
144
108
    def __get_root(self):
145
109
        return self._new_root
146
110
 
147
111
    root = property(__get_root)
148
112
 
 
113
    def finalize(self):
 
114
        """Release the working tree lock, if held, clean up limbo dir."""
 
115
        if self._tree is None:
 
116
            return
 
117
        try:
 
118
            for trans_id, kind in self._new_contents.iteritems():
 
119
                path = self._limbo_name(trans_id)
 
120
                if kind == "directory":
 
121
                    os.rmdir(path)
 
122
                else:
 
123
                    os.unlink(path)
 
124
            try:
 
125
                os.rmdir(self._limbodir)
 
126
            except OSError:
 
127
                # We don't especially care *why* the dir is immortal.
 
128
                raise ImmortalLimbo(self._limbodir)
 
129
        finally:
 
130
            self._tree.unlock()
 
131
            self._tree = None
 
132
 
149
133
    def _assign_id(self):
150
134
        """Produce a new tranform id"""
151
135
        new_id = "new-%s" % self._id_number
165
149
            raise CantMoveRoot
166
150
        self._new_name[trans_id] = name
167
151
        self._new_parent[trans_id] = parent
168
 
        if parent == ROOT_PARENT:
169
 
            if self._new_root is not None:
170
 
                raise ValueError("Cannot have multiple roots.")
171
 
            self._new_root = trans_id
172
152
 
173
153
    def adjust_root_path(self, name, parent):
174
154
        """Emulate moving the root by moving all children, instead.
175
 
 
 
155
        
176
156
        We do this by undoing the association of root's transaction id with the
177
157
        current tree.  This allows us to create a new directory with that
178
 
        transaction id.  We unversion the root directory and version the
 
158
        transaction id.  We unversion the root directory and version the 
179
159
        physically new directory, and hope someone versions the tree root
180
160
        later.
181
161
        """
184
164
        # force moving all children of root
185
165
        for child_id in self.iter_tree_children(old_root):
186
166
            if child_id != parent:
187
 
                self.adjust_path(self.final_name(child_id),
 
167
                self.adjust_path(self.final_name(child_id), 
188
168
                                 self.final_parent(child_id), child_id)
189
169
            file_id = self.final_file_id(child_id)
190
170
            if file_id is not None:
191
171
                self.unversion_file(child_id)
192
172
            self.version_file(file_id, child_id)
193
 
 
 
173
        
194
174
        # the physical root needs a new transaction id
195
175
        self._tree_path_ids.pop("")
196
176
        self._tree_id_paths.pop(old_root)
204
184
 
205
185
    def trans_id_tree_file_id(self, inventory_id):
206
186
        """Determine the transaction id of a working tree file.
207
 
 
 
187
        
208
188
        This reflects only files that already exist, not ones that will be
209
189
        added by transactions.
210
190
        """
211
 
        if inventory_id is None:
212
 
            raise ValueError('None is not a valid file id')
213
 
        path = self._tree.id2path(inventory_id)
 
191
        path = self._tree.inventory.id2path(inventory_id)
214
192
        return self.trans_id_tree_path(path)
215
193
 
216
194
    def trans_id_file_id(self, file_id):
219
197
        a transaction has been unversioned, it is deliberately still returned.
220
198
        (this will likely lead to an unversioned parent conflict.)
221
199
        """
222
 
        if file_id is None:
223
 
            raise ValueError('None is not a valid file id')
224
200
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
225
201
            return self._r_new_id[file_id]
 
202
        elif file_id in self._tree.inventory:
 
203
            return self.trans_id_tree_file_id(file_id)
 
204
        elif file_id in self._non_present_ids:
 
205
            return self._non_present_ids[file_id]
226
206
        else:
227
 
            try:
228
 
                self._tree.iter_entries_by_dir([file_id]).next()
229
 
            except StopIteration:
230
 
                if file_id in self._non_present_ids:
231
 
                    return self._non_present_ids[file_id]
232
 
                else:
233
 
                    trans_id = self._assign_id()
234
 
                    self._non_present_ids[file_id] = trans_id
235
 
                    return trans_id
236
 
            else:
237
 
                return self.trans_id_tree_file_id(file_id)
 
207
            trans_id = self._assign_id()
 
208
            self._non_present_ids[file_id] = trans_id
 
209
            return trans_id
 
210
 
 
211
    def canonical_path(self, path):
 
212
        """Get the canonical tree-relative path"""
 
213
        # don't follow final symlinks
 
214
        dirname, basename = os.path.split(self._tree.abspath(path))
 
215
        dirname = os.path.realpath(dirname)
 
216
        return self._tree.relpath(pathjoin(dirname, basename))
238
217
 
239
218
    def trans_id_tree_path(self, path):
240
219
        """Determine (and maybe set) the transaction ID for a tree path."""
251
230
            return ROOT_PARENT
252
231
        return self.trans_id_tree_path(os.path.dirname(path))
253
232
 
 
233
    def create_file(self, contents, trans_id, mode_id=None):
 
234
        """Schedule creation of a new file.
 
235
 
 
236
        See also new_file.
 
237
        
 
238
        Contents is an iterator of strings, all of which will be written
 
239
        to the target destination.
 
240
 
 
241
        New file takes the permissions of any existing file with that id,
 
242
        unless mode_id is specified.
 
243
        """
 
244
        f = file(self._limbo_name(trans_id), 'wb')
 
245
        unique_add(self._new_contents, trans_id, 'file')
 
246
        for segment in contents:
 
247
            f.write(segment)
 
248
        f.close()
 
249
        self._set_mode(trans_id, mode_id, S_ISREG)
 
250
 
 
251
    def _set_mode(self, trans_id, mode_id, typefunc):
 
252
        """Set the mode of new file contents.
 
253
        The mode_id is the existing file to get the mode from (often the same
 
254
        as trans_id).  The operation is only performed if there's a mode match
 
255
        according to typefunc.
 
256
        """
 
257
        if mode_id is None:
 
258
            mode_id = trans_id
 
259
        try:
 
260
            old_path = self._tree_id_paths[mode_id]
 
261
        except KeyError:
 
262
            return
 
263
        try:
 
264
            mode = os.stat(old_path).st_mode
 
265
        except OSError, e:
 
266
            if e.errno == errno.ENOENT:
 
267
                return
 
268
            else:
 
269
                raise
 
270
        if typefunc(mode):
 
271
            os.chmod(self._limbo_name(trans_id), mode)
 
272
 
 
273
    def create_directory(self, trans_id):
 
274
        """Schedule creation of a new directory.
 
275
        
 
276
        See also new_directory.
 
277
        """
 
278
        os.mkdir(self._limbo_name(trans_id))
 
279
        unique_add(self._new_contents, trans_id, 'directory')
 
280
 
 
281
    def create_symlink(self, target, trans_id):
 
282
        """Schedule creation of a new symbolic link.
 
283
 
 
284
        target is a bytestring.
 
285
        See also new_symlink.
 
286
        """
 
287
        os.symlink(target, self._limbo_name(trans_id))
 
288
        unique_add(self._new_contents, trans_id, 'symlink')
 
289
 
 
290
    def cancel_creation(self, trans_id):
 
291
        """Cancel the creation of new file contents."""
 
292
        del self._new_contents[trans_id]
 
293
        delete_any(self._limbo_name(trans_id))
 
294
 
254
295
    def delete_contents(self, trans_id):
255
296
        """Schedule the contents of a path entry for deletion"""
256
297
        self.tree_kind(trans_id)
278
319
        else:
279
320
            unique_add(self._new_executability, trans_id, executability)
280
321
 
281
 
    def set_tree_reference(self, revision_id, trans_id):
282
 
        """Set the reference associated with a directory"""
283
 
        unique_add(self._new_reference_revision, trans_id, revision_id)
284
 
 
285
322
    def version_file(self, file_id, trans_id):
286
323
        """Schedule a file to become versioned."""
287
 
        if file_id is None:
288
 
            raise ValueError()
 
324
        assert file_id is not None
289
325
        unique_add(self._new_id, trans_id, file_id)
290
326
        unique_add(self._r_new_id, file_id, trans_id)
291
327
 
295
331
        del self._new_id[trans_id]
296
332
        del self._r_new_id[file_id]
297
333
 
298
 
    def new_paths(self, filesystem_only=False):
299
 
        """Determine the paths of all new and changed files.
300
 
 
301
 
        :param filesystem_only: if True, only calculate values for files
302
 
            that require renames or execute bit changes.
 
334
    def new_paths(self):
 
335
        """Determine the paths of all new and changed files"""
 
336
        new_ids = set()
 
337
        fp = FinalPaths(self)
 
338
        for id_set in (self._new_name, self._new_parent, self._new_contents,
 
339
                       self._new_id, self._new_executability):
 
340
            new_ids.update(id_set)
 
341
        new_paths = [(fp.get_path(t), t) for t in new_ids]
 
342
        new_paths.sort()
 
343
        return new_paths
 
344
 
 
345
    def tree_kind(self, trans_id):
 
346
        """Determine the file kind in the working tree.
 
347
 
 
348
        Raises NoSuchFile if the file does not exist
303
349
        """
304
 
        new_ids = set()
305
 
        if filesystem_only:
306
 
            stale_ids = self._needs_rename.difference(self._new_name)
307
 
            stale_ids.difference_update(self._new_parent)
308
 
            stale_ids.difference_update(self._new_contents)
309
 
            stale_ids.difference_update(self._new_id)
310
 
            needs_rename = self._needs_rename.difference(stale_ids)
311
 
            id_sets = (needs_rename, self._new_executability)
312
 
        else:
313
 
            id_sets = (self._new_name, self._new_parent, self._new_contents,
314
 
                       self._new_id, self._new_executability)
315
 
        for id_set in id_sets:
316
 
            new_ids.update(id_set)
317
 
        return sorted(FinalPaths(self).get_paths(new_ids))
318
 
 
319
 
    def _inventory_altered(self):
320
 
        """Get the trans_ids and paths of files needing new inv entries."""
321
 
        new_ids = set()
322
 
        for id_set in [self._new_name, self._new_parent, self._new_id,
323
 
                       self._new_executability]:
324
 
            new_ids.update(id_set)
325
 
        changed_kind = set(self._removed_contents)
326
 
        changed_kind.intersection_update(self._new_contents)
327
 
        changed_kind.difference_update(new_ids)
328
 
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
329
 
                        self.final_kind(t))
330
 
        new_ids.update(changed_kind)
331
 
        return sorted(FinalPaths(self).get_paths(new_ids))
 
350
        path = self._tree_id_paths.get(trans_id)
 
351
        if path is None:
 
352
            raise NoSuchFile(None)
 
353
        try:
 
354
            return file_kind(self._tree.abspath(path))
 
355
        except OSError, e:
 
356
            if e.errno != errno.ENOENT:
 
357
                raise
 
358
            else:
 
359
                raise NoSuchFile(path)
332
360
 
333
361
    def final_kind(self, trans_id):
334
362
        """Determine the final file kind, after any changes applied.
335
 
 
 
363
        
336
364
        Raises NoSuchFile if the file does not exist/has no contents.
337
365
        (It is conceivable that a path would be created without the
338
366
        corresponding contents insertion command)
353
381
            return None
354
382
        # the file is old; the old id is still valid
355
383
        if self._new_root == trans_id:
356
 
            return self._tree.get_root_id()
357
 
        return self._tree.path2id(path)
 
384
            return self._tree.inventory.root.file_id
 
385
        return self._tree.inventory.path2id(path)
358
386
 
359
387
    def final_file_id(self, trans_id):
360
388
        """Determine the file id after any changes are applied, or None.
361
 
 
 
389
        
362
390
        None indicates that the file will not be versioned after changes are
363
391
        applied.
364
392
        """
365
393
        try:
 
394
            # there is a new id for this file
 
395
            assert self._new_id[trans_id] is not None
366
396
            return self._new_id[trans_id]
367
397
        except KeyError:
368
398
            if trans_id in self._removed_id:
396
426
        try:
397
427
            return self._new_name[trans_id]
398
428
        except KeyError:
399
 
            try:
400
 
                return os.path.basename(self._tree_id_paths[trans_id])
401
 
            except KeyError:
402
 
                raise NoFinalPath(trans_id, self)
 
429
            return os.path.basename(self._tree_id_paths[trans_id])
403
430
 
404
431
    def by_parent(self):
405
432
        """Return a map of parent: children for known parents.
406
 
 
 
433
        
407
434
        Only new paths and parents of tree files with assigned ids are used.
408
435
        """
409
436
        by_parent = {}
410
437
        items = list(self._new_parent.iteritems())
411
 
        items.extend((t, self.final_parent(t)) for t in
 
438
        items.extend((t, self.final_parent(t)) for t in 
412
439
                      self._tree_id_paths.keys())
413
440
        for trans_id, parent_id in items:
414
441
            if parent_id not in by_parent:
418
445
 
419
446
    def path_changed(self, trans_id):
420
447
        """Return True if a trans_id's path has changed."""
421
 
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
422
 
 
423
 
    def new_contents(self, trans_id):
424
 
        return (trans_id in self._new_contents)
 
448
        return trans_id in self._new_name or trans_id in self._new_parent
425
449
 
426
450
    def find_conflicts(self):
427
451
        """Find any violations of inventory or filesystem invariants"""
428
 
        if self._done is True:
 
452
        if self.__done is True:
429
453
            raise ReusingTransform()
430
454
        conflicts = []
431
455
        # ensure all children of all existent parents are known
442
466
        conflicts.extend(self._overwrite_conflicts())
443
467
        return conflicts
444
468
 
445
 
    def _check_malformed(self):
446
 
        conflicts = self.find_conflicts()
447
 
        if len(conflicts) != 0:
448
 
            raise MalformedTransform(conflicts=conflicts)
449
 
 
450
469
    def _add_tree_children(self):
451
470
        """Add all the children of all active parents to the known paths.
452
471
 
454
473
        removed.  This is a necessary first step in detecting conflicts.
455
474
        """
456
475
        parents = self.by_parent().keys()
457
 
        parents.extend([t for t in self._removed_contents if
 
476
        parents.extend([t for t in self._removed_contents if 
458
477
                        self.tree_kind(t) == 'directory'])
459
478
        for trans_id in self._removed_id:
460
479
            file_id = self.tree_file_id(trans_id)
461
 
            if file_id is not None:
462
 
                if self._tree.inventory[file_id].kind == 'directory':
463
 
                    parents.append(trans_id)
464
 
            elif self.tree_kind(trans_id) == 'directory':
 
480
            if self._tree.inventory[file_id].kind in ('directory', 
 
481
                                                      'root_directory'):
465
482
                parents.append(trans_id)
466
483
 
467
484
        for parent_id in parents:
468
485
            # ensure that all children are registered with the transaction
469
486
            list(self.iter_tree_children(parent_id))
470
487
 
 
488
    def iter_tree_children(self, parent_id):
 
489
        """Iterate through the entry's tree children, if any"""
 
490
        try:
 
491
            path = self._tree_id_paths[parent_id]
 
492
        except KeyError:
 
493
            return
 
494
        try:
 
495
            children = os.listdir(self._tree.abspath(path))
 
496
        except OSError, e:
 
497
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
 
498
                raise
 
499
            return
 
500
            
 
501
        for child in children:
 
502
            childpath = joinpath(path, child)
 
503
            if self._tree.is_control_filename(childpath):
 
504
                continue
 
505
            yield self.trans_id_tree_path(childpath)
 
506
 
471
507
    def has_named_child(self, by_parent, parent_id, name):
472
508
        try:
473
509
            children = by_parent[parent_id]
485
521
        if child_id is None:
486
522
            return lexists(self._tree.abspath(childpath))
487
523
        else:
488
 
            if self.final_parent(child_id) != parent_id:
 
524
            if tt.final_parent(child_id) != parent_id:
489
525
                return False
490
 
            if child_id in self._removed_contents:
 
526
            if child_id in tt._removed_contents:
491
527
                # XXX What about dangling file-ids?
492
528
                return False
493
529
            else:
501
537
            parent_id = trans_id
502
538
            while parent_id is not ROOT_PARENT:
503
539
                seen.add(parent_id)
504
 
                try:
505
 
                    parent_id = self.final_parent(parent_id)
506
 
                except KeyError:
507
 
                    break
 
540
                parent_id = self.final_parent(parent_id)
508
541
                if parent_id == trans_id:
509
542
                    conflicts.append(('parent loop', trans_id))
510
543
                if parent_id in seen:
527
560
 
528
561
    def _improper_versioning(self):
529
562
        """Cannot version a file with no contents, or a bad type.
530
 
 
 
563
        
531
564
        However, existing entries with no contents are okay.
532
565
        """
533
566
        conflicts = []
543
576
 
544
577
    def _executability_conflicts(self):
545
578
        """Check for bad executability changes.
546
 
 
 
579
        
547
580
        Only versioned files may have their executability set, because
548
581
        1. only versioned entries can have executability under windows
549
582
        2. only files can be executable.  (The execute bit on a directory
578
611
    def _duplicate_entries(self, by_parent):
579
612
        """No directory may have two entries with the same name."""
580
613
        conflicts = []
581
 
        if (self._new_name, self._new_parent) == ({}, {}):
582
 
            return conflicts
583
614
        for children in by_parent.itervalues():
584
615
            name_ids = [(self.final_name(t), t) for t in children]
585
 
            if not self._case_sensitive_target:
586
 
                name_ids = [(n.lower(), t) for n, t in name_ids]
587
616
            name_ids.sort()
588
617
            last_name = None
589
618
            last_trans_id = None
590
619
            for name, trans_id in name_ids:
591
 
                try:
592
 
                    kind = self.final_kind(trans_id)
593
 
                except NoSuchFile:
594
 
                    kind = None
595
 
                file_id = self.final_file_id(trans_id)
596
 
                if kind is None and file_id is None:
597
 
                    continue
598
620
                if name == last_name:
599
621
                    conflicts.append(('duplicate', last_trans_id, trans_id,
600
622
                    name))
601
 
                last_name = name
602
 
                last_trans_id = trans_id
 
623
                try:
 
624
                    kind = self.final_kind(trans_id)
 
625
                except NoSuchFile:
 
626
                    kind = None
 
627
                file_id = self.final_file_id(trans_id)
 
628
                if kind is not None or file_id is not None:
 
629
                    last_name = name
 
630
                    last_trans_id = trans_id
603
631
        return conflicts
604
632
 
605
633
    def _duplicate_ids(self):
607
635
        conflicts = []
608
636
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
609
637
                                self._removed_id))
610
 
        all_ids = self._tree.all_file_ids()
611
 
        active_tree_ids = all_ids.difference(removed_tree_ids)
 
638
        active_tree_ids = set((f for f in self._tree.inventory if
 
639
                               f not in removed_tree_ids))
612
640
        for trans_id, file_id in self._new_id.iteritems():
613
641
            if file_id in active_tree_ids:
614
642
                old_trans_id = self.trans_id_tree_file_id(file_id)
647
675
                continue
648
676
            return True
649
677
        return False
650
 
 
651
 
    def _set_executability(self, path, trans_id):
 
678
            
 
679
    def apply(self):
 
680
        """Apply all changes to the inventory and filesystem.
 
681
        
 
682
        If filesystem or inventory conflicts are present, MalformedTransform
 
683
        will be thrown.
 
684
        """
 
685
        conflicts = self.find_conflicts()
 
686
        if len(conflicts) != 0:
 
687
            raise MalformedTransform(conflicts=conflicts)
 
688
        limbo_inv = {}
 
689
        inv = self._tree.inventory
 
690
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
691
        try:
 
692
            child_pb.update('Apply phase', 0, 2)
 
693
            self._apply_removals(inv, limbo_inv)
 
694
            child_pb.update('Apply phase', 1, 2)
 
695
            modified_paths = self._apply_insertions(inv, limbo_inv)
 
696
        finally:
 
697
            child_pb.finished()
 
698
        self._tree._write_inventory(inv)
 
699
        self.__done = True
 
700
        self.finalize()
 
701
        return _TransformResults(modified_paths)
 
702
 
 
703
    def _limbo_name(self, trans_id):
 
704
        """Generate the limbo name of a file"""
 
705
        return pathjoin(self._limbodir, trans_id)
 
706
 
 
707
    def _apply_removals(self, inv, limbo_inv):
 
708
        """Perform tree operations that remove directory/inventory names.
 
709
        
 
710
        That is, delete files that are to be deleted, and put any files that
 
711
        need renaming into limbo.  This must be done in strict child-to-parent
 
712
        order.
 
713
        """
 
714
        tree_paths = list(self._tree_path_ids.iteritems())
 
715
        tree_paths.sort(reverse=True)
 
716
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
717
        try:
 
718
            for num, data in enumerate(tree_paths):
 
719
                path, trans_id = data
 
720
                child_pb.update('removing file', num, len(tree_paths))
 
721
                full_path = self._tree.abspath(path)
 
722
                if trans_id in self._removed_contents:
 
723
                    delete_any(full_path)
 
724
                elif trans_id in self._new_name or trans_id in \
 
725
                    self._new_parent:
 
726
                    try:
 
727
                        os.rename(full_path, self._limbo_name(trans_id))
 
728
                    except OSError, e:
 
729
                        if e.errno != errno.ENOENT:
 
730
                            raise
 
731
                if trans_id in self._removed_id:
 
732
                    if trans_id == self._new_root:
 
733
                        file_id = self._tree.inventory.root.file_id
 
734
                    else:
 
735
                        file_id = self.tree_file_id(trans_id)
 
736
                    del inv[file_id]
 
737
                elif trans_id in self._new_name or trans_id in self._new_parent:
 
738
                    file_id = self.tree_file_id(trans_id)
 
739
                    if file_id is not None:
 
740
                        limbo_inv[trans_id] = inv[file_id]
 
741
                        del inv[file_id]
 
742
        finally:
 
743
            child_pb.finished()
 
744
 
 
745
    def _apply_insertions(self, inv, limbo_inv):
 
746
        """Perform tree operations that insert directory/inventory names.
 
747
        
 
748
        That is, create any files that need to be created, and restore from
 
749
        limbo any files that needed renaming.  This must be done in strict
 
750
        parent-to-child order.
 
751
        """
 
752
        new_paths = self.new_paths()
 
753
        modified_paths = []
 
754
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
755
        try:
 
756
            for num, (path, trans_id) in enumerate(new_paths):
 
757
                child_pb.update('adding file', num, len(new_paths))
 
758
                try:
 
759
                    kind = self._new_contents[trans_id]
 
760
                except KeyError:
 
761
                    kind = contents = None
 
762
                if trans_id in self._new_contents or \
 
763
                    self.path_changed(trans_id):
 
764
                    full_path = self._tree.abspath(path)
 
765
                    try:
 
766
                        os.rename(self._limbo_name(trans_id), full_path)
 
767
                    except OSError, e:
 
768
                        # We may be renaming a dangling inventory id
 
769
                        if e.errno != errno.ENOENT:
 
770
                            raise
 
771
                    if trans_id in self._new_contents:
 
772
                        modified_paths.append(full_path)
 
773
                        del self._new_contents[trans_id]
 
774
 
 
775
                if trans_id in self._new_id:
 
776
                    if kind is None:
 
777
                        kind = file_kind(self._tree.abspath(path))
 
778
                    inv.add_path(path, kind, self._new_id[trans_id])
 
779
                elif trans_id in self._new_name or trans_id in\
 
780
                    self._new_parent:
 
781
                    entry = limbo_inv.get(trans_id)
 
782
                    if entry is not None:
 
783
                        entry.name = self.final_name(trans_id)
 
784
                        parent_path = os.path.dirname(path)
 
785
                        entry.parent_id = \
 
786
                            self._tree.inventory.path2id(parent_path)
 
787
                        inv.add(entry)
 
788
 
 
789
                # requires files and inventory entries to be in place
 
790
                if trans_id in self._new_executability:
 
791
                    self._set_executability(path, inv, trans_id)
 
792
        finally:
 
793
            child_pb.finished()
 
794
        return modified_paths
 
795
 
 
796
    def _set_executability(self, path, inv, trans_id):
652
797
        """Set the executability of versioned files """
 
798
        file_id = inv.path2id(path)
 
799
        new_executability = self._new_executability[trans_id]
 
800
        inv[file_id].executable = new_executability
653
801
        if supports_executable():
654
 
            new_executability = self._new_executability[trans_id]
655
802
            abspath = self._tree.abspath(path)
656
803
            current_mode = os.stat(abspath).st_mode
657
804
            if new_executability:
674
821
            self.version_file(file_id, trans_id)
675
822
        return trans_id
676
823
 
677
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
824
    def new_file(self, name, parent_id, contents, file_id=None, 
678
825
                 executable=None):
679
826
        """Convenience method to create files.
680
 
 
 
827
        
681
828
        name is the name of the file to create.
682
829
        parent_id is the transaction id of the parent directory of the file.
683
830
        contents is an iterator of bytestrings, which will be used to produce
684
831
        the file.
685
 
        :param file_id: The inventory ID of the file, if it is to be versioned.
686
 
        :param executable: Only valid when a file_id has been supplied.
 
832
        file_id is the inventory ID of the file, if it is to be versioned.
687
833
        """
688
834
        trans_id = self._new_entry(name, parent_id, file_id)
689
 
        # TODO: rather than scheduling a set_executable call,
690
 
        # have create_file create the file with the right mode.
691
835
        self.create_file(contents, trans_id)
692
836
        if executable is not None:
693
837
            self.set_executability(executable, trans_id)
703
847
        """
704
848
        trans_id = self._new_entry(name, parent_id, file_id)
705
849
        self.create_directory(trans_id)
706
 
        return trans_id
 
850
        return trans_id 
707
851
 
708
852
    def new_symlink(self, name, parent_id, target, file_id=None):
709
853
        """Convenience method to create symbolic link.
710
 
 
 
854
        
711
855
        name is the name of the symlink to create.
712
856
        parent_id is the transaction id of the parent directory of the symlink.
713
857
        target is a bytestring of the target of the symlink.
717
861
        self.create_symlink(target, trans_id)
718
862
        return trans_id
719
863
 
720
 
    def _affected_ids(self):
721
 
        """Return the set of transform ids affected by the transform"""
722
 
        trans_ids = set(self._removed_id)
723
 
        trans_ids.update(self._new_id.keys())
724
 
        trans_ids.update(self._removed_contents)
725
 
        trans_ids.update(self._new_contents.keys())
726
 
        trans_ids.update(self._new_executability.keys())
727
 
        trans_ids.update(self._new_name.keys())
728
 
        trans_ids.update(self._new_parent.keys())
729
 
        return trans_ids
730
 
 
731
 
    def _get_file_id_maps(self):
732
 
        """Return mapping of file_ids to trans_ids in the to and from states"""
733
 
        trans_ids = self._affected_ids()
734
 
        from_trans_ids = {}
735
 
        to_trans_ids = {}
736
 
        # Build up two dicts: trans_ids associated with file ids in the
737
 
        # FROM state, vs the TO state.
738
 
        for trans_id in trans_ids:
739
 
            from_file_id = self.tree_file_id(trans_id)
740
 
            if from_file_id is not None:
741
 
                from_trans_ids[from_file_id] = trans_id
742
 
            to_file_id = self.final_file_id(trans_id)
743
 
            if to_file_id is not None:
744
 
                to_trans_ids[to_file_id] = trans_id
745
 
        return from_trans_ids, to_trans_ids
746
 
 
747
 
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
748
 
        """Get data about a file in the from (tree) state
749
 
 
750
 
        Return a (name, parent, kind, executable) tuple
751
 
        """
752
 
        from_path = self._tree_id_paths.get(from_trans_id)
753
 
        if from_versioned:
754
 
            # get data from working tree if versioned
755
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
756
 
            from_name = from_entry.name
757
 
            from_parent = from_entry.parent_id
758
 
        else:
759
 
            from_entry = None
760
 
            if from_path is None:
761
 
                # File does not exist in FROM state
762
 
                from_name = None
763
 
                from_parent = None
764
 
            else:
765
 
                # File exists, but is not versioned.  Have to use path-
766
 
                # splitting stuff
767
 
                from_name = os.path.basename(from_path)
768
 
                tree_parent = self.get_tree_parent(from_trans_id)
769
 
                from_parent = self.tree_file_id(tree_parent)
770
 
        if from_path is not None:
771
 
            from_kind, from_executable, from_stats = \
772
 
                self._tree._comparison_data(from_entry, from_path)
773
 
        else:
774
 
            from_kind = None
775
 
            from_executable = False
776
 
        return from_name, from_parent, from_kind, from_executable
777
 
 
778
 
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
779
 
        """Get data about a file in the to (target) state
780
 
 
781
 
        Return a (name, parent, kind, executable) tuple
782
 
        """
783
 
        to_name = self.final_name(to_trans_id)
784
 
        try:
785
 
            to_kind = self.final_kind(to_trans_id)
786
 
        except NoSuchFile:
787
 
            to_kind = None
788
 
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
789
 
        if to_trans_id in self._new_executability:
790
 
            to_executable = self._new_executability[to_trans_id]
791
 
        elif to_trans_id == from_trans_id:
792
 
            to_executable = from_executable
793
 
        else:
794
 
            to_executable = False
795
 
        return to_name, to_parent, to_kind, to_executable
796
 
 
797
 
    def iter_changes(self):
798
 
        """Produce output in the same format as Tree.iter_changes.
799
 
 
800
 
        Will produce nonsensical results if invoked while inventory/filesystem
801
 
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
802
 
 
803
 
        This reads the Transform, but only reproduces changes involving a
804
 
        file_id.  Files that are not versioned in either of the FROM or TO
805
 
        states are not reflected.
806
 
        """
807
 
        final_paths = FinalPaths(self)
808
 
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
809
 
        results = []
810
 
        # Now iterate through all active file_ids
811
 
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
812
 
            modified = False
813
 
            from_trans_id = from_trans_ids.get(file_id)
814
 
            # find file ids, and determine versioning state
815
 
            if from_trans_id is None:
816
 
                from_versioned = False
817
 
                from_trans_id = to_trans_ids[file_id]
818
 
            else:
819
 
                from_versioned = True
820
 
            to_trans_id = to_trans_ids.get(file_id)
821
 
            if to_trans_id is None:
822
 
                to_versioned = False
823
 
                to_trans_id = from_trans_id
824
 
            else:
825
 
                to_versioned = True
826
 
 
827
 
            from_name, from_parent, from_kind, from_executable = \
828
 
                self._from_file_data(from_trans_id, from_versioned, file_id)
829
 
 
830
 
            to_name, to_parent, to_kind, to_executable = \
831
 
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
832
 
 
833
 
            if not from_versioned:
834
 
                from_path = None
835
 
            else:
836
 
                from_path = self._tree_id_paths.get(from_trans_id)
837
 
            if not to_versioned:
838
 
                to_path = None
839
 
            else:
840
 
                to_path = final_paths.get_path(to_trans_id)
841
 
            if from_kind != to_kind:
842
 
                modified = True
843
 
            elif to_kind in ('file', 'symlink') and (
844
 
                to_trans_id != from_trans_id or
845
 
                to_trans_id in self._new_contents):
846
 
                modified = True
847
 
            if (not modified and from_versioned == to_versioned and
848
 
                from_parent==to_parent and from_name == to_name and
849
 
                from_executable == to_executable):
850
 
                continue
851
 
            results.append((file_id, (from_path, to_path), modified,
852
 
                   (from_versioned, to_versioned),
853
 
                   (from_parent, to_parent),
854
 
                   (from_name, to_name),
855
 
                   (from_kind, to_kind),
856
 
                   (from_executable, to_executable)))
857
 
        return iter(sorted(results, key=lambda x:x[1]))
858
 
 
859
 
    def get_preview_tree(self):
860
 
        """Return a tree representing the result of the transform.
861
 
 
862
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
863
 
        it.
864
 
        """
865
 
        return _PreviewTree(self)
866
 
 
867
 
    def commit(self, branch, message, merge_parents=None, strict=False):
868
 
        """Commit the result of this TreeTransform to a branch.
869
 
 
870
 
        :param branch: The branch to commit to.
871
 
        :param message: The message to attach to the commit.
872
 
        :param merge_parents: Additional parents specified by pending merges.
873
 
        :return: The revision_id of the revision committed.
874
 
        """
875
 
        self._check_malformed()
876
 
        if strict:
877
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
878
 
            for trans_id in unversioned:
879
 
                if self.final_file_id(trans_id) is None:
880
 
                    raise errors.StrictCommitFailed()
881
 
 
882
 
        revno, last_rev_id = branch.last_revision_info()
883
 
        if last_rev_id == _mod_revision.NULL_REVISION:
884
 
            if merge_parents is not None:
885
 
                raise ValueError('Cannot supply merge parents for first'
886
 
                                 ' commit.')
887
 
            parent_ids = []
888
 
        else:
889
 
            parent_ids = [last_rev_id]
890
 
            if merge_parents is not None:
891
 
                parent_ids.extend(merge_parents)
892
 
        if self._tree.get_revision_id() != last_rev_id:
893
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
894
 
                             self._tree.get_revision_id())
895
 
        builder = branch.get_commit_builder(parent_ids)
896
 
        preview = self.get_preview_tree()
897
 
        list(builder.record_iter_changes(preview, last_rev_id,
898
 
                                         self.iter_changes()))
899
 
        builder.finish_inventory()
900
 
        revision_id = builder.commit(message)
901
 
        branch.set_last_revision_info(revno + 1, revision_id)
902
 
        return revision_id
903
 
 
904
 
    def _text_parent(self, trans_id):
905
 
        file_id = self.tree_file_id(trans_id)
906
 
        try:
907
 
            if file_id is None or self._tree.kind(file_id) != 'file':
908
 
                return None
909
 
        except errors.NoSuchFile:
910
 
            return None
911
 
        return file_id
912
 
 
913
 
    def _get_parents_texts(self, trans_id):
914
 
        """Get texts for compression parents of this file."""
915
 
        file_id = self._text_parent(trans_id)
916
 
        if file_id is None:
917
 
            return ()
918
 
        return (self._tree.get_file_text(file_id),)
919
 
 
920
 
    def _get_parents_lines(self, trans_id):
921
 
        """Get lines for compression parents of this file."""
922
 
        file_id = self._text_parent(trans_id)
923
 
        if file_id is None:
924
 
            return ()
925
 
        return (self._tree.get_file_lines(file_id),)
926
 
 
927
 
    def serialize(self, serializer):
928
 
        """Serialize this TreeTransform.
929
 
 
930
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
931
 
        """
932
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
933
 
                        self._new_name.items())
934
 
        new_executability = dict((k, int(v)) for k, v in
935
 
                                 self._new_executability.items())
936
 
        tree_path_ids = dict((k.encode('utf-8'), v)
937
 
                             for k, v in self._tree_path_ids.items())
938
 
        attribs = {
939
 
            '_id_number': self._id_number,
940
 
            '_new_name': new_name,
941
 
            '_new_parent': self._new_parent,
942
 
            '_new_executability': new_executability,
943
 
            '_new_id': self._new_id,
944
 
            '_tree_path_ids': tree_path_ids,
945
 
            '_removed_id': list(self._removed_id),
946
 
            '_removed_contents': list(self._removed_contents),
947
 
            '_non_present_ids': self._non_present_ids,
948
 
            }
949
 
        yield serializer.bytes_record(bencode.bencode(attribs),
950
 
                                      (('attribs',),))
951
 
        for trans_id, kind in self._new_contents.items():
952
 
            if kind == 'file':
953
 
                lines = osutils.chunks_to_lines(
954
 
                    self._read_file_chunks(trans_id))
955
 
                parents = self._get_parents_lines(trans_id)
956
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
957
 
                content = ''.join(mpdiff.to_patch())
958
 
            if kind == 'directory':
959
 
                content = ''
960
 
            if kind == 'symlink':
961
 
                content = self._read_symlink_target(trans_id)
962
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
963
 
 
964
 
    def deserialize(self, records):
965
 
        """Deserialize a stored TreeTransform.
966
 
 
967
 
        :param records: An iterable of (names, content) tuples, as per
968
 
            pack.ContainerPushParser.
969
 
        """
970
 
        names, content = records.next()
971
 
        attribs = bencode.bdecode(content)
972
 
        self._id_number = attribs['_id_number']
973
 
        self._new_name = dict((k, v.decode('utf-8'))
974
 
                            for k, v in attribs['_new_name'].items())
975
 
        self._new_parent = attribs['_new_parent']
976
 
        self._new_executability = dict((k, bool(v)) for k, v in
977
 
            attribs['_new_executability'].items())
978
 
        self._new_id = attribs['_new_id']
979
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
980
 
        self._tree_path_ids = {}
981
 
        self._tree_id_paths = {}
982
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
983
 
            path = bytepath.decode('utf-8')
984
 
            self._tree_path_ids[path] = trans_id
985
 
            self._tree_id_paths[trans_id] = path
986
 
        self._removed_id = set(attribs['_removed_id'])
987
 
        self._removed_contents = set(attribs['_removed_contents'])
988
 
        self._non_present_ids = attribs['_non_present_ids']
989
 
        for ((trans_id, kind),), content in records:
990
 
            if kind == 'file':
991
 
                mpdiff = multiparent.MultiParent.from_patch(content)
992
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
993
 
                self.create_file(lines, trans_id)
994
 
            if kind == 'directory':
995
 
                self.create_directory(trans_id)
996
 
            if kind == 'symlink':
997
 
                self.create_symlink(content.decode('utf-8'), trans_id)
998
 
 
999
 
 
1000
 
class DiskTreeTransform(TreeTransformBase):
1001
 
    """Tree transform storing its contents on disk."""
1002
 
 
1003
 
    def __init__(self, tree, limbodir, pb=DummyProgress(),
1004
 
                 case_sensitive=True):
1005
 
        """Constructor.
1006
 
        :param tree: The tree that will be transformed, but not necessarily
1007
 
            the output tree.
1008
 
        :param limbodir: A directory where new files can be stored until
1009
 
            they are installed in their proper places
1010
 
        :param pb: A ProgressBar indicating how much progress is being made
1011
 
        :param case_sensitive: If True, the target of the transform is
1012
 
            case sensitive, not just case preserving.
1013
 
        """
1014
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1015
 
        self._limbodir = limbodir
1016
 
        self._deletiondir = None
1017
 
        # A mapping of transform ids to their limbo filename
1018
 
        self._limbo_files = {}
1019
 
        # A mapping of transform ids to a set of the transform ids of children
1020
 
        # that their limbo directory has
1021
 
        self._limbo_children = {}
1022
 
        # Map transform ids to maps of child filename to child transform id
1023
 
        self._limbo_children_names = {}
1024
 
        # List of transform ids that need to be renamed from limbo into place
1025
 
        self._needs_rename = set()
1026
 
 
1027
 
    def finalize(self):
1028
 
        """Release the working tree lock, if held, clean up limbo dir.
1029
 
 
1030
 
        This is required if apply has not been invoked, but can be invoked
1031
 
        even after apply.
1032
 
        """
1033
 
        if self._tree is None:
1034
 
            return
1035
 
        try:
1036
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1037
 
                       self._new_contents.iteritems()]
1038
 
            entries.sort(reverse=True)
1039
 
            for path, trans_id, kind in entries:
1040
 
                delete_any(path)
1041
 
            try:
1042
 
                delete_any(self._limbodir)
1043
 
            except OSError:
1044
 
                # We don't especially care *why* the dir is immortal.
1045
 
                raise ImmortalLimbo(self._limbodir)
1046
 
            try:
1047
 
                if self._deletiondir is not None:
1048
 
                    delete_any(self._deletiondir)
1049
 
            except OSError:
1050
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1051
 
        finally:
1052
 
            TreeTransformBase.finalize(self)
1053
 
 
1054
 
    def _limbo_name(self, trans_id):
1055
 
        """Generate the limbo name of a file"""
1056
 
        limbo_name = self._limbo_files.get(trans_id)
1057
 
        if limbo_name is None:
1058
 
            limbo_name = self._generate_limbo_path(trans_id)
1059
 
            self._limbo_files[trans_id] = limbo_name
1060
 
        return limbo_name
1061
 
 
1062
 
    def _generate_limbo_path(self, trans_id):
1063
 
        """Generate a limbo path using the trans_id as the relative path.
1064
 
 
1065
 
        This is suitable as a fallback, and when the transform should not be
1066
 
        sensitive to the path encoding of the limbo directory.
1067
 
        """
1068
 
        self._needs_rename.add(trans_id)
1069
 
        return pathjoin(self._limbodir, trans_id)
1070
 
 
1071
 
    def adjust_path(self, name, parent, trans_id):
1072
 
        previous_parent = self._new_parent.get(trans_id)
1073
 
        previous_name = self._new_name.get(trans_id)
1074
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1075
 
        if (trans_id in self._limbo_files and
1076
 
            trans_id not in self._needs_rename):
1077
 
            self._rename_in_limbo([trans_id])
1078
 
            self._limbo_children[previous_parent].remove(trans_id)
1079
 
            del self._limbo_children_names[previous_parent][previous_name]
1080
 
 
1081
 
    def _rename_in_limbo(self, trans_ids):
1082
 
        """Fix limbo names so that the right final path is produced.
1083
 
 
1084
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1085
 
        these files later by creating them with their final names in their
1086
 
        final parents.  But now the previous name or parent is no longer
1087
 
        suitable, so we have to rename them.
1088
 
 
1089
 
        Even for trans_ids that have no new contents, we must remove their
1090
 
        entries from _limbo_files, because they are now stale.
1091
 
        """
1092
 
        for trans_id in trans_ids:
1093
 
            old_path = self._limbo_files.pop(trans_id)
1094
 
            if trans_id not in self._new_contents:
1095
 
                continue
1096
 
            new_path = self._limbo_name(trans_id)
1097
 
            os.rename(old_path, new_path)
1098
 
            for descendant in self._limbo_descendants(trans_id):
1099
 
                desc_path = self._limbo_files[descendant]
1100
 
                desc_path = new_path + desc_path[len(old_path):]
1101
 
                self._limbo_files[descendant] = desc_path
1102
 
 
1103
 
    def _limbo_descendants(self, trans_id):
1104
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1105
 
        descendants = set(self._limbo_children.get(trans_id, []))
1106
 
        for descendant in list(descendants):
1107
 
            descendants.update(self._limbo_descendants(descendant))
1108
 
        return descendants
1109
 
 
1110
 
    def create_file(self, contents, trans_id, mode_id=None):
1111
 
        """Schedule creation of a new file.
1112
 
 
1113
 
        See also new_file.
1114
 
 
1115
 
        Contents is an iterator of strings, all of which will be written
1116
 
        to the target destination.
1117
 
 
1118
 
        New file takes the permissions of any existing file with that id,
1119
 
        unless mode_id is specified.
1120
 
        """
1121
 
        name = self._limbo_name(trans_id)
1122
 
        f = open(name, 'wb')
1123
 
        try:
1124
 
            try:
1125
 
                unique_add(self._new_contents, trans_id, 'file')
1126
 
            except:
1127
 
                # Clean up the file, it never got registered so
1128
 
                # TreeTransform.finalize() won't clean it up.
1129
 
                f.close()
1130
 
                os.unlink(name)
1131
 
                raise
1132
 
 
1133
 
            f.writelines(contents)
1134
 
        finally:
1135
 
            f.close()
1136
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1137
 
 
1138
 
    def _read_file_chunks(self, trans_id):
1139
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1140
 
        try:
1141
 
            return cur_file.readlines()
1142
 
        finally:
1143
 
            cur_file.close()
1144
 
 
1145
 
    def _read_symlink_target(self, trans_id):
1146
 
        return os.readlink(self._limbo_name(trans_id))
1147
 
 
1148
 
    def create_hardlink(self, path, trans_id):
1149
 
        """Schedule creation of a hard link"""
1150
 
        name = self._limbo_name(trans_id)
1151
 
        try:
1152
 
            os.link(path, name)
1153
 
        except OSError, e:
1154
 
            if e.errno != errno.EPERM:
1155
 
                raise
1156
 
            raise errors.HardLinkNotSupported(path)
1157
 
        try:
1158
 
            unique_add(self._new_contents, trans_id, 'file')
1159
 
        except:
1160
 
            # Clean up the file, it never got registered so
1161
 
            # TreeTransform.finalize() won't clean it up.
1162
 
            os.unlink(name)
1163
 
            raise
1164
 
 
1165
 
    def create_directory(self, trans_id):
1166
 
        """Schedule creation of a new directory.
1167
 
 
1168
 
        See also new_directory.
1169
 
        """
1170
 
        os.mkdir(self._limbo_name(trans_id))
1171
 
        unique_add(self._new_contents, trans_id, 'directory')
1172
 
 
1173
 
    def create_symlink(self, target, trans_id):
1174
 
        """Schedule creation of a new symbolic link.
1175
 
 
1176
 
        target is a bytestring.
1177
 
        See also new_symlink.
1178
 
        """
1179
 
        if has_symlinks():
1180
 
            os.symlink(target, self._limbo_name(trans_id))
1181
 
            unique_add(self._new_contents, trans_id, 'symlink')
1182
 
        else:
1183
 
            try:
1184
 
                path = FinalPaths(self).get_path(trans_id)
1185
 
            except KeyError:
1186
 
                path = None
1187
 
            raise UnableCreateSymlink(path=path)
1188
 
 
1189
 
    def cancel_creation(self, trans_id):
1190
 
        """Cancel the creation of new file contents."""
1191
 
        del self._new_contents[trans_id]
1192
 
        children = self._limbo_children.get(trans_id)
1193
 
        # if this is a limbo directory with children, move them before removing
1194
 
        # the directory
1195
 
        if children is not None:
1196
 
            self._rename_in_limbo(children)
1197
 
            del self._limbo_children[trans_id]
1198
 
            del self._limbo_children_names[trans_id]
1199
 
        delete_any(self._limbo_name(trans_id))
1200
 
 
1201
 
 
1202
 
class TreeTransform(DiskTreeTransform):
1203
 
    """Represent a tree transformation.
1204
 
 
1205
 
    This object is designed to support incremental generation of the transform,
1206
 
    in any order.
1207
 
 
1208
 
    However, it gives optimum performance when parent directories are created
1209
 
    before their contents.  The transform is then able to put child files
1210
 
    directly in their parent directory, avoiding later renames.
1211
 
 
1212
 
    It is easy to produce malformed transforms, but they are generally
1213
 
    harmless.  Attempting to apply a malformed transform will cause an
1214
 
    exception to be raised before any modifications are made to the tree.
1215
 
 
1216
 
    Many kinds of malformed transforms can be corrected with the
1217
 
    resolve_conflicts function.  The remaining ones indicate programming error,
1218
 
    such as trying to create a file with no path.
1219
 
 
1220
 
    Two sets of file creation methods are supplied.  Convenience methods are:
1221
 
     * new_file
1222
 
     * new_directory
1223
 
     * new_symlink
1224
 
 
1225
 
    These are composed of the low-level methods:
1226
 
     * create_path
1227
 
     * create_file or create_directory or create_symlink
1228
 
     * version_file
1229
 
     * set_executability
1230
 
 
1231
 
    Transform/Transaction ids
1232
 
    -------------------------
1233
 
    trans_ids are temporary ids assigned to all files involved in a transform.
1234
 
    It's possible, even common, that not all files in the Tree have trans_ids.
1235
 
 
1236
 
    trans_ids are used because filenames and file_ids are not good enough
1237
 
    identifiers; filenames change, and not all files have file_ids.  File-ids
1238
 
    are also associated with trans-ids, so that moving a file moves its
1239
 
    file-id.
1240
 
 
1241
 
    trans_ids are only valid for the TreeTransform that generated them.
1242
 
 
1243
 
    Limbo
1244
 
    -----
1245
 
    Limbo is a temporary directory use to hold new versions of files.
1246
 
    Files are added to limbo by create_file, create_directory, create_symlink,
1247
 
    and their convenience variants (new_*).  Files may be removed from limbo
1248
 
    using cancel_creation.  Files are renamed from limbo into their final
1249
 
    location as part of TreeTransform.apply
1250
 
 
1251
 
    Limbo must be cleaned up, by either calling TreeTransform.apply or
1252
 
    calling TreeTransform.finalize.
1253
 
 
1254
 
    Files are placed into limbo inside their parent directories, where
1255
 
    possible.  This reduces subsequent renames, and makes operations involving
1256
 
    lots of files faster.  This optimization is only possible if the parent
1257
 
    directory is created *before* creating any of its children, so avoid
1258
 
    creating children before parents, where possible.
1259
 
 
1260
 
    Pending-deletion
1261
 
    ----------------
1262
 
    This temporary directory is used by _FileMover for storing files that are
1263
 
    about to be deleted.  In case of rollback, the files will be restored.
1264
 
    FileMover does not delete files until it is sure that a rollback will not
1265
 
    happen.
1266
 
    """
1267
 
    def __init__(self, tree, pb=DummyProgress()):
1268
 
        """Note: a tree_write lock is taken on the tree.
1269
 
 
1270
 
        Use TreeTransform.finalize() to release the lock (can be omitted if
1271
 
        TreeTransform.apply() called).
1272
 
        """
1273
 
        tree.lock_tree_write()
1274
 
 
1275
 
        try:
1276
 
            limbodir = urlutils.local_path_from_url(
1277
 
                tree._transport.abspath('limbo'))
1278
 
            try:
1279
 
                os.mkdir(limbodir)
1280
 
            except OSError, e:
1281
 
                if e.errno == errno.EEXIST:
1282
 
                    raise ExistingLimbo(limbodir)
1283
 
            deletiondir = urlutils.local_path_from_url(
1284
 
                tree._transport.abspath('pending-deletion'))
1285
 
            try:
1286
 
                os.mkdir(deletiondir)
1287
 
            except OSError, e:
1288
 
                if e.errno == errno.EEXIST:
1289
 
                    raise errors.ExistingPendingDeletion(deletiondir)
1290
 
        except:
1291
 
            tree.unlock()
1292
 
            raise
1293
 
 
1294
 
        # Cache of realpath results, to speed up canonical_path
1295
 
        self._realpaths = {}
1296
 
        # Cache of relpath results, to speed up canonical_path
1297
 
        self._relpaths = {}
1298
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
1299
 
                                   tree.case_sensitive)
1300
 
        self._deletiondir = deletiondir
1301
 
 
1302
 
    def canonical_path(self, path):
1303
 
        """Get the canonical tree-relative path"""
1304
 
        # don't follow final symlinks
1305
 
        abs = self._tree.abspath(path)
1306
 
        if abs in self._relpaths:
1307
 
            return self._relpaths[abs]
1308
 
        dirname, basename = os.path.split(abs)
1309
 
        if dirname not in self._realpaths:
1310
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1311
 
        dirname = self._realpaths[dirname]
1312
 
        abs = pathjoin(dirname, basename)
1313
 
        if dirname in self._relpaths:
1314
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1315
 
            relpath = relpath.rstrip('/\\')
1316
 
        else:
1317
 
            relpath = self._tree.relpath(abs)
1318
 
        self._relpaths[abs] = relpath
1319
 
        return relpath
1320
 
 
1321
 
    def tree_kind(self, trans_id):
1322
 
        """Determine the file kind in the working tree.
1323
 
 
1324
 
        Raises NoSuchFile if the file does not exist
1325
 
        """
1326
 
        path = self._tree_id_paths.get(trans_id)
1327
 
        if path is None:
1328
 
            raise NoSuchFile(None)
1329
 
        try:
1330
 
            return file_kind(self._tree.abspath(path))
1331
 
        except OSError, e:
1332
 
            if e.errno != errno.ENOENT:
1333
 
                raise
1334
 
            else:
1335
 
                raise NoSuchFile(path)
1336
 
 
1337
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1338
 
        """Set the mode of new file contents.
1339
 
        The mode_id is the existing file to get the mode from (often the same
1340
 
        as trans_id).  The operation is only performed if there's a mode match
1341
 
        according to typefunc.
1342
 
        """
1343
 
        if mode_id is None:
1344
 
            mode_id = trans_id
1345
 
        try:
1346
 
            old_path = self._tree_id_paths[mode_id]
1347
 
        except KeyError:
1348
 
            return
1349
 
        try:
1350
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1351
 
        except OSError, e:
1352
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1353
 
                # Either old_path doesn't exist, or the parent of the
1354
 
                # target is not a directory (but will be one eventually)
1355
 
                # Either way, we know it doesn't exist *right now*
1356
 
                # See also bug #248448
1357
 
                return
1358
 
            else:
1359
 
                raise
1360
 
        if typefunc(mode):
1361
 
            os.chmod(self._limbo_name(trans_id), mode)
1362
 
 
1363
 
    def iter_tree_children(self, parent_id):
1364
 
        """Iterate through the entry's tree children, if any"""
1365
 
        try:
1366
 
            path = self._tree_id_paths[parent_id]
1367
 
        except KeyError:
1368
 
            return
1369
 
        try:
1370
 
            children = os.listdir(self._tree.abspath(path))
1371
 
        except OSError, e:
1372
 
            if not (osutils._is_error_enotdir(e)
1373
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1374
 
                raise
1375
 
            return
1376
 
 
1377
 
        for child in children:
1378
 
            childpath = joinpath(path, child)
1379
 
            if self._tree.is_control_filename(childpath):
1380
 
                continue
1381
 
            yield self.trans_id_tree_path(childpath)
1382
 
 
1383
 
    def _generate_limbo_path(self, trans_id):
1384
 
        """Generate a limbo path using the final path if possible.
1385
 
 
1386
 
        This optimizes the performance of applying the tree transform by
1387
 
        avoiding renames.  These renames can be avoided only when the parent
1388
 
        directory is already scheduled for creation.
1389
 
 
1390
 
        If the final path cannot be used, falls back to using the trans_id as
1391
 
        the relpath.
1392
 
        """
1393
 
        parent = self._new_parent.get(trans_id)
1394
 
        # if the parent directory is already in limbo (e.g. when building a
1395
 
        # tree), choose a limbo name inside the parent, to reduce further
1396
 
        # renames.
1397
 
        use_direct_path = False
1398
 
        if self._new_contents.get(parent) == 'directory':
1399
 
            filename = self._new_name.get(trans_id)
1400
 
            if filename is not None:
1401
 
                if parent not in self._limbo_children:
1402
 
                    self._limbo_children[parent] = set()
1403
 
                    self._limbo_children_names[parent] = {}
1404
 
                    use_direct_path = True
1405
 
                # the direct path can only be used if no other file has
1406
 
                # already taken this pathname, i.e. if the name is unused, or
1407
 
                # if it is already associated with this trans_id.
1408
 
                elif self._case_sensitive_target:
1409
 
                    if (self._limbo_children_names[parent].get(filename)
1410
 
                        in (trans_id, None)):
1411
 
                        use_direct_path = True
1412
 
                else:
1413
 
                    for l_filename, l_trans_id in\
1414
 
                        self._limbo_children_names[parent].iteritems():
1415
 
                        if l_trans_id == trans_id:
1416
 
                            continue
1417
 
                        if l_filename.lower() == filename.lower():
1418
 
                            break
1419
 
                    else:
1420
 
                        use_direct_path = True
1421
 
 
1422
 
        if not use_direct_path:
1423
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1424
 
 
1425
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1426
 
        self._limbo_children[parent].add(trans_id)
1427
 
        self._limbo_children_names[parent][filename] = trans_id
1428
 
        return limbo_name
1429
 
 
1430
 
 
1431
 
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1432
 
        """Apply all changes to the inventory and filesystem.
1433
 
 
1434
 
        If filesystem or inventory conflicts are present, MalformedTransform
1435
 
        will be thrown.
1436
 
 
1437
 
        If apply succeeds, finalize is not necessary.
1438
 
 
1439
 
        :param no_conflicts: if True, the caller guarantees there are no
1440
 
            conflicts, so no check is made.
1441
 
        :param precomputed_delta: An inventory delta to use instead of
1442
 
            calculating one.
1443
 
        :param _mover: Supply an alternate FileMover, for testing
1444
 
        """
1445
 
        if not no_conflicts:
1446
 
            self._check_malformed()
1447
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1448
 
        try:
1449
 
            if precomputed_delta is None:
1450
 
                child_pb.update('Apply phase', 0, 2)
1451
 
                inventory_delta = self._generate_inventory_delta()
1452
 
                offset = 1
1453
 
            else:
1454
 
                inventory_delta = precomputed_delta
1455
 
                offset = 0
1456
 
            if _mover is None:
1457
 
                mover = _FileMover()
1458
 
            else:
1459
 
                mover = _mover
1460
 
            try:
1461
 
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
1462
 
                self._apply_removals(mover)
1463
 
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
1464
 
                modified_paths = self._apply_insertions(mover)
1465
 
            except:
1466
 
                mover.rollback()
1467
 
                raise
1468
 
            else:
1469
 
                mover.apply_deletions()
1470
 
        finally:
1471
 
            child_pb.finished()
1472
 
        self._tree.apply_inventory_delta(inventory_delta)
1473
 
        self._done = True
1474
 
        self.finalize()
1475
 
        return _TransformResults(modified_paths, self.rename_count)
1476
 
 
1477
 
    def _generate_inventory_delta(self):
1478
 
        """Generate an inventory delta for the current transform."""
1479
 
        inventory_delta = []
1480
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1481
 
        new_paths = self._inventory_altered()
1482
 
        total_entries = len(new_paths) + len(self._removed_id)
1483
 
        try:
1484
 
            for num, trans_id in enumerate(self._removed_id):
1485
 
                if (num % 10) == 0:
1486
 
                    child_pb.update('removing file', num, total_entries)
1487
 
                if trans_id == self._new_root:
1488
 
                    file_id = self._tree.get_root_id()
1489
 
                else:
1490
 
                    file_id = self.tree_file_id(trans_id)
1491
 
                # File-id isn't really being deleted, just moved
1492
 
                if file_id in self._r_new_id:
1493
 
                    continue
1494
 
                path = self._tree_id_paths[trans_id]
1495
 
                inventory_delta.append((path, None, file_id, None))
1496
 
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1497
 
                                     new_paths)
1498
 
            entries = self._tree.iter_entries_by_dir(
1499
 
                new_path_file_ids.values())
1500
 
            old_paths = dict((e.file_id, p) for p, e in entries)
1501
 
            final_kinds = {}
1502
 
            for num, (path, trans_id) in enumerate(new_paths):
1503
 
                if (num % 10) == 0:
1504
 
                    child_pb.update('adding file',
1505
 
                                    num + len(self._removed_id), total_entries)
1506
 
                file_id = new_path_file_ids[trans_id]
1507
 
                if file_id is None:
1508
 
                    continue
1509
 
                needs_entry = False
1510
 
                try:
1511
 
                    kind = self.final_kind(trans_id)
1512
 
                except NoSuchFile:
1513
 
                    kind = self._tree.stored_kind(file_id)
1514
 
                parent_trans_id = self.final_parent(trans_id)
1515
 
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1516
 
                if parent_file_id is None:
1517
 
                    parent_file_id = self.final_file_id(parent_trans_id)
1518
 
                if trans_id in self._new_reference_revision:
1519
 
                    new_entry = inventory.TreeReference(
1520
 
                        file_id,
1521
 
                        self._new_name[trans_id],
1522
 
                        self.final_file_id(self._new_parent[trans_id]),
1523
 
                        None, self._new_reference_revision[trans_id])
1524
 
                else:
1525
 
                    new_entry = inventory.make_entry(kind,
1526
 
                        self.final_name(trans_id),
1527
 
                        parent_file_id, file_id)
1528
 
                old_path = old_paths.get(new_entry.file_id)
1529
 
                new_executability = self._new_executability.get(trans_id)
1530
 
                if new_executability is not None:
1531
 
                    new_entry.executable = new_executability
1532
 
                inventory_delta.append(
1533
 
                    (old_path, path, new_entry.file_id, new_entry))
1534
 
        finally:
1535
 
            child_pb.finished()
1536
 
        return inventory_delta
1537
 
 
1538
 
    def _apply_removals(self, mover):
1539
 
        """Perform tree operations that remove directory/inventory names.
1540
 
 
1541
 
        That is, delete files that are to be deleted, and put any files that
1542
 
        need renaming into limbo.  This must be done in strict child-to-parent
1543
 
        order.
1544
 
 
1545
 
        If inventory_delta is None, no inventory delta generation is performed.
1546
 
        """
1547
 
        tree_paths = list(self._tree_path_ids.iteritems())
1548
 
        tree_paths.sort(reverse=True)
1549
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1550
 
        try:
1551
 
            for num, data in enumerate(tree_paths):
1552
 
                path, trans_id = data
1553
 
                child_pb.update('removing file', num, len(tree_paths))
1554
 
                full_path = self._tree.abspath(path)
1555
 
                if trans_id in self._removed_contents:
1556
 
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
1557
 
                                     trans_id))
1558
 
                elif trans_id in self._new_name or trans_id in \
1559
 
                    self._new_parent:
1560
 
                    try:
1561
 
                        mover.rename(full_path, self._limbo_name(trans_id))
1562
 
                    except OSError, e:
1563
 
                        if e.errno != errno.ENOENT:
1564
 
                            raise
1565
 
                    else:
1566
 
                        self.rename_count += 1
1567
 
        finally:
1568
 
            child_pb.finished()
1569
 
 
1570
 
    def _apply_insertions(self, mover):
1571
 
        """Perform tree operations that insert directory/inventory names.
1572
 
 
1573
 
        That is, create any files that need to be created, and restore from
1574
 
        limbo any files that needed renaming.  This must be done in strict
1575
 
        parent-to-child order.
1576
 
 
1577
 
        If inventory_delta is None, no inventory delta is calculated, and
1578
 
        no list of modified paths is returned.
1579
 
        """
1580
 
        new_paths = self.new_paths(filesystem_only=True)
1581
 
        modified_paths = []
1582
 
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1583
 
                                 new_paths)
1584
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1585
 
        try:
1586
 
            for num, (path, trans_id) in enumerate(new_paths):
1587
 
                if (num % 10) == 0:
1588
 
                    child_pb.update('adding file', num, len(new_paths))
1589
 
                full_path = self._tree.abspath(path)
1590
 
                if trans_id in self._needs_rename:
1591
 
                    try:
1592
 
                        mover.rename(self._limbo_name(trans_id), full_path)
1593
 
                    except OSError, e:
1594
 
                        # We may be renaming a dangling inventory id
1595
 
                        if e.errno != errno.ENOENT:
1596
 
                            raise
1597
 
                    else:
1598
 
                        self.rename_count += 1
1599
 
                if (trans_id in self._new_contents or
1600
 
                    self.path_changed(trans_id)):
1601
 
                    if trans_id in self._new_contents:
1602
 
                        modified_paths.append(full_path)
1603
 
                if trans_id in self._new_executability:
1604
 
                    self._set_executability(path, trans_id)
1605
 
        finally:
1606
 
            child_pb.finished()
1607
 
        self._new_contents.clear()
1608
 
        return modified_paths
1609
 
 
1610
 
 
1611
 
class TransformPreview(DiskTreeTransform):
1612
 
    """A TreeTransform for generating preview trees.
1613
 
 
1614
 
    Unlike TreeTransform, this version works when the input tree is a
1615
 
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
1616
 
    unversioned files in the input tree.
1617
 
    """
1618
 
 
1619
 
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1620
 
        tree.lock_read()
1621
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1622
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1623
 
 
1624
 
    def canonical_path(self, path):
1625
 
        return path
1626
 
 
1627
 
    def tree_kind(self, trans_id):
1628
 
        path = self._tree_id_paths.get(trans_id)
1629
 
        if path is None:
1630
 
            raise NoSuchFile(None)
1631
 
        file_id = self._tree.path2id(path)
1632
 
        return self._tree.kind(file_id)
1633
 
 
1634
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1635
 
        """Set the mode of new file contents.
1636
 
        The mode_id is the existing file to get the mode from (often the same
1637
 
        as trans_id).  The operation is only performed if there's a mode match
1638
 
        according to typefunc.
1639
 
        """
1640
 
        # is it ok to ignore this?  probably
1641
 
        pass
1642
 
 
1643
 
    def iter_tree_children(self, parent_id):
1644
 
        """Iterate through the entry's tree children, if any"""
1645
 
        try:
1646
 
            path = self._tree_id_paths[parent_id]
1647
 
        except KeyError:
1648
 
            return
1649
 
        file_id = self.tree_file_id(parent_id)
1650
 
        if file_id is None:
1651
 
            return
1652
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1653
 
        children = getattr(entry, 'children', {})
1654
 
        for child in children:
1655
 
            childpath = joinpath(path, child)
1656
 
            yield self.trans_id_tree_path(childpath)
1657
 
 
1658
 
 
1659
 
class _PreviewTree(tree.Tree):
1660
 
    """Partial implementation of Tree to support show_diff_trees"""
1661
 
 
1662
 
    def __init__(self, transform):
1663
 
        self._transform = transform
1664
 
        self._final_paths = FinalPaths(transform)
1665
 
        self.__by_parent = None
1666
 
        self._parent_ids = []
1667
 
        self._all_children_cache = {}
1668
 
        self._path2trans_id_cache = {}
1669
 
        self._final_name_cache = {}
1670
 
        self._iter_changes_cache = dict((c[0], c) for c in
1671
 
                                        self._transform.iter_changes())
1672
 
 
1673
 
    def _content_change(self, file_id):
1674
 
        """Return True if the content of this file changed"""
1675
 
        changes = self._iter_changes_cache.get(file_id)
1676
 
        # changes[2] is true if the file content changed.  See
1677
 
        # InterTree.iter_changes.
1678
 
        return (changes is not None and changes[2])
1679
 
 
1680
 
    def _get_repository(self):
1681
 
        repo = getattr(self._transform._tree, '_repository', None)
1682
 
        if repo is None:
1683
 
            repo = self._transform._tree.branch.repository
1684
 
        return repo
1685
 
 
1686
 
    def _iter_parent_trees(self):
1687
 
        for revision_id in self.get_parent_ids():
1688
 
            try:
1689
 
                yield self.revision_tree(revision_id)
1690
 
            except errors.NoSuchRevisionInTree:
1691
 
                yield self._get_repository().revision_tree(revision_id)
1692
 
 
1693
 
    def _get_file_revision(self, file_id, vf, tree_revision):
1694
 
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1695
 
                       self._iter_parent_trees()]
1696
 
        vf.add_lines((file_id, tree_revision), parent_keys,
1697
 
                     self.get_file(file_id).readlines())
1698
 
        repo = self._get_repository()
1699
 
        base_vf = repo.texts
1700
 
        if base_vf not in vf.fallback_versionedfiles:
1701
 
            vf.fallback_versionedfiles.append(base_vf)
1702
 
        return tree_revision
1703
 
 
1704
 
    def _stat_limbo_file(self, file_id):
1705
 
        trans_id = self._transform.trans_id_file_id(file_id)
1706
 
        name = self._transform._limbo_name(trans_id)
1707
 
        return os.lstat(name)
1708
 
 
1709
 
    @property
1710
 
    def _by_parent(self):
1711
 
        if self.__by_parent is None:
1712
 
            self.__by_parent = self._transform.by_parent()
1713
 
        return self.__by_parent
1714
 
 
1715
 
    def _comparison_data(self, entry, path):
1716
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1717
 
        if kind == 'missing':
1718
 
            kind = None
1719
 
            executable = False
1720
 
        else:
1721
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
1722
 
            executable = self.is_executable(file_id, path)
1723
 
        return kind, executable, None
1724
 
 
1725
 
    def lock_read(self):
1726
 
        # Perhaps in theory, this should lock the TreeTransform?
1727
 
        pass
1728
 
 
1729
 
    def unlock(self):
1730
 
        pass
1731
 
 
1732
 
    @property
1733
 
    def inventory(self):
1734
 
        """This Tree does not use inventory as its backing data."""
1735
 
        raise NotImplementedError(_PreviewTree.inventory)
1736
 
 
1737
 
    def get_root_id(self):
1738
 
        return self._transform.final_file_id(self._transform.root)
1739
 
 
1740
 
    def all_file_ids(self):
1741
 
        tree_ids = set(self._transform._tree.all_file_ids())
1742
 
        tree_ids.difference_update(self._transform.tree_file_id(t)
1743
 
                                   for t in self._transform._removed_id)
1744
 
        tree_ids.update(self._transform._new_id.values())
1745
 
        return tree_ids
1746
 
 
1747
 
    def __iter__(self):
1748
 
        return iter(self.all_file_ids())
1749
 
 
1750
 
    def _has_id(self, file_id, fallback_check):
1751
 
        if file_id in self._transform._r_new_id:
1752
 
            return True
1753
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1754
 
            trans_id in self._transform._removed_id]):
1755
 
            return False
1756
 
        else:
1757
 
            return fallback_check(file_id)
1758
 
 
1759
 
    def has_id(self, file_id):
1760
 
        return self._has_id(file_id, self._transform._tree.has_id)
1761
 
 
1762
 
    def has_or_had_id(self, file_id):
1763
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
1764
 
 
1765
 
    def _path2trans_id(self, path):
1766
 
        # We must not use None here, because that is a valid value to store.
1767
 
        trans_id = self._path2trans_id_cache.get(path, object)
1768
 
        if trans_id is not object:
1769
 
            return trans_id
1770
 
        segments = splitpath(path)
1771
 
        cur_parent = self._transform.root
1772
 
        for cur_segment in segments:
1773
 
            for child in self._all_children(cur_parent):
1774
 
                final_name = self._final_name_cache.get(child)
1775
 
                if final_name is None:
1776
 
                    final_name = self._transform.final_name(child)
1777
 
                    self._final_name_cache[child] = final_name
1778
 
                if final_name == cur_segment:
1779
 
                    cur_parent = child
1780
 
                    break
1781
 
            else:
1782
 
                self._path2trans_id_cache[path] = None
1783
 
                return None
1784
 
        self._path2trans_id_cache[path] = cur_parent
1785
 
        return cur_parent
1786
 
 
1787
 
    def path2id(self, path):
1788
 
        return self._transform.final_file_id(self._path2trans_id(path))
1789
 
 
1790
 
    def id2path(self, file_id):
1791
 
        trans_id = self._transform.trans_id_file_id(file_id)
1792
 
        try:
1793
 
            return self._final_paths._determine_path(trans_id)
1794
 
        except NoFinalPath:
1795
 
            raise errors.NoSuchId(self, file_id)
1796
 
 
1797
 
    def _all_children(self, trans_id):
1798
 
        children = self._all_children_cache.get(trans_id)
1799
 
        if children is not None:
1800
 
            return children
1801
 
        children = set(self._transform.iter_tree_children(trans_id))
1802
 
        # children in the _new_parent set are provided by _by_parent.
1803
 
        children.difference_update(self._transform._new_parent.keys())
1804
 
        children.update(self._by_parent.get(trans_id, []))
1805
 
        self._all_children_cache[trans_id] = children
1806
 
        return children
1807
 
 
1808
 
    def iter_children(self, file_id):
1809
 
        trans_id = self._transform.trans_id_file_id(file_id)
1810
 
        for child_trans_id in self._all_children(trans_id):
1811
 
            yield self._transform.final_file_id(child_trans_id)
1812
 
 
1813
 
    def extras(self):
1814
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
1815
 
                              in self._transform._tree.extras())
1816
 
        possible_extras.update(self._transform._new_contents)
1817
 
        possible_extras.update(self._transform._removed_id)
1818
 
        for trans_id in possible_extras:
1819
 
            if self._transform.final_file_id(trans_id) is None:
1820
 
                yield self._final_paths._determine_path(trans_id)
1821
 
 
1822
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1823
 
        yield_parents=False):
1824
 
        for trans_id, parent_file_id in ordered_entries:
1825
 
            file_id = self._transform.final_file_id(trans_id)
1826
 
            if file_id is None:
1827
 
                continue
1828
 
            if (specific_file_ids is not None
1829
 
                and file_id not in specific_file_ids):
1830
 
                continue
1831
 
            try:
1832
 
                kind = self._transform.final_kind(trans_id)
1833
 
            except NoSuchFile:
1834
 
                kind = self._transform._tree.stored_kind(file_id)
1835
 
            new_entry = inventory.make_entry(
1836
 
                kind,
1837
 
                self._transform.final_name(trans_id),
1838
 
                parent_file_id, file_id)
1839
 
            yield new_entry, trans_id
1840
 
 
1841
 
    def _list_files_by_dir(self):
1842
 
        todo = [ROOT_PARENT]
1843
 
        ordered_ids = []
1844
 
        while len(todo) > 0:
1845
 
            parent = todo.pop()
1846
 
            parent_file_id = self._transform.final_file_id(parent)
1847
 
            children = list(self._all_children(parent))
1848
 
            paths = dict(zip(children, self._final_paths.get_paths(children)))
1849
 
            children.sort(key=paths.get)
1850
 
            todo.extend(reversed(children))
1851
 
            for trans_id in children:
1852
 
                ordered_ids.append((trans_id, parent_file_id))
1853
 
        return ordered_ids
1854
 
 
1855
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1856
 
        # This may not be a maximally efficient implementation, but it is
1857
 
        # reasonably straightforward.  An implementation that grafts the
1858
 
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1859
 
        # might be more efficient, but requires tricky inferences about stack
1860
 
        # position.
1861
 
        ordered_ids = self._list_files_by_dir()
1862
 
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1863
 
            specific_file_ids, yield_parents=yield_parents):
1864
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1865
 
 
1866
 
    def _iter_entries_for_dir(self, dir_path):
1867
 
        """Return path, entry for items in a directory without recursing down."""
1868
 
        dir_file_id = self.path2id(dir_path)
1869
 
        ordered_ids = []
1870
 
        for file_id in self.iter_children(dir_file_id):
1871
 
            trans_id = self._transform.trans_id_file_id(file_id)
1872
 
            ordered_ids.append((trans_id, file_id))
1873
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1874
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1875
 
 
1876
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1877
 
        """See WorkingTree.list_files."""
1878
 
        # XXX This should behave like WorkingTree.list_files, but is really
1879
 
        # more like RevisionTree.list_files.
1880
 
        if recursive:
1881
 
            prefix = None
1882
 
            if from_dir:
1883
 
                prefix = from_dir + '/'
1884
 
            entries = self.iter_entries_by_dir()
1885
 
            for path, entry in entries:
1886
 
                if entry.name == '' and not include_root:
1887
 
                    continue
1888
 
                if prefix:
1889
 
                    if not path.startswith(prefix):
1890
 
                        continue
1891
 
                    path = path[len(prefix):]
1892
 
                yield path, 'V', entry.kind, entry.file_id, entry
1893
 
        else:
1894
 
            if from_dir is None and include_root is True:
1895
 
                root_entry = inventory.make_entry('directory', '',
1896
 
                    ROOT_PARENT, self.get_root_id())
1897
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1898
 
            entries = self._iter_entries_for_dir(from_dir or '')
1899
 
            for path, entry in entries:
1900
 
                yield path, 'V', entry.kind, entry.file_id, entry
1901
 
 
1902
 
    def kind(self, file_id):
1903
 
        trans_id = self._transform.trans_id_file_id(file_id)
1904
 
        return self._transform.final_kind(trans_id)
1905
 
 
1906
 
    def stored_kind(self, file_id):
1907
 
        trans_id = self._transform.trans_id_file_id(file_id)
1908
 
        try:
1909
 
            return self._transform._new_contents[trans_id]
1910
 
        except KeyError:
1911
 
            return self._transform._tree.stored_kind(file_id)
1912
 
 
1913
 
    def get_file_mtime(self, file_id, path=None):
1914
 
        """See Tree.get_file_mtime"""
1915
 
        if not self._content_change(file_id):
1916
 
            return self._transform._tree.get_file_mtime(file_id)
1917
 
        return self._stat_limbo_file(file_id).st_mtime
1918
 
 
1919
 
    def _file_size(self, entry, stat_value):
1920
 
        return self.get_file_size(entry.file_id)
1921
 
 
1922
 
    def get_file_size(self, file_id):
1923
 
        """See Tree.get_file_size"""
1924
 
        if self.kind(file_id) == 'file':
1925
 
            return self._transform._tree.get_file_size(file_id)
1926
 
        else:
1927
 
            return None
1928
 
 
1929
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1930
 
        trans_id = self._transform.trans_id_file_id(file_id)
1931
 
        kind = self._transform._new_contents.get(trans_id)
1932
 
        if kind is None:
1933
 
            return self._transform._tree.get_file_sha1(file_id)
1934
 
        if kind == 'file':
1935
 
            fileobj = self.get_file(file_id)
1936
 
            try:
1937
 
                return sha_file(fileobj)
1938
 
            finally:
1939
 
                fileobj.close()
1940
 
 
1941
 
    def is_executable(self, file_id, path=None):
1942
 
        if file_id is None:
1943
 
            return False
1944
 
        trans_id = self._transform.trans_id_file_id(file_id)
1945
 
        try:
1946
 
            return self._transform._new_executability[trans_id]
1947
 
        except KeyError:
1948
 
            try:
1949
 
                return self._transform._tree.is_executable(file_id, path)
1950
 
            except OSError, e:
1951
 
                if e.errno == errno.ENOENT:
1952
 
                    return False
1953
 
                raise
1954
 
            except errors.NoSuchId:
1955
 
                return False
1956
 
 
1957
 
    def path_content_summary(self, path):
1958
 
        trans_id = self._path2trans_id(path)
1959
 
        tt = self._transform
1960
 
        tree_path = tt._tree_id_paths.get(trans_id)
1961
 
        kind = tt._new_contents.get(trans_id)
1962
 
        if kind is None:
1963
 
            if tree_path is None or trans_id in tt._removed_contents:
1964
 
                return 'missing', None, None, None
1965
 
            summary = tt._tree.path_content_summary(tree_path)
1966
 
            kind, size, executable, link_or_sha1 = summary
1967
 
        else:
1968
 
            link_or_sha1 = None
1969
 
            limbo_name = tt._limbo_name(trans_id)
1970
 
            if trans_id in tt._new_reference_revision:
1971
 
                kind = 'tree-reference'
1972
 
            if kind == 'file':
1973
 
                statval = os.lstat(limbo_name)
1974
 
                size = statval.st_size
1975
 
                if not supports_executable():
1976
 
                    executable = None
1977
 
                else:
1978
 
                    executable = statval.st_mode & S_IEXEC
1979
 
            else:
1980
 
                size = None
1981
 
                executable = None
1982
 
            if kind == 'symlink':
1983
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1984
 
        if supports_executable():
1985
 
            executable = tt._new_executability.get(trans_id, executable)
1986
 
        return kind, size, executable, link_or_sha1
1987
 
 
1988
 
    def iter_changes(self, from_tree, include_unchanged=False,
1989
 
                      specific_files=None, pb=None, extra_trees=None,
1990
 
                      require_versioned=True, want_unversioned=False):
1991
 
        """See InterTree.iter_changes.
1992
 
 
1993
 
        This has a fast path that is only used when the from_tree matches
1994
 
        the transform tree, and no fancy options are supplied.
1995
 
        """
1996
 
        if (from_tree is not self._transform._tree or include_unchanged or
1997
 
            specific_files or want_unversioned):
1998
 
            return tree.InterTree(from_tree, self).iter_changes(
1999
 
                include_unchanged=include_unchanged,
2000
 
                specific_files=specific_files,
2001
 
                pb=pb,
2002
 
                extra_trees=extra_trees,
2003
 
                require_versioned=require_versioned,
2004
 
                want_unversioned=want_unversioned)
2005
 
        if want_unversioned:
2006
 
            raise ValueError('want_unversioned is not supported')
2007
 
        return self._transform.iter_changes()
2008
 
 
2009
 
    def get_file(self, file_id, path=None):
2010
 
        """See Tree.get_file"""
2011
 
        if not self._content_change(file_id):
2012
 
            return self._transform._tree.get_file(file_id, path)
2013
 
        trans_id = self._transform.trans_id_file_id(file_id)
2014
 
        name = self._transform._limbo_name(trans_id)
2015
 
        return open(name, 'rb')
2016
 
 
2017
 
    def get_file_with_stat(self, file_id, path=None):
2018
 
        return self.get_file(file_id, path), None
2019
 
 
2020
 
    def annotate_iter(self, file_id,
2021
 
                      default_revision=_mod_revision.CURRENT_REVISION):
2022
 
        changes = self._iter_changes_cache.get(file_id)
2023
 
        if changes is None:
2024
 
            get_old = True
2025
 
        else:
2026
 
            changed_content, versioned, kind = (changes[2], changes[3],
2027
 
                                                changes[6])
2028
 
            if kind[1] is None:
2029
 
                return None
2030
 
            get_old = (kind[0] == 'file' and versioned[0])
2031
 
        if get_old:
2032
 
            old_annotation = self._transform._tree.annotate_iter(file_id,
2033
 
                default_revision=default_revision)
2034
 
        else:
2035
 
            old_annotation = []
2036
 
        if changes is None:
2037
 
            return old_annotation
2038
 
        if not changed_content:
2039
 
            return old_annotation
2040
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2041
 
        #       doing, however it fails slightly because it doesn't know what
2042
 
        #       the *other* revision_id is, so it doesn't know how to give the
2043
 
        #       other as the origin for some lines, they all get
2044
 
        #       'default_revision'
2045
 
        #       It would be nice to be able to use the new Annotator based
2046
 
        #       approach, as well.
2047
 
        return annotate.reannotate([old_annotation],
2048
 
                                   self.get_file(file_id).readlines(),
2049
 
                                   default_revision)
2050
 
 
2051
 
    def get_symlink_target(self, file_id):
2052
 
        """See Tree.get_symlink_target"""
2053
 
        if not self._content_change(file_id):
2054
 
            return self._transform._tree.get_symlink_target(file_id)
2055
 
        trans_id = self._transform.trans_id_file_id(file_id)
2056
 
        name = self._transform._limbo_name(trans_id)
2057
 
        return osutils.readlink(name)
2058
 
 
2059
 
    def walkdirs(self, prefix=''):
2060
 
        pending = [self._transform.root]
2061
 
        while len(pending) > 0:
2062
 
            parent_id = pending.pop()
2063
 
            children = []
2064
 
            subdirs = []
2065
 
            prefix = prefix.rstrip('/')
2066
 
            parent_path = self._final_paths.get_path(parent_id)
2067
 
            parent_file_id = self._transform.final_file_id(parent_id)
2068
 
            for child_id in self._all_children(parent_id):
2069
 
                path_from_root = self._final_paths.get_path(child_id)
2070
 
                basename = self._transform.final_name(child_id)
2071
 
                file_id = self._transform.final_file_id(child_id)
2072
 
                try:
2073
 
                    kind = self._transform.final_kind(child_id)
2074
 
                    versioned_kind = kind
2075
 
                except NoSuchFile:
2076
 
                    kind = 'unknown'
2077
 
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2078
 
                if versioned_kind == 'directory':
2079
 
                    subdirs.append(child_id)
2080
 
                children.append((path_from_root, basename, kind, None,
2081
 
                                 file_id, versioned_kind))
2082
 
            children.sort()
2083
 
            if parent_path.startswith(prefix):
2084
 
                yield (parent_path, parent_file_id), children
2085
 
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2086
 
                                  reverse=True))
2087
 
 
2088
 
    def get_parent_ids(self):
2089
 
        return self._parent_ids
2090
 
 
2091
 
    def set_parent_ids(self, parent_ids):
2092
 
        self._parent_ids = parent_ids
2093
 
 
2094
 
    def get_revision_tree(self, revision_id):
2095
 
        return self._transform._tree.get_revision_tree(revision_id)
2096
 
 
2097
 
 
2098
864
def joinpath(parent, child):
2099
865
    """Join tree-relative paths, handling the tree root specially"""
2100
866
    if parent is None or parent == "":
2115
881
        self.transform = transform
2116
882
 
2117
883
    def _determine_path(self, trans_id):
2118
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
884
        if trans_id == self.transform.root:
2119
885
            return ""
2120
886
        name = self.transform.final_name(trans_id)
2121
887
        parent_id = self.transform.final_parent(trans_id)
2130
896
            self._known_paths[trans_id] = self._determine_path(trans_id)
2131
897
        return self._known_paths[trans_id]
2132
898
 
2133
 
    def get_paths(self, trans_ids):
2134
 
        return [(self.get_path(t), t) for t in trans_ids]
2135
 
 
2136
 
 
2137
 
 
2138
899
def topology_sorted_ids(tree):
2139
900
    """Determine the topological order of the ids in a tree"""
2140
901
    file_ids = list(tree)
2141
902
    file_ids.sort(key=tree.id2path)
2142
903
    return file_ids
2143
904
 
2144
 
 
2145
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2146
 
               delta_from_tree=False):
2147
 
    """Create working tree for a branch, using a TreeTransform.
2148
 
 
2149
 
    This function should be used on empty trees, having a tree root at most.
2150
 
    (see merge and revert functionality for working with existing trees)
2151
 
 
2152
 
    Existing files are handled like so:
2153
 
 
2154
 
    - Existing bzrdirs take precedence over creating new items.  They are
2155
 
      created as '%s.diverted' % name.
2156
 
    - Otherwise, if the content on disk matches the content we are building,
2157
 
      it is silently replaced.
2158
 
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2159
 
 
2160
 
    :param tree: The tree to convert wt into a copy of
2161
 
    :param wt: The working tree that files will be placed into
2162
 
    :param accelerator_tree: A tree which can be used for retrieving file
2163
 
        contents more quickly than tree itself, i.e. a workingtree.  tree
2164
 
        will be used for cases where accelerator_tree's content is different.
2165
 
    :param hardlink: If true, hard-link files to accelerator_tree, where
2166
 
        possible.  accelerator_tree must implement abspath, i.e. be a
2167
 
        working tree.
2168
 
    :param delta_from_tree: If true, build_tree may use the input Tree to
2169
 
        generate the inventory delta.
2170
 
    """
2171
 
    wt.lock_tree_write()
2172
 
    try:
2173
 
        tree.lock_read()
2174
 
        try:
2175
 
            if accelerator_tree is not None:
2176
 
                accelerator_tree.lock_read()
2177
 
            try:
2178
 
                return _build_tree(tree, wt, accelerator_tree, hardlink,
2179
 
                                   delta_from_tree)
2180
 
            finally:
2181
 
                if accelerator_tree is not None:
2182
 
                    accelerator_tree.unlock()
2183
 
        finally:
2184
 
            tree.unlock()
2185
 
    finally:
2186
 
        wt.unlock()
2187
 
 
2188
 
 
2189
 
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2190
 
    """See build_tree."""
2191
 
    for num, _unused in enumerate(wt.all_file_ids()):
2192
 
        if num > 0:  # more than just a root
2193
 
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2194
 
    existing_files = set()
2195
 
    for dir, files in wt.walkdirs():
2196
 
        existing_files.update(f[0] for f in files)
 
905
def build_tree(tree, wt):
 
906
    """Create working tree for a branch, using a Transaction."""
2197
907
    file_trans_id = {}
2198
908
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2199
909
    pp = ProgressPhase("Build phase", 2, top_pb)
2200
 
    if tree.inventory.root is not None:
2201
 
        # This is kind of a hack: we should be altering the root
2202
 
        # as part of the regular tree shape diff logic.
2203
 
        # The conditional test here is to avoid doing an
2204
 
        # expensive operation (flush) every time the root id
2205
 
        # is set within the tree, nor setting the root and thus
2206
 
        # marking the tree as dirty, because we use two different
2207
 
        # idioms here: tree interfaces and inventory interfaces.
2208
 
        if wt.get_root_id() != tree.get_root_id():
2209
 
            wt.set_root_id(tree.get_root_id())
2210
 
            wt.flush()
2211
910
    tt = TreeTransform(wt)
2212
 
    divert = set()
2213
911
    try:
2214
912
        pp.next_phase()
2215
 
        file_trans_id[wt.get_root_id()] = \
2216
 
            tt.trans_id_tree_file_id(wt.get_root_id())
 
913
        file_trans_id[wt.get_root_id()] = tt.trans_id_tree_file_id(wt.get_root_id())
 
914
        file_ids = topology_sorted_ids(tree)
2217
915
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2218
916
        try:
2219
 
            deferred_contents = []
2220
 
            num = 0
2221
 
            total = len(tree.inventory)
2222
 
            if delta_from_tree:
2223
 
                precomputed_delta = []
2224
 
            else:
2225
 
                precomputed_delta = None
2226
 
            for num, (tree_path, entry) in \
2227
 
                enumerate(tree.inventory.iter_entries_by_dir()):
2228
 
                pb.update("Building tree", num - len(deferred_contents), total)
 
917
            for num, file_id in enumerate(file_ids):
 
918
                pb.update("Building tree", num, len(file_ids))
 
919
                entry = tree.inventory[file_id]
2229
920
                if entry.parent_id is None:
2230
921
                    continue
2231
 
                reparent = False
2232
 
                file_id = entry.file_id
2233
 
                if delta_from_tree:
2234
 
                    precomputed_delta.append((None, tree_path, file_id, entry))
2235
 
                if tree_path in existing_files:
2236
 
                    target_path = wt.abspath(tree_path)
2237
 
                    kind = file_kind(target_path)
2238
 
                    if kind == "directory":
2239
 
                        try:
2240
 
                            bzrdir.BzrDir.open(target_path)
2241
 
                        except errors.NotBranchError:
2242
 
                            pass
2243
 
                        else:
2244
 
                            divert.add(file_id)
2245
 
                    if (file_id not in divert and
2246
 
                        _content_match(tree, entry, file_id, kind,
2247
 
                        target_path)):
2248
 
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2249
 
                        if kind == 'directory':
2250
 
                            reparent = True
 
922
                if entry.parent_id not in file_trans_id:
 
923
                    raise repr(entry.parent_id)
2251
924
                parent_id = file_trans_id[entry.parent_id]
2252
 
                if entry.kind == 'file':
2253
 
                    # We *almost* replicate new_by_entry, so that we can defer
2254
 
                    # getting the file text, and get them all at once.
2255
 
                    trans_id = tt.create_path(entry.name, parent_id)
2256
 
                    file_trans_id[file_id] = trans_id
2257
 
                    tt.version_file(file_id, trans_id)
2258
 
                    executable = tree.is_executable(file_id, tree_path)
2259
 
                    if executable:
2260
 
                        tt.set_executability(executable, trans_id)
2261
 
                    trans_data = (trans_id, tree_path)
2262
 
                    deferred_contents.append((file_id, trans_data))
2263
 
                else:
2264
 
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2265
 
                                                          tree)
2266
 
                if reparent:
2267
 
                    new_trans_id = file_trans_id[file_id]
2268
 
                    old_parent = tt.trans_id_tree_path(tree_path)
2269
 
                    _reparent_children(tt, old_parent, new_trans_id)
2270
 
            offset = num + 1 - len(deferred_contents)
2271
 
            _create_files(tt, tree, deferred_contents, pb, offset,
2272
 
                          accelerator_tree, hardlink)
 
925
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id, 
 
926
                                                      tree)
2273
927
        finally:
2274
928
            pb.finished()
2275
929
        pp.next_phase()
2276
 
        divert_trans = set(file_trans_id[f] for f in divert)
2277
 
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2278
 
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2279
 
        if len(raw_conflicts) > 0:
2280
 
            precomputed_delta = None
2281
 
        conflicts = cook_conflicts(raw_conflicts, tt)
2282
 
        for conflict in conflicts:
2283
 
            warning(conflict)
2284
 
        try:
2285
 
            wt.add_conflicts(conflicts)
2286
 
        except errors.UnsupportedOperation:
2287
 
            pass
2288
 
        result = tt.apply(no_conflicts=True,
2289
 
                          precomputed_delta=precomputed_delta)
 
930
        tt.apply()
2290
931
    finally:
2291
932
        tt.finalize()
2292
933
        top_pb.finished()
2293
 
    return result
2294
 
 
2295
 
 
2296
 
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2297
 
                  hardlink):
2298
 
    total = len(desired_files) + offset
2299
 
    wt = tt._tree
2300
 
    if accelerator_tree is None:
2301
 
        new_desired_files = desired_files
2302
 
    else:
2303
 
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2304
 
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2305
 
                         in iter if not (c or e[0] != e[1]))
2306
 
        new_desired_files = []
2307
 
        count = 0
2308
 
        for file_id, (trans_id, tree_path) in desired_files:
2309
 
            accelerator_path = unchanged.get(file_id)
2310
 
            if accelerator_path is None:
2311
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
2312
 
                continue
2313
 
            pb.update('Adding file contents', count + offset, total)
2314
 
            if hardlink:
2315
 
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2316
 
                                   trans_id)
2317
 
            else:
2318
 
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2319
 
                if wt.supports_content_filtering():
2320
 
                    filters = wt._content_filter_stack(tree_path)
2321
 
                    contents = filtered_output_bytes(contents, filters,
2322
 
                        ContentFilterContext(tree_path, tree))
2323
 
                try:
2324
 
                    tt.create_file(contents, trans_id)
2325
 
                finally:
2326
 
                    try:
2327
 
                        contents.close()
2328
 
                    except AttributeError:
2329
 
                        # after filtering, contents may no longer be file-like
2330
 
                        pass
2331
 
            count += 1
2332
 
        offset += count
2333
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2334
 
            tree.iter_files_bytes(new_desired_files)):
2335
 
        if wt.supports_content_filtering():
2336
 
            filters = wt._content_filter_stack(tree_path)
2337
 
            contents = filtered_output_bytes(contents, filters,
2338
 
                ContentFilterContext(tree_path, tree))
2339
 
        tt.create_file(contents, trans_id)
2340
 
        pb.update('Adding file contents', count + offset, total)
2341
 
 
2342
 
 
2343
 
def _reparent_children(tt, old_parent, new_parent):
2344
 
    for child in tt.iter_tree_children(old_parent):
2345
 
        tt.adjust_path(tt.final_name(child), new_parent, child)
2346
 
 
2347
 
def _reparent_transform_children(tt, old_parent, new_parent):
2348
 
    by_parent = tt.by_parent()
2349
 
    for child in by_parent[old_parent]:
2350
 
        tt.adjust_path(tt.final_name(child), new_parent, child)
2351
 
    return by_parent[old_parent]
2352
 
 
2353
 
def _content_match(tree, entry, file_id, kind, target_path):
2354
 
    if entry.kind != kind:
2355
 
        return False
2356
 
    if entry.kind == "directory":
2357
 
        return True
2358
 
    if entry.kind == "file":
2359
 
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2360
 
            return True
2361
 
    elif entry.kind == "symlink":
2362
 
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2363
 
            return True
2364
 
    return False
2365
 
 
2366
 
 
2367
 
def resolve_checkout(tt, conflicts, divert):
2368
 
    new_conflicts = set()
2369
 
    for c_type, conflict in ((c[0], c) for c in conflicts):
2370
 
        # Anything but a 'duplicate' would indicate programmer error
2371
 
        if c_type != 'duplicate':
2372
 
            raise AssertionError(c_type)
2373
 
        # Now figure out which is new and which is old
2374
 
        if tt.new_contents(conflict[1]):
2375
 
            new_file = conflict[1]
2376
 
            old_file = conflict[2]
2377
 
        else:
2378
 
            new_file = conflict[2]
2379
 
            old_file = conflict[1]
2380
 
 
2381
 
        # We should only get here if the conflict wasn't completely
2382
 
        # resolved
2383
 
        final_parent = tt.final_parent(old_file)
2384
 
        if new_file in divert:
2385
 
            new_name = tt.final_name(old_file)+'.diverted'
2386
 
            tt.adjust_path(new_name, final_parent, new_file)
2387
 
            new_conflicts.add((c_type, 'Diverted to',
2388
 
                               new_file, old_file))
2389
 
        else:
2390
 
            new_name = tt.final_name(old_file)+'.moved'
2391
 
            tt.adjust_path(new_name, final_parent, old_file)
2392
 
            new_conflicts.add((c_type, 'Moved existing file to',
2393
 
                               old_file, new_file))
2394
 
    return new_conflicts
2395
 
 
2396
934
 
2397
935
def new_by_entry(tt, entry, parent_id, tree):
2398
936
    """Create a new file according to its inventory entry"""
2401
939
    if kind == 'file':
2402
940
        contents = tree.get_file(entry.file_id).readlines()
2403
941
        executable = tree.is_executable(entry.file_id)
2404
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
942
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2405
943
                           executable)
2406
 
    elif kind in ('directory', 'tree-reference'):
2407
 
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2408
 
        if kind == 'tree-reference':
2409
 
            tt.set_tree_reference(entry.reference_revision, trans_id)
2410
 
        return trans_id
 
944
    elif kind == 'directory':
 
945
        return tt.new_directory(name, parent_id, entry.file_id)
2411
946
    elif kind == 'symlink':
2412
947
        target = tree.get_symlink_target(entry.file_id)
2413
948
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2414
 
    else:
2415
 
        raise errors.BadFileKindError(name, kind)
2416
 
 
2417
 
 
2418
 
@deprecated_function(deprecated_in((1, 9, 0)))
 
949
 
2419
950
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2420
 
    """Create new file contents according to an inventory entry.
2421
 
 
2422
 
    DEPRECATED.  Use create_from_tree instead.
2423
 
    """
 
951
    """Create new file contents according to an inventory entry."""
2424
952
    if entry.kind == "file":
2425
 
        if lines is None:
 
953
        if lines == None:
2426
954
            lines = tree.get_file(entry.file_id).readlines()
2427
955
        tt.create_file(lines, trans_id, mode_id=mode_id)
2428
956
    elif entry.kind == "symlink":
2430
958
    elif entry.kind == "directory":
2431
959
        tt.create_directory(trans_id)
2432
960
 
2433
 
 
2434
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2435
 
    """Create new file contents according to tree contents."""
2436
 
    kind = tree.kind(file_id)
2437
 
    if kind == 'directory':
2438
 
        tt.create_directory(trans_id)
2439
 
    elif kind == "file":
2440
 
        if bytes is None:
2441
 
            tree_file = tree.get_file(file_id)
2442
 
            try:
2443
 
                bytes = tree_file.readlines()
2444
 
            finally:
2445
 
                tree_file.close()
2446
 
        tt.create_file(bytes, trans_id)
2447
 
    elif kind == "symlink":
2448
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2449
 
    else:
2450
 
        raise AssertionError('Unknown kind %r' % kind)
2451
 
 
2452
 
 
2453
961
def create_entry_executability(tt, entry, trans_id):
2454
962
    """Set the executability of a trans_id according to an inventory entry"""
2455
963
    if entry.kind == "file":
2456
964
        tt.set_executability(entry.executable, trans_id)
2457
965
 
2458
966
 
 
967
def find_interesting(working_tree, target_tree, filenames):
 
968
    """Find the ids corresponding to specified filenames."""
 
969
    if not filenames:
 
970
        interesting_ids = None
 
971
    else:
 
972
        interesting_ids = set()
 
973
        for tree_path in filenames:
 
974
            not_found = True
 
975
            for tree in (working_tree, target_tree):
 
976
                file_id = tree.inventory.path2id(tree_path)
 
977
                if file_id is not None:
 
978
                    interesting_ids.add(file_id)
 
979
                    not_found = False
 
980
            if not_found:
 
981
                raise NotVersionedError(path=tree_path)
 
982
    return interesting_ids
 
983
 
 
984
 
 
985
def change_entry(tt, file_id, working_tree, target_tree, 
 
986
                 trans_id_file_id, backups, trans_id, by_parent):
 
987
    """Replace a file_id's contents with those from a target tree."""
 
988
    e_trans_id = trans_id_file_id(file_id)
 
989
    entry = target_tree.inventory[file_id]
 
990
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
 
991
                                                           working_tree)
 
992
    if contents_mod:
 
993
        mode_id = e_trans_id
 
994
        if has_contents:
 
995
            if not backups:
 
996
                tt.delete_contents(e_trans_id)
 
997
            else:
 
998
                parent_trans_id = trans_id_file_id(entry.parent_id)
 
999
                backup_name = get_backup_name(entry, by_parent,
 
1000
                                              parent_trans_id, tt)
 
1001
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
 
1002
                tt.unversion_file(e_trans_id)
 
1003
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
 
1004
                tt.version_file(file_id, e_trans_id)
 
1005
                trans_id[file_id] = e_trans_id
 
1006
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
 
1007
        create_entry_executability(tt, entry, e_trans_id)
 
1008
 
 
1009
    elif meta_mod:
 
1010
        tt.set_executability(entry.executable, e_trans_id)
 
1011
    if tt.final_name(e_trans_id) != entry.name:
 
1012
        adjust_path  = True
 
1013
    else:
 
1014
        parent_id = tt.final_parent(e_trans_id)
 
1015
        parent_file_id = tt.final_file_id(parent_id)
 
1016
        if parent_file_id != entry.parent_id:
 
1017
            adjust_path = True
 
1018
        else:
 
1019
            adjust_path = False
 
1020
    if adjust_path:
 
1021
        parent_trans_id = trans_id_file_id(entry.parent_id)
 
1022
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
 
1023
 
 
1024
 
2459
1025
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2460
 
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2461
 
 
2462
 
 
2463
 
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2464
1026
    """Produce a backup-style name that appears to be available"""
2465
1027
    def name_gen():
2466
1028
        counter = 1
2467
1029
        while True:
2468
 
            yield "%s.~%d~" % (name, counter)
 
1030
            yield "%s.~%d~" % (entry.name, counter)
2469
1031
            counter += 1
2470
 
    for new_name in name_gen():
2471
 
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2472
 
            return new_name
2473
 
 
 
1032
    for name in name_gen():
 
1033
        if not tt.has_named_child(by_parent, parent_trans_id, name):
 
1034
            return name
2474
1035
 
2475
1036
def _entry_changes(file_id, entry, working_tree):
2476
1037
    """Determine in which ways the inventory entry has changed.
2484
1045
    try:
2485
1046
        working_kind = working_tree.kind(file_id)
2486
1047
        has_contents = True
2487
 
    except NoSuchFile:
 
1048
    except OSError, e:
 
1049
        if e.errno != errno.ENOENT:
 
1050
            raise
2488
1051
        has_contents = False
2489
1052
        contents_mod = True
2490
1053
        meta_mod = False
2491
1054
    if has_contents is True:
2492
 
        if entry.kind != working_kind:
 
1055
        real_e_kind = entry.kind
 
1056
        if real_e_kind == 'root_directory':
 
1057
            real_e_kind = 'directory'
 
1058
        if real_e_kind != working_kind:
2493
1059
            contents_mod, meta_mod = True, False
2494
1060
        else:
2495
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
1061
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2496
1062
                                       working_tree)
2497
1063
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2498
1064
            cur_entry._forget_tree_state()
2499
1065
    return has_contents, contents_mod, meta_mod
2500
1066
 
2501
1067
 
2502
 
def revert(working_tree, target_tree, filenames, backups=False,
2503
 
           pb=DummyProgress(), change_reporter=None):
 
1068
def revert(working_tree, target_tree, filenames, backups=False, 
 
1069
           pb=DummyProgress()):
2504
1070
    """Revert a working tree's contents to those of a target tree."""
2505
 
    target_tree.lock_read()
 
1071
    interesting_ids = find_interesting(working_tree, target_tree, filenames)
 
1072
    def interesting(file_id):
 
1073
        return interesting_ids is None or file_id in interesting_ids
 
1074
 
2506
1075
    tt = TreeTransform(working_tree, pb)
2507
1076
    try:
2508
 
        pp = ProgressPhase("Revert phase", 3, pb)
2509
 
        conflicts, merge_modified = _prepare_revert_transform(
2510
 
            working_tree, target_tree, tt, filenames, backups, pp)
2511
 
        if change_reporter:
2512
 
            change_reporter = delta._ChangeReporter(
2513
 
                unversioned_filter=working_tree.is_ignored)
2514
 
            delta.report_changes(tt.iter_changes(), change_reporter)
 
1077
        merge_modified = working_tree.merge_modified()
 
1078
        trans_id = {}
 
1079
        def trans_id_file_id(file_id):
 
1080
            try:
 
1081
                return trans_id[file_id]
 
1082
            except KeyError:
 
1083
                return tt.trans_id_tree_file_id(file_id)
 
1084
 
 
1085
        pp = ProgressPhase("Revert phase", 4, pb)
 
1086
        pp.next_phase()
 
1087
        sorted_interesting = [i for i in topology_sorted_ids(target_tree) if
 
1088
                              interesting(i)]
 
1089
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1090
        try:
 
1091
            by_parent = tt.by_parent()
 
1092
            for id_num, file_id in enumerate(sorted_interesting):
 
1093
                child_pb.update("Reverting file", id_num+1, 
 
1094
                                len(sorted_interesting))
 
1095
                if file_id not in working_tree.inventory:
 
1096
                    entry = target_tree.inventory[file_id]
 
1097
                    parent_id = trans_id_file_id(entry.parent_id)
 
1098
                    e_trans_id = new_by_entry(tt, entry, parent_id, target_tree)
 
1099
                    trans_id[file_id] = e_trans_id
 
1100
                else:
 
1101
                    backup_this = backups
 
1102
                    if file_id in merge_modified:
 
1103
                        backup_this = False
 
1104
                        del merge_modified[file_id]
 
1105
                    change_entry(tt, file_id, working_tree, target_tree, 
 
1106
                                 trans_id_file_id, backup_this, trans_id,
 
1107
                                 by_parent)
 
1108
        finally:
 
1109
            child_pb.finished()
 
1110
        pp.next_phase()
 
1111
        wt_interesting = [i for i in working_tree.inventory if interesting(i)]
 
1112
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1113
        try:
 
1114
            for id_num, file_id in enumerate(wt_interesting):
 
1115
                child_pb.update("New file check", id_num+1, 
 
1116
                                len(sorted_interesting))
 
1117
                if file_id not in target_tree:
 
1118
                    trans_id = tt.trans_id_tree_file_id(file_id)
 
1119
                    tt.unversion_file(trans_id)
 
1120
                    if file_id in merge_modified:
 
1121
                        tt.delete_contents(trans_id)
 
1122
                        del merge_modified[file_id]
 
1123
        finally:
 
1124
            child_pb.finished()
 
1125
        pp.next_phase()
 
1126
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1127
        try:
 
1128
            raw_conflicts = resolve_conflicts(tt, child_pb)
 
1129
        finally:
 
1130
            child_pb.finished()
 
1131
        conflicts = cook_conflicts(raw_conflicts, tt)
2515
1132
        for conflict in conflicts:
2516
1133
            warning(conflict)
2517
1134
        pp.next_phase()
2518
1135
        tt.apply()
2519
 
        working_tree.set_merge_modified(merge_modified)
 
1136
        working_tree.set_merge_modified({})
2520
1137
    finally:
2521
 
        target_tree.unlock()
2522
1138
        tt.finalize()
2523
1139
        pb.clear()
2524
1140
    return conflicts
2525
1141
 
2526
1142
 
2527
 
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2528
 
                              backups, pp, basis_tree=None,
2529
 
                              merge_modified=None):
2530
 
    pp.next_phase()
2531
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2532
 
    try:
2533
 
        if merge_modified is None:
2534
 
            merge_modified = working_tree.merge_modified()
2535
 
        merge_modified = _alter_files(working_tree, target_tree, tt,
2536
 
                                      child_pb, filenames, backups,
2537
 
                                      merge_modified, basis_tree)
2538
 
    finally:
2539
 
        child_pb.finished()
2540
 
    pp.next_phase()
2541
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2542
 
    try:
2543
 
        raw_conflicts = resolve_conflicts(tt, child_pb,
2544
 
            lambda t, c: conflict_pass(t, c, target_tree))
2545
 
    finally:
2546
 
        child_pb.finished()
2547
 
    conflicts = cook_conflicts(raw_conflicts, tt)
2548
 
    return conflicts, merge_modified
2549
 
 
2550
 
 
2551
 
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2552
 
                 backups, merge_modified, basis_tree=None):
2553
 
    if basis_tree is not None:
2554
 
        basis_tree.lock_read()
2555
 
    change_list = target_tree.iter_changes(working_tree,
2556
 
        specific_files=specific_files, pb=pb)
2557
 
    if target_tree.get_root_id() is None:
2558
 
        skip_root = True
2559
 
    else:
2560
 
        skip_root = False
2561
 
    try:
2562
 
        deferred_files = []
2563
 
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2564
 
                kind, executable) in enumerate(change_list):
2565
 
            if skip_root and file_id[0] is not None and parent[0] is None:
2566
 
                continue
2567
 
            trans_id = tt.trans_id_file_id(file_id)
2568
 
            mode_id = None
2569
 
            if changed_content:
2570
 
                keep_content = False
2571
 
                if kind[0] == 'file' and (backups or kind[1] is None):
2572
 
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2573
 
                    if merge_modified.get(file_id) != wt_sha1:
2574
 
                        # acquire the basis tree lazily to prevent the
2575
 
                        # expense of accessing it when it's not needed ?
2576
 
                        # (Guessing, RBC, 200702)
2577
 
                        if basis_tree is None:
2578
 
                            basis_tree = working_tree.basis_tree()
2579
 
                            basis_tree.lock_read()
2580
 
                        if file_id in basis_tree:
2581
 
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2582
 
                                keep_content = True
2583
 
                        elif kind[1] is None and not versioned[1]:
2584
 
                            keep_content = True
2585
 
                if kind[0] is not None:
2586
 
                    if not keep_content:
2587
 
                        tt.delete_contents(trans_id)
2588
 
                    elif kind[1] is not None:
2589
 
                        parent_trans_id = tt.trans_id_file_id(parent[0])
2590
 
                        by_parent = tt.by_parent()
2591
 
                        backup_name = _get_backup_name(name[0], by_parent,
2592
 
                                                       parent_trans_id, tt)
2593
 
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2594
 
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
2595
 
                        if versioned == (True, True):
2596
 
                            tt.unversion_file(trans_id)
2597
 
                            tt.version_file(file_id, new_trans_id)
2598
 
                        # New contents should have the same unix perms as old
2599
 
                        # contents
2600
 
                        mode_id = trans_id
2601
 
                        trans_id = new_trans_id
2602
 
                if kind[1] in ('directory', 'tree-reference'):
2603
 
                    tt.create_directory(trans_id)
2604
 
                    if kind[1] == 'tree-reference':
2605
 
                        revision = target_tree.get_reference_revision(file_id,
2606
 
                                                                      path[1])
2607
 
                        tt.set_tree_reference(revision, trans_id)
2608
 
                elif kind[1] == 'symlink':
2609
 
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2610
 
                                      trans_id)
2611
 
                elif kind[1] == 'file':
2612
 
                    deferred_files.append((file_id, (trans_id, mode_id)))
2613
 
                    if basis_tree is None:
2614
 
                        basis_tree = working_tree.basis_tree()
2615
 
                        basis_tree.lock_read()
2616
 
                    new_sha1 = target_tree.get_file_sha1(file_id)
2617
 
                    if (file_id in basis_tree and new_sha1 ==
2618
 
                        basis_tree.get_file_sha1(file_id)):
2619
 
                        if file_id in merge_modified:
2620
 
                            del merge_modified[file_id]
2621
 
                    else:
2622
 
                        merge_modified[file_id] = new_sha1
2623
 
 
2624
 
                    # preserve the execute bit when backing up
2625
 
                    if keep_content and executable[0] == executable[1]:
2626
 
                        tt.set_executability(executable[1], trans_id)
2627
 
                elif kind[1] is not None:
2628
 
                    raise AssertionError(kind[1])
2629
 
            if versioned == (False, True):
2630
 
                tt.version_file(file_id, trans_id)
2631
 
            if versioned == (True, False):
2632
 
                tt.unversion_file(trans_id)
2633
 
            if (name[1] is not None and
2634
 
                (name[0] != name[1] or parent[0] != parent[1])):
2635
 
                if name[1] == '' and parent[1] is None:
2636
 
                    parent_trans = ROOT_PARENT
2637
 
                else:
2638
 
                    parent_trans = tt.trans_id_file_id(parent[1])
2639
 
                tt.adjust_path(name[1], parent_trans, trans_id)
2640
 
            if executable[0] != executable[1] and kind[1] == "file":
2641
 
                tt.set_executability(executable[1], trans_id)
2642
 
        if working_tree.supports_content_filtering():
2643
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2644
 
                target_tree.iter_files_bytes(deferred_files)):
2645
 
                file_id = deferred_files[index][0]
2646
 
                # We're reverting a tree to the target tree so using the
2647
 
                # target tree to find the file path seems the best choice
2648
 
                # here IMO - Ian C 27/Oct/2009
2649
 
                filter_tree_path = target_tree.id2path(file_id)
2650
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2651
 
                bytes = filtered_output_bytes(bytes, filters,
2652
 
                    ContentFilterContext(filter_tree_path, working_tree))
2653
 
                tt.create_file(bytes, trans_id, mode_id)
2654
 
        else:
2655
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2656
 
                deferred_files):
2657
 
                tt.create_file(bytes, trans_id, mode_id)
2658
 
    finally:
2659
 
        if basis_tree is not None:
2660
 
            basis_tree.unlock()
2661
 
    return merge_modified
2662
 
 
2663
 
 
2664
 
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
1143
def resolve_conflicts(tt, pb=DummyProgress()):
2665
1144
    """Make many conflict-resolution attempts, but die if they fail"""
2666
 
    if pass_func is None:
2667
 
        pass_func = conflict_pass
2668
1145
    new_conflicts = set()
2669
1146
    try:
2670
1147
        for n in range(10):
2672
1149
            conflicts = tt.find_conflicts()
2673
1150
            if len(conflicts) == 0:
2674
1151
                return new_conflicts
2675
 
            new_conflicts.update(pass_func(tt, conflicts))
 
1152
            new_conflicts.update(conflict_pass(tt, conflicts))
2676
1153
        raise MalformedTransform(conflicts=conflicts)
2677
1154
    finally:
2678
1155
        pb.clear()
2679
1156
 
2680
1157
 
2681
 
def conflict_pass(tt, conflicts, path_tree=None):
2682
 
    """Resolve some classes of conflicts.
2683
 
 
2684
 
    :param tt: The transform to resolve conflicts in
2685
 
    :param conflicts: The conflicts to resolve
2686
 
    :param path_tree: A Tree to get supplemental paths from
2687
 
    """
 
1158
def conflict_pass(tt, conflicts):
 
1159
    """Resolve some classes of conflicts."""
2688
1160
    new_conflicts = set()
2689
1161
    for c_type, conflict in ((c[0], c) for c in conflicts):
2690
1162
        if c_type == 'duplicate id':
2693
1165
                               conflict[1], conflict[2], ))
2694
1166
        elif c_type == 'duplicate':
2695
1167
            # files that were renamed take precedence
 
1168
            new_name = tt.final_name(conflict[1])+'.moved'
2696
1169
            final_parent = tt.final_parent(conflict[1])
2697
1170
            if tt.path_changed(conflict[1]):
2698
 
                existing_file, new_file = conflict[2], conflict[1]
 
1171
                tt.adjust_path(new_name, final_parent, conflict[2])
 
1172
                new_conflicts.add((c_type, 'Moved existing file to', 
 
1173
                                   conflict[2], conflict[1]))
2699
1174
            else:
2700
 
                existing_file, new_file = conflict[1], conflict[2]
2701
 
            new_name = tt.final_name(existing_file)+'.moved'
2702
 
            tt.adjust_path(new_name, final_parent, existing_file)
2703
 
            new_conflicts.add((c_type, 'Moved existing file to',
2704
 
                               existing_file, new_file))
 
1175
                tt.adjust_path(new_name, final_parent, conflict[1])
 
1176
                new_conflicts.add((c_type, 'Moved existing file to', 
 
1177
                                  conflict[1], conflict[2]))
2705
1178
        elif c_type == 'parent loop':
2706
1179
            # break the loop by undoing one of the ops that caused the loop
2707
1180
            cur = conflict[1]
2710
1183
            new_conflicts.add((c_type, 'Cancelled move', cur,
2711
1184
                               tt.final_parent(cur),))
2712
1185
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2713
 
 
 
1186
            
2714
1187
        elif c_type == 'missing parent':
2715
1188
            trans_id = conflict[1]
2716
1189
            try:
2717
1190
                tt.cancel_deletion(trans_id)
2718
 
                new_conflicts.add(('deleting parent', 'Not deleting',
2719
 
                                   trans_id))
 
1191
                new_conflicts.add((c_type, 'Not deleting', trans_id))
2720
1192
            except KeyError:
2721
 
                create = True
2722
 
                try:
2723
 
                    tt.final_name(trans_id)
2724
 
                except NoFinalPath:
2725
 
                    if path_tree is not None:
2726
 
                        file_id = tt.final_file_id(trans_id)
2727
 
                        if file_id is None:
2728
 
                            file_id = tt.inactive_file_id(trans_id)
2729
 
                        entry = path_tree.inventory[file_id]
2730
 
                        # special-case the other tree root (move its
2731
 
                        # children to current root)
2732
 
                        if entry.parent_id is None:
2733
 
                            create=False
2734
 
                            moved = _reparent_transform_children(
2735
 
                                tt, trans_id, tt.root)
2736
 
                            for child in moved:
2737
 
                                new_conflicts.add((c_type, 'Moved to root',
2738
 
                                                   child))
2739
 
                        else:
2740
 
                            parent_trans_id = tt.trans_id_file_id(
2741
 
                                entry.parent_id)
2742
 
                            tt.adjust_path(entry.name, parent_trans_id,
2743
 
                                           trans_id)
2744
 
                if create:
2745
 
                    tt.create_directory(trans_id)
2746
 
                    new_conflicts.add((c_type, 'Created directory', trans_id))
 
1193
                tt.create_directory(trans_id)
 
1194
                new_conflicts.add((c_type, 'Created directory.', trans_id))
2747
1195
        elif c_type == 'unversioned parent':
2748
 
            file_id = tt.inactive_file_id(conflict[1])
2749
 
            # special-case the other tree root (move its children instead)
2750
 
            if path_tree and file_id in path_tree:
2751
 
                if path_tree.inventory[file_id].parent_id is None:
2752
 
                    continue
2753
 
            tt.version_file(file_id, conflict[1])
 
1196
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
2754
1197
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2755
 
        elif c_type == 'non-directory parent':
2756
 
            parent_id = conflict[1]
2757
 
            parent_parent = tt.final_parent(parent_id)
2758
 
            parent_name = tt.final_name(parent_id)
2759
 
            parent_file_id = tt.final_file_id(parent_id)
2760
 
            new_parent_id = tt.new_directory(parent_name + '.new',
2761
 
                parent_parent, parent_file_id)
2762
 
            _reparent_transform_children(tt, parent_id, new_parent_id)
2763
 
            if parent_file_id is not None:
2764
 
                tt.unversion_file(parent_id)
2765
 
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
2766
 
        elif c_type == 'versioning no contents':
2767
 
            tt.cancel_versioning(conflict[1])
2768
1198
    return new_conflicts
2769
1199
 
2770
 
 
2771
1200
def cook_conflicts(raw_conflicts, tt):
2772
1201
    """Generate a list of cooked conflicts, sorted by file path"""
2773
 
    from bzrlib.conflicts import Conflict
2774
 
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2775
 
    return sorted(conflict_iter, key=Conflict.sort_key)
 
1202
    def key(conflict):
 
1203
        if conflict.path is not None:
 
1204
            return conflict.path, conflict.typestring
 
1205
        elif getattr(conflict, "conflict_path", None) is not None:
 
1206
            return conflict.conflict_path, conflict.typestring
 
1207
        else:
 
1208
            return None, conflict.typestring
2776
1209
 
 
1210
    return sorted(list(iter_cook_conflicts(raw_conflicts, tt)), key=key)
2777
1211
 
2778
1212
def iter_cook_conflicts(raw_conflicts, tt):
2779
1213
    from bzrlib.conflicts import Conflict
2786
1220
        if len(conflict) == 3:
2787
1221
            yield Conflict.factory(c_type, action=action, path=modified_path,
2788
1222
                                     file_id=modified_id)
2789
 
 
 
1223
             
2790
1224
        else:
2791
1225
            conflicting_path = fp.get_path(conflict[3])
2792
1226
            conflicting_id = tt.final_file_id(conflict[3])
2793
1227
            yield Conflict.factory(c_type, action=action, path=modified_path,
2794
 
                                   file_id=modified_id,
 
1228
                                   file_id=modified_id, 
2795
1229
                                   conflict_path=conflicting_path,
2796
1230
                                   conflict_file_id=conflicting_id)
2797
 
 
2798
 
 
2799
 
class _FileMover(object):
2800
 
    """Moves and deletes files for TreeTransform, tracking operations"""
2801
 
 
2802
 
    def __init__(self):
2803
 
        self.past_renames = []
2804
 
        self.pending_deletions = []
2805
 
 
2806
 
    def rename(self, from_, to):
2807
 
        """Rename a file from one path to another.  Functions like os.rename"""
2808
 
        try:
2809
 
            os.rename(from_, to)
2810
 
        except OSError, e:
2811
 
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2812
 
                raise errors.FileExists(to, str(e))
2813
 
            raise
2814
 
        self.past_renames.append((from_, to))
2815
 
 
2816
 
    def pre_delete(self, from_, to):
2817
 
        """Rename a file out of the way and mark it for deletion.
2818
 
 
2819
 
        Unlike os.unlink, this works equally well for files and directories.
2820
 
        :param from_: The current file path
2821
 
        :param to: A temporary path for the file
2822
 
        """
2823
 
        self.rename(from_, to)
2824
 
        self.pending_deletions.append(to)
2825
 
 
2826
 
    def rollback(self):
2827
 
        """Reverse all renames that have been performed"""
2828
 
        for from_, to in reversed(self.past_renames):
2829
 
            os.rename(to, from_)
2830
 
        # after rollback, don't reuse _FileMover
2831
 
        past_renames = None
2832
 
        pending_deletions = None
2833
 
 
2834
 
    def apply_deletions(self):
2835
 
        """Apply all marked deletions"""
2836
 
        for path in self.pending_deletions:
2837
 
            delete_any(path)
2838
 
        # after apply_deletions, don't reuse _FileMover
2839
 
        past_renames = None
2840
 
        pending_deletions = None